canmove, Confirmed users
737
edits
Jetpack/SDK/Writing Documentation: Difference between revisions
Jump to navigation
Jump to search
→APIDoc Syntax
No edit summary |
|||
| Line 14: | Line 14: | ||
"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 | 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 widely-used syntax such as [http://code.google.com/p/jsdoc-toolkit/ JSDoc] in the future. | ||
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>. | ||