1.0.0

Author: achun

README.md

@@ -1,10 +1,8 @@
 # apiez
 
-Easily generate API documentation for javascript from runtime instead of source.
+Easily generate API documentation at runtime, rather than from the source code.
 
-Contract:
-
-	The document is a continuous comment at the top of the function body
+Results details to see [test](./test.js) and [test-class](./test-class.js)
 
 ## Install
 
@@ -15,65 +13,50 @@ $ npm install apiez
 ## Useage
 
 ```js
-var apidoc = require('apiez');
+var apiez = require('apiez');
 
-apidoc(require('buffer'))
+apiez(apiez)
 ```
 
 cli
 
 ```shell
-$ apiez buffer
+$ apiez apiez
 ```
 
-## Example
-
-```js
-var apiez = require('apiez'),
-	assert = require('assert');
-
-function A() {
-	/*A*/
-}
-
-A.prototype.a = function(a /**/ ) {
-	/*
-	 a
-
-	  b
-	*/
-
-	// After the blank line is not a document
-}
+output
 
-A.prototype.b = function a(a /**/ ) {
-	//
-	// a
-	//
-	//  b
-	//
-
-	// After the blank line is not a document
-}
-
-function test(x, s) {
-	assert.equal(apiez(x, JSON.stringify), s)
-}
-
-test(function a(/*ignore*/ a , /*c,*/ /*ignore*/ b /*,c
-	c*/ , /*ignore*/ c /*c*/ ) {
-
-}, '{"a":{"args":[["a","c,"],["b",",c","c"],["c","c"]]}}')
-
-test(A, '{"A":{"methods":{' +
-	'"a":{"args":["a"],"doc":["a",""," b"]},' +
-	'"b":{"args":["a"],"doc":["a",""," b"]}' +
-	'}}}')
-
-test({ B: A }, '{"B":{"methods":{' +
-	'"a":{"args":["a"],"doc":["a",""," b"]},' +
-	'"b":{"args":["a"],"doc":["a",""," b"]}' +
-	'}}}')
+```
+apiez
+    params
+        funcInside
+            a function or object
+        results
+            default Object.create(null)
+            object as
+
+            {
+            	name:{
+            		params:[["paramN","doc"...]...],
+            		notes:["doc"...]
+            	}
+            }
+    notes
+        Generate API documentation object for funcInside.
+
+        Contract:
+
+            The summary is a continuous comment at the top of the function body
+            Anonymous functions named ""
+
+        Feature:
+
+            Parameter Comment
+            Prototype methods
+            Extends class
+            Constructor, if it is first method
+            Remove head and tail empty lines
+            Remove the same indent white-spaces
 ```
 
 # License

cli.js

@@ -1,7 +1,8 @@
 #!/usr/bin/env node
 
-var docez = require('./index'),
+var apiez = require('./index'),
 	args = process.argv.slice(2),
+	api,
 	x,
 	f;
 
@@ -14,12 +15,56 @@ try {
 	x = require(args[0])
 	if (args.length > 1)
 		f = require(args[1])
-
+	f = typeof f == 'function' && f || null
 } catch (e) {
 	console.error(e.message)
 	process.exit(1)
 }
 
-console.log(docez(x, f || true))
+api = apiez(x)
+
+if (f) {
+	console.log(f(api))
+} else
+	echo(api)
+
+function echo(api) {
+	Object.keys(api).forEach(function(name) {
+		console.log(format('', name, api[name]).join('\n'))
+	}, api)
+}
+
+function format(prefix, name, x, lines) {
+	lines = lines || []
+	lines.push(prefix + name);
+	if (x.extends) lines.push(
+			prefix + '    extends ' + x.extends)
+	if (x.params) {
+		lines.push(prefix + '    params');
+		x.params.forEach(function(a) {
+			lines.push(prefix + '        ' + a[0])
+			a.forEach(function(c, i) {
+				if (!i) return
+				lines.push(prefix + '            ' + c)
+			})
+		})
+	}
+
+	if (x.notes) {
+		lines.push(prefix + '    notes');
+		x.notes.forEach(function(c) {
+			lines.push(prefix + '        ' + c)
+		})
+	}
+
+	if (x.methods) {
+		lines.push(prefix + '    methods');
+		Object.keys(x.methods).forEach(function(name) {
+			format(prefix + '        ', name, x.methods[name], lines)
+		})
+	} else
+		lines.push('\n')
+	return lines
+}
 
 process.exit(0)