https://github.com/vladocar/autoobjectdocumentation
Auto Object Documentation - JavaScript
https://github.com/vladocar/autoobjectdocumentation
auto-docs auto-documentation documentation javascript javascript-library js object-tracking objects
Last synced: 7 months ago
JSON representation
Auto Object Documentation - JavaScript
- Host: GitHub
- URL: https://github.com/vladocar/autoobjectdocumentation
- Owner: vladocar
- Created: 2011-06-13T02:11:35.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2018-02-05T10:29:33.000Z (almost 8 years ago)
- Last Synced: 2025-06-07T03:35:54.526Z (8 months ago)
- Topics: auto-docs, auto-documentation, documentation, javascript, javascript-library, js, object-tracking, objects
- Language: JavaScript
- Homepage: http://www.vcarrer.com
- Size: 32.2 KB
- Stars: 51
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Object Auto Documentation
-----
Object Auto Documentation simply displays JavaScript Object methods in elegant way.
How to use Object Auto Documentation:
---------------------
Just in the HTML file include the docJS.js style.css and the library you want to document.
Then call the Object that you want to document
example: docJS(SomeObjectName,"optional Object name")
That is all.
The styling is inspired from backbone.js documentation.
Works in: Firefox 4, Safari 5 and Chrome 5
Demos:
---------------------
* [jQuery](demos/autoDocs-jQuery.html)
* [dojo](demos/autoDocs-dojo.html)
* [Ext](autoDocs-Ext.html)
* [fuse](autoDocs-fuse.html)
* [Modernizr2](autoDocs-Modernizr2.html)
* [mootools](autoDocs-mootools.html)
* [prototype.js](autoDocs-prototype.html)
* [swfobject](autoDocs-swfobject.html)
* [webfont Google](autoDocs-webfont.html)
* [YUI](autoDocs-YUI.html)
* [Zepto](demos/autoDocs-Zepto.html)
News:
---------------------
Thanks to [@brandonc](https://github.com/brandonc) for implementing syntax highlighting with google-prettify. [Demo jQuery](demos/autoDocs-jQuery-prettify.html)
Thanks to [@Contra](https://github.com/Contra) now you can display multiple objects. [Demo](http://wearefractal.github.com/nova/docs/index.html)
Basic object(method) profiling is added like number of lines, number of characters, number of arguments. The idea for object profiling is taken from [kratko js](http://perfectionkills.com/refactoring-javascript-with-kratko-js/)
In the demos [autoDocs-NoName.html](demos/autoDocs-NoName.html) is added that can take any external JS library dynamically and also any JavaScript Object can be added.