silverstripe / silverstripe-framework

admin/code/CMSMenu.php

Doc Comments +5 added lines, -3 removed lines

@@ -86,7 +86,7 @@ 
 	 *                          left.
 	 * @param array $attributes an array of attributes to include on the link.
 	 *
-	 * @return boolean The result of the operation.
+	 * @return boolean|null The result of the operation.
 	 */
 	public static function add_link($code, $menuTitle, $url, $priority = -1, $attributes = null) {
 		return self::add_menu_item($code, $menuTitle, $url, null, $priority, $attributes);
@@ -106,7 +106,7 @@ 
 	 * 					have the rights to access some other part of the admin area.
 	 * @param array $attributes an array of attributes to include on the link.
 	 *
-	 * @return boolean Success
+	 * @return boolean|null Success
 	 */
 	public static function add_menu_item($code, $menuTitle, $url, $controllerClass = null, $priority = -1,
 											$attributes = null) {
@@ -237,7 +237,7 @@ 
 	 * 					have the rights to access some other part of the admin area.
 	 * @param array $attributes an array of attributes to include on the link.
 	 *
-	 * @return boolean Success
+	 * @return boolean|null Success
 	 */
 	public static function replace_menu_item($code, $menuTitle, $url, $controllerClass = null, $priority = -1,
 												$attributes = null) {
@@ -256,6 +256,8 @@ 
 	
 	/**
 	 * Add a previously built menu item object to the menu
+	 * @param string $code
+	 * @param CMSMenuItem $cmsMenuItem
 	 */
 	protected static function add_menu_item_obj($code, $cmsMenuItem) {
 		self::$menu_item_changes[] = array(

admin/code/CMSMenuItem.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
 	/**
 	 * @param array
 	 *
-	 * @return HTML
+	 * @return string
 	 */
 	public function getAttributesHTML($attrs = null) {
 		$exclude = (is_string($attrs)) ? func_get_args() : null;

admin/code/GroupImportForm.php

Doc Comments +4 added lines

@@ -14,6 +14,10 @@
 	 */
 	protected $group;
 
+	/**
+	 * @param SecurityAdmin $controller
+	 * @param string $name
+	 */
 	public function __construct($controller, $name, $fields = null, $actions = null, $validator = null) {
 		if(!$fields) {
 			$helpHtml = _t(

admin/code/MemberImportForm.php

Doc Comments +5 added lines, -1 removed lines

@@ -14,6 +14,10 @@ 
 	 */
 	protected $group;
 
+	/**
+	 * @param SecurityAdmin $controller
+	 * @param string $name
+	 */
 	public function __construct($controller, $name, $fields = null, $actions = null, $validator = null) {
 		if(!$fields) {
 			$helpHtml = _t(
@@ -100,7 +104,7 @@ 
 	}
 
 	/**
-	 * @param $group Group
+	 * @param DataObject $group Group
 	 */
 	public function setGroup($group) {
 		$this->group = $group;

api/RestfulService.php

Doc Comments +3 added lines, -3 removed lines

@@ -336,8 +336,8 @@ 
 	/**
 	 * Extracts the response body and headers from a full curl response
 	 *
-	 * @param curl_handle $ch The curl handle for the request
-	 * @param string $rawResponse The raw response text
+	 * @param resource $ch The curl handle for the request
+	 * @param string $rawHeaders
 	 *
 	 * @return RestfulService_Response The response object
 	 */
@@ -601,7 +601,7 @@ 
 	 * get the cached response object. This allows you to access the cached
 	 * eaders, not just the cached body.
 	 *
-	 * @return RestfulSerivice_Response The cached response object
+	 * @return boolean The cached response object
 	 */
 	public function getCachedResponse() {
 		return $this->cachedResponse;

api/RSSFeed.php

Doc Comments +5 added lines

@@ -214,6 +214,7 @@ 
 	 * via the standard template inclusion process.
 	 *
 	 * @param string
+	 * @param string $template
 	 */
 	public function setTemplate($template) {
 		$this->template = $template;
@@ -269,6 +270,9 @@ 
 
 	/**
 	 * Create a new RSSFeed entry.
+	 * @param string $titleField
+	 * @param string $descriptionField
+	 * @param string $authorField
 	 */
 	public function __construct($entry, $titleField, $descriptionField,
 											$authorField) {
@@ -310,6 +314,7 @@ 
 	/**
 	 * Return the named field as an obj() call from $this->failover.
 	 * Default to the given class if there's no casting information.
+	 * @param string $fieldName
 	 */
 	public function rssField($fieldName, $defaultClass = 'Varchar') {
 		if($fieldName) {

control/ContentNegotiator.php

Doc Comments +1 added lines

@@ -109,6 +109,7 @@
 	/**
 	 * Returns true if negotiation is enabled for the given response. By default, negotiation is only
 	 * enabled for pages that have the xml header.
+	 * @param SS_HTTPResponse $response
 	 */
 	public static function enabled_for($response) {
 		$contentType = $response->getHeader("Content-Type");

control/CookieJar.php

Doc Comments +2 added lines, -2 removed lines

@@ -144,13 +144,13 @@
 	 * @see http://uk3.php.net/manual/en/function.setcookie.php
 	 *
 	 * @param string $name The name of the cookie
-	 * @param string|array $value The value for the cookie to hold
+	 * @param false|string $value The value for the cookie to hold
 	 * @param int $expiry The number of days until expiry
 	 * @param string $path The path to save the cookie on (falls back to site base)
 	 * @param string $domain The domain to make the cookie available on
 	 * @param boolean $secure Can the cookie only be sent over SSL?
 	 * @param boolean $httpOnly Prevent the cookie being accessible by JS
-	 * @return boolean If the cookie was set or not; doesn't mean it's accepted by the browser
+	 * @return boolean|null If the cookie was set or not; doesn't mean it's accepted by the browser
 	 */
 	protected function outputCookie(
 		$name, $value, $expiry = 90, $path = null, $domain = null, $secure = false, $httpOnly = true

control/Director.php

Doc Comments +3 added lines, -3 removed lines

@@ -534,7 +534,7 @@ 
 	 * Returns the domain part of the URL 'http://www.mysite.com'. Returns FALSE is this environment
 	 * variable isn't set.
 	 *
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function protocolAndHost() {
 		$alternate = Config::inst()->get('Director', 'alternate_base_url');
@@ -869,7 +869,7 @@ 
 	/**
 	 * Returns true if the given file exists. Filename should be relative to the site root.
 	 *
-	 * @param $file
+	 * @param string $file
 	 *
 	 * @return bool
 	 */
@@ -1087,7 +1087,7 @@ 
 	 * Can also be checked with {@link Director::isDev()}, {@link Director::isTest()}, and
 	 * {@link Director::isLive()}.
 	 *
-	 * @return bool|string
+	 * @return string|false
 	 */
 	public static function get_environment_type() {
 		if(Director::isLive()) {