APIDOC Namespace Reference

Overview

Summary

The APIDOC namespace provides a way of describing an API in XML.

Description

APIDOC is an XML based API documentation system which allows the document writer to create document content using a set of logical tags in an XML file.  A perl script, parse_apidoc.pl, processes the source XML, and generates a collection of HTML files suitable for web publishing.

The set of tags available in APIDOC is very small compared to HTML, and can be broken down into three groups.  These are Organizational, Formatting, and Other.  Organizational tags are logical sections of an API document, such as an ENTRY, a DESCRIPTION or an EXAMPLE.  Formatting tags provide a set of basic format control tags, such as B and I, as well as intelligent tags like C and S which automatically create links to other ENTRYs or external documents. The group of tags classified as Other don't fit into either of the other two categories, but don't warrant a group of their own.

See the README for instructions on how to run APIDOC.  

Notes

Tags and attributes are case sensitive.  In APIDOC, all tag names are in UPPERCASE, and all attribute names are lowercase.

The document you are reading was created with APIDOC, see http://www.mozilla.org/projects/apidoc/apidoc.xml for the source.

APIDOC was originally written to allow engineers in the JavaScript group at Netscape to maintain their own documentation on the JavaScript Embedding API.  That document is available from the JavaScript Page on mozilla.org

See Also

Groups [ Formatting | Organizational | Other ]
Documents [ README | apidoc.xml | parse_apidoc.pl | mozilla.org | JavaScript Page | APIDOC ]
Entries [ B | C | DESCRIPTION | ENTRY | EXAMPLE | I | S ]

This page was generated by APIDOC