17
edits
Jetpack/SDK/Writing Documentation: Difference between revisions
Jump to navigation
Jump to search
m
Jetpack/SDK/Writing Documentation (view source)
Revision as of 19:29, 18 August 2010
, 18 August 2010→Writing Documentation with the Add-ons Builder SDK
| Line 2: | Line 2: | ||
== Writing Documentation with the Add-ons Builder SDK == | == Writing Documentation with the Add-ons Builder SDK == | ||
Documentation in the Jetpack SDK is a self-contained system within the SDK itself. All of the documentation is generated on the fly, via actual files located in the directory structure and viewable either as source or as a web page after the SDK has been activated and the "cfx docs" command has been run from the command line. | |||
The "cfx docs" command launches a small web server in order to render the documentation for human consumption. It relies on three things: | |||
* That the documentation is written in Markdown syntax | |||
* That the API component is written in APIDocs syntax | |||
* That there are corresponding .js/.md files in the lib/docs directories | |||
=== Markdown === | All documentation for Jetpack(s) can be written following those three principles. | ||
=== On Markdown === | |||
The format for the human-readable documentation for the Jetpack SDK is Markdown. More information about Markdown can be found [http://daringfireball.net/projects/markdown/ here]. | The format for the human-readable documentation for the Jetpack SDK is Markdown. More information about Markdown can be found [http://daringfireball.net/projects/markdown/ here]. | ||
=== APIDocs === | |||
=== On APIDocs === | |||
This has roots in the JavaDoc format for documenting APIs within the structure of the Java code itself. The idea was to make it functionally similar to document APIs within the code as well as provide a way to give a framework for documenting the API in a human-readable format. An overview of JavaDoc format on [http://en.wikipedia.org/wiki/Javadoc wikipedia]. | This has roots in the JavaDoc format for documenting APIs within the structure of the Java code itself. The idea was to make it functionally similar to document APIs within the code as well as provide a way to give a framework for documenting the API in a human-readable format. An overview of JavaDoc format on [http://en.wikipedia.org/wiki/Javadoc wikipedia]. | ||
More details on this syntax can be found in the example below. | |||
== A Short, Well Documented Example == | == A Short, Well Documented Example == | ||