You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xerces.apache.org by an...@apache.org on 2001/08/02 07:37:33 UTC
cvs commit: xml-xerces/java/docs api.xml
andyc 01/08/01 22:37:33
Modified: java Tag: xerces_j_2 build.xml
java/docs Tag: xerces_j_2 api.xml
Log:
Added API JavaDoc into the documentation. Instead of just having
a single section that's either under-documented or over-documented,
I separated the javadocs into 4 categories:
* Standard APIs (JAXP, DOM, SAX)
* Xerces Native Interface (Core and Parser Configuration)
* Xerces2 Implementation
* Other Classes
Also updated the build.xml file to build these four sets of
javadocs separately.
Revision Changes Path
No revision
No revision
1.14.2.13 +40 -2 xml-xerces/java/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/xml-xerces/java/build.xml,v
retrieving revision 1.14.2.12
retrieving revision 1.14.2.13
diff -u -r1.14.2.12 -r1.14.2.13
--- build.xml 2001/07/19 06:43:10 1.14.2.12
+++ build.xml 2001/08/02 05:37:33 1.14.2.13
@@ -51,7 +51,7 @@
Copyright:
Copyright (c) 2000 The Apache Software Foundation.
- $Id: build.xml,v 1.14.2.12 2001/07/19 06:43:10 andyc Exp $
+ $Id: build.xml,v 1.14.2.13 2001/08/02 05:37:33 andyc Exp $
==================================================================== -->
@@ -193,7 +193,7 @@
</copy>
<javac srcdir="${build.src}"
- excludes="**/RevalidatingDOMParser.java "
+ excludes="**/RevalidatingDOMParser.java **/v1/** **/v2/**"
destdir="${build.dest}"
debug="${debug}"
deprecation="${deprecation}"
@@ -271,6 +271,7 @@
<!-- Creates the API documentation -->
<!-- =================================================================== -->
<target name="javadocs" depends="prepare-src">
+ <!--
<mkdir dir="${build.javadocs}"/>
<javadoc packagenames="${packages}"
sourcepath="${build.src}"
@@ -281,6 +282,43 @@
windowtitle="${Name} API"
doctitle="${Name}"
bottom="${copyright}" />
+ -->
+ <mkdir dir='${build.dir}/docs/api'/>
+ <javadoc packagenames='javax.xml.parsers,org.w3c.*,org.xml.*'
+ sourcepath='${build.src}' destdir='${build.dir}/docs/api'
+ author='true' version='true'
+ windowtitle='XML Standard API' doctitle='XML Standard API'
+ bottom='${copyright}'
+ locale='en_US'/>
+ <mkdir dir='${build.dir}/docs/xni'/>
+ <javadoc packagenames='org.apache.xerces.xni.*'
+ sourcepath='${build.src}' destdir='${build.dir}/docs/xni'
+ author='true' version='true'
+ windowtitle='Xerces Native Interface'
+ doctitle='Xerces Native Interface'
+ bottom='${copyright}'
+ locale='en_US'/>
+ <mkdir dir='${build.dir}/docs/xerces2'/>
+ <javadoc packagenames='org.apache.xerces.dom.*,
+ org.apache.xerces.impl.*,
+ org.apache.xerces.jaxp,
+ org.apache.xerces.parsers,
+ org.apache.xerces.util'
+ sourcepath='${build.src}' destdir='${build.dir}/docs/xerces2'
+ author='true' version='true'
+ windowtitle='Xerces2 Implementation'
+ doctitle='Xerces2 Implementation'
+ bottom='${copyright}'
+ locale='en_US'/>
+ <mkdir dir='${build.dir}/docs/other'/>
+ <javadoc packagenames='org.apache.html.*,
+ org.apache.wml.*,
+ org.apache.xml.serialize.*'
+ sourcepath='${build.src}' destdir='${build.dir}/docs/other'
+ author='true' version='true'
+ windowtitle='Other Classes' doctitle='Other Classes'
+ bottom='${copyright}'
+ locale='en_US'/>
</target>
<!-- =================================================================== -->
No revision
No revision
1.5.2.2 +93 -2 xml-xerces/java/docs/api.xml
Index: api.xml
===================================================================
RCS file: /home/cvs/xml-xerces/java/docs/api.xml,v
retrieving revision 1.5.2.1
retrieving revision 1.5.2.2
diff -u -r1.5.2.1 -r1.5.2.2
--- api.xml 2001/07/19 06:43:10 1.5.2.1
+++ api.xml 2001/08/02 05:37:33 1.5.2.2
@@ -2,9 +2,100 @@
<!DOCTYPE s1 SYSTEM 'dtd/document.dtd'>
<s1 title='API JavaDoc'>
<s2 title='Standard API Documentation'>
+ <p>
+ Always try to use only the standard XML APIs when writing
+ XML applications. This will keep your application shielded
+ from changes in the underlying implementation of those
+ standard APIs and also gives you more flexibility to change
+ the implementation of the standard pieces without modifying
+ your application code.
+ </p>
+ <ul>
+ <li><jump href='../api/index.html'>Standard API</jump></li>
+ <ul>
+ <li>Java API for XML Processing (JAXP)</li>
+ <ul>
+ <li>
+ <jump href='../api/javax/xml/parsers/package-summary.html'>XML
+ Parser Factories</jump>
+ </li>
+ </ul>
+ <li>Document Object Model (DOM)</li>
+ <ul>
+ <li>
+ <jump href='../api/org/w3c/dom/package-summary.html'>Core</jump>
+ </li>
+ <li>
+ <jump href='../api/org/w3c/dom/events/package-summary.html'>Events</jump>
+ </li>
+ <li>
+ <jump href='../api/org/w3c/dom/html/package-summary.html'>HTML</jump>
+ </li>
+ <li>
+ <jump href='../api/org/w3c/dom/ranges/package-summary.html'>Ranges</jump>
+ </li>
+ <li>
+ <jump href='../api/org/w3c/dom/traversal/package-summary.html'>Traversal</jump>
+ </li>
+ </ul>
+ <li>Simple API for XML (SAX)</li>
+ <ul>
+ <li>
+ <jump href='../api/org/xml/sax/package-summary.html'>Core</jump>
+ </li>
+ <li>
+ <jump href='../api/org/xml/sax/helpers/package-summary.html'>Helper Classes</jump>
+ </li>
+ <li>
+ <jump href='../api/org/xml/sax/ext/package-summary.html'>Extensions</jump>
+ </li>
+ </ul>
+ </ul>
+ </ul>
</s2>
- <s2 title='Xerces-J User API Documentation'>
+ <s2 title='Xerces Native Interface Documentation'>
+ <p>
+ If you need functionality that is not available in the
+ standard APIs like DOM and SAX, then perhaps using the Xerces
+ Native Interface (XNI) will provide the information to build
+ the appropriate parsing tools for your application. For more
+ detailed information regarding XNI, refer to the
+ <link idref='xni'>XNI Manual</link>.
+ </p>
+ <ul>
+ <li>
+ <jump href='../xni/index.html'>Xerces Native Interface</jump>
+ </li>
+ <ul>
+ <li>
+ <jump href='../xni/org/apache/xerces/xni/package-summary.html'>Core</jump>
+ </li>
+ <li>
+ <jump href='../xni/org/apache/xerces/xni/parser/package-summary.html'>Parser
+ Configuration</jump>
+ </li>
+ </ul>
+ </ul>
</s2>
- <s2 title='Xerces-J Developer API Documentation'>
+ <s2 title='Xerces2 Implementation Documentation'>
+ <p>
+ For maintainers and developers of the Xerces2 reference
+ implementation, it's important to know the internal APIs
+ used.
+ </p>
+ <ul>
+ <li>
+ <jump href='../xerces2/index.html'>Xerces2 Implementation</jump>
+ </li>
+ </ul>
+ </s2>
+ <s2 title='Other Classes Documentation'>
+ <p>
+ The Xerces2 package also contains other implementation classes.
+ You can jump to the API for these classes via the following links:
+ </p>
+ <ul>
+ <li><jump href='../other/index.html'>Other Classes</jump></li>
+ </ul>
</s2>
</s1>
---------------------------------------------------------------------
To unsubscribe, e-mail: xerces-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: xerces-cvs-help@xml.apache.org