From a894ad377dc1b0df438c5a36969701f355f528ac Mon Sep 17 00:00:00 2001
From: Ingo Schommer <ingo@silverstripe.com>
Date: Sun, 15 Jun 2008 13:33:53 +0000
Subject: [PATCH] MINOR Unified @package PHPdoc (added where missing, removed
 duplicates)

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/cms/trunk@56212 467b73ca-7a2a-4603-9d3b-597d59a354a9
---
 code/AssetTableField.php                   | 6 +-----
 code/CMSActionOptionsForm.php              | 7 +------
 code/CMSMain.php                           | 6 +-----
 code/CommentAdmin.php                      | 6 ------
 code/CommentTableField.php                 | 6 ------
 code/FileList.php                          | 6 ------
 code/GenericDataAdmin.php                  | 6 ------
 code/ImageEditor.php                       | 6 ------
 code/MemberList.php                        | 9 +++------
 code/MemberTableField.php                  | 6 ------
 code/PageTypes/UserDefinedForm.php         | 6 ------
 code/ReportAdmin.php                       | 6 ------
 code/SecurityAdmin.php                     | 6 ------
 code/SideReport.php                        | 6 ------
 code/StaticExporter.php                    | 6 ------
 code/ThumbnailStripField.php               | 6 ------
 code/WidgetAreaEditor.php                  | 6 ------
 code/sitefeatures/MathSpamProtection.php   | 6 ------
 code/sitefeatures/PageComment.php          | 6 ------
 code/sitefeatures/PageCommentInterface.php | 6 ------
 code/sitefeatures/SSAkismet.php            | 6 ------
 tests/LeftAndMainTest.php                  | 4 ++++
 22 files changed, 10 insertions(+), 124 deletions(-)

diff --git a/code/AssetTableField.php b/code/AssetTableField.php
index d20aec58..3cad6ef5 100755
--- a/code/AssetTableField.php
+++ b/code/AssetTableField.php
@@ -1,11 +1,7 @@
 <?php
-/**
- * @package cms
- * @subpackage assets
- */
-
 /**
  * A special kind of complex table field for manipulating assets.
+ *
  * @package cms
  * @subpackage assets
  */
diff --git a/code/CMSActionOptionsForm.php b/code/CMSActionOptionsForm.php
index 3948d64f..7b119a1a 100755
--- a/code/CMSActionOptionsForm.php
+++ b/code/CMSActionOptionsForm.php
@@ -1,13 +1,8 @@
 <?php
-
-/**
- * @package cms
- * @subpackage core
- */
-
 /**
  * A special kind of form used to make the action dialogs that appear just underneath the top-right
  * buttons in the CMS
+ * 
  * @package cms
  * @subpackage core
  */
diff --git a/code/CMSMain.php b/code/CMSMain.php
index e4614392..be128c2b 100644
--- a/code/CMSMain.php
+++ b/code/CMSMain.php
@@ -1,13 +1,9 @@
 <?php
-/**
- * @package cms
- * @subpackage content
- */
-
 /**
  * The main "content" area of the CMS.
  * This class creates a 2-frame layout - left-tree and right-form - to sit beneath the main
  * admin menu.
+ * 
  * @package cms
  * @subpackage content
  * @todo Create some base classes to contain the generic functionality that will be replicated.
diff --git a/code/CommentAdmin.php b/code/CommentAdmin.php
index 1a2a551c..cc231908 100644
--- a/code/CommentAdmin.php
+++ b/code/CommentAdmin.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package cms
- * @subpackage comments
- */
-
 /**
  * Comment administration system within the CMS
  * @package cms
diff --git a/code/CommentTableField.php b/code/CommentTableField.php
index e4e4f338..1700d5fa 100644
--- a/code/CommentTableField.php
+++ b/code/CommentTableField.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package cms
- * @subpackage comments
- */
-
 /**
  * Special kind of ComplexTableField for managing comments.
  * @package cms
diff --git a/code/FileList.php b/code/FileList.php
index 0e1c7f60..9b3c486a 100755
--- a/code/FileList.php
+++ b/code/FileList.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package cms
- * @subpackage assets
- */
-
 /**
  * A FormField showing a list of files
  * @package cms
diff --git a/code/GenericDataAdmin.php b/code/GenericDataAdmin.php
index 19183920..0e5537b2 100755
--- a/code/GenericDataAdmin.php
+++ b/code/GenericDataAdmin.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package cms
- * @subpackage core
- */
-
 /**
  * Provides a common interface for searching, viewing and editing DataObjects.
  * Extend the class to adjust functionality to your specific DataObjects.
diff --git a/code/ImageEditor.php b/code/ImageEditor.php
index 4bb53e60..3e3ca36b 100644
--- a/code/ImageEditor.php
+++ b/code/ImageEditor.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package cms
- * @subpackage assets
- */
-
 /**
  * This Controller handles all operation needed for ImageEditor to work(expect for GD operations).
  * @package cms
diff --git a/code/MemberList.php b/code/MemberList.php
index 3a18be9c..a57b5a09 100755
--- a/code/MemberList.php
+++ b/code/MemberList.php
@@ -1,12 +1,9 @@
 <?php
-
-/**
- * @package cms
- * @subpackage security
- */
-
 /**
  * Form field showing a list of members.
+ *
+ * @deprecated Use {@link MemberTableField} instead
+ *
  * @package cms
  * @subpackage security
  */
diff --git a/code/MemberTableField.php b/code/MemberTableField.php
index e8688c7f..09f8084e 100755
--- a/code/MemberTableField.php
+++ b/code/MemberTableField.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package cms
- * @subpackage security
- */
-
 /**
  * Enhances {ComplexTableField} with the ability to list groups and given members.
  * It is based around groups, so it deletes Members from a Group rather than from the entire system.
diff --git a/code/PageTypes/UserDefinedForm.php b/code/PageTypes/UserDefinedForm.php
index 23d56758..49f3ea99 100755
--- a/code/PageTypes/UserDefinedForm.php
+++ b/code/PageTypes/UserDefinedForm.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package cms
- * @subpackage pagetypes
- */
-
 /**
  * Page type that lets users build a contact form.
  * @package cms
diff --git a/code/ReportAdmin.php b/code/ReportAdmin.php
index 7f51194c..958110fa 100755
--- a/code/ReportAdmin.php
+++ b/code/ReportAdmin.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package cms
- * @subpackage reports
- */
-
 /**
  * Reports section of the CMS
  * @package cms
diff --git a/code/SecurityAdmin.php b/code/SecurityAdmin.php
index 3dbf4b69..2a8846fb 100644
--- a/code/SecurityAdmin.php
+++ b/code/SecurityAdmin.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package cms
- * @subpackage security
- */
-
 /**
  * Security section of the CMS
  * @package cms
diff --git a/code/SideReport.php b/code/SideReport.php
index b3f1b3ef..b9689632 100755
--- a/code/SideReport.php
+++ b/code/SideReport.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package cms
- * @subpackage content
- */
-
 /**
  * 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.
diff --git a/code/StaticExporter.php b/code/StaticExporter.php
index 3b8971fb..f1ff0d6f 100755
--- a/code/StaticExporter.php
+++ b/code/StaticExporter.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package cms
- * @subpackage export
- */
-
 /**
  * This class lets you export a static copy of your site.
  * It creates a huge number of folders each containing an index.html file.
diff --git a/code/ThumbnailStripField.php b/code/ThumbnailStripField.php
index d5f46683..a5d59d04 100755
--- a/code/ThumbnailStripField.php
+++ b/code/ThumbnailStripField.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package cms
- * @subpackage assets
- */
-
 /**
  * Provides a strip of thumbnails showing all of the images in the system.
  * It will be tied to a 'parent field' that will provide it with a filter by which to reduce the number
diff --git a/code/WidgetAreaEditor.php b/code/WidgetAreaEditor.php
index ac09279d..bc899648 100644
--- a/code/WidgetAreaEditor.php
+++ b/code/WidgetAreaEditor.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package cms
- * @subpackage content
- */
-
 /**
  * Special field type for selecting and configuring widgets on a page.
  * @package cms
diff --git a/code/sitefeatures/MathSpamProtection.php b/code/sitefeatures/MathSpamProtection.php
index c5258e3e..8084f5a5 100644
--- a/code/sitefeatures/MathSpamProtection.php
+++ b/code/sitefeatures/MathSpamProtection.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package cms
- * @subpackage comments
- */
-
 /**
  * Tools for adding an optional protection question to a form.
  * Remember to add MathSpamProtection::enabled(true); to _config.php for this question to be added to the comments form.
diff --git a/code/sitefeatures/PageComment.php b/code/sitefeatures/PageComment.php
index 734b6a17..a96621ba 100755
--- a/code/sitefeatures/PageComment.php
+++ b/code/sitefeatures/PageComment.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package cms
- * @subpackage comments
- */
-
 /**
  * Represents a single comment on a page
  * @package cms
diff --git a/code/sitefeatures/PageCommentInterface.php b/code/sitefeatures/PageCommentInterface.php
index f7e22c9b..17c703da 100755
--- a/code/sitefeatures/PageCommentInterface.php
+++ b/code/sitefeatures/PageCommentInterface.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package cms
- * @subpackage comments
- */
-
 /**
  * Represents an interface for viewing and adding page comments
  * Create one, passing the page discussed to the constructor.  It can then be
diff --git a/code/sitefeatures/SSAkismet.php b/code/sitefeatures/SSAkismet.php
index 7fc61fa9..2bf0d8fe 100644
--- a/code/sitefeatures/SSAkismet.php
+++ b/code/sitefeatures/SSAkismet.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package cms
- * @subpackage comments
- */
-
 /**
  * @package cms
  * @subpackage comments
diff --git a/tests/LeftAndMainTest.php b/tests/LeftAndMainTest.php
index e4097c62..7282d929 100644
--- a/tests/LeftAndMainTest.php
+++ b/tests/LeftAndMainTest.php
@@ -1,4 +1,8 @@
 <?php
+/**
+ * @package cms
+ * @subpackage tests
+ */
 class LeftAndMainTest extends SapphireTest {
 	
 	public function testMainMenuSpecification() {