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

Doc Comments +5 added lines, -1 removed lines

@@ -115,6 +115,7 @@ 
 	/**
 	 * Overloads the LeftAndMain::ShowView. Allows to pass a page as a parameter, so we are able
 	 * to switch view also for archived versions.
+	 * @param DataObject $page
 	 */
 	function SwitchView($page = null) {
 		if(!$page) {
@@ -137,6 +138,7 @@ 
 	/**
 	 * Override {@link LeftAndMain} Link to allow blank URL segment for CMSMain.
 	 * 
+	 * @param string $action
 	 * @return string
 	 */
 	public function Link($action = null) {
@@ -371,7 +373,7 @@ 
 	 *
 	 * @param array $data 
 	 * @param Form $form 
-	 * @return FormResponse
+	 * @return null|SS_HTTPResponse
 	 */
 	function save_siteconfig($data, $form) {
 		$siteConfig = SiteConfig::current_site_config();
@@ -834,6 +836,8 @@ 
 	 *  - Update the action buttons
 	 *  - Update the treenote
 	 *  - Send a status message
+	 * @param DataObject|null $page
+	 * @param string $statusMessage
 	 */
 	function tellBrowserAboutPublicationChange($page, $statusMessage) {
 		$JS_title = Convert::raw2js($page->TreeTitle());

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

Doc Comments +12 added lines, -3 removed lines

@@ -334,6 +334,7 @@ 
 	 * You should implement a Link() function in your subclass of LeftAndMain,
 	 * to point to the URL of that particular controller.
 	 * 
+	 * @param string $action
 	 * @return string
 	 */
 	public function Link($action = null) {
@@ -353,6 +354,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
  	*/
 	static function menu_title_for_class($class) {
 		$title = eval("return $class::\$menu_title;");
@@ -397,6 +399,10 @@ 
 		}
 		else return "";
 	}
+
+	/**
+	 * @param string $html
+	 */
 	public function getLastFormIn($html) {
 		$parts = split('</?form[^>]*>', $html);
 		return $parts[sizeof($parts)-2];
@@ -474,6 +480,7 @@ 
 
   /**
    * Return a list of appropriate templates for this class, with the given suffix
+   * @param string $suffix
    */
   protected function getTemplatesWithSuffix($suffix) {
     $classes = array_reverse(ClassInfo::ancestry($this->class));
@@ -504,8 +511,10 @@ 
 	 * @param $className The class of the root object
 	 * @param $rootID The ID of the root object.  If this is null then a complete tree will be
 	 *                shown
-	 * @param $childrenMethod The method to call to get the children of the tree.  For example,
+	 * @param string $childrenMethod The method to call to get the children of the tree.  For example,
 	 *                        Children, AllChildrenIncludingDeleted, or AllHistoricalChildren
+	 * @param string $numChildrenMethod
+	 * @return string
 	 */
 	function getSiteTreeFor($className, $rootID = null, $childrenMethod = null, $numChildrenMethod = null, $filterFunction = null, $minNodeCount = 30) {
 		// Default childrenMethod and numChildrenMethod
@@ -826,7 +835,7 @@ 
 	/**
 	 * Returns a javascript snippet to generate a tree node for the given page, if visible
 	 *
-	 * @return string
+	 * @return null|SS_HTTPResponse
 	 */
 	public function addTreeNodeJS($page, $select = false) {
 		$parentID = (int)$page->ParentID;
@@ -843,7 +852,7 @@ 
 	/**
 	 * Returns a javascript snippet to remove a tree node for the given page, if it exists.
 	 *
-	 * @return string
+	 * @return null|SS_HTTPResponse
 	 */
 	public function deleteTreeNodeJS($page) {
 		$id = $page->ID ? $page->ID : $page->OldID;

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;