silverstripe / silverstripe-cms

code/Controllers/CMSMain.php

Doc Comments +6 added lines, -3 removed lines

@@ -331,6 +331,9 @@ 
         }
     }
 
+    /**
+     * @param string $link
+     */
     public function LinkWithSearch($link)
     {
         // Whitelist to avoid side effects
@@ -842,7 +845,7 @@ 
 
     /**
      * @param HTTPRequest $request
-     * @return string HTML
+     * @return HTTPResponse HTML
      */
     public function treeview($request)
     {
@@ -851,7 +854,7 @@ 
 
     /**
      * @param HTTPRequest $request
-     * @return string HTML
+     * @return HTTPResponse HTML
      */
     public function listview($request)
     {
@@ -1207,7 +1210,7 @@ 
      * Actually perform the publication step
      *
      * @param Versioned|DataObject $record
-     * @return mixed
+     * @return HTTPResponse|null
      */
     public function performPublish($record)
     {

code/Controllers/CMSPageEditController.php

Doc Comments +1 added lines, -1 removed lines

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

code/Controllers/CMSPageHistoryController.php

Doc Comments +2 added lines, -2 removed lines

@@ -63,7 +63,7 @@ 
 
     /**
      * @param HTTPRequest $request
-     * @return array
+     * @return HTTPResponse
      */
     public function show($request)
     {
@@ -83,7 +83,7 @@ 
 
     /**
      * @param HTTPRequest $request
-     * @return array
+     * @return HTTPResponse
      */
     public function compare($request)
     {

code/Controllers/SilverStripeNavigatorItem.php

Doc Comments +2 added lines, -2 removed lines

@@ -25,7 +25,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/Forms/SiteTreeURLSegmentField.php

Doc Comments +3 added lines

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

code/Model/ErrorPage.php

Doc Comments +1 added lines, -1 removed lines

@@ -295,7 +295,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()
     {

code/Model/SiteTree.php

Doc Comments +1 added lines, -1 removed lines

@@ -782,7 +782,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)
     {

code/Model/SiteTreeFileExtension.php

Doc Comments +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
     /**
      * Generate an HTML list which provides links to where a file is used.
      *
-     * @return string
+     * @return \SilverStripe\ORM\FieldType\DBHTMLText
      */
     public function BackLinkHTMLList()
     {

code/Model/VirtualPage.php

Doc Comments +3 added lines

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