Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-11-04 16:15:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
c3ac3cd2d4
gecko-dev/webtools/apidoc
History
rginda%netscape.com afde87d5e3 Modify parse_devedge_doc.pl so it didn't lose the description after the first note (this was bad.) 
Madify parse_apidoc.pl to warn (not croak) on empty tags, and to be able to deal with duplicate tags.
2000-03-04 05:07:20 +00:00
..
tests Initial add of APIDOC api documentation script. a=leaf 2000-03-01 01:14:20 +00:00
api-content.css Initial add of APIDOC api documentation script. a=leaf 2000-03-01 01:14:20 +00:00
api-toc.css Initial add of APIDOC api documentation script. a=leaf 2000-03-01 01:14:20 +00:00
complete-frameset.html Initial add of APIDOC api documentation script. a=leaf 2000-03-01 01:14:20 +00:00
parse_apidoc.pl Modify parse_devedge_doc.pl so it didn't lose the description after the first note (this was bad.) 2000-03-04 05:07:20 +00:00
parse_devedge_doc.pl Modify parse_devedge_doc.pl so it didn't lose the description after the first note (this was bad.) 2000-03-04 05:07:20 +00:00
README updated readme, add comments to parse_apidoc.pl, make parse_devedge_doc.pl exit on startup, remove zpidoc.xml (it's in mozilla.org/projects/apidoc) 2000-03-03 19:59:54 +00:00
sparse-frameset.html Initial add of APIDOC api documentation script. a=leaf 2000-03-01 01:14:20 +00:00

README 

DESCRIPTION:
APIDOC tool source.
Generates HTML API documentation from an xml source.

--

FILES:


===* parse_apidoc.pl

Syntax:
  perl parse_apidoc.pl jsref.xml [<output-directory>]

Requires:
  XML::Parser (http://search.cpan.org/search?dist=XML-Parser)

Description:
  Parses apidoc xml files, producing html output for viewing in normal browsers.
  Output will be placed in the specified directory, or ./apidocs if none is
  specified.  Output pages with content will refer to api-content.css, table
  of content pages will refer to api-toc.css.

See Also:
  http://www.mozilla.org/projects/apidoc

===* parse_devedge_doc.pl

Syntax:
  perl parse_devedge_doc.pl < jsref.htm > jsref.xml

Requires: 
  nothing.

Description: 
  Parses the nasty devedge document (jsref.htm) into somewhat nicer xml.
  The XML source, jsref.xml, located at
  http://www.mozilla.org/js/apidoc/jsapi.xml is now the authoritative place to
  make changes.
  This file should be considered dead.  Do not use it.  It is here for emergency
  use only.
  REPEAT: DO NOT USE THIS SCRIPT!