canmove, Confirmed users
737
edits
Jetpack/SDK/Writing Documentation: Difference between revisions
Jump to navigation
Jump to search
Jetpack/SDK/Writing Documentation (view source)
Revision as of 20:12, 5 December 2013
, 5 December 2013→Documenting API elements
| Line 70: | Line 70: | ||
* Overview text | * Overview text | ||
** [H5]Parameters | ** [H5]Parameters | ||
** | ** [STRONG]parameterName : parameterType | ||
** Parameter description | |||
**[TABLE]mandatory options | |||
**[TABLE]optional options | |||
First there's the title, which is an H4 with the special class "addon-sdk-api-name", styled as code. The name includes brackets and parameters, like PageMod(options). | First there's the title, which is an H4 with the special class "addon-sdk-api-name", styled as code. The name includes brackets and parameters, like PageMod(options). | ||
| Line 91: | Line 91: | ||
Functions are documented like this: | Functions are documented like this: | ||
* [H4 class="addon-sdk-api-name"][CODE] Name(parameters) | *[H4 class="addon-sdk-api-name"][CODE] Name(parameters) | ||
* Overview text | *Overview text | ||
* [H5]Parameters | * [H5]Parameters | ||
* [STRONG]parameterName : parameterType | * [STRONG]parameterName : parameterType | ||