silverstripe / silverstripe-cms

tasks/UpgradeSiteTreePermissionSchemaTask.php

Doc Comments +3 added lines

@@ -19,6 +19,9 @@
 		See http://open.silverstripe.com/ticket/2847
 	";
 	
+	/**
+	 * @param SS_HTTPRequest $request
+	 */
 	public function run($request) {
 		// transfer values for changed column name
 		foreach(array('SiteTree','SiteTree_Live','SiteTree_versions') as $table) {

code/model/ErrorPage.php

Doc Comments +1 added lines, -1 removed lines

@@ -252,7 +252,7 @@
 	/**
 	 * Write out the published version of the page to the filesystem
 	 *
-	 * @return true if the page write was successful
+	 * @return boolean if the page write was successful
 	 */
 	public function writeStaticPage() {
 		if(!self::config()->enable_static_file) {

code/controllers/ContentController.php

Doc Comments +1 added lines

@@ -222,6 +222,7 @@
 
 	/**
 	 * Returns the associated database record
+	 * @return SiteTree
 	 */
 	public function data() {
 		return $this->dataRecord;

code/model/VirtualPage.php

Doc Comments +3 added lines

@@ -341,6 +341,9 @@
 		}
 	}
 
+	/**
+	 * @param string $field
+	 */
 	public function getField($field) {
 		if($this->isFieldVirtualised($field)) {
 			return $this->CopyContentFrom()->getField($field);

code/controllers/CMSPageHistoryController.php

Doc Comments +4 added lines, -4 removed lines

@@ -40,7 +40,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return array
+	 * @return SS_HTTPResponse
 	 */
 	public function show($request) {
 		$form = $this->ShowVersionForm($request->param('VersionID'));
@@ -59,7 +59,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return array
+	 * @return SS_HTTPResponse
 	 */
 	public function compare($request) {
 		$form = $this->CompareVersionsForm(
@@ -278,7 +278,7 @@ 
 	 * @param array
 	 * @param Form
 	 *
-	 * @return html
+	 * @return null|SilverStripe\Model\FieldType\DBField
 	 */
 	public function doCompare($data, $form) {
 		$versions = $data['Versions'];
@@ -315,7 +315,7 @@ 
 	 * @param array
 	 * @param Form
 	 *
-	 * @return html
+	 * @return null|SilverStripe\Model\FieldType\DBField
 	 */
 	public function doShowVersion($data, $form) {
 		$versionID = null;

code/controllers/ModelAsController.php

Doc Comments +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
 	/**
 	 * @uses ModelAsController::getNestedController()
 	 * @param SS_HTTPRequest $request
-	 * @param DataModel $model
+	 * @param null|DataModel $model
 	 * @return SS_HTTPResponse
 	 */
 	public function handleRequest(SS_HTTPRequest $request, DataModel $model) {

code/controllers/SilverStripeNavigator.php

Doc Comments +3 added lines, -3 removed lines

@@ -20,7 +20,7 @@ 
 	protected $record;
 
 	/**
-	 * @param DataObject|CMSPreviewable $record
+	 * @param CMSPreviewable $record
 	 */
 	public function __construct(CMSPreviewable $record) {
 		parent::__construct();
@@ -106,7 +106,7 @@ 
 	protected $record;
 
 	/**
-	 * @param DataObject|CMSPreviewable $record
+	 * @param CMSPreviewable $record
 	 */
 	public function __construct(CMSPreviewable $record) {
 		parent::__construct();
@@ -149,7 +149,7 @@ 
 	public function getMessage() {}
 
 	/**
-	 * @return DataObject
+	 * @return CMSPreviewable
 	 */
 	public function getRecord() {
 		return $this->record;

code/controllers/AssetAdmin.php

Doc Comments +5 added lines

@@ -48,6 +48,7 @@ 
 
 	/**
 	 * Return fake-ID "root" if no ID is found (needed to upload files into the root-folder)
+	 * @return string
 	 */
 	public function currentPageID() {
 		if(is_numeric($this->getRequest()->requestVar('ID')))	{
@@ -562,6 +563,10 @@ 
 		return new Folder();
 	}
 
+	/**
+	 * @param string $childrenMethod
+	 * @param string $numChildrenMethod
+	 */
 	public function getSiteTreeFor($className, $rootID = null, $childrenMethod = null, $numChildrenMethod = null, $filterFunction = null, $minNodeCount = 30) {
 		if (!$childrenMethod) $childrenMethod = 'ChildFolders';
 		if (!$numChildrenMethod) $numChildrenMethod = 'numChildFolders';

code/controllers/CMSSiteTreeFilter.php

Doc Comments +1 added lines, -1 removed lines

@@ -113,7 +113,7 @@
 	 * Gets the list of filtered pages
 	 *
 	 * @see {@link SiteTree::getStatusFlags()}
-	 * @return SS_List
+	 * @return DataList
 	 */
 	abstract public function getFilteredPages();