Author: Tobias Schlitt
Date: 2006-01-18 15:48:15 +0100 (Wed, 18 Jan 2006)
New Revision: 1965
Log:
- Documentation update.
Modified:
packages/ConsoleTools/releases/1.0rc1/src/input.php
packages/ConsoleTools/releases/1.0rc1/src/output.php
packages/ConsoleTools/releases/1.0rc1/src/progressbar.php
packages/ConsoleTools/releases/1.0rc1/src/table.php
Modified: packages/ConsoleTools/releases/1.0rc1/src/input.php
===================================================================
--- packages/ConsoleTools/releases/1.0rc1/src/input.php 2006-01-18 14:23:15 UTC
(rev 1964)
+++ packages/ConsoleTools/releases/1.0rc1/src/input.php 2006-01-18 14:48:15 UTC
(rev 1965)
@@ -498,14 +498,14 @@
* Returns an array of all registered options in the following format:
* <code>
* array(
- * 0 => object(ezcConsoleOption),
- * 1 => object(ezcConsoleOption),
- * 2 => object(ezcConsoleOption),
+ * 0 => ezcConsoleOption,
+ * 1 => ezcConsoleOption,
+ * 2 => ezcConsoleOption,
* ...
* );
* </code>
*
- * @return array(string=>object(ezcConsoleOption)) Registered options.
+ * @return array(string=>ezcConsoleOption) Registered options.
*/
public function getOptions()
{
Modified: packages/ConsoleTools/releases/1.0rc1/src/output.php
===================================================================
--- packages/ConsoleTools/releases/1.0rc1/src/output.php 2006-01-18
14:23:15 UTC (rev 1964)
+++ packages/ConsoleTools/releases/1.0rc1/src/output.php 2006-01-18
14:48:15 UTC (rev 1965)
@@ -58,8 +58,10 @@
* // This is visible, since we set verbosityLevel to 10, and printed in format
* // 'failure'
* $out->outputText( "And some not so verbose, failure output.\n", 'failure',
5 );
+ * </code>
*
- * </code>
+ * For a list of valid colors, style attributes and background colors, please
+ * refer to [EMAIL PROTECTED] ezcConsoleOutputFormat}.
*
* @package ConsoleTools
* @version 1.0rc1
@@ -69,14 +71,14 @@
/**
* Options
*
- * @var object(ezcConsoleOutputOptions)
+ * @var ezcConsoleOutputOptions
*/
protected $options;
/**
* Formats
*
- * @var object(ezcConsoleOutputFormats)
+ * @var ezcConsoleOutputFormats
*/
protected $formats;
Modified: packages/ConsoleTools/releases/1.0rc1/src/progressbar.php
===================================================================
--- packages/ConsoleTools/releases/1.0rc1/src/progressbar.php 2006-01-18
14:23:15 UTC (rev 1964)
+++ packages/ConsoleTools/releases/1.0rc1/src/progressbar.php 2006-01-18
14:48:15 UTC (rev 1965)
@@ -52,7 +52,6 @@
*
* <code>
* $progress->max; // The maximum progress value to reach.
- * $ptogress->step; // The step size to raise the progress.
* </code>
*
* @var array(string=>int)
@@ -132,14 +131,10 @@
* @param ezcConsoleOutput $outHandler Handler to utilize for output
* @param int $max Maximum value, where progressbar
* reaches 100%.
- * @param int $step The ammount of $max that is
- * consumed each time
- * [EMAIL PROTECTED]
ezcConsoleProgressbar::advance()}
- * is called.
* @param array(string=>string) $options Options
*
- * @see ezcConsoleTable::$settings
- * @see ezcConsoleTable::$options
+ * @see ezcConsoleProgressbar::$settings
+ * @see ezcConsoleProgressbar::$options
*/
public function __construct( ezcConsoleOutput $outHandler, $max, array
$options = array() )
{
Modified: packages/ConsoleTools/releases/1.0rc1/src/table.php
===================================================================
--- packages/ConsoleTools/releases/1.0rc1/src/table.php 2006-01-18 14:23:15 UTC
(rev 1964)
+++ packages/ConsoleTools/releases/1.0rc1/src/table.php 2006-01-18 14:48:15 UTC
(rev 1965)
@@ -226,7 +226,7 @@
* since it creates them on the fly, if a given item does not exist.
*
* @param int $offset The offset to check.
- * @return object(ezcConsoleTableCell)
+ * @return ezcConsoleTableCell
*
* @throws ezcBaseValueException
* If a non numeric row ID is requested.
@@ -254,8 +254,8 @@
* This method is part of the ArrayAccess interface to allow access to the
* data of this object as if it was an array.
*
- * @param int $offset The offset to assign an item to.
- * @param object(ezcConsoleTableCell) The item to assign.
+ * @param int $offset The offset to assign an item to.
+ * @param ezcConsoleTableCell The row to assign.
* @return void
*
* @throws ezcBaseValueException
@@ -322,7 +322,7 @@
* cells of this row by iterating over it like an array (e.g. using
* foreach).
*
- * @return object(ezcConsoleTableCell) The currently selected cell.
+ * @return ezcConsoleTableCell The currently selected cell.
*/
public function current()
{
--
svn-components mailing list
[email protected]
http://lists.ez.no/mailman/listinfo/svn-components
