Prev: Module debug: Runtime Debugging

Generating Documentation

Generating documentation from m source is a simple way of producing reference documentation, in particular for APIs. If a source is commented properly and marked up where necessary, helpful HTML documentation can be generated automatically.

• The module mdoc scans list of m sources (and the sources imported by them) and generates HTML documentation from them. The generated documentation is configurable by class properties, and of course by subclassing and overriding the HTML generating methods.
• A sample application mDocumenter adds a user interface on top of module mdoc to select source files and generate documentation. All the documentations of m modules in the mdoc index have been generated using this tool.

  Sample m screen

• Item Descriptions
• Module mdoc: Documentation Generator

---

Next: Item Descriptions

Navigation