From 01b02969f93d6d66a05118f5629938edc7d0f4df Mon Sep 17 00:00:00 2001
From: Ingo Schommer <ingo@silverstripe.com>
Date: Fri, 23 Apr 2010 00:11:32 +0000
Subject: [PATCH] MINOR Fixed phpdoc documentation

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/cms/trunk@103384 467b73ca-7a2a-4603-9d3b-597d59a354a9
---
 code/LeftAndMain.php              |  6 +++++-
 code/MemberTableField.php         | 10 ++++++++++
 code/PermissionRoleAdmin.php      |  9 +++++++++
 code/SideReport.php               | 17 +++++++++++++++++
 code/sitefeatures/PageComment.php |  5 +++++
 tasks/FilesystemSyncTask.php      |  4 ++++
 6 files changed, 50 insertions(+), 1 deletion(-)

diff --git a/code/LeftAndMain.php b/code/LeftAndMain.php
index 5b24d945..10e2b0bc 100644
--- a/code/LeftAndMain.php
+++ b/code/LeftAndMain.php
@@ -475,7 +475,7 @@ class LeftAndMain extends Controller {
 	 *  shown
 	 * @param $childrenMethod The method to call to get the children of the tree. For example,
 	 *  Children, AllChildrenIncludingDeleted, or AllHistoricalChildren
-	 * @return String Nested <ul> list with links to each page
+	 * @return String Nested unordered list with links to each page
 	 */
 	function getSiteTreeFor($className, $rootID = null, $childrenMethod = null, $numChildrenMethod = null, $filterFunction = null, $minNodeCount = 30) {
 		// Default childrenMethod and numChildrenMethod
@@ -1214,6 +1214,10 @@ class LeftAndMain extends Controller {
 	
 }
 
+/**
+ * @package cms
+ * @subpackage core
+ */
 class LeftAndMainMarkingFilter {
 	
 	/**
diff --git a/code/MemberTableField.php b/code/MemberTableField.php
index 1bfc30df..d749fbcd 100755
--- a/code/MemberTableField.php
+++ b/code/MemberTableField.php
@@ -13,6 +13,7 @@
  * - members of a provided group
  * - all members
  * - members based on a search-query
+ * 
  * @package cms
  * @subpackage security
  */
@@ -447,6 +448,10 @@ class MemberTableField_Popup extends ComplexTableField_Popup {
 
 }
 
+/**
+* @package cms
+* @subpackage security
+*/
 class MemberTableField_Item extends ComplexTableField_Item {
 
 	function Actions() {
@@ -474,6 +479,11 @@ class MemberTableField_Item extends ComplexTableField_Item {
 	}
 }
 
+/**
+* @package cms
+* @subpackage security
+*/
+
 class MemberTableField_ItemRequest extends ComplexTableField_ItemRequest {
 
 	/**
diff --git a/code/PermissionRoleAdmin.php b/code/PermissionRoleAdmin.php
index 1f4aed6c..545528b4 100644
--- a/code/PermissionRoleAdmin.php
+++ b/code/PermissionRoleAdmin.php
@@ -2,6 +2,9 @@
 
 /**
  * Admin interface for Permission Roles.
+ * 
+ * @package cms
+ * @subpackage security
  */
 class PermissionRoleAdmin extends ModelAdmin {
 	static $managed_models = array(
@@ -17,6 +20,9 @@ class PermissionRoleAdmin extends ModelAdmin {
 
 /**
  * Customized controller for hiding permissions on AddForm
+ * 
+ * @package cms
+ * @subpackage security
  */
 class PermissionRoleAdmin_CollectionController extends ModelAdmin_CollectionController {
 	public function AddForm() {
@@ -31,6 +37,9 @@ class PermissionRoleAdmin_CollectionController extends ModelAdmin_CollectionCont
 
 /**
  * Customized controller for hiding permissions on EditForm
+ * 
+ * @package cms
+ * @subpackage security
  */
 class PermissionRoleAdmin_RecordController extends ModelAdmin_RecordController {
 	public function EditForm() {
diff --git a/code/SideReport.php b/code/SideReport.php
index 33b865b1..79f681cb 100755
--- a/code/SideReport.php
+++ b/code/SideReport.php
@@ -2,6 +2,7 @@
 /**
  * Base class for the small reports that appear in the left hand site of the Site Content section of the CMS.
  * Create subclasses of this class to build new reports.
+ * 
  * @package cms
  * @subpackage content
  */
@@ -92,6 +93,7 @@ abstract class SideReport extends Object {
 
 /**
  * Content side-report listing empty pages
+ * 
  * @package cms
  * @subpackage content
  */
@@ -117,6 +119,7 @@ class SideReport_EmptyPages extends SideReport {
 
 /**
  * Content side-report listing recently editing pages.
+ * 
  * @package cms
  * @subpackage content
  */
@@ -141,6 +144,10 @@ class SideReport_RecentlyEdited extends SideReport {
 	}
 }
 
+/**
+* @package cms
+* @subpackage content
+*/
 class SideReport_ToDo extends SideReport {
 	function title() {
 		return _t('SideReport.TODO',"Pages with To Do items");
@@ -170,6 +177,7 @@ class SideReport_ToDo extends SideReport {
 
 /**
  * Content side-report listing pages with broken links
+ * 
  * @package cms
  * @subpackage content
  */
@@ -204,6 +212,7 @@ class SideReport_BrokenLinks extends SideReport {
 /**
  * Content side-report listing pages with broken files
  * or asset links
+ * 
  * @package cms
  * @subpackage content
  */
@@ -235,6 +244,10 @@ class SideReport_BrokenFiles extends SideReport {
 	}
 }
 
+/**
+* @package cms
+* @subpackage content
+*/
 class SideReport_BrokenVirtualPages extends SideReport {
 	function title() {
 		return _t('SideReport.BROKENVIRTUALPAGES', 'VirtualPages pointing to deleted pages');
@@ -261,6 +274,10 @@ class SideReport_BrokenVirtualPages extends SideReport {
 	}
 }
 
+/**
+* @package cms
+* @subpackage content
+*/
 class SideReport_BrokenRedirectorPages extends SideReport {
 	function title() {
 		return _t('SideReport.BROKENREDIRECTORPAGES', 'RedirectorPages pointing to deleted pages');
diff --git a/code/sitefeatures/PageComment.php b/code/sitefeatures/PageComment.php
index 9067d0f7..5b6847e8 100755
--- a/code/sitefeatures/PageComment.php
+++ b/code/sitefeatures/PageComment.php
@@ -1,6 +1,7 @@
 <?php
 /**
  * Represents a single comment on a page
+ * 
  * @package cms
  * @subpackage comments
  */
@@ -158,6 +159,10 @@ class PageComment extends DataObject {
 }
 
 
+/**
+ * @package cms
+ * @subpackage comments
+ */
 class PageComment_Controller extends Controller {
 	function rss() {
 		$parentcheck = isset($_REQUEST['pageid']) ? "\"ParentID\" = " . (int) $_REQUEST['pageid'] : "\"ParentID\" > 0";
diff --git a/tasks/FilesystemSyncTask.php b/tasks/FilesystemSyncTask.php
index aa5e5085..d050b0bb 100644
--- a/tasks/FilesystemSyncTask.php
+++ b/tasks/FilesystemSyncTask.php
@@ -1,4 +1,8 @@
 <?php
+/**
+ * @package cms
+ * @subpackage assets
+ */
 class FilesystemSyncTask extends BuildTask {
 	
 	protected $title = "Sync Files & Images assets";