https://github.com/fflorent/fbug-jsdoc
https://github.com/fflorent/fbug-jsdoc
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/fflorent/fbug-jsdoc
- Owner: fflorent
- Created: 2013-01-05T21:47:40.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2013-01-05T22:21:23.000Z (over 13 years ago)
- Last Synced: 2025-01-15T10:02:28.996Z (over 1 year ago)
- Language: JavaScript
- Size: 3.33 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.txt
Awesome Lists containing this project
README
Firebug API Reference
Jan Odvarko
---------------------------------------------------------------------------------------------------
Support for generating API Reference documentation from Firebug source files.
- Result docs (set of HTML Files) is generated using jsdoc-toolkit:
http://code.google.com/p/jsdoc-toolkit/
- Integration with ANT is done using jsdoc-toolkit-ant-task:
http://code.google.com/p/jsdoc-toolkit-ant-task/
---------------------------------------------------------------------------------------------------
Instructions:
- Use build.xml to generate API documentation from Firebug source files.
- Run "ant jsdoc" on the command line (within $svn/branches/firebug1.5/ directory)
- See output HTML files within $svn/jsdoc/out
- You can also use simple-build.xml and run: $ant -f simple-build.xml jsdoc
In this case the output will be saved into ./release/jsdoc
Development:
- Firebug uses its own template for generating result HTML
See: ./jsdoc-toolkit-2.3.0/templates/firebug
directory
- Firebug uses its own plugin for customizing the generation process.
See: ./jsdoc-toolkit-2.3.0/app/plugins/firebug.js