silverstripe / silverstripe-cms

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/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/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/CMSMain.php

Doc Comments +6 added lines, -3 removed lines

@@ -284,6 +284,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $link
+	 */
 	public function LinkWithSearch($link) {
 		// Whitelist to avoid side effects
 		$params = array(
@@ -766,7 +769,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return string HTML
+	 * @return DBHTMLText HTML
 	 */
 	public function treeview($request) {
 		return $this->renderWith($this->getTemplatesWithSuffix('_TreeView'));
@@ -774,7 +777,7 @@ 
 
 	/**
 	 * @param SS_HTTPRequest $request
-	 * @return string HTML
+	 * @return DBHTMLText HTML
 	 */
 	public function listview($request) {
 		return $this->renderWith($this->getTemplatesWithSuffix('_ListView'));
@@ -1095,7 +1098,7 @@ 
 	 * Actually perform the publication step
 	 *
 	 * @param Versioned|DataObject $record
-	 * @return mixed
+	 * @return SS_HTTPResponse|null
 	 */
 	public function performPublish($record) {
 		if($record && !$record->canPublish()) {

code/Controllers/CMSPageEditController.php

Doc Comments +3 added lines, -3 removed lines

@@ -39,7 +39,7 @@ 
 	 *
 	 * @param array $data
 	 * @param Form $form
-	 * @return DBHTMLText|SS_HTTPResponse
+	 * @return SS_HTTPResponse|null
 	 */
 	public function addtocampaign($data, $form)
 	{
@@ -66,7 +66,7 @@ 
 	 * Url handler for add to campaign form
 	 *
 	 * @param SS_HTTPRequest $request
-	 * @return Form
+	 * @return null|\Form
 	 */
 	public function AddToCampaignForm($request)
 	{
@@ -77,7 +77,7 @@ 
 
 	/**
 	 * @param int $id
-	 * @return Form
+	 * @return null|\Form
 	 */
 	public function getAddToCampaignForm($id)
 	{

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()
 	{