updated docs

cboyden · Feb 13, 2014 · 9c792e0 · 9c792e0
1 parent 7e7e4be
commit 9c792e0
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 10 deletions.
diff --git a/docs/tasks.md b/docs/tasks.md
@@ -88,6 +88,31 @@ $this->taskChangelog()
 * change(Parameter #0 [ <required> $change ])
 * getChanges()
 
+### GenMarkdownDocTask
+
+Simple documentation generator from source files.
+Takes docblocks from classes and methods and generates markdown file.
+
+``` php
+$this->taskGenDoc('models.md')
+     ->docClass('Model\User')
+     ->docClass('Model\Post')
+     ->filterMethods(function(\ReflectionMethod $r) {
+         return $r->isPublic(); // process only public methods
+     })->processClass(function(\ReflectionClass $r, $text) {
+         return "Class ".$r->getName()."\n\n$text\n\n###Methods\n";
+     })->run();
+```
+
+* docClass(string $classname)
+* filterMethods(\Closure $func)
+* filterClasses(\Closure $func)
+* processMethod(\Closure $func)
+* processClass(\Closure $func)
+* reorder(\Closure $func)
+* prepend(string $text)
+* append(string $text)
+
 ## Exec
 
 ``` use Robo\Task\Exec;```

diff --git a/src/Task/Development.php b/src/Task/Development.php
@@ -17,7 +17,7 @@ protected function taskChangelog($filename = 'CHANGELOG.md')
 
     protected function taskGenDoc($filename)
     {
-        return new GenMarkdownDoc($filename);
+        return new GenMarkdownDocTask($filename);
     }
 
 }
@@ -139,16 +139,16 @@ public function run()
  *      })->run();
  * ```
  *
- * @method GenMarkdownDoc docClass(string $classname)
- * @method GenMarkdownDoc filterMethods(\Closure $func)
- * @method GenMarkdownDoc filterClasses(\Closure $func)
- * @method GenMarkdownDoc processMethod(\Closure $func)
- * @method GenMarkdownDoc processClass(\Closure $func)
- * @method GenMarkdownDoc reorder(\Closure $func)
- * @method GenMarkdownDoc prepend(string $text)
- * @method GenMarkdownDoc append(string $text)
+ * @method GenMarkdownDocTask docClass(string $classname)
+ * @method GenMarkdownDocTask filterMethods(\Closure $func)
+ * @method GenMarkdownDocTask filterClasses(\Closure $func)
+ * @method GenMarkdownDocTask processMethod(\Closure $func)
+ * @method GenMarkdownDocTask processClass(\Closure $func)
+ * @method GenMarkdownDocTask reorder(\Closure $func)
+ * @method GenMarkdownDocTask prepend(string $text)
+ * @method GenMarkdownDocTask append(string $text)
  */
-class GenMarkdownDoc implements TaskInterface
+class GenMarkdownDocTask implements TaskInterface
 {
     use DynamicConfig;
     use Output;