canmove, Confirmed users
737
edits
Jetpack/SDK/Writing Documentation: Difference between revisions
Jump to navigation
Jump to search
→APIDoc Syntax
| Line 12: | Line 12: | ||
== APIDoc Syntax == | == APIDoc Syntax == | ||
"APIDoc" is a simple markup syntax we've defined for documenting the | "APIDoc" is a simple markup syntax we've defined for documenting the elements 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 widely-used syntax such as [http://code.google.com/p/jsdoc-toolkit/ JSDoc] 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 widely-used syntax such as [http://code.google.com/p/jsdoc-toolkit/ JSDoc] in the future. | ||