silverstripe / silverstripe-framework

admin/code/CMSBatchAction.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
 	 * @param $objs The SS_List of objects to perform this batch action
 	 * on.
 	 * @param $helperMethod The method to call on each of those objects.
-	 * @return JSON encoded map in the following format:
+	 * @return string encoded map in the following format:
 	 *  {
 	 *     'modified': {
 	 *       3: {'TreeTitle': 'Page3'},

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/LeftAndMain.php

Doc Comments +7 added lines, -2 removed lines

@@ -550,6 +550,7 @@ 
 	 * Returns the menu title for the given LeftAndMain subclass.
 	 * Implemented static so that we can get this value without instantiating an object.
 	 * Menu title is *not* internationalised.
+	 * @return string
 	 */
 	public static function menu_title_for_class($class) {
 		$title = Config::inst()->get($class, 'menu_title', Config::FIRST_SET);
@@ -715,6 +716,7 @@ 
 	 * Return a list of appropriate templates for this class, with the given suffix using
 	 * {@link SSViewer::get_templates_by_class()}
 	 *
+	 * @param string $suffix
 	 * @return array
 	 */
 	public function getTemplatesWithSuffix($suffix) {
@@ -1535,7 +1537,7 @@ 
 	 * The controller might not have any previewable content, in which case
 	 * this method returns FALSE.
 	 *
-	 * @return String|boolean
+	 * @return boolean
 	 */
 	public function LinkPreview() {
 		return false;
@@ -1726,7 +1728,7 @@ 
 	}
 
 	/**
-	 * @return String
+	 * @return DBField
 	 */
 	public function Locale() {
 		return DBField::create_field('DBLocale', i18n::get_locale());
@@ -1892,6 +1894,9 @@ 
 		return (parent::isFinished() || $this->isFinished);
 	}
 
+	/**
+	 * @param boolean $bool
+	 */
 	public function setIsFinished($bool) {
 		$this->isFinished = $bool;
 	}

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