Dojo API Documentation Tools¶
| Project owner: | Neil Roberts |
|---|---|
| since: | V1.3 |
Contents
Deprecated, see https://github.com/wkeese/api-viewer/blob/master/README.rst for latest instructions.
Dojo uses a specially crafted, highly readable inline documentation format and distributes the PHP-based code parser used to collect the information.
Introduction¶
The Dojo JavaScript codebase makes use of a consistent commenting style to facilitate generated API documentation, which gives developers an outline of what methods are defined and how to use them. This is analogous to Javadoc and similar conventions used in most programming languages today. The parser collects the information from the JavaScript files and produces output in json or XML format. This can be further transformed for use by editors and IDEs for example, or fed into a viewer application for a handy browsable interface to the API. These pages describe the parts of the system and how to use them to generate your own documentation of both Dojo and custom code.
- API doc syntax - how to markup API documentation in your code
- Running the generation tools - directories setup, defining custom namespaces, configuring and running the generation tools
- Viewing the API output data - how to setup and load the extracted API data into a web-based viewer