silverstripe / silverstripe-cms

code/CMSBatchAction.php

Doc Comments +3 added lines, -2 removed lines

@@ -35,7 +35,8 @@ 
 	 *
 	 * @param $pages The DataObjectSet of SiteTree objects to perform this batch action
 	 * on.
-	 * @param $helperMethod The method to call on each of those objects.
+	 * @param string $helperMethod The method to call on each of those objects.
+	 * @param string $successMessage
 	 */
 	public function batchaction(DataObjectSet $pages, $helperMethod, $successMessage, $arguments = array()) {
 		$failures = 0;
@@ -72,7 +73,7 @@ 
 	 * Helper method for applicablePages() methods.  Acts as a skeleton implementation.
 	 * 
 	 * @param $ids The IDs passed to applicablePages
-	 * @param $methodName The canXXX() method to call on each page to check if the action is applicable
+	 * @param string $methodName The canXXX() method to call on each page to check if the action is applicable
 	 * @param $checkStagePages Set to true if you want to check stage pages
 	 * @param $checkLivePages Set to true if you want to check live pages (e.g, for deleted-from-draft)
 	 */

code/CMSBatchActionHandler.php

Doc Comments +4 added lines

@@ -37,6 +37,10 @@
 		}
 	}
 	
+	/**
+	 * @param CMSMain $parentController
+	 * @param string $urlSegment
+	 */
 	function __construct($parentController, $urlSegment) {
 		$this->parentController = $parentController;
 		$this->urlSegment = $urlSegment;

code/CMSMenu.php

Doc Comments +5 added lines, -3 removed lines

@@ -105,7 +105,7 @@ 
 	 * @param string $menuTitle The link's title in the CMS menu
 	 * @param string $url The url of the link
 	 * @param integer $priority The menu priority (sorting order) of the menu item.  Higher priorities will be further left.
-	 * @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) {
 		return self::add_menu_item($code, $menuTitle, $url, null, $priority);
@@ -123,7 +123,7 @@ 
 	 * @param string $controllerClass The controller class for this menu, used to check permisssions.  
 	 * 					If blank, it's assumed that this is public, and always shown to users who 
 	 * 					have the rights to access some other part of the admin area.
-	 * @return boolean Success
+	 * @return boolean|null Success
 	 */
 	public static function add_menu_item($code, $menuTitle, $url, $controllerClass = null, $priority = -1) {
 		// If a class is defined, then force the use of that as a code.  This helps prevent menu item duplication
@@ -242,7 +242,7 @@ 
 	 * @param string $controllerClass The controller class for this menu, used to check permisssions.  
 	 * 					If blank, it's assumed that this is public, and always shown to users who 
 	 * 					have the rights to access some other part of the admin area.
-	 * @return boolean Success
+	 * @return boolean|null Success
 	 */
 	public static function replace_menu_item($code, $menuTitle, $url, $controllerClass = null, $priority = -1) {
 		self::$menu_item_changes[] = array(
@@ -254,6 +254,8 @@ 
 	
 	/**
 	 * Add a previously built menuitem object to the menu
+	 * @param string $code
+	 * @param CMSMenuItem $cmsMenuItem
 	 */
 	protected static function add_menu_item_obj($code, $cmsMenuItem) {
 		self::$menu_item_changes[] = array(

code/CommentTableField.php

Doc Comments +6 added lines

@@ -8,6 +8,12 @@
 	protected $template = "CommentTableField";
 	protected $mode;
 	
+	/**
+	 * @param CommentAdmin $controller
+	 * @param string $name
+	 * @param string $sourceClass
+	 * @param FieldSet $detailFormFields
+	 */
 	function __construct($controller, $name, $sourceClass, $mode, $fieldList, $detailFormFields = null, $sourceFilter = "", $sourceSort = "Created", $sourceJoin = "") {
 		$this->mode = $mode;
 		

code/Diff.php

Doc Comments +10 added lines, -1 removed lines

@@ -247,6 +247,10 @@ 
      * match.  The caller must trim matching lines from the beginning and end
      * of the portions it is going to specify.
      */
+
+    /**
+     * @param double $nchunks
+     */
     function _diag ($xoff, $xlim, $yoff, $ylim, $nchunks) {
 	$flip = false;
 	
@@ -357,6 +361,11 @@ 
      * Note that XLIM, YLIM are exclusive bounds.
      * All line numbers are origin-0 and discarded lines are not counted.
      */
+
+    /**
+     * @param integer $xoff
+     * @param integer $yoff
+     */
     function _compareseq ($xoff, $xlim, $yoff, $ylim) {
 	// Slide down the bottom initial diagonal.
 	while ($xoff < $xlim && $yoff < $ylim
@@ -554,7 +563,7 @@ 
      *
      *  $diff = new Diff($lines1, $lines2);
      *  $rev = $diff->reverse();
-     * @return object A Diff object representing the inverse of the
+     * @return Diff A Diff object representing the inverse of the
      *                original diff.
      */
     function reverse () {

code/GroupImportForm.php

Doc Comments +4 added lines

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

code/MemberImportForm.php

Doc Comments +5 added lines, -1 removed lines

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

code/ModelAdmin.php

Doc Comments +4 added lines, -3 removed lines

@@ -645,7 +645,7 @@ 
 	 * Action to render a data object collection, using the model context to provide filters
 	 * and paging.
 	 * 
-	 * @return string
+	 * @return SS_HTTPResponse
 	 */
 	function search($request, $form) {
 		// Get the results form to be rendered
@@ -794,7 +794,7 @@ 
 	 * Create a new model record.
 	 *
 	 * @param unknown_type $request
-	 * @return unknown
+	 * @return SS_HTTPResponse
 	 */
 	function add($request) {
 		return new SS_HTTPResponse(
@@ -912,6 +912,7 @@ 
 	
 	/**
 	 * Edit action - shows a form for editing this record
+	 * @param SS_HTTPRequest $request
 	 */
 	function edit($request) {
 		if ($this->currentRecord) {
@@ -1012,7 +1013,7 @@ 
 	 * Renders the record view template.
 	 * 
 	 * @param SS_HTTPRequest $request
-	 * @return mixed
+	 * @return string
 	 */
 	function view($request) {
 		if($this->currentRecord) {

code/Report.php

Doc Comments +6 added lines

@@ -314,6 +314,7 @@ 
 	
 	/**
 	 * Return the SS_Report objects making up the given list.
+	 * @param string $list
 	 * @return An array of SS_Report objects
 	 */
 	static function get_reports($list) {
@@ -365,6 +366,10 @@ 
 	
 	protected $obj, $method, $params;
 	
+	/**
+	 * @param SS_Report $obj
+	 * @param string $method
+	 */
 	function __construct($obj, $method, $params) {
 		$this->obj = $obj;
 		$this->method = $method;
@@ -373,6 +378,7 @@ 
 	
 	/**
 	 * Provide a method that will return a list of columns that can be used to sort.
+	 * @param string $sortColMethod
 	 */
 	function setSortColumnMethod($sortColMethod) {
 		$this->sortColMethod = $sortColMethod;