silverstripe / silverstripe-framework

model/HTMLValue.php

Doc Comments +1 added lines, -2 removed lines

@@ -20,7 +20,6 @@ 
 	abstract public function setContent($fragment);
 
 	/**
-	 * @param string $content
 	 * @return string
 	 */
 	public function getContent() {
@@ -140,7 +139,7 @@ 
 	/**
 	 * Make an xpath query against this HTML
 	 *
-	 * @param $query string - The xpath query string
+	 * @param string $query string - The xpath query string
 	 * @return DOMNodeList
 	 */
 	public function query($query) {

model/Map.php

Doc Comments +5 added lines, -1 removed lines

@@ -41,6 +41,7 @@ 
 	 * Set the key field for this map.
 	 *
 	 * @var string $keyField
+	 * @param string $keyField
 	 */
 	public function setKeyField($keyField) {
 		$this->keyField = $keyField;
@@ -50,6 +51,7 @@ 
 	 * Set the value field for this map.
 	 *
 	 * @var string $valueField
+	 * @param string $valueField
 	 */
 	public function setValueField($valueField) {
 		$this->valueField = $valueField;
@@ -95,6 +97,7 @@ 
 	 *
 	 * @var string $key
 	 * @var mixed $value
+	 * @param string $value
 	 */
 	public function unshift($key, $value) {
 		$oldItems = $this->firstItems;
@@ -114,6 +117,7 @@ 
 	 *
 	 * @var string $key
 	 * @var mixed $value
+	 * @param string $value
 	 */
 	public function push($key, $value) {
 		$oldItems = $this->lastItems;
@@ -286,7 +290,7 @@ 
 	 * @param Iterator $items The iterator to build this map from
 	 * @param string $keyField The field to use for the keys
 	 * @param string $titleField The field to use for the values
-	 * @param array $fristItems An optional map of items to show first
+	 * @param array $firstItems An optional map of items to show first
 	 * @param array $lastItems An optional map of items to show last
 	 */
 	public function __construct(Iterator $items, $keyField, $titleField, $firstItems = null, $lastItems = null) {

model/queries/SQLAssignmentRow.php

Doc Comments -3 removed lines

@@ -74,9 +74,6 @@
 	 * Given a list of assignments in any user-acceptible format, normalise the
 	 * value to a common array('SQL' => array(parameters)) format
 	 *
-	 * @param array $predicates List of assignments.
-	 * The key of this array should be the field name, and the value the assigned
-	 * literal value, or an array with parameterised information.
 	 * @return array List of normalised assignments
 	 */
 	protected function normaliseAssignments(array $assignments) {

model/queries/SQLConditionalExpression.php

Doc Comments -4 removed lines

@@ -374,7 +374,6 @@ 
 	 * @see SQLConditionalExpression::addWhere() for syntax examples
 	 *
 	 * @param mixed $where Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $where,... Unlimited additional predicates
 	 * @return self Self reference
 	 */
 	public function setWhere($where) {
@@ -460,7 +459,6 @@ 
 	 * </code>
 	 *
 	 * @param mixed $where Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $where,... Unlimited additional predicates
 	 * @return self Self reference
 	 */
 	public function addWhere($where) {
@@ -476,7 +474,6 @@ 
 	 * @see SQLConditionalExpression::addWhere()
 	 *
 	 * @param mixed $filters Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $filters,... Unlimited additional predicates
 	 * @return self Self reference
 	 */
 	public function setWhereAny($filters) {
@@ -490,7 +487,6 @@ 
 	 * @see SQLConditionalExpression::addWhere()
 	 *
 	 * @param mixed $filters Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $filters,... Unlimited additional predicates
 	 * @return self Self reference
 	 */
 	public function addWhereAny($filters) {

model/queries/SQLExpression.php

Doc Comments -1 removed lines

@@ -125,7 +125,6 @@
 	 * Copies the query parameters contained in this object to another
 	 * SQLExpression
 	 *
-	 * @param SQLExpression $expression The object to copy properties to
 	 */
 	protected function copyTo(SQLExpression $object) {
 		$target = array_keys(get_object_vars($object));

model/queries/SQLSelect.php

Doc Comments +1 added lines, -4 removed lines

@@ -115,7 +115,6 @@ 
 	 * </code>
 	 *
 	 * @param string|array $fields Field names should be ANSI SQL quoted. Array keys should be unquoted.
-	 * @param boolean $clear Clear existing select fields?
 	 * @return $this Self reference
 	 */
 	public function setSelect($fields) {
@@ -352,7 +351,7 @@ 
 	 *
 	 * @param string $value
 	 * @param string $defaultDirection
-	 * @return array A two element array: array($column, $direction)
+	 * @return string[] A two element array: array($column, $direction)
 	 */
 	private function getDirectionFromString($value, $defaultDirection = null) {
 		if(preg_match('/^(.*)(asc|desc)$/i', $value, $matches)) {
@@ -447,7 +446,6 @@ 
 	 * @see SQLSelect::addWhere() for syntax examples
 	 *
 	 * @param mixed $having Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $having,... Unlimited additional predicates
 	 * @return self Self reference
 	 */
 	public function setHaving($having) {
@@ -462,7 +460,6 @@ 
 	 * @see SQLSelect::addWhere() for syntax examples
 	 *
 	 * @param mixed $having Predicate(s) to set, as escaped SQL statements or paramaterised queries
-	 * @param mixed $having,... Unlimited additional predicates
 	 * @return self Self reference
 	 */
 	public function addHaving($having) {

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(.,"]")]');