canmove, Confirmed users
737
edits
Jetpack/SDK/Writing Documentation: Difference between revisions
Jump to navigation
Jump to search
→APIDoc Syntax
| 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. | ||
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 | 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. | ||
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. | ||