Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-11-26 22:32:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

initial add of js api documentation source

Browse Source
This commit is contained in:
rginda%netscape.com 2002-05-14 01:39:03 +00:00
parent ddd3d5d711
commit 28d3a51f59
8 changed files with 8092 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
js/docs/Makefile Normal file
View File

@ -0,0 +1,15 @@
# directory to store APIDOC results. This directory WILL BE DELETED before
# calling APIDOC!
OUTDIR = gen/
CSSFILES = api-content.css \
api-toc.css
CLEAN_LS = ls --color=never
apidocs::
rm -rf $(OUTDIR)
mkdir $(OUTDIR)
perl parse_apidoc.pl jsref.xml $(OUTDIR)
cp $(CSSFILES) $(OUTDIR)
cd $(OUTDIR); $(CLEAN_LS) *.html > NOWRAP

20
js/docs/README Normal file
View File

@ -0,0 +1,20 @@
This directory contains the source XML file for the API documentation. On UNIX-
like systems, type "make" in this directory to generate HTML documentation.
Users of non-UNIX systems will have to run parse_apidoc.pl by hand, or submit a
patch to fix the Makefile. See the Makefile for details.
Once the HTML files are generated, visit the <sparse-frameset.html> or
<complete-frameset.html> files in this directory for one-entry-at-a-time and
all-in-one framesets.
APIDOC output can also be browsed in two seperate windows. Open
<gen/sparse-toc.html> in one window. Click on any API entrypoint to open a new
window. The new window will be re-used when you choose a different entrypoint.
This documentation is available online at
<http://www.mozilla.org/js/spidermonkey/>.
The version of parse_apidoc.pl included here was copied from
<http://lxr.mozilla.org/mozilla/source/webtools/apidoc/parse_apidoc.pl> on
05/13/2002. See <http://www.mozilla.org/projects/apidoc/> for details on
APIDOC.

55
js/docs/api-content.css Normal file
View File

@ -0,0 +1,55 @@
body {
background: #F9F1D1;
}
.api-entry {
background: white;
}
.entry-heading {
background: lightgrey;
}
.entry-title {
font-weight: bold;
}
.entry-type {
background: black;
color: white;
font-weight: bold;
}
.entry-deprecated {
font-weight: bold;
background: red;
color: white;
}
.entry-summary {
}
.entry-syntax {
background: #EEEEEE;
}
.param-list-head {
background: lightgrey;
}
.param-row-even {
background: white;
}
.entry-description {
}
.entry-example {
}
.entry-notes {
}
.entry-seealso {
background: #EEEEEE;
}

30
js/docs/api-toc.css Normal file
View File

@ -0,0 +1,30 @@
body {
background: #F9F1D1;
}
a {
/* text-decoration: none;*/
}
.toc-title {
background: lightgrey;
}
.toc-abc,
.toc-group-even {
background: white;
}
.toc-group-odd {
background: #EEEEEE;
}
.toc-entry-deprecated {
font-weight: bold;
}
.toc-ind-deprecated {
font-weight: bold;
background: red;
color: white;
}

12
js/docs/complete-frameset.html Normal file
View File

@ -0,0 +1,12 @@
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
<head>
<title>
JavaScript-C API Reference
</title>
</head>
<frameset name='doc-frameset' cols='25%,*'>
<frame name='toc-container' src='gen/complete-toc.html'>
<frame name='content-container' src='gen/complete.html'>
</frameset>
</html>

6911
js/docs/jsref.xml Normal file
View File

File diff suppressed because it is too large Load Diff

1037
js/docs/parse_apidoc.pl Normal file
View File

File diff suppressed because it is too large Load Diff

12
js/docs/sparse-frameset.html Normal file
View File

@ -0,0 +1,12 @@
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
<head>
<title>
JavaScript-C API Reference
</title>
</head>
<frameset name='doc-frameset' cols='30%,*'>
<frame name='toc-container' src='gen/sparse-toc.html'>
<frame name='content-container' src='gen/api-BOOLEAN_TO_JSVAL.html'>
</frameset>
</html>