silverstripe / silverstripe-cms

code/Controllers/AssetAdmin.php

Doc Comments +4 added lines

@@ -538,6 +538,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/CMSMain.php

Doc Comments +7 added lines, -4 removed lines

@@ -283,6 +283,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $link
+	 */
 	public function LinkWithSearch($link) {
 		// Whitelist to avoid side effects
 		$params = array(
@@ -757,7 +760,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return string HTML
+	 * @return DBHTMLText HTML
 	 */
 	public function treeview($request) {
 		return $this->renderWith($this->getTemplatesWithSuffix('_TreeView'));
@@ -765,7 +768,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return string HTML
+	 * @return DBHTMLText HTML
 	 */
 	public function listview($request) {
 		return $this->renderWith($this->getTemplatesWithSuffix('_ListView'));
@@ -1078,7 +1081,7 @@ 
 	 * Actually perform the publication step
 	 *
 	 * @param Versioned|DataObject $record
-	 * @return mixed
+	 * @return SS_HTTPResponse|null
 	 */
 	public function performPublish($record) {
 		if($record && !$record->canPublish()) {
@@ -1232,7 +1235,7 @@ 
 	}
 
 	/**
-	 * @return array
+	 * @return SS_HTTPResponse|null
 	 */
 	public function rollback() {
 		return $this->doRollback(array(

Unused Use Statements -6 removed lines

@@ -17,8 +17,6 @@ 
 use SilverStripe\Security\Permission;
 use SilverStripe\Security\PermissionProvider;
 use LeftAndMain;
-
-
 use SS_HTTPRequest;
 use Translatable;
 use Requirements;
@@ -27,15 +25,12 @@ 
 use AdminRootController;
 use Director;
 use Page;
-
 use TextField;
-use HeaderField;
 use DateField;
 use DropdownField;
 use FieldGroup;
 use FieldList;
 use FormAction;
-use Object;
 use Form;
 use SS_Cache;
 use Zend_Cache;
@@ -56,7 +51,6 @@ 
 use SS_HTTPResponse_Exception;
 use Session;
 use AddToCampaignHandler;
-use HTMLEditorField;
 use SS_HTTPResponse;
 use SilverStripe\CMS\Model\SiteTree;
 use SilverStripe\CMS\Model\RedirectorPage;

code/Controllers/CMSPageHistoryController.php

Doc Comments +2 added lines, -2 removed lines

@@ -61,7 +61,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return array
+	 * @return SS_HTTPResponse
 	 */
 	public function show($request) {
 		$form = $this->ShowVersionForm($request->param('VersionID'));
@@ -80,7 +80,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return array
+	 * @return SS_HTTPResponse
 	 */
 	public function compare($request) {
 		$form = $this->CompareVersionsForm(

code/Controllers/ContentController.php

Unused Use Statements -2 removed lines

@@ -17,9 +17,7 @@
 use SilverStripe\Security\Permission;
 use Controller;
 use Page;
-
 use SiteConfig;
-use Config;
 use SS_HTTPRequest;
 use Translatable;
 use i18n;

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;

Unused Use Statements -1 removed lines

@@ -13,7 +13,6 @@
 use ClassInfo;
 use LeftAndMain;
 use Controller;
-
 use SiteTreeFutureState;
 use SilverStripe\CMS\Model\RedirectorPage;
 

code/Forms/SiteTreeURLSegmentField.php

Doc Comments +3 added lines

@@ -118,6 +118,9 @@
 		return $this->defaultUrl;
 	}
 
+	/**
+	 * @param string $url
+	 */
 	public function setDefaultURL($url) {
 		$this->defaultUrl = $url;
 		return $this;

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/Model/SiteTree.php

Doc Comments +2 added lines, -2 removed lines

@@ -749,7 +749,7 @@ 
 	 * @param boolean $unlinked Whether to link page titles.
 	 * @param boolean|string $stopAtPageType ClassName of a page to stop the upwards traversal.
 	 * @param boolean $showHidden Include pages marked with the attribute ShowInMenus = 0
-	 * @return string The breadcrumb trail.
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText The breadcrumb trail.
 	 */
 	public function Breadcrumbs($maxDepth = 20, $unlinked = false, $stopAtPageType = false, $showHidden = false) {
 		$pages = $this->getBreadcrumbItems($maxDepth, $stopAtPageType, $showHidden);
@@ -1343,7 +1343,7 @@ 
 	/**
 	 * Get the 'can edit' information for a number of SiteTree pages.
 	 *
-	 * @param array $ids       An array of IDs of the SiteTree pages to look up
+	 * @param integer[] $ids       An array of IDs of the SiteTree pages to look up
 	 * @param int   $memberID  ID of member
 	 * @param bool  $useCached Return values from the permission cache if they exist
 	 * @return array

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);