libsablot/utils/apidoc/README

   1 DESCRIPTION:
   2 APIDOC tool source.
   3 Generates HTML API documentation from an xml source.
   4
   5 --
   6
   7 FILES:
   8
   9
  10 ===* parse_apidoc.pl
  11
  12 Syntax:
  13   perl parse_apidoc.pl jsref.xml [<output-directory>]
  14
  15 Requires:
  16   XML::Parser (http://search.cpan.org/search?dist=XML-Parser)
  17
  18 Description:
  19   Parses apidoc xml files, producing html output for viewing in normal browsers.
  20   Output will be placed in the specified directory, or ./apidocs if none is
  21   specified.  Output pages with content will refer to api-content.css, table
  22   of content pages will refer to api-toc.css.
  23
  24 See Also:
  25   http://www.mozilla.org/projects/apidoc
  26
  27 ===* parse_devedge_doc.pl
  28
  29 Syntax:
  30   perl parse_devedge_doc.pl < jsref.htm > jsref.xml
  31
  32 Requires:
  33   nothing.
  34
  35 Description:
  36   Parses the nasty devedge document (jsref.htm) into somewhat nicer xml.
  37   The XML source, jsref.xml, located at
  38   http://www.mozilla.org/js/apidoc/jsapi.xml is now the authoritative place to
  39   make changes.
  40   This file should be considered dead.  Do not use it.  It is here for emergency
  41   use only.
  42   REPEAT: DO NOT USE THIS SCRIPT!
  43
  44