MINOR Fixed phpdoc documentation

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/branches/2.4@103398 467b73ca-7a2a-4603-9d3b-597d59a354a9

api/DataFormatter.php

@@ -121,7 +121,7 @@ abstract class DataFormatter extends Object {
 	/**
 	 * Get a DataFormatter object suitable for handling the given mimetype.
 	 * 
-	 * @string $mimeType
+	 * @param string $mimeType
 	 * @return DataFormatter
 	 */
 	static function for_mimetype($mimeType) {

core/SSViewer.php

@@ -842,6 +842,10 @@ class SSViewer_PartialParser {
 	}
 }
 
+/**
+ * @package sapphire
+ * @subpackage view
+ */
 class SSViewer_Cached_PartialParser extends SSViewer_PartialParser {
 
 	function __construct($template, $content, $offset, $keyparts, $conditional, $condition) {

core/model/DataObjectSet.php

@@ -993,6 +993,9 @@ function column_sort_callback_basic($a, $b) {
 
 /**
  * An Iterator for a DataObjectSet
+ * 
+ * @package sapphire
+ * @subpackage model
  */
 class DataObjectSet_Iterator implements Iterator {
 	function __construct($items) {

core/model/YamlFixture.php

@@ -17,13 +17,17 @@ require_once 'thirdparty/spyc/spyc.php';
  *   However, if you want to define a relationship, you can do so using "=>"
  * 
  * There are a couple of lines like this:
- * @example Parent: =>Page.about
+ * <code>
+ * Parent: =>Page.about
+ * </code>
  * This will tell the system to set the ParentID database field to the ID of the Page object with the identifier ÒaboutÓ. 
  * This can be used on any has-one or many-many relationship. 
  * Note that we use the name of the relationship (Parent), and not the name of the database field (ParentID)
  *
  * On many-many relationships, you should specify a comma separated list of values.
- * @example MyRelation: =>Class.inst1,=>Class.inst2,=>Class.inst3
+ * <code>
+ * MyRelation: =>Class.inst1,=>Class.inst2,=>Class.inst3
+ * </code>
  * An crucial thing to note is that the YAML file specifies DataObjects, not database records. 
  * The database is populated by instantiating DataObject objects, setting the fields listed, and calling write(). 
  * This means that any onBeforeWrite() or default value logic will be executed as part of the test. 

dev/SapphireTestReporter.php

@@ -232,7 +232,7 @@ class SapphireTestReporter implements PHPUnit_Framework_TestListener {
 	/**
 	 * Upon completion of a test suite adds the suite to the suties performed
 	 * 
-	 * @acces public
+	 * @access public
 	 * @param obj PHPUnit_Framework_TestSuite, current suite that is being run
 	 * @return void
 	 */

dev/TestSession.php

@@ -2,6 +2,7 @@
 /**
  * Represents a test usage session of a web-app
  * It will maintain session-state from request to request
+ * 
  * @package sapphire
  * @subpackage testing
  */
@@ -156,6 +157,9 @@ class TestSession {
 
 /**
  * Wrapper around SS_HTTPResponse to make it look like a SimpleHTTPResposne
+ * 
+ * @package sapphire
+ * @subpackage testing
  */
 class TestSession_STResponseWrapper {
 	private $response;

dev/ZendLog.php

@@ -1,4 +1,6 @@
 <?php
+require_once 'Zend/Log.php';
+
 /**
  * Extensions to Zend_Log to make it work nicer
  * with {@link SS_Log}.
@@ -9,9 +11,6 @@
  * @package sapphire
  * @subpackage dev
  */
-
-require_once 'Zend/Log.php';
-
 class SS_ZendLog extends Zend_Log {
 
 	/**

filesystem/Folder.php

@@ -483,6 +483,10 @@ HTML;
 	}
 }
 
+/**
+ * @package sapphire
+ * @subpackage filesystem
+ */
 class Folder_UnusedAssetsField extends CompositeField {
 	protected $folder;
 	

filesystem/Upload.php

@@ -309,6 +309,11 @@ class Upload extends Controller {
 	}
 	
 }
+
+/**
+ * @package sapphire
+ * @subpackage filesystem
+ */
 class Upload_Validator {
 
 	/**
@@ -338,8 +343,6 @@ class Upload_Validator {
 	 * <code>
 	 * 	array("jpg","GIF")
 	 * </code>
-	 * 
-	 * @var array
 	 */
 	public $allowedExtensions = array();
 

profiler/Profiler.php

@@ -9,6 +9,7 @@
 
 /**
  * Execution time profiler.
+ * 
  * @package sapphire
  * @subpackage misc
  */

search/ContentControllerSearchExtension.php

@@ -1,7 +1,9 @@
 <?php
-
 /**
  * Extension to provide a search interface when applied to ContentController
+ * 
+ * @package sapphire
+ * @subpackage search
  */
 class ContentControllerSearchExtension extends Extension { 
 	static $allowed_actions = array(

search/FulltextSearchable.php

@@ -1,7 +1,9 @@
 <?php
-
 /**
  * Provides a simple search engine for your site based on the MySQL FULLTEXT index
+ * 
+ * @package sapphire
+ * @subpackage search
  */
 class FulltextSearchable extends DataObjectDecorator {
 	protected $searchFields;

search/filters/StartsWithMultiFilter.php

@@ -9,6 +9,8 @@
  * SQL syntax used: Column IN ('val1','val2')
  * 
  * @todo Add negation (NOT IN)6
+ * @package sapphire
+ * @subpackage search
  */
 class StartsWithMultiFilter extends SearchFilter {