updated docs

ahmetgunes · Jan 21, 2015 · 70fd25d · 70fd25d
1 parent 4d3bc2e
commit 70fd25d
Show file tree

Hide file tree

Showing 21 changed files with 68 additions and 1,312 deletions.
diff --git a/RoboFile.php b/RoboFile.php
@@ -98,23 +98,24 @@ function (\ReflectionMethod $m) {
                     if ($m->isConstructor() or $m->isDestructor() or $m->isStatic()) {
                         return false;
                     }
-                    return !in_array($m->name, ['run', '', '__call', 'getCommand']) and $m->isPublic(); // methods are not documented
+                    return !in_array($m->name, ['run', '', '__call', 'getCommand', 'getPrinted']) and $m->isPublic(); // methods are not documented
                 }
             )->processClassSignature(
                 function ($c) {
                     return "## " . preg_replace('~Task$~', '', $c->getShortName()) . "\n";
                 }
             )->processClassDocBlock(
                 function ($c, $doc) {
-                    return preg_replace('~@method .*?\wTask (.*?)\)~', '* `$1)` ', $doc);
+                    return preg_replace('~@method .*?(.*?)\)~', '* `$1)` ', $doc);
                 }
             )->processMethodSignature(
                 function (\ReflectionMethod $m, $text) {
                     return str_replace('#### *public* ', '* `', $text) . '`';
                 }
             )->processMethodDocBlock(
                 function (\ReflectionMethod $m, $text) {
-                    return $text ? ' ' . strtok($text, "\n") : '';
+
+                    return $text ? ' ' . trim(strtok($text, "\n"), "\n") : '';
                 }
             )->run();
         }

diff --git a/docs/tasks/ApiGen.md b/docs/tasks/ApiGen.md
@@ -14,14 +14,6 @@ $this->taskApiGen('./apigen.neon')
 ?>
 ```
 
-
-
-
-
-
-
-
-
 * `config($config)` 
 * `source($src)`   * `param array|string|Traversable` $src one or more source values
 * `destination($dest)` 
@@ -54,33 +46,9 @@ $this->taskApiGen('./apigen.neon')
 * `colors($colors)`   * `param boolean|string` $colors 'yes' or true colorize the output, 'no' or false otherwise
 * `updateCheck($check)`   * `param boolean|string` $check 'yes' or true to check for updates, 'no' or false otherwise
 * `debug($debug)`   * `param boolean|string` $debug 'yes' or true to enable debug mode, 'no' or false otherwise
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
 * `arg($arg)`  Pass argument to executable
 * `args($args)`  Pass methods parameters as arguments to executable
 * `option($option, $value = null)`  Pass option to executable. Options are prefixed with `--` , value can be provided in second parameter
-* `getPrinted()` 
 * `dir($dir)`  changes working directory of command
 * `printed($arg)`  Should command output be printed
 
-
-
-
diff --git a/docs/tasks/Assets.md b/docs/tasks/Assets.md
@@ -18,32 +18,7 @@ Please install additional dependencies to use:
 ```
 
 
-
-
-
 * `to($dst)`  Sets destination. Tries to guess type from it.
 * `type($type)`  Sets type with validation.
-
-
-
-
 * `__toString()`  @return string
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/tasks/Base.md b/docs/tasks/Base.md
@@ -19,51 +19,15 @@ if ($this->taskExec('phpunit .')->run()->wasSuccessful()) {
 ?>
 ```
 
-
-
-
-
-
-
-
-
-
-
 * `background()`  Executes command in background mode (asynchronously)
 * `timeout($timeout)`  Stop command if it runs longer then $timeout in seconds
 * `idleTimeout($timeout)`  Stops command if it does not output something for a while
-
-* `stop()` 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-* `getPrinted()` 
-
 * `arg($arg)`  Pass argument to executable
 * `args($args)`  Pass methods parameters as arguments to executable
 * `option($option, $value = null)`  Pass option to executable. Options are prefixed with `--` , value can be provided in second parameter
 * `dir($dir)`  changes working directory of command
 * `printed($arg)`  Should command output be printed
 
-
-
-
 ## ExecStack
 
 
@@ -81,45 +45,13 @@ $this->taskExecStack()
 ?>
 ```
 
-@method ExecStack exec(string)
-@method ExecStack stopOnFail(string)
-
-
-
-
-
-
-
-* `getPrinted()` 
+* `ExecStack exec(string)` 
+* `ExecStack stopOnFail(string)` 
 
 * `exec($command)` 
 * `printed($arg)`  Should command output be printed
 * `dir($dir)`  changes working directory of command
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
 ## ParallelExec
 
 
@@ -136,41 +68,12 @@ $this->taskParallelExec()
 ```
 
 
-@method \Robo\Task\Base\ParallelExec timeout(int $timeout) stops process if it runs longer then `$timeout` (seconds)
-@method \Robo\Task\Base\ParallelExec idleTimeout(int $timeout) stops process if it does not output for time longer then `$timeout` (seconds)
-
+* `\Robo\Task\Base\ParallelExec timeout(int $timeout)`  stops process if it runs longer then `$timeout` (seconds)
+* `\Robo\Task\Base\ParallelExec idleTimeout(int $timeout)`  stops process if it does not output for time longer then `$timeout` (seconds)
 
-
-
-
-* `getPrinted()` 
 * `printed($isPrinted = null)` 
 * `process($command)` 
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
 ## SymfonyCommand
 
 
@@ -191,28 +94,9 @@ $this->taskSymfonyCommand(new ModelGeneratorCommand())
 ?>
 ```
 
-
 * `arg($arg, $value)` 
 * `opt($option, $value = null)` 
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
 ## Watch
 
 
@@ -230,26 +114,6 @@ $this->taskWatch()
 ?>
 ```
 
-
-
 * `monitor($paths, $callable)` 
 
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-