updated documents

tjchaplin · Apr 12, 2014 · c310f73 · c310f73
1 parent 1d6b370
commit c310f73
Show file tree

Hide file tree

Showing 4 changed files with 108 additions and 79 deletions.
diff --git a/doc/README.md b/doc/README.md
@@ -26,12 +26,10 @@ Template that groups by the file passed into mox.  Example here:
 var mox = require("../lib/mox");
 
 var source1 = "./source1.js";
-var source2 = "./source2.js";
 
-var options = {
-	outputFile :"./someOutputfile.md", //->output markdown file
-	template:"category" //->specfies to use the category based template.  Table of contents will be based on **@categoy** tag
-};
+//->specfies to use the category based template.  Table of contents will be based on **@categoy** tag
+mox.run(source1,{template:"category"})
+	.pipe(process.stdout);
 ```
 
 ##Code being documented in example templates:

diff --git a/doc/category/README.md b/doc/category/README.md
@@ -1,110 +1,120 @@
 ## `SomeClassCategory`
-
 * [`SomeClass`][0]
 * [`aProperty`][1]
 * [`aPropertyWithType`][2]
 * [`someClassMethod`][3]
 
 ## `SomeClassCategory2`
-
 * [`SomeClass2`][4]
 * [`someClassMethod2`][5]
 
 ## `SomeClassCategory`
 
 ### `SomeClass`
 
-[\#][0] [Ⓣ][6]
+[\#][0] | [Ⓣ][6]
+
+
 
 Example:
 
     SomeClass.someClassMethod(x);
-
 
 #### Arguments
-
-1. `param` _(String)_ - a parameter
+1. `param` (*String*) - a parameter
 
 ---
 
+
+
 ### `aProperty`
 
-[\#][1] [Ⓣ][6]
+[\#][1] | [Ⓣ][6]
+
+
 
 Some property description
 
 ---
 
+
+
 ### `aPropertyWithType`
 
-[\#][2] [Ⓣ][6]
+[\#][2] | [Ⓣ][6]
 
 #### Types
 
-  * _String_
+
+
 
 Some property with type description
 
 ---
 
+
+
 ### `someClassMethod`
 
-[\#][3] [Ⓣ][6]
+[\#][3] | [Ⓣ][6]
+
+
 
 Example:
 
     SomeClass.someClassMethod(x);
-
 
 #### Arguments
-
-1. `methodParam` _(Function | String)_ - some method param
+1. `methodParam` (*Function | String*) - some method param
 
 #### Returns  
 
-_(Function | String)_ - A return value
+*(Function | String)* - A return value
 
 ---
 
+
+
 ## `SomeClassCategory2`
 
 ### `SomeClass2`
 
-[\#][4] [Ⓣ][7]
+[\#][4] | [Ⓣ][7]
+
+
 
 Example:
 
     SomeClass2.someClassMethod(x);
-
 
 #### Arguments
-
-1. `param` _(String)_ - a parameter
+1. `param` (*String*) - a parameter
 
 ---
 
+
+
 ### `someClassMethod2`
 
-[\#][5] [Ⓣ][7]
+[\#][5] | [Ⓣ][7]
+
+
 
 Example:
 
     SomeClass2.someClassMethod(x);
-
 
 #### Arguments
-
-1. `methodParam` _(Function)_ - some method param
-2. `methodParam2` _(Function)_ - some method param
+1. `methodParam` (*Function*) - some method param
+2. `methodParam2` (*Function*) - some method param
 
 #### Returns  
 
-_(String)_ - A return value
+*(String)* - A return value
 
 ---
 
 
-
 [0]: #someclass
 [1]: #aproperty
 [2]: #apropertywithtype

diff --git a/doc/default/README.md b/doc/default/README.md
@@ -1,111 +1,121 @@
 # PackageName - v0.0.1
 
 ## `Methods`
-
 * [`SomeClass`][0]
 * [`someClassMethod`][1]
 * [`SomeClass2`][2]
 * [`someClassMethod2`][3]
 
 ## `Declarations`
-
 * [`aProperty`][4]
 
 ## `Methods`
 
 ### `SomeClass`
 
-[\#][0] [Ⓣ][5]
+[\#][0] | [Ⓣ][5]
+
+
 
 Example:
 
     SomeClass.someClassMethod(x);
-
 
 #### Arguments
-
-1. `param` _(String)_ - a parameter
+1. `param` (*String*) - a parameter
 
 ---
 
+
+
 ### `someClassMethod`
 
-[\#][1] [Ⓣ][5]
+[\#][1] | [Ⓣ][5]
+
+
 
 Example:
 
     SomeClass.someClassMethod(x);
-
 
 #### Arguments
-
-1. `methodParam` _(Function | String)_ - some method param
+1. `methodParam` (*Function | String*) - some method param
 
 #### Returns  
 
-_(Function | String)_ - A return value
+(*Function | String*) - A return value
 
 ---
 
+
+
 ### `SomeClass2`
 
-[\#][2] [Ⓣ][5]
+[\#][2] | [Ⓣ][5]
+
+
 
 Example:
 
     SomeClass2.someClassMethod(x);
-
 
 #### Arguments
-
-1. `param` _(String)_ - a parameter
+1. `param` (*String*) - a parameter
 
 ---
 
+
+
 ### `someClassMethod2`
 
-[\#][3] [Ⓣ][5]
+[\#][3] | [Ⓣ][5]
+
+
 
 Example:
 
     SomeClass2.someClassMethod(x);
-
 
 #### Arguments
-
-1. `methodParam` _(Function)_ - some method param
-2. `methodParam2` _(Function)_ - some method param
+1. `methodParam` (*Function*) - some method param
+2. `methodParam2` (*Function*) - some method param
 
 #### Returns  
 
-_(String)_ - A return value
+(*String*) - A return value
 
 ---
 
+
+
 ## `Declarations`
 
 ### aProperty
 
-[\#][4] [Ⓣ][6]
+[\#][4] | [Ⓣ][6]
+
+
 
 Some property description
 
 ---
 
+
+
 ### aPropertyWithType
 
-[\#][7] [Ⓣ][6]
+[\#][7] | [Ⓣ][6]
+
+
 
 #### Types
 
-  * _String_
 
 Some property with type description
 
 ---
 
 
-
 [0]: #someclass
 [1]: #someclassmethod
 [2]: #someclass2