Skip to content

Commit

Permalink
Updating docblocks; adding missing options.
Browse files Browse the repository at this point in the history
  • Loading branch information
mariuswilms committed May 3, 2014
1 parent 651d07a commit 61224fc
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 22 deletions.
16 changes: 8 additions & 8 deletions console/Command.php
Original file line number Diff line number Diff line change
Expand Up @@ -378,14 +378,14 @@ public function stop($status = 0, $message = null) {
/**
* Handles the response that is sent to the stream.
*
* @param string $type the stream either output or error
* @param string $string the message to render
* @param integer|string|array $options
* integer as the number of new lines.
* string as the style
* array as :
* - nl : number of new lines to add at the end
* - style : the style name to wrap around the
* @param string $type The stream either output or error.
* @param string $string The message to render.
* @param integer|string|array $options When passed an integer is used as the number
* of new lines, when passed a string it is interpreted as
* style to use otherwise when an array following options are
* available:
* - `'nl'` _integer_: number of new lines to add at the end.
* - `'style'` _string_: the style name to wrap around the.
* @return void
*/
protected function _response($type, $string, $options) {
Expand Down
1 change: 1 addition & 0 deletions console/command/Library.php
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,7 @@ protected function _findReplacements($base = null) {
*
* @param string $extracted contains the path to the extracted archive.
* @param array $options Valid options are:
* - `'namespace'`: Namespace used for extracted libraries.
* - `'replacements'`: an array of string replacements indexed by filename.
* It's also possible to use glob-style wildcards in the filename such
* as `*` or `*.php` or `resources/g11n/*`. If the filename starts
Expand Down
10 changes: 5 additions & 5 deletions data/source/Database.php
Original file line number Diff line number Diff line change
Expand Up @@ -1570,12 +1570,12 @@ protected function _on(array $constraints, $aliasFrom, $aliasTo, $mapAlias = arr
}

/**
* Build a SQL column/table meta
* Build a SQL column/table meta.
*
* @param string $type The type of the meta to build (possible values: 'table' or 'column')
* @param string $name The name of the meta to build
* @param mixed $value The value used for building the meta
* @return string The SQL meta string
* @param string $type The type of the meta to build (possible values: `'table'` or `'column'`).
* @param string $name The name of the meta to build.
* @param mixed $value The value used for building the meta.
* @return string The SQL meta string.
*/
protected function _meta($type, $name, $value) {
$meta = isset($this->_metas[$type][$name]) ? $this->_metas[$type][$name] : null;
Expand Down
7 changes: 4 additions & 3 deletions data/source/database/adapter/MySql.php
Original file line number Diff line number Diff line change
Expand Up @@ -400,10 +400,11 @@ protected function _column($real) {
}

/**
* Helper for `DatabaseSchema::_column()`
* Helper for `Database::column()`
*
* @param array $field A field array
* @return string The SQL column string
* @see lithium\data\Database::column()
* @param array $field A field array.
* @return string The SQL column string.
*/
protected function _buildColumn($field) {
extract($field);
Expand Down
7 changes: 4 additions & 3 deletions data/source/database/adapter/PostgreSql.php
Original file line number Diff line number Diff line change
Expand Up @@ -488,10 +488,11 @@ protected function _formatters() {
}

/**
* Helper for `DatabaseSchema::_column()`
* Helper for `Database::column()`.
*
* @param array $field A field array
* @return string SQL column string
* @see lithium\data\Database::column()
* @param array $field A field array.
* @return string SQL column string.
*/
protected function _buildColumn($field) {
extract($field);
Expand Down
7 changes: 4 additions & 3 deletions data/source/database/adapter/Sqlite3.php
Original file line number Diff line number Diff line change
Expand Up @@ -356,10 +356,11 @@ protected function _column($real) {
}

/**
* Helper for `DatabaseSchema::_column()`
* Helper for `Database::column()`.
*
* @param array $field A field array
* @return string SQL column string
* @see lithium\data\Database::column()
* @param array $field A field array.
* @return string SQL column string.
*/
protected function _buildColumn($field) {
extract($field);
Expand Down

0 comments on commit 61224fc

Please sign in to comment.