silverstripe / silverstripe-cms

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;

code/ReportAdmin.php

Doc Comments +1 added lines, -1 removed lines

@@ -88,7 +88,7 @@
 	 * @TODO What does this do?
 	 *
 	 * @param unknown_type $params
-	 * @param unknown_type $editForm
+	 * @param Form $editForm
 	 * @return unknown
 	 */
 	protected function showWithEditForm($params, $editForm) {

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;