canmove, Confirmed users
737
edits
Jetpack/SDK/Writing Documentation: Difference between revisions
→APIDoc Syntax
No edit summary |
|||
| Line 13: | Line 13: | ||
"APIDoc" is a simple markup syntax we've defined for documenting the component parts of an API. | "APIDoc" is a simple markup syntax we've defined for documenting the component parts of an API. | ||
The main benefit of using a defined syntax is that we can ensure that all APIs are consistently documented. Having said that, we'd like to move to a more standard syntax in the future. | The main benefit of using a defined syntax is that we can ensure that all APIs are consistently documented. Having said that, we'd like to move to a more standard syntax in the future. | ||
| Line 20: | Line 18: | ||
A good way to understand the syntax is to look at the existing module documentation, which can be found in your SDK installation, under <code>packages/addon-kit/docs/</code>. | A good way to understand the syntax is to look at the existing module documentation, which can be found in your SDK installation, under <code>packages/addon-kit/docs/</code>. | ||
In APIDoc each component of an API - functions, constructors, properties, and so on - is enclosed in a pair of <code><api></api></code> tags. These are recognized by the documentation system, which parses them into a JSON structure and then renders them to HTML. | |||
APIDoc defines the following component types: | APIDoc defines the following component types: | ||