diff --git a/api/Spyc.php b/api/Spyc.php index 4e6a41b4f..03f6050de 100644 --- a/api/Spyc.php +++ b/api/Spyc.php @@ -23,7 +23,7 @@ class YAMLNode { */ public $parent; public $id; - /**#@+*/ + /**#@-*/ /** * @access public * @var mixed @@ -349,7 +349,7 @@ class Spyc { private $_isInline; private $_dumpIndent; private $_dumpWordWrap; - /**#@+*/ + /**#@-*/ /**** Public Properties ****/ @@ -358,7 +358,7 @@ class Spyc { * @var mixed */ public $_nodeId; - /**#@+*/ + /**#@-*/ /**** Private Methods ****/ diff --git a/cli-script.php b/cli-script.php index 8f4644166..1cb51d6e6 100755 --- a/cli-script.php +++ b/cli-script.php @@ -16,6 +16,9 @@ $_SERVER['HTTP_HOST'] = $_SERVER['argv'][2]; $_SERVER['SCRIPT_FILENAME'] = __FILE__; chdir(dirname($_SERVER['SCRIPT_FILENAME'])); +/** + * Include Sapphire's core code + */ require_once("core/Core.php"); header("Content-type: text/html; charset=\"utf-8\""); diff --git a/core/Email.php b/core/Email.php index d1c41f43c..781dd29ba 100755 --- a/core/Email.php +++ b/core/Email.php @@ -368,6 +368,11 @@ class Email extends ViewableData { } } +/** + * Implements an email template that can be populated. + * @package sapphire + * @subpackage email + */ class Email_Template extends Email { public function __construct() { } diff --git a/core/ManifestBuilder.php b/core/ManifestBuilder.php index 7463c7775..655f0bc1e 100644 --- a/core/ManifestBuilder.php +++ b/core/ManifestBuilder.php @@ -205,7 +205,7 @@ class ManifestBuilder { * application * * @param string $folder The folder to traverse (recursively) - * @pram array $classMap The already built class map + * @param array $classMap The already built class map */ private static function getClassManifest($folder, &$classMap) { $items = scandir($folder); diff --git a/core/control/Director.php b/core/control/Director.php index d9071cb00..f5ad9f755 100644 --- a/core/control/Director.php +++ b/core/control/Director.php @@ -86,8 +86,8 @@ class Director { * - output the response to the browser, using {@link HTTPResponse::output()}. * * @param $url String, the URL the user is visiting, without the querystring. - * @uses getControllerForURL() The rule-lookup logic is handled by this. - * @uses Controller::run() The actual page logic is handled by this. + * @uses getControllerForURL() rule-lookup logic is handled by this. + * @uses Controller::run() Controller::run() handles the page logic for a Director::direct() call. */ function direct($url) { if(isset($_GET['debug_profile'])) Profiler::mark("Director","direct"); @@ -125,7 +125,7 @@ class Director { * calls of Director::test(), you can simulate a peristed session. * * @uses getControllerForURL() The rule-lookup logic is handled by this. - * @uses Controller::run() The actual page logic is handled by this. + * @uses Controller::run() Controller::run() handles the page logic for a Director::direct() call. */ function test($url, $post = null, $session = null) { $getVars = array(); diff --git a/core/model/Database.php b/core/model/Database.php index cc211dff0..2f53dc6aa 100755 --- a/core/model/Database.php +++ b/core/model/Database.php @@ -445,6 +445,8 @@ abstract class Database extends Object { * Primarily, the Query class takes care of the iterator plumbing, letting the subclasses focusing * on providing the specific data-access methods that are required: {@link nextRecord()}, {@link numRecords()} * and {@link seek()} + * @package sapphire + * @subpackage model */ abstract class Query extends Object implements Iterator { /** diff --git a/core/model/ErrorPage.php b/core/model/ErrorPage.php index 3fa087894..11afad36b 100755 --- a/core/model/ErrorPage.php +++ b/core/model/ErrorPage.php @@ -104,6 +104,7 @@ class ErrorPage extends Page { /** * Controller for ErrorPages. + * @package cms */ class ErrorPage_Controller extends Page_Controller { public function init() { diff --git a/core/model/GhostPage.php b/core/model/GhostPage.php index 2717880e7..f9f74b307 100755 --- a/core/model/GhostPage.php +++ b/core/model/GhostPage.php @@ -96,6 +96,7 @@ class GhostPage extends SiteTree implements HiddenClass { /** * Controller for GhostPages + * @package cms */ class GhostPage_Controller extends Page_Controller { function getViewer($action) { @@ -105,6 +106,7 @@ class GhostPage_Controller extends Page_Controller { /** * Special type of ComponentSet just for GhostPages + * @package cms */ class GhostPage_ComponentSet extends ComponentSet { function setOwner($ownerObj) { diff --git a/core/model/Image.php b/core/model/Image.php index f0fe927b7..6daef47a7 100755 --- a/core/model/Image.php +++ b/core/model/Image.php @@ -264,9 +264,9 @@ class Image extends File { * Generate an image on the specified format. It will save the image * at the location specified by cacheFilename(). The image will be generated * using the specific 'generate' method for the specified format. - * @var string $format Name of the format to generate. - * @var string $arg1 Argument to pass to the generate method. - * @var string $arg2 A second argument to pass to the generate method. + * @param string $format Name of the format to generate. + * @param string $arg1 Argument to pass to the generate method. + * @param string $arg2 A second argument to pass to the generate method. */ function generateFormattedImage($format, $arg1 = null, $arg2 = null) { $cacheFile = $this->cacheFilename($format, $arg1, $arg2); @@ -367,7 +367,11 @@ class Image extends File { } /** - * Image not stored in the database, that is just a cached resampled image + * A resized / processed {@link Image} object. + * When Image object are processed or resized, a suitable Image_Cached object is returned, pointing to the + * cached copy of the processed image. + * @package sapphire + * @subpackage filesystem */ class Image_Cached extends Image { /** @@ -395,6 +399,12 @@ class Image_Cached extends Image { } } +/** + * A db field type designed to help save images. + * @deprecated Use a has_one relationship pointing to the file table instead. + * @package sapphire + * @subpackage filesystem + */ class Image_Saver extends DBField { function saveInto($record) { $image = $record->getComponent($this->name); @@ -414,8 +424,9 @@ class Image_Saver extends DBField { } /** - * Uploader support for the uploading anything which is a File or subclass of - * File, eg Image. + * Uploader support for the uploading anything which is a File or subclass of File, eg Image. + * @package sapphire + * @subpackage filesystem */ class Image_Uploader extends Controller { /** diff --git a/core/model/MySQLDatabase.php b/core/model/MySQLDatabase.php index 23f36bee1..3468d1a0b 100644 --- a/core/model/MySQLDatabase.php +++ b/core/model/MySQLDatabase.php @@ -32,10 +32,10 @@ class MySQLDatabase extends Database { /** * Connect to a MySQL database. * @param array $parameters An map of parameters, which should include: - *