Permalink
Browse files

Standardising docblock endings throughout.

  • Loading branch information...
1 parent 5092262 commit 0977b3fe1531e2a86cf632cc8616b25f252bba2d @predominant predominant committed Nov 14, 2009
Showing with 559 additions and 552 deletions.
  1. +3 −3 cake/console/libs/acl.php
  2. +3 −3 cake/console/libs/schema.php
  3. +1 −1 cake/console/libs/shell.php
  4. +6 −6 cake/console/libs/tasks/controller.php
  5. +2 −2 cake/console/libs/tasks/db_config.php
  6. +9 −9 cake/console/libs/tasks/fixture.php
  7. +19 −19 cake/console/libs/tasks/model.php
  8. +1 −1 cake/console/libs/tasks/plugin.php
  9. +1 −1 cake/console/libs/tasks/project.php
  10. +7 −7 cake/console/libs/tasks/template.php
  11. +20 −20 cake/console/libs/tasks/test.php
  12. +4 −4 cake/console/libs/tasks/view.php
  13. +9 −9 cake/libs/cake_log.php
  14. +1 −1 cake/libs/cake_session.php
  15. +1 −1 cake/libs/configure.php
  16. +1 −1 cake/libs/controller/component.php
  17. +1 −1 cake/libs/controller/components/cookie.php
  18. +5 −5 cake/libs/inflector.php
  19. +3 −3 cake/libs/log/file_log.php
  20. +2 −2 cake/libs/magic_db.php
  21. +3 −3 cake/libs/model/cake_schema.php
  22. +1 −1 cake/libs/model/datasources/datasource.php
  23. +1 −1 cake/libs/model/datasources/dbo/dbo_adodb.php
  24. +1 −1 cake/libs/model/datasources/dbo/dbo_db2.php
  25. +2 −2 cake/libs/model/datasources/dbo/dbo_firebird.php
  26. +1 −1 cake/libs/model/datasources/dbo/dbo_mssql.php
  27. +2 −2 cake/libs/model/datasources/dbo/dbo_mysql.php
  28. +1 −1 cake/libs/model/datasources/dbo/dbo_mysqli.php
  29. +1 −1 cake/libs/model/datasources/dbo/dbo_odbc.php
  30. +1 −1 cake/libs/model/datasources/dbo/dbo_postgres.php
  31. +1 −1 cake/libs/model/datasources/dbo/dbo_sqlite.php
  32. +1 −1 cake/libs/model/datasources/dbo/dbo_sybase.php
  33. +3 −3 cake/libs/model/datasources/dbo_source.php
  34. +2 −2 cake/libs/router.php
  35. +1 −1 cake/libs/view/helper.php
  36. +6 −6 cake/libs/view/helpers/html.php
  37. +1 −1 cake/libs/view/helpers/javascript.php
  38. +15 −15 cake/libs/view/helpers/jquery_engine.php
  39. +50 −50 cake/libs/view/helpers/js.php
  40. +13 −13 cake/libs/view/helpers/mootools_engine.php
  41. +3 −3 cake/libs/view/helpers/number.php
  42. +2 −2 cake/libs/view/helpers/paginator.php
  43. +14 −14 cake/libs/view/helpers/prototype_engine.php
  44. +1 −1 cake/libs/view/helpers/rss.php
  45. +1 −1 cake/libs/view/view.php
  46. +27 −26 cake/tests/cases/basics.test.php
  47. +63 −60 cake/tests/cases/dispatcher.test.php
  48. +6 −6 cake/tests/cases/libs/cake_log.test.php
  49. +2 −2 cake/tests/cases/libs/cake_test_case.test.php
  50. +1 −1 cake/tests/cases/libs/cake_test_fixture.test.php
  51. +2 −2 cake/tests/cases/libs/code_coverage_manager.test.php
  52. +2 −2 cake/tests/cases/libs/configure.test.php
  53. +1 −1 cake/tests/cases/libs/controller/component.test.php
  54. +6 −6 cake/tests/cases/libs/controller/components/auth.test.php
  55. +5 −5 cake/tests/cases/libs/controller/components/request_handler.test.php
  56. +2 −2 cake/tests/cases/libs/controller/components/security.test.php
  57. +4 −4 cake/tests/cases/libs/controller/controller.test.php
  58. +36 −33 cake/tests/cases/libs/controller/controller_merge_vars.test.php
  59. +11 −11 cake/tests/cases/libs/controller/scaffold.test.php
  60. +2 −2 cake/tests/cases/libs/error.test.php
  61. +1 −1 cake/tests/cases/libs/folder.test.php
  62. +1 −1 cake/tests/cases/libs/log/file_log.test.php
  63. +1 −1 cake/tests/cases/libs/magic_db.test.php
  64. +4 −4 cake/tests/cases/libs/model/cake_schema.test.php
  65. +1 −1 cake/tests/cases/libs/model/datasources/dbo/dbo_adodb.test.php
  66. +5 −5 cake/tests/cases/libs/model/datasources/dbo/dbo_mysql.test.php
  67. +1 −1 cake/tests/cases/libs/model/datasources/dbo/dbo_mysqli.test.php
  68. +2 −2 cake/tests/cases/libs/model/datasources/dbo/dbo_postgres.test.php
  69. +3 −3 cake/tests/cases/libs/model/datasources/dbo/dbo_sqlite.test.php
  70. +5 −5 cake/tests/cases/libs/model/datasources/dbo_source.test.php
  71. +2 −2 cake/tests/cases/libs/model/model_behavior.test.php
  72. +1 −1 cake/tests/cases/libs/model/model_delete.test.php
  73. +4 −4 cake/tests/cases/libs/model/model_integration.test.php
  74. +2 −2 cake/tests/cases/libs/model/model_read.test.php
  75. +1 −1 cake/tests/cases/libs/model/model_validation.test.php
  76. +5 −5 cake/tests/cases/libs/model/model_write.test.php
  77. +5 −5 cake/tests/cases/libs/model/models.php
  78. +5 −5 cake/tests/cases/libs/object.test.php
  79. +5 −5 cake/tests/cases/libs/router.test.php
  80. +1 −1 cake/tests/cases/libs/string.test.php
  81. +1 −1 cake/tests/cases/libs/validation.test.php
  82. +3 −3 cake/tests/cases/libs/view/helper.test.php
  83. +3 −3 cake/tests/cases/libs/view/helpers/cache.test.php
  84. +12 −12 cake/tests/cases/libs/view/helpers/form.test.php
  85. +6 −6 cake/tests/cases/libs/view/helpers/html.test.php
  86. +2 −2 cake/tests/cases/libs/view/helpers/javascript.test.php
  87. +13 −13 cake/tests/cases/libs/view/helpers/jquery_engine.test.php
  88. +24 −24 cake/tests/cases/libs/view/helpers/js.test.php
  89. +13 −13 cake/tests/cases/libs/view/helpers/mootools_engine.test.php
  90. +2 −2 cake/tests/cases/libs/view/helpers/paginator.test.php
  91. +13 −13 cake/tests/cases/libs/view/helpers/prototype_engine.test.php
  92. +1 −1 cake/tests/cases/libs/view/helpers/session.test.php
  93. +4 −4 cake/tests/cases/libs/view/view.test.php
  94. +3 −3 cake/tests/cases/libs/xml.test.php
  95. +3 −3 cake/tests/lib/cake_reporter.php
  96. +1 −1 cake/tests/lib/cake_test_fixture.php
  97. +3 −3 cake/tests/lib/cake_text_reporter.php
@@ -236,7 +236,7 @@ function getPath() {
* @param integer $indent indent level.
* @return void
* @access protected
- **/
+ */
function _outputNode($class, $node, $indent) {
$indent = str_repeat(' ', $indent);
$data = $node[$class];
@@ -521,7 +521,7 @@ function nodeExists() {
*
* @param string $identifier Identifier to parse
* @return mixed a string for aliases, and an array for model.foreignKey
- **/
+ */
function parseIdentifier($identifier) {
if (preg_match('/^([\w]+)\.(.*)$/', $identifier, $matches)) {
return array(
@@ -539,7 +539,7 @@ function parseIdentifier($identifier) {
* @param string $class Class type you want (Aro/Aco)
* @param mixed $identifier A mixed identifier for finding the node.
* @return int Integer of NodeId. Will trigger an error if nothing is found.
- **/
+ */
function _getNodeId($class, $identifier) {
$node = $this->Acl->{$class}->node($identifier);
if (empty($node)) {
@@ -242,7 +242,7 @@ function dump() {
* Run database create commands. Alias for run create.
*
* @return void
- **/
+ */
function create() {
list($Schema, $table) = $this->_loadSchema();
$this->__create($Schema, $table);
@@ -252,7 +252,7 @@ function create() {
* Run database create commands. Alias for run create.
*
* @return void
- **/
+ */
function update() {
list($Schema, $table) = $this->_loadSchema();
$this->__update($Schema, $table);
@@ -262,7 +262,7 @@ function update() {
* Prepares the Schema objects for database operations.
*
* @return void
- **/
+ */
function _loadSchema() {
$name = $plugin = null;
if (isset($this->params['name'])) {
@@ -642,7 +642,7 @@ function _pluralHumanName($name) {
*
* @param string $pluginName Name of the plugin you want ie. DebugKit
* @return string $path path to the correct plugin.
- **/
+ */
function _pluginPath($pluginName) {
return App::pluginPath($pluginName);
}
@@ -113,7 +113,7 @@ function execute() {
*
* @access public
* @return void
- **/
+ */
function all() {
$this->interactive = false;
$this->listAll($this->connection, false);
@@ -219,7 +219,7 @@ function __interactive() {
* Confirm a to be baked controller with the user
*
* @return void
- **/
+ */
function confirmController($controllerName, $useDynamicScaffold, $helpers, $components) {
$this->out();
$this->hr();
@@ -257,7 +257,7 @@ function confirmController($controllerName, $useDynamicScaffold, $helpers, $comp
* Interact with the user and ask about which methods (admin or regular they want to bake)
*
* @return array Array containing (bakeRegular, bakeAdmin) answers
- **/
+ */
function _askAboutMethods() {
$wannaBakeCrud = $this->in(
__("Would you like to create some basic class methods \n(index(), add(), view(), edit())?", true),
@@ -348,7 +348,7 @@ function bakeTest($className) {
* Interact with the user and get a list of additional helpers
*
* @return array Helpers that the user wants to use.
- **/
+ */
function doHelpers() {
return $this->_doPropertyChoices(
__("Would you like this controller to use other helpers\nbesides HtmlHelper and FormHelper?", true),
@@ -360,7 +360,7 @@ function doHelpers() {
* Interact with the user and get a list of additional components
*
* @return array Components the user wants to use.
- **/
+ */
function doComponents() {
return $this->_doPropertyChoices(
__("Would you like this controller to use any components?", true),
@@ -374,7 +374,7 @@ function doComponents() {
* @param string $prompt A yes/no question to precede the list
* @param sting $example A question for a comma separated list, with examples.
* @return array Array of values for property.
- **/
+ */
function _doPropertyChoices($prompt, $example) {
$proceed = $this->in($prompt, array('y','n'), 'n');
$property = array();
@@ -53,7 +53,7 @@ class DbConfigTask extends Shell {
* Used for testing.
*
* @var string
- **/
+ */
var $databaseClassName = 'DATABASE_CONFIG';
/**
@@ -351,7 +351,7 @@ function bake($configs) {
* Get a user specified Connection name
*
* @return void
- **/
+ */
function getConfig() {
App::import('Model', 'ConnectionManager', false);
@@ -54,14 +54,14 @@ class FixtureTask extends Shell {
* The db connection being used for baking
*
* @var string
- **/
+ */
var $connection = null;
/**
* Schema instance
*
* @var object
- **/
+ */
var $_Schema = null;
/**
@@ -103,7 +103,7 @@ function execute() {
*
* @access public
* @return void
- **/
+ */
function all() {
$this->interactive = false;
$this->Model->interactive = false;
@@ -140,7 +140,7 @@ function __interactive() {
*
* @param string $modelName Name of model you are dealing with.
* @return array Array of import options.
- **/
+ */
function importOptions($modelName) {
$options = array();
$doSchema = $this->in(__('Would you like to import schema for this fixture?', true), array('y', 'n'), 'n');
@@ -230,7 +230,7 @@ function bake($model, $useTable = false, $importOptions = array()) {
* @param string $fixture Contents of the fixture file.
* @access public
* @return void
- **/
+ */
function generateFixtureFile($model, $otherVars) {
$defaults = array('table' => null, 'schema' => null, 'records' => null, 'import' => null, 'fields' => null);
$vars = array_merge($defaults, $otherVars);
@@ -255,7 +255,7 @@ function generateFixtureFile($model, $otherVars) {
*
* @param array $table Table schema array
* @return string fields definitions
- **/
+ */
function _generateSchema($tableInfo) {
$schema = $this->_Schema->generateTable('f', $tableInfo);
return substr($schema, 10, -2);
@@ -266,7 +266,7 @@ function _generateSchema($tableInfo) {
*
* @param array $table Table schema array
* @return array Array of records to use in the fixture.
- **/
+ */
function _generateRecords($tableInfo, $recordCount = 1) {
$records = array();
for ($i = 0; $i < $recordCount; $i++) {
@@ -337,7 +337,7 @@ function _generateRecords($tableInfo, $recordCount = 1) {
*
* @param array $records Array of records to be converted to string
* @return string A string value of the $records array.
- **/
+ */
function _makeRecordString($records) {
$out = "array(\n";
foreach ($records as $record) {
@@ -360,7 +360,7 @@ function _makeRecordString($records) {
* @param string $modelName name of the model to take records from.
* @param string $useTable Name of table to use.
* @return array Array of records.
- **/
+ */
function _getRecordsFromTable($modelName, $useTable = null) {
if ($this->interactive) {
$condition = null;
@@ -64,14 +64,14 @@ class ModelTask extends Shell {
* Holds tables found on connection.
*
* @var array
- **/
+ */
var $__tables = array();
/**
* Holds validation method map.
*
* @var array
- **/
+ */
var $__validations = array();
/**
@@ -109,7 +109,7 @@ function execute() {
* Bake all models at once.
*
* @return void
- **/
+ */
function all() {
$this->listAll($this->connection, false);
$unitTestExists = $this->_checkUnitTest();
@@ -129,7 +129,7 @@ function all() {
*
* @param string $className Name of class you want model to be.
* @return object Model instance
- **/
+ */
function &_getModelObject($className) {
$object = new Model(array('name' => $className, 'ds' => $this->connection));
return $object;
@@ -142,7 +142,7 @@ function &_getModelObject($className) {
* @param string $prompt Prompt to use for options list.
* @param integer $default The default option for the given prompt.
* @return result of user choice.
- **/
+ */
function inOptions($options, $prompt = null, $default = null) {
$valid = false;
$max = count($options);
@@ -262,7 +262,7 @@ function __interactive() {
* @param string $associations Collection of associations.
* @access protected
* @return void
- **/
+ */
function _printAssociation($modelName, $type, $associations) {
if (!empty($associations[$type])) {
for ($i = 0; $i < count($associations[$type]); $i++) {
@@ -278,7 +278,7 @@ function _printAssociation($modelName, $type, $associations) {
* @param array $fields Array of fields that might have a primary key.
* @return string Name of field that is a primary key.
* @access public
- **/
+ */
function findPrimaryKey($fields) {
foreach ($fields as $name => $field) {
if (isset($field['key']) && $field['key'] == 'primary') {
@@ -293,7 +293,7 @@ function findPrimaryKey($fields) {
*
* @param array $fields Array of fields to look for and choose as a displayField
* @return mixed Name of field to use for displayField or false if the user declines to choose
- **/
+ */
function findDisplayField($fields) {
$fieldNames = array_keys($fields);
$prompt = __("A displayField could not be automatically detected\nwould you like to choose one?", true);
@@ -337,7 +337,7 @@ function doValidation(&$model) {
* Populate the __validations array
*
* @return void
- **/
+ */
function initValidations() {
$options = $choices = array();
if (class_exists('Validation')) {
@@ -363,7 +363,7 @@ function initValidations() {
* @param string $fieldName Name of field to be validated.
* @param array $metaData metadata for field
* @return array Array of validation for the field.
- **/
+ */
function fieldValidation($fieldName, $metaData, $primaryKey = 'id') {
$defaultChoice = count($this->__validations);
$validate = $alreadyChosen = array();
@@ -484,7 +484,7 @@ function doAssociations(&$model) {
* @param object $model Model instance of model being generated.
* @param array $associations Array of inprogress associations
* @return array $associations with belongsTo added in.
- **/
+ */
function findBelongsTo(&$model, $associations) {
$fields = $model->schema();
foreach ($fields as $fieldName => $field) {
@@ -513,7 +513,7 @@ function findBelongsTo(&$model, $associations) {
* @param object $model Model instance being generated
* @param array $associations Array of inprogress associations
* @return array $associations with hasOne and hasMany added in.
- **/
+ */
function findHasOneAndMany(&$model, $associations) {
$foreignKey = $this->_modelKey($model->name);
foreach ($this->__tables as $otherTable) {
@@ -556,7 +556,7 @@ function findHasOneAndMany(&$model, $associations) {
* @param object $model Model instance being generated
* @param array $associations Array of inprogress associations
* @return array $associations with hasAndBelongsToMany added in.
- **/
+ */
function findHasAndBelongsToMany(&$model, $associations) {
$foreignKey = $this->_modelKey($model->name);
foreach ($this->__tables as $otherTable) {
@@ -596,7 +596,7 @@ function findHasAndBelongsToMany(&$model, $associations) {
* @param array $model Temporary Model instance.
* @param array $associations Array of associations to be confirmed.
* @return array Array of confirmed associations
- **/
+ */
function confirmAssociations(&$model, $associations) {
foreach ($associations as $type => $settings) {
if (!empty($associations[$type])) {
@@ -624,7 +624,7 @@ function confirmAssociations(&$model, $associations) {
* @param object $model Temporary model instance
* @param array $associations Array of associations.
* @return array Array of associations.
- **/
+ */
function doMoreAssociations($model, $associations) {
$prompt = __('Would you like to define some additional model associations?', true);
$wannaDoMoreAssoc = $this->in($prompt, array('y','n'), 'n');
@@ -689,7 +689,7 @@ function doMoreAssociations($model, $associations) {
* Finds all possible keys to use on custom associations.
*
* @return array array of tables and possible keys
- **/
+ */
function _generatePossibleKeys() {
$possible = array();
foreach ($this->__tables as $otherTable) {
@@ -782,7 +782,7 @@ function listAll($useDbConfig = null) {
* @param string $modelName Name of the model you want a table for.
* @param string $useDbConfig Name of the database config you want to get tables from.
* @return void
- **/
+ */
function getTable($modelName, $useDbConfig = null) {
if (!isset($useDbConfig)) {
$useDbConfig = $this->connection;
@@ -811,7 +811,7 @@ function getTable($modelName, $useDbConfig = null) {
*
* @param string $useDbConfig Connection name to scan.
* @return array Array of tables in the database.
- **/
+ */
function getAllTables($useDbConfig = null) {
if (!isset($useDbConfig)) {
$useDbConfig = $this->connection;
@@ -906,7 +906,7 @@ function help() {
* @access public
* @return void
* @see FixtureTask::bake
- **/
+ */
function bakeFixture($className, $useTable = null) {
$this->Fixture->connection = $this->connection;
$this->Fixture->plugin = $this->plugin;
@@ -204,7 +204,7 @@ function bake($plugin) {
* find and change $this->path to the user selection
*
* @return void
- **/
+ */
function findPath($pathOptions) {
$valid = false;
$max = count($pathOptions);
Oops, something went wrong.

0 comments on commit 0977b3f

Please sign in to comment.