diff --git a/api/DataFormatter.php b/api/DataFormatter.php
index 52da844c1..a2cccab93 100644
--- a/api/DataFormatter.php
+++ b/api/DataFormatter.php
@@ -1,10 +1,11 @@
+ *
* ClassInfo::subclassesFor('BaseClass');
* array(
* 0 => 'BaseClass',
* 'ChildClass' => 'ChildClass',
* 'GrandChildClass' => 'GrandChildClass'
* )
- *
+ *
*
* @param mixed $class string of the classname or instance of the class
* @return array Names of all subclasses as an associative array.
diff --git a/core/Convert.php b/core/Convert.php
index 417ecffb5..7634e1be6 100755
--- a/core/Convert.php
+++ b/core/Convert.php
@@ -17,7 +17,6 @@
* Objects of type {@link ViewableData} can have an "escaping type",
* which determines if they are automatically escaped before output by {@link SSViewer}.
*
- * @usedby ViewableData::XML_val()
* @package sapphire
* @subpackage misc
*/
diff --git a/core/Requirements.php b/core/Requirements.php
index 2b4effc7a..67694d526 100644
--- a/core/Requirements.php
+++ b/core/Requirements.php
@@ -315,8 +315,6 @@ class Requirements_Backend {
/**
* Remembers the filepaths of all cleared Requirements
* through {@link clear()}.
- *
- * @usedby {@link restore()}
*
* @var array $disabled
*/
diff --git a/core/ValidationException.php b/core/ValidationException.php
index 1b62e4739..3ffddaee8 100644
--- a/core/ValidationException.php
+++ b/core/ValidationException.php
@@ -3,6 +3,9 @@
* Exception thrown by {@link DataObject}::write if validation fails. By throwing an
* exception rather than a user error, the exception can be caught in unit tests and as such
* can be used as a successful test.
+ *
+ * @package sapphire
+ * @subpackage validation
*/
class ValidationException extends Exception {
diff --git a/core/ViewableData.php b/core/ViewableData.php
index 0d12f456a..ebc7c613a 100644
--- a/core/ViewableData.php
+++ b/core/ViewableData.php
@@ -281,7 +281,6 @@ class ViewableData extends Object implements IteratorAggregate {
/**
* Return the string-format type for the given field.
*
- * @usedby ViewableData::XML_val()
* @param string $fieldName
* @return string 'xml'|'raw'
*/
@@ -870,9 +869,9 @@ class ViewableData extends Object implements IteratorAggregate {
* Avoids having to subclass just to built templates with new css-classes,
* and allows for versatile css inheritance and overrides.
*
- *
+ *
*
- *
+ *
*
* @uses ClassInfo
*
diff --git a/core/control/ContentNegotiator.php b/core/control/ContentNegotiator.php
index 116bf59e8..8d5b20352 100755
--- a/core/control/ContentNegotiator.php
+++ b/core/control/ContentNegotiator.php
@@ -51,9 +51,6 @@ class ContentNegotiator {
return self::$encoding;
}
- /**
- * @usedby Controller->handleRequest()
- */
static function process(HTTPResponse $response) {
if(!self::enabled_for($response)) return;
diff --git a/core/control/ModelAsController.php b/core/control/ModelAsController.php
index 1f601f913..e08d9cfa8 100644
--- a/core/control/ModelAsController.php
+++ b/core/control/ModelAsController.php
@@ -5,6 +5,7 @@
* that controller will be used instead. It should be a subclass of ContentController.
*
* @package sapphire
+ * @subpackage control
*/
class ModelAsController extends Controller implements NestedController {
diff --git a/core/control/RequestHandler.php b/core/control/RequestHandler.php
index e11c9dd0f..f4e25e4ab 100644
--- a/core/control/RequestHandler.php
+++ b/core/control/RequestHandler.php
@@ -24,6 +24,9 @@
* Matching $url_handlers: "$Action/$ID" => "handleItem" (defined in TreeMultiSelectField class)
*
* {@link RequestHandler::handleRequest()} is where this behaviour is implemented.
+ *
+ * @package sapphire
+ * @subpackage control
*/
class RequestHandler extends ViewableData {
protected $request = null;
diff --git a/core/model/DataObject.php b/core/model/DataObject.php
index 476df9d1b..9f38ee7d5 100644
--- a/core/model/DataObject.php
+++ b/core/model/DataObject.php
@@ -426,8 +426,6 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
* }
*
*
- * @usedby {@link DataObjectSet->toDropDownMap()}
- *
* @return string
*/
public function getTitle() {
@@ -1581,7 +1579,6 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
* Generates a SearchContext to be used for building and processing
* a generic search form for properties on this object.
*
- * @usedby {@link ModelAdmin}
* @return SearchContext
*/
public function getDefaultSearchContext() {
@@ -1600,7 +1597,7 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
* Some additional logic is included for switching field labels, based on
* how generic or specific the field type is.
*
- * @usedby {@link SearchContext}
+ * Used by {@link SearchContext}.
*
* @param array $_params
* 'fieldClasses': Associative array of field names as keys and FormField classes as values
@@ -1693,7 +1690,7 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
* generate this set. To customize, overload this method in a subclass
* or decorate onto it by using {@link DataObjectDecorator->updateCMSFields()}.
*
- *
+ *
* klass MyCustomClass extends DataObject {
* static $db = array('CustomProperty'=>'Boolean');
*
@@ -1703,7 +1700,7 @@ class DataObject extends ViewableData implements DataObjectInterface, i18nEntity
* return $fields;
* }
* }
- *
+ *
*
* @see Good example of complex FormField building: SiteTree::getCMSFields()
*
diff --git a/core/model/Image.php b/core/model/Image.php
index 57fb37429..40f7cbe05 100755
--- a/core/model/Image.php
+++ b/core/model/Image.php
@@ -462,8 +462,8 @@ class Image_Cached extends Image {
* Is connected to the URL routing "/image" through sapphire/_config.php,
* and used by all iframe-based upload-fields in the CMS.
*
- * @usedby FileIFrameField
- * @usedby ImageField
+ * Used by {@link FileIFrameField}, {@link ImageField}.
+ *
* @todo Refactor to using FileIFrameField and ImageField as a controller for the upload,
* rather than something totally disconnected from the original Form and FormField
* context. Without the original context its impossible to control permissions etc.
diff --git a/core/model/MySQLDatabase.php b/core/model/MySQLDatabase.php
index ed43406b4..7b7bf1bc5 100644
--- a/core/model/MySQLDatabase.php
+++ b/core/model/MySQLDatabase.php
@@ -489,7 +489,7 @@ class MySQLDatabase extends Database {
/**
* Return a boolean type-formatted string
*
- * @params array $values Contains a tokenised list of info about this data type
+ * @param array $values Contains a tokenised list of info about this data type
* @return string
*/
public function boolean($values){
@@ -504,7 +504,7 @@ class MySQLDatabase extends Database {
* Return a date type-formatted string
* For MySQL, we simply return the word 'date', no other parameters are necessary
*
- * @params array $values Contains a tokenised list of info about this data type
+ * @param array $values Contains a tokenised list of info about this data type
* @return string
*/
public function date($values){
@@ -518,7 +518,7 @@ class MySQLDatabase extends Database {
/**
* Return a decimal type-formatted string
*
- * @params array $values Contains a tokenised list of info about this data type
+ * @param array $values Contains a tokenised list of info about this data type
* @return string
*/
public function decimal($values){
@@ -539,7 +539,7 @@ class MySQLDatabase extends Database {
/**
* Return a enum type-formatted string
*
- * @params array $values Contains a tokenised list of info about this data type
+ * @param array $values Contains a tokenised list of info about this data type
* @return string
*/
public function enum($values){
@@ -554,7 +554,7 @@ class MySQLDatabase extends Database {
* Return a float type-formatted string
* For MySQL, we simply return the word 'date', no other parameters are necessary
*
- * @params array $values Contains a tokenised list of info about this data type
+ * @param array $values Contains a tokenised list of info about this data type
* @return string
*/
public function float($values){
@@ -568,7 +568,7 @@ class MySQLDatabase extends Database {
/**
* Return a int type-formatted string
*
- * @params array $values Contains a tokenised list of info about this data type
+ * @param array $values Contains a tokenised list of info about this data type
* @return string
*/
public function int($values){
@@ -583,7 +583,7 @@ class MySQLDatabase extends Database {
* Return a datetime type-formatted string
* For MySQL, we simply return the word 'datetime', no other parameters are necessary
*
- * @params array $values Contains a tokenised list of info about this data type
+ * @param array $values Contains a tokenised list of info about this data type
* @return string
*/
public function ssdatetime($values){
@@ -597,7 +597,7 @@ class MySQLDatabase extends Database {
/**
* Return a text type-formatted string
*
- * @params array $values Contains a tokenised list of info about this data type
+ * @param array $values Contains a tokenised list of info about this data type
* @return string
*/
public function text($values){
@@ -612,7 +612,7 @@ class MySQLDatabase extends Database {
* Return a time type-formatted string
* For MySQL, we simply return the word 'time', no other parameters are necessary
*
- * @params array $values Contains a tokenised list of info about this data type
+ * @param array $values Contains a tokenised list of info about this data type
* @return string
*/
public function time($values){
@@ -626,7 +626,7 @@ class MySQLDatabase extends Database {
/**
* Return a varchar type-formatted string
*
- * @params array $values Contains a tokenised list of info about this data type
+ * @param array $values Contains a tokenised list of info about this data type
* @return string
*/
public function varchar($values){
diff --git a/core/model/Translatable.php b/core/model/Translatable.php
index 009f77aba..9bc4bb520 100755
--- a/core/model/Translatable.php
+++ b/core/model/Translatable.php
@@ -10,40 +10,40 @@
*
Configuration
*
* You can enable {Translatable} for any subclass of {@link DataObject}:
- *
+ *
* class MyClass extends DataObject {
* static $extensions = array(
* "Translatable"
* );
* }
- *
+ *
* Make sure to rebuild the database through /dev/build after enabling translatable.
*
* Usage
*
* Getting a translation for an existing instance:
- *
+ *
* $translatedObj = DataObject::get_one_by_locale('MyObject', 'de_DE');
- *
+ *
*
* Getting a translation for an existing instance:
- *
+ *
* $obj = DataObject::get_by_id('MyObject', 99); // original language
* $translatedObj = $obj->getTranslation('de_DE');
- *
+ *
*
* Getting translations through {@link Translatable::set_reading_locale()}.
* This is *not* a recommended approach, but sometimes inavoidable (e.g. for {@link Versioned} methods).
- *
+ *
* $obj = DataObject::get_by_id('MyObject', 99); // original language
* $translatedObj = $obj->getTranslation('de_DE');
- *
+ *
*
* Creating a translation:
- *
+ *
* $obj = new MyObject();
* $translatedObj = $obj->createTranslation('de_DE');
- *
+ *
*
* Usage for SiteTree
*
@@ -62,14 +62,14 @@
* Note: You can't get Children() for a parent page in a different language
* through set_reading_lang(). Get the translated parent first.
*
- *
+ *
* // wrong
* Translatable::set_reading_lang('de');
* $englishParent->Children();
* // right
* $germanParent = $englishParent->getTranslation('de');
* $germanParent->Children();
- *
+ *
*
* Translation groups
*
diff --git a/core/model/fieldtypes/DBField.php b/core/model/fieldtypes/DBField.php
index 09f03bd30..1691fac74 100644
--- a/core/model/fieldtypes/DBField.php
+++ b/core/model/fieldtypes/DBField.php
@@ -218,9 +218,7 @@ abstract class DBField extends ViewableData {
* Returns a FormField instance used as a default
* for form scaffolding.
*
- * @usedby {@link SearchContext}
- * @usedby {@link ModelAdmin}
- * @usedby {@link DataObject::scaffoldFormFields()}
+ * Used by {@link SearchContext}, {@link ModelAdmin}, {@link DataObject::scaffoldFormFields()}
*
* @param string $title Optional. Localized title of the generated instance
* @return FormField
@@ -235,9 +233,7 @@ abstract class DBField extends ViewableData {
* Returns a FormField instance used as a default
* for searchform scaffolding.
*
- * @usedby {@link SearchContext}
- * @usedby {@link ModelAdmin}
- * @usedby {@link DataObject::scaffoldFormFields()}
+ * Used by {@link SearchContext}, {@link ModelAdmin}, {@link DataObject::scaffoldFormFields()}.
*
* @param string $title Optional. Localized title of the generated instance
* @return FormField
diff --git a/core/model/fieldtypes/Double.php b/core/model/fieldtypes/Double.php
index b96c85677..e86c74388 100644
--- a/core/model/fieldtypes/Double.php
+++ b/core/model/fieldtypes/Double.php
@@ -1,6 +1,8 @@
object = $object;
parent::__construct($name);
diff --git a/dev/BulkLoader.php b/dev/BulkLoader.php
index 6059f48f8..e363b9a23 100644
--- a/dev/BulkLoader.php
+++ b/dev/BulkLoader.php
@@ -190,15 +190,14 @@ abstract class BulkLoader extends ViewableData {
* Useful for generation of spec documents for technical end users.
*
* Return Format:
- *
+ *
* array(
* 'fields' => array('myFieldName'=>'myDescription'),
* 'relations' => array('myRelationName'=>'myDescription'),
* )
- *
+ *
*
* @todo Mix in custom column mappings
- * @usedby {@link ModelAdmin}
*
* @return array
**/
diff --git a/dev/CSVParser.php b/dev/CSVParser.php
index 7c82958cb..c24ceaf97 100644
--- a/dev/CSVParser.php
+++ b/dev/CSVParser.php
@@ -1,5 +1,4 @@
write();
* }
*
+ *
+ * @package sapphire
+ * @subpackage bulkloading
*/
class CSVParser extends Object implements Iterator {
protected $filename;
diff --git a/dev/CliTestReporter.php b/dev/CliTestReporter.php
index cced3b280..e902397bc 100644
--- a/dev/CliTestReporter.php
+++ b/dev/CliTestReporter.php
@@ -1,7 +1,9 @@
+ *
*
*
*
@@ -28,7 +28,7 @@
*
*
*
- *
+ *
*
* @package sapphire
* @subpackage testing
diff --git a/dev/ModelViewer.php b/dev/ModelViewer.php
index 4f5b7f358..0cbfb395c 100644
--- a/dev/ModelViewer.php
+++ b/dev/ModelViewer.php
@@ -1,8 +1,10 @@
send()
- * @usedby Email->sendPlain()
- * @usedby Debug->friendlyError()
+ * Used by {@link Email->send()}, {@link Email->sendPlain()}, {@link Debug->friendlyError()}.
*
* @param string $newEmail
*/
diff --git a/forms/NestedForm.php b/forms/NestedForm.php
index 635d93a35..7f248536a 100644
--- a/forms/NestedForm.php
+++ b/forms/NestedForm.php
@@ -1,8 +1,10 @@
\ No newline at end of file
diff --git a/parsers/SQLFormatter.php b/parsers/SQLFormatter.php
index cf1aa2afd..bade1e92c 100644
--- a/parsers/SQLFormatter.php
+++ b/parsers/SQLFormatter.php
@@ -8,7 +8,6 @@
* @package sapphire
* @subpackage parsers
* @author Ingo Schommer, Silverstripe Ltd. (@silverstripe.com)
- * @usedby Database->databaseError()
*/
class SQLFormatter extends Object {
diff --git a/search/SearchContext.php b/search/SearchContext.php
index 359f4065d..fec616298 100644
--- a/search/SearchContext.php
+++ b/search/SearchContext.php
@@ -11,15 +11,9 @@
*
* In case you need multiple contexts, consider namespacing your request parameters
* by using {@link FieldSet->namespace()} on the $fields constructor parameter.
-*
-* @usedby {@link ModelAdmin}
-*
-* @param string $modelClass The base {@link DataObject} class that search properties related to.
-* Also used to generate a set of result objects based on this class.
-* @param FieldSet $fields Optional. FormFields mapping to {@link DataObject::$db} properties
-* which are to be searched. Derived from modelclass using
-* {@link DataObject::scaffoldSearchFields()} if left blank.
-* @param array $filters Optional. Derived from modelclass if left blank
+*
+* @package sapphire
+* @subpackage search
*/
class SearchContext extends Object {
@@ -58,8 +52,14 @@ class SearchContext extends Object {
* Usually these values come from a submitted searchform
* in the form of a $_REQUEST object.
* CAUTION: All values should be treated as insecure client input.
- */
-
+ *
+ * @param string $modelClass The base {@link DataObject} class that search properties related to.
+ * Also used to generate a set of result objects based on this class.
+ * @param FieldSet $fields Optional. FormFields mapping to {@link DataObject::$db} properties
+ * which are to be searched. Derived from modelclass using
+ * {@link DataObject::scaffoldSearchFields()} if left blank.
+ * @param array $filters Optional. Derived from modelclass if left blank
+ */
function __construct($modelClass, $fields = null, $filters = null) {
$this->modelClass = $modelClass;
$this->fields = ($fields) ? $fields : new FieldSet();
diff --git a/search/filters/NegationFilter.php b/search/filters/NegationFilter.php
index a40607716..73ad02ecd 100644
--- a/search/filters/NegationFilter.php
+++ b/search/filters/NegationFilter.php
@@ -1,14 +1,9 @@