silverstripe / silverstripe-cms

code/SecurityAdmin.php

Doc Comments +1 added lines, -1 removed lines

@@ -127,7 +127,7 @@
 	}
 
 	/**
-	 * @return FieldSet
+	 * @return Form
 	 */
 	function RootForm() {
 		$memberList = new MemberTableField(

code/SideReport.php

Doc Comments +3 added lines

@@ -11,6 +11,9 @@
 	protected $controller, $report;
 	protected $parameters;
 	
+	/**
+	 * @param CMSMain $controller
+	 */
 	function __construct($controller, $report) {
 		$this->controller = $controller;
 		$this->report = $report;

code/sitefeatures/Akismet.php

Doc Comments +5 added lines

@@ -113,6 +113,11 @@
 			}
 		}
 	
+	/**
+	 * @param string $request
+	 * @param string $host
+	 * @param string $path
+	 */
 	private function http_post($request, $host, $path)
 		{
 		$http_request  = "POST " . $path . " HTTP/1.1\r\n";

code/sitefeatures/PageCommentInterface.php

Doc Comments +2 added lines, -1 removed lines

@@ -120,6 +120,7 @@ 
 	 * See {@link PageCommentInterface::$use_ajax_commenting}
 	 *
 	 * @param bool
+	 * @param boolean $state
 	 */
 	static function set_use_ajax_commenting($state) {
 		self::$use_ajax_commenting = $state;
@@ -154,7 +155,7 @@ 
 	 * valid permission code in order to post (used to customize the error 
 	 * message).
 	 * 
-	 * @return bool
+	 * @return string
 	 */
 	function PostingRequiresPermission() {
 		return self::$comments_require_permission;

code/staticpublisher/FilesystemPublisher.php

Doc Comments +3 added lines

@@ -271,6 +271,9 @@
 	
 	/**
 	 * Generate the templated content for a PHP script that can serve up the given piece of content with the given age and expiry
+	 * @param string $content
+	 * @param integer $age
+	 * @param string $lastModified
 	 */
 	protected function generatePHPCacheFile($content, $age, $lastModified) {
 		$template = file_get_contents(BASE_PATH . '/cms/code/staticpublisher/CachedPHPPage.tmpl');

code/staticpublisher/StaticPublisher.php

Doc Comments +1 added lines

@@ -34,6 +34,7 @@
 	/**
 	 * Either turns on (boolean true) or off (boolean false) the progress indicators.
 	 * @see StaticPublisher::$echo_progress
+	 * @param boolean $progress
 	 */
 	static function set_echo_progress($progress) {
 		self::$echo_progress = (boolean)$progress;

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) {
@@ -377,7 +379,7 @@ 
 	 *
 	 * @param array $data 
 	 * @param Form $form 
-	 * @return FormResponse
+	 * @return null|SS_HTTPResponse
 	 */
 	function save_siteconfig($data, $form) {
 		$siteConfig = SiteConfig::current_site_config();
@@ -851,6 +853,8 @@ 
 	 *  - Update the action buttons
 	 *  - Update the treenote
 	 *  - Send a status message
+	 * @param DataObject $page
+	 * @param string $statusMessage
 	 */
 	function tellBrowserAboutPublicationChange($page, $statusMessage) {
 		$JS_title = Convert::raw2js($page->TreeTitle());

code/LeftAndMain.php

Doc Comments +11 added lines, -2 removed lines

@@ -341,6 +341,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) {
@@ -360,6 +361,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;");
@@ -404,6 +406,10 @@ 
 		}
 		else return "";
 	}
+
+	/**
+	 * @param string $html
+	 */
 	public function getLastFormIn($html) {
 		$parts = split('</?form[^>]*>', $html);
 		return $parts[sizeof($parts)-2];
@@ -481,6 +487,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));
@@ -511,8 +518,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
@@ -841,7 +850,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;