silverstripe / silverstripe-cms

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;

Unused Use Statements -1 removed lines

@@ -7,7 +7,6 @@
 use SilverStripe\Control\HTTPRequest;
 use SilverStripe\Core\Convert;
 use SilverStripe\Forms\TextField;
-use SilverStripe\View\Requirements;
 
 /**
  * Used to edit the SiteTree->URLSegment property, and suggest input based on the serverside rules

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

Doc Comments +1 added lines, -1 removed lines

@@ -753,7 +753,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);

code/Controllers/SilverStripeNavigator.php

Doc Comments +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
 	protected $record;
 
 	/**
-	 * @param DataObject|CMSPreviewable $record
+	 * @param CMSPreviewable $record
 	 */
 	public function __construct(CMSPreviewable $record) {
 		parent::__construct();

code/Controllers/SilverStripeNavigatorItem.php

Doc Comments +2 added lines, -2 removed lines

@@ -27,7 +27,7 @@ 
 	protected $recordLink;
 
 	/**
-	 * @param DataObject|CMSPreviewable $record
+	 * @param CMSPreviewable $record
 	 */
 	public function __construct(CMSPreviewable $record)
 	{
@@ -76,7 +76,7 @@ 
 	}
 
 	/**
-	 * @return DataObject
+	 * @return CMSPreviewable
 	 */
 	public function getRecord()
 	{

code/Model/SiteTreeFileExtension.php

Unused Use Statements -1 removed lines

@@ -3,7 +3,6 @@
 namespace SilverStripe\CMS\Model;
 
 use SilverStripe\Assets\File;
-use SilverStripe\Core\Convert;
 use SilverStripe\Forms\FieldList;
 use SilverStripe\Forms\ReadonlyField;
 use SilverStripe\ORM\DataExtension;

Doc Comments +1 added lines, -1 removed lines

@@ -59,7 +59,7 @@
 	/**
 	 * Generate an HTML list which provides links to where a file is used.
 	 *
-	 * @return string
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText
 	 */
 	public function BackLinkHTMLList() {
 		$viewer = new SSViewer(["type" => "Includes", self::class . "_description"]);

code/Controllers/CMSMain.php

Doc Comments +6 added lines, -3 removed lines

@@ -272,6 +272,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $link
+	 */
 	public function LinkWithSearch($link) {
 		// Whitelist to avoid side effects
 		$params = array(
@@ -754,7 +757,7 @@ 
 
 	/**
 	 * @param HTTPRequest $request
-	 * @return string HTML
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText HTML
 	 */
 	public function treeview($request) {
 		return $this->renderWith($this->getTemplatesWithSuffix('_TreeView'));
@@ -762,7 +765,7 @@ 
 
 	/**
 	 * @param HTTPRequest $request
-	 * @return string HTML
+	 * @return \SilverStripe\ORM\FieldType\DBHTMLText HTML
 	 */
 	public function listview($request) {
 		return $this->renderWith($this->getTemplatesWithSuffix('_ListView'));
@@ -1085,7 +1088,7 @@ 
 	 * Actually perform the publication step
 	 *
 	 * @param Versioned|DataObject $record
-	 * @return mixed
+	 * @return HTTPResponse|null
 	 */
 	public function performPublish($record) {
 		if($record && !$record->canPublish()) {

code/Controllers/CMSPageEditController.php

Doc Comments +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
 	 *
 	 * @param array $data
 	 * @param Form $form
-	 * @return DBHTMLText|HTTPResponse
+	 * @return null|HTTPResponse
 	 */
 	public function addtocampaign($data, $form)
 	{