MINOR Unified @Package PHPdoc (added where missing, removed duplicates)

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@56212 467b73ca-7a2a-4603-9d3b-597d59a354a9
silverstripe · Jun 15, 2008 · 60860cc · 60860cc
1 parent 4312a4a
commit 60860cc
Show file tree

Hide file tree

Showing 255 changed files with 125 additions and 1,330 deletions.
diff --git a/api/RSSFeed.php b/api/RSSFeed.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage integration
- */
-
 /**
  * RSSFeed class
  *

diff --git a/api/RestfulServer.php b/api/RestfulServer.php
@@ -23,6 +23,9 @@
  *  - DELETE /api/v1/(ClassName)/(ID)/(Relation)/(ForeignID) - remove the relationship between two database records, but don't actually delete the foreign object (NOT IMPLEMENTED YET)
  *
  *  - POST /api/v1/(ClassName)/(ID)/(MethodName) - executes a method on the given object (e.g, publish)
+ *
+ * @package sapphire
+ * @subpackage api
  */
 class RestfulServer extends Controller {
 	protected static $api_base = "api/v1/";

diff --git a/api/RestfulService.php b/api/RestfulService.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage integration
- */
-
 /**
  * RestfulService class allows you to consume various RESTful APIs.
  * Through this you could connect and aggregate data of various web services.

diff --git a/api/SapphireSoapServer.php b/api/SapphireSoapServer.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage integration
- */
-
 /**
  * Soap server class
  * @todo Improve documentation

diff --git a/api/SimplePie.php b/api/SimplePie.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage integration
- */
-
 /**
  * A PHP-Based RSS and Atom Feed Framework
  * Takes the hard work out of managing a complete RSS/Atom solution.

diff --git a/api/Spyc.php b/api/Spyc.php
@@ -7,8 +7,6 @@
  * @link http://spyc.sourceforge.net/
  * @copyright Copyright 2005-2006 Chris Wanstrath
  * @license http://www.opensource.org/licenses/mit-license.php MIT License
- * @package sapphire
- * @subpackage misc
  */
 
 /**

diff --git a/cli/CliController.php b/cli/CliController.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage cron
- */
-
 /**
  * Base class invoked from CLI rather than the webserver (Cron jobs, handling email bounces)
  * @package sapphire

diff --git a/cli/DailyTask.php b/cli/DailyTask.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage cron
- */
-
 /**
  * Classes that must be run daily extend this class
  * @todo Improve documentation

diff --git a/cli/MonthlyTask.php b/cli/MonthlyTask.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage cron
- */
-
 /**
  * Classes that must be run monthly extend this class
  * @package sapphire

diff --git a/cli/ScheduledTask.php b/cli/ScheduledTask.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage cron
- */
-
 /**
  * Abstract task representing scheudled tasks
  * @todo Improve documentation

diff --git a/cli/WeeklyTask.php b/cli/WeeklyTask.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage cron
- */
-
 /**
  * Classes that must be run weekly extend this class
  * @package sapphire

diff --git a/cli/YearlyTask.php b/cli/YearlyTask.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage cron
- */
-
 /**
  * Classes that must be run yearly extend this class
  * @package sapphire

diff --git a/core/ArrayData.php b/core/ArrayData.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage view
- */
-
 /**
  * Lets you wrap a bunch of array data into a {@link ViewableData} object.
  *

diff --git a/core/ArrayLib.php b/core/ArrayLib.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage misc
- */
-
 /**
  * Library of static methods for manipulating arrays.
  * @package sapphire

diff --git a/core/ClassInfo.php b/core/ClassInfo.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage core
- */
-
 /**
  * Provides introspection information about the class tree.
  * It's a cached wrapper around the built-in class functions.  Sapphire uses class introspection heavily

diff --git a/core/Convert.php b/core/Convert.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage misc
- */
-
 /**
  * Library of conversion functions, implemented as static methods.
  *

diff --git a/core/Cookie.php b/core/Cookie.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage misc
- */
-
 /**
  * A set of static methods for manipulating cookies.
  * @package sapphire

diff --git a/core/Extension.php b/core/Extension.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage core
- */
-
 /**
  * Add extension that can be added to an object with Object::add_extension().
  * For DataObject extensions, use DataObjectDecorator

diff --git a/core/HTTP.php b/core/HTTP.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage misc
- */
-
 /**
  * A class with HTTP-related helpers.
  * Like Debug, this is more a bundle of methods than a class ;-)

diff --git a/core/Mailer.php b/core/Mailer.php
@@ -1,4 +1,8 @@
 <?php
+/**
+ * @package sapphire
+ * @subpackage email
+ */
 
 /**
  * Mailer objects are responsible for actually sending emails.

diff --git a/core/ManifestBuilder.php b/core/ManifestBuilder.php
@@ -1,13 +1,5 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage core
- */
-
-/**
- * Name of the manifest file
- */
+// Name of the manifest file
 define("MANIFEST_FILE", TEMP_FOLDER . "/manifest" . str_replace(array("/",":", "\\"),"_", $_SERVER['SCRIPT_FILENAME']));
 
 /**

diff --git a/core/Requirements.php b/core/Requirements.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage view
- */
-
 /**
  * Requirements tracker, for javascript and css.
  * @todo Document the requirements tracker, and discuss it with the others.

diff --git a/core/SSViewer.php b/core/SSViewer.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage view
- */
-
 /**
  * The SSViewer executes a .ss template file.
  * The SSViewer class handles rendering of .ss templates.  In addition to a full template in

diff --git a/core/Session.php b/core/Session.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage control
- */
-
 /**
  * Handles all manipulation of the session.
  * 

diff --git a/core/TokenisedRegularExpression.php b/core/TokenisedRegularExpression.php
@@ -3,6 +3,8 @@
 /**
  * A tokenised regular expression is a parser, similar to a regular expression, that acts on tokens rather than characters.
  * This is a crucial component of the ManifestBuilder.
+ * @package sapphire
+ * @subpackage core
  */ 
 class TokenisedRegularExpression extends Object {
 	/**

diff --git a/core/ValidationResult.php b/core/ValidationResult.php
@@ -3,6 +3,8 @@
 /**
  * A class that combined as a boolean result with an optional list of error messages.
  * This is used for returning validation results from validators
+ * @package sapphire
+ * @subpackage core
  */
 class ValidationResult extends Object {
 	/**

diff --git a/core/ViewableData.php b/core/ViewableData.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage view
- */
-
 /**
  * Generic class for all data that will be accessed from a view.
  * 

diff --git a/core/control/ContentController.php b/core/control/ContentController.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage control
- */
-
 /**
  * The most common kind of controller; effectively a controller linked to a {@link DataObject}.
  *

diff --git a/core/control/ContentNegotiator.php b/core/control/ContentNegotiator.php
@@ -1,9 +1,4 @@
 <?php
-/**
- * @package sapphire
- * @subpackage control
- */
-
 /**
  * The content negotiator performs text/html or application/xhtml+xml switching.
  * It does this through the static function ContentNegotiator::process()

diff --git a/core/control/Controller.php b/core/control/Controller.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage control
- */
-
 /**
  * Base controller class.
  * Controllers are the cornerstone of all site functionality in Sapphire.  The {@link Director}

diff --git a/core/control/Director.php b/core/control/Director.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage control
- */
-
 /**
  * Director is responsible for processing URLs, and providing environment information.
  * 

diff --git a/core/control/FormResponse.php b/core/control/FormResponse.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package forms
- * @subpackage core
- */
-
 /**
  * This class collects all output that needs to be returned after an Form-Request to the client. It automatically determines
  * if it needs to send back javascript after an Ajax-Request or just redirect to another page (on a normal request).

diff --git a/core/control/HTTPResponse.php b/core/control/HTTPResponse.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage control
- */
-
 /**
  * Represenets an HTTPResponse returned by a controller.
  *

diff --git a/core/control/ModelAsController.php b/core/control/ModelAsController.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage control
- */
-
 /**
  * ModelAsController will hand over all control to the appopriate model object
  * It uses URLSegment to determine the right object.  Also, if (ModelClass)_Controller exists,

diff --git a/core/control/NestedController.php b/core/control/NestedController.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage control
- */
-
 /**
  * Interface that is implemented by controllers that are designed to hand control over to another controller.  
  * ModelAsController, which selects up a SiteTree object and passes control over to a suitable subclass of ContentController, is a good

diff --git a/core/control/RootURLController.php b/core/control/RootURLController.php
@@ -1,10 +1,4 @@
 <?php
-
-/**
- * @package sapphire
- * @subpackage control
- */
-
 /**
  * This controller handles what happens when you visit the root URL.
  *

diff --git a/core/control/SapphireInfo.php b/core/control/SapphireInfo.php
@@ -1,7 +1,8 @@
 <?php
-
 /**
  * Returns information about the current site instance.
+ * @package sapphire
+ * @subpackage control
  */
 class SapphireInfo extends Controller {
 	function Version() {