silverstripe / silverstripe-framework

parsers/BBCodeParser.php

Doc Comments +1 added lines, -1 removed lines

@@ -165,7 +165,7 @@
 	 * Main BBCode parser method. This takes plain jane content and
 	 * runs it through so many filters
 	 *
-	 * @return Text
+	 * @return string
 	 */
 	public function parse() {
 		$this->content = str_replace(array('&', '<', '>'), array('&amp;', '&lt;', '&gt;'), $this->content);

parsers/HTML/HTMLBBCodeParser.php

Doc Comments +7 added lines, -2 removed lines

@@ -177,6 +177,10 @@ 
 		$this->addFilters($this->_options['filters']);
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $var
+	 */
 	static function &getStaticProperty($class, $var)
 	{
 		static $properties;
@@ -406,6 +410,7 @@ 
 	 * array as an associative array.
 	 *
 	 * @param    string          string to build tag from
+	 * @param string $str
 	 * @return   array           tag in array format
 	 * @access   private
 	 * @see      _buildTagArray()
@@ -840,7 +845,7 @@ 
 	/**
 	 * Quick method to do setText(), parse() and getParsed at once
 	 *
-	 * @return   none
+	 * @return   string
 	 * @access   public
 	 * @see      parse()
 	 * @see      $_text
@@ -856,7 +861,7 @@ 
 	/**
 	 * Quick static method to do setText(), parse() and getParsed at once
 	 *
-	 * @return   none
+	 * @return   string
 	 * @access   public
 	 * @see      parse()
 	 * @see      $_text

parsers/ShortcodeParser.php

Doc Comments +7 added lines, -1 removed lines

@@ -152,6 +152,9 @@ 
 
 	// --------------------------------------------------------------------------------------------------------------
 
+	/**
+	 * @param DOMElement $node
+	 */
 	protected function removeNode($node) {
 		$node->parentNode->removeChild($node);
 	}
@@ -167,6 +170,9 @@ 
 		}
 	}
 
+	/**
+	 * @param DOMElement $after
+	 */
 	protected function insertListAfter($new, $after) {
 		$doc = $after->ownerDocument; $parent = $after->parentNode; $next = $after->nextSibling;
 
@@ -347,6 +353,7 @@ 
 	 *
 	 * @param string $content - The HTML string with [tag] style shortcodes embedded
 	 * @param array $tags - The tags extracted by extractTags
+	 * @param Closure $generator
 	 * @return string - The HTML string with [tag] style shortcodes replaced by markers
 	 */
 	protected function replaceTagsWithText($content, $tags, $generator) {
@@ -379,7 +386,6 @@ 
 	 * We don't use markers with attributes because there's no point, it's easier to do all the matching
 	 * in-DOM after the XML parse
 	 *
-	 * @param DOMDocument $doc
 	 */
 	protected function replaceAttributeTagsWithContent($htmlvalue) {
 		$attributes = $htmlvalue->query('//@*[contains(.,"[")][contains(.,"]")]');

search/filters/ComparisonFilter.php

Doc Comments +2 added lines, -2 removed lines

@@ -34,7 +34,7 @@ 
 	 * Handles SQL escaping for both numeric and string values
 	 *
 	 * @param DataQuery $query
-	 * @return $this|DataQuery
+	 * @return DataQuery
 	 */
 	protected function applyOne(DataQuery $query) {
 		$this->model = $query->applyRelation($this->relation);
@@ -50,7 +50,7 @@ 
 	 * Handles SQL escaping for both numeric and string values
 	 *
 	 * @param DataQuery $query
-	 * @return $this|DataQuery
+	 * @return DataQuery
 	 */
 	protected function excludeOne(DataQuery $query) {
 		$this->model = $query->applyRelation($this->relation);

security/Authenticator.php

Doc Comments +3 added lines, -2 removed lines

@@ -43,7 +43,7 @@ 
 	/**
 	 * Method that creates the login form for this authentication method
 	 *
-	 * @param Controller The parent controller, necessary to create the
+	 * @param Controller Controller parent controller, necessary to create the
 	 *                   appropriate form action tag
 	 * @return Form Returns the login form to use with this authentication
 	 *              method
@@ -121,7 +121,7 @@ 
 	 * Remove a previously registered authenticator
 	 *
 	 * @param string $authenticator Name of the authenticator class to register
-	 * @return bool Returns TRUE on success, FALSE otherwise.
+	 * @return boolean|null Returns TRUE on success, FALSE otherwise.
 	 */
 	public static function unregister_authenticator($authenticator) {
 		if(call_user_func(array($authenticator, 'on_unregister')) === true) {
@@ -164,6 +164,7 @@ 
 	 * Set a default authenticator (shows first in tabs)
 	 *
 	 * @param string
+	 * @param string $authenticator
 	 */
 	public static function set_default_authenticator($authenticator) {
 		self::$default_authenticator = $authenticator;

security/CMSSecurity.php

Doc Comments +9 added lines

@@ -42,6 +42,9 @@ 
 		);
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function Link($action = null) {
 		return Controller::join_links(Director::baseURL(), "CMSSecurity", $action);
 	}
@@ -57,6 +60,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $title
+	 */
 	public function getResponseController($title) {
 		// Use $this to prevent use of Page to render underlying templates
 		return $this;
@@ -172,6 +178,9 @@ 
 		user_error('Passed invalid authentication method', E_USER_ERROR);
 	}
 
+	/**
+	 * @param string $action
+	 */
 	public function getTemplatesFor($action) {
 		return array("CMSSecurity_{$action}", "CMSSecurity")
 			+ parent::getTemplatesFor($action);

security/Group.php

Doc Comments +1 added lines

@@ -331,6 +331,7 @@
 	 * Overloaded to ensure the code is always descent.
 	 *
 	 * @param string
+	 * @param string $val
 	 */
 	public function setCode($val){
 		$this->setField("Code", Convert::raw2url($val));

security/Member.php

Doc Comments +3 added lines, -1 removed lines

@@ -585,6 +585,8 @@ 
 
 	/**
 	 * Utility for generating secure password hashes for this member.
+	 * @param string $string
+	 * @return string
 	 */
 	public function encryptWithUserSettings($string) {
 		if (!$string) return null;
@@ -735,7 +737,7 @@ 
 	/**
 	 * Returns the current logged in user
 	 *
-	 * @return Member|null
+	 * @return DataObject|null
 	 */
 	public static function currentUser() {
 		$id = Member::currentUserID();

security/MemberAuthenticator.php

Doc Comments +2 added lines, -2 removed lines

@@ -134,7 +134,7 @@ 
 	 * @param Form $form Optional: If passed, better error messages can be
 	 *                             produced by using
 	 *                             {@link Form::sessionMessage()}
-	 * @return bool|Member Returns FALSE if authentication fails, otherwise
+	 * @return Member|null Returns FALSE if authentication fails, otherwise
 	 *                     the member object
 	 * @see Security::setDefaultAdmin()
 	 */
@@ -165,7 +165,7 @@ 
 	/**
 	 * Method that creates the login form for this authentication method
 	 *
-	 * @param Controller The parent controller, necessary to create the
+	 * @param Controller Controller parent controller, necessary to create the
 	 *                   appropriate form action tag
 	 * @return Form Returns the login form to use with this authentication
 	 *              method