Firebug API Reference
by Honza- Published:September 11th, 2009
- Comments:4 Comments
- Category:Documentation, Firebug, Planet Mozilla
In order to create additional source of information for Firebug contributors and extension developers, there is new API Reference documentation generated from Firebug source code.
The source code processing is made by js-doc-toolkit, which is an extensible doc generator for JavaScript, supporting its very specifics.
Comments are based on JavaDoc like syntax and using tags like e.g. @param (check out complete list of default tags). Firebug also defines its own specific tags like: @module, @panel, @domplate that help to match its specific architecture features.
Here is a simple example of a commented source code:
* @module This object represents a module
* that is responsible for...
*/
Firebug.MyModule = extend(Firebug.Module,
/** @lends Firebug.MyModule */
{
/**
* Called by Firebug when Firefox is closed.
*/
shutdown: function()
{
Firebug.Module.initialize.apply(this, arguments);
}
});
See further info and examples here.
Note that the goal of this documentation is having complementary source of information for coders that provides conveniently browsable environment giving an overview of Firebug's source code. Such a reference should live along side to the all tutorials and guides we have and which I hope will be yet written.
This is a fresh new doc so, there is not immense number of comments so far, but this will change over time. After all, source code documentation is a fundamental engineering practice critical to efficient development process.
4 Comments
The link to the list of default tags should be without the extra space before -toolkit:
http://code.google.com/p/jsdoc-toolkit/wiki/TagReference
@Ivo: Fixed, thanks!
Is there any documentation on the console API and how to override or extend it.
@Sean: I don't know about any useful docs so, looks like a good tip for IX. part of my Extending Firebug tutorial 🙂