silverstripe / silverstripe-framework

model/UnsavedRelationList.php

Doc Comments +2 added lines, -2 removed lines

@@ -50,6 +50,7 @@ 
 	 * Create a new UnsavedRelationList
 	 *
 	 * @param string $dataClass The DataObject class used in the relation
+	 * @param string $relationName
 	 */
 	public function __construct($baseClass, $relationName, $dataClass) {
 		$this->baseClass = $baseClass;
@@ -142,7 +143,7 @@ 
 	 * Add a number of items to the relation.
 	 *
 	 * @param array $items Items to add, as either DataObjects or IDs.
-	 * @return DataList
+	 * @return UnsavedRelationList
 	 */
 	public function addMany($items) {
 		foreach($items as $item) {
@@ -177,7 +178,6 @@ 
 	/**
 	 * Remove the items from this list with the given IDs
 	 *
-	 * @param array $idList
 	 */
 	public function removeMany($items) {
 		$this->items = array_diff($this->items, $items);

model/URLSegmentFilter.php

Doc Comments +2 added lines, -1 removed lines

@@ -106,7 +106,7 @@ 
 	protected $transliterator;
 
 	/**
-	 * @return SS_Transliterator|NULL
+	 * @return SS_Transliterator
 	 */
 	public function getTransliterator() {
 		if($this->transliterator === null && $this->config()->default_use_transliterator) {
@@ -129,6 +129,7 @@ 
 
 	/**
 	 * @param boolean
+	 * @param boolean $bool
 	 */
 	public function setAllowMultibyte($bool) {
 		$this->allowMultibyte = $bool;

oembed/Oembed.php

Doc Comments +5 added lines

@@ -46,6 +46,7 @@ 
 	 *
 	 * @param $url Human-readable URL.
 	 * @returns string/bool URL of an endpoint, or false if no matching provider exists.
+	 * @return string
 	 */
 	protected static function find_endpoint($url) {
 		foreach(self::get_providers() as $scheme=>$endpoint) {
@@ -261,6 +262,9 @@ 
 		parent::__construct();
 	}
 
+	/**
+	 * @return string
+	 */
 	public function getOembedURL() {
 		return $this->url;
 	}
@@ -319,6 +323,7 @@ 
 
 	/**
 	 * Wrap the check for looking into Oembed JSON within $this->data.
+	 * @param string $field
 	 */
 	public function hasField($field) {
 		$this->loadData();

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);

search/filters/SearchFilter.php

Doc Comments +2 added lines, -2 removed lines

@@ -47,7 +47,7 @@ 
 	 *  column. Can contain a relation name in dot notation, which will automatically join
 	 *  the necessary tables (e.g. "Comments.Name" to join the "Comments" has-many relationship and
 	 *  search the "Name" column when applying this filter to a SiteTree class).
-	 * @param mixed $value
+	 * @param string $value
 	 * @param array $modifiers
 	 */
 	public function __construct($fullName, $value = false, array $modifiers = array()) {
@@ -287,7 +287,7 @@ 
 	/**
 	 * Determines case sensitivity based on {@link getModifiers()}.
 	 *
-	 * @return Mixed TRUE or FALSE to enforce sensitivity, NULL to use field collation.
+	 * @return boolean|null TRUE or FALSE to enforce sensitivity, NULL to use field collation.
 	 */
 	protected function getCaseSensitive() {
 		$modifiers = $this->getModifiers();

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;