silverstripe / silverstripe-framework

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

tasks/EncryptAllPasswordsTask.php

Doc Comments +1 added lines

@@ -66,6 +66,7 @@
 
 	/**
 	 * @todo This should really be taken care of by TestRunner
+	 * @param string $msg
 	 */
 	protected function debugMessage($msg) {
 		if(class_exists('SapphireTest', false) && !SapphireTest::is_running_test()) {

tests/core/manifest/ConfigManifestTest.php

Doc Comments +3 added lines, -2 removed lines

@@ -10,7 +10,7 @@ 
 
 	/**
 	 * This is a helper method for getting a new manifest
-	 * @param $name
+	 * @param string $name
 	 * @return any
 	 */
 	protected function getConfigFixtureValue($name) {
@@ -20,6 +20,7 @@ 
 
 	/**
 	 * This is a helper method for displaying a relevant message about a parsing failure
+	 * @param string $path
 	 */
 	protected function getParsedAsMessage($path) {
 		return sprintf('Reference path "%s" failed to parse correctly', $path);
@@ -41,7 +42,7 @@ 
 
 	/**
 	 * A helper method to return a mock of the manifest in order to test expectations and reduce dependency
-	 * @param $methods
+	 * @param string[] $methods
 	 * @return SS_ConfigManifest
 	 */
 	protected function getManifestMock($methods) {

tests/dev/CsvBulkLoaderTest.php

Doc Comments +3 added lines

@@ -222,6 +222,9 @@
 	}
 
 
+	/**
+	 * @param resource $file
+	 */
 	protected function getLineCount(&$file) {
 		$i = 0;
 		while(fgets($file) !== false) $i++;

tests/dev/DevAdminControllerTest.php

Doc Comments +6 added lines

@@ -47,6 +47,9 @@ 
 
 
 
+	/**
+	 * @param string $url
+	 */
 	protected function getCapture($url){
 		$this->logInWithPermission('ADMIN');
 
@@ -58,6 +61,9 @@ 
 		return $r;
 	}
 
+	/**
+	 * @param string $url
+	 */
 	protected function getAndCheckForError($url){
 		$this->logInWithPermission('ADMIN');
 

tests/forms/EmailFieldTest.php

Doc Comments +5 added lines

@@ -23,6 +23,11 @@
 		$this->internalCheck("domain.but.no.user", "Invalid, no user part", false);
 	}
 
+	/**
+	 * @param string $email
+	 * @param string $checkText
+	 * @param boolean $expectSuccess
+	 */
 	public function internalCheck($email, $checkText, $expectSuccess) {
 		$field = new EmailField("MyEmail");
 		$field->setValue($email);

tests/forms/gridfield/GridField_URLHandlerTest.php

Doc Comments +3 added lines

@@ -111,6 +111,9 @@
 
 	protected $id;
 
+	/**
+	 * @param string $link
+	 */
 	public function __construct($gridField, $id, $link) {
 		$this->gridField = $gridField;
 		$this->id = $id;

tests/forms/NumericFieldTest.php

Doc Comments +3 added lines

@@ -21,6 +21,9 @@
 		return str_replace(' ', $nbsp, trim($input));
 	}
 
+	/**
+	 * @param string $locale
+	 */
 	protected function checkInputValidation($locale, $tests) {
 		i18n::set_locale($locale);
 		$field = new NumericField('Number');