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 20:48, 18 August 2010
, 18 August 2010→On APIDoc Syntax
| Line 17: | Line 17: | ||
=== On APIDoc Syntax === | === On APIDoc Syntax === | ||
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. | 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 to provide a way to give a framework for documenting the API in a human-readable format. Please see an overview of JavaDoc format on [http://en.wikipedia.org/wiki/Javadoc wikipedia here]. | ||
An example of this syntax in action can be found below. | |||
== A Short, Well Documented Example == | == A Short, Well Documented Example == | ||