Super-tiny, not pretending to be complete static html documentation generator. As a result you will get something like this
npm install makedoc -g
makedoc path/to/your/code.js path/to/another/file.js
will create ./doc/code.html and ./doc/file.html
makedoc lib/*.js
will process whole lib directory.
Other options:
-t title # specify title for docs
-g githubname/reponame # specify github repo
-d lib # download files from lib folder of github hosted project
-o ./docs # specify output dir (by defaulf ./doc)
more features coming soon.
makedoc looking for /** started comment, then wait for */ and check next line, if it ends with {, grab all following lines unless \n}. That's it.
This input information allows us to get split methods to three kinds:
- class methods (
SomeClass.someMethod = function someMethod() {) - instance methods (
SomeClass.prototype.someMethod = function someMethod() {) - helper methods (
function someMethod() {)
Copyright (C) 2011 by Anatoliy Chakkaev
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.