bug: doc.: DOMParser control API undocumented

[Daniel Barclay <Da...@digitalfocus.com>]

The API for invoking and controlling DOMParser is not documented in
the Xerces release.

The SAX-like methods parse(...), setEntityResolver(...), etc. on
method DOMParser are defined in (apparently) internal class 
org.apache.xerces.framework.XMLParser, but that class is not documented 
(its documentation is not included) in the Xerces release.

A solution would be to document the public methods intended for controlling 
DOMParser.

You could just list, in the class description, the SAX-like methods that
DOMParser uses (and refer the reader to the actual SAX methods for 
documentation).  Maybe something VERY roughly like:


        DOMParser uses methods from the SAX API to control the parser
        and to report errors ...

        Although DOMParser does not implement either the SAX interface
	XMLReader or Parser, it defines methods methods 
        parse( InputSource ), setErrorHandler( ErrorHandler ), ... 
        from XMLReaer and Parser, and uses them as SAX parser would.

	See the documentation of those methods of XMLReader/Parser.


Documenting each method would be even better, but that would require
re-declaring each such method (simply calling super.xxx(...)) to have a
place to put the Javadoc source in the Java to get it to appear in the
generated documentation page.

(An interim solution might be to include class
org.apache.xerces.framework.XMLParser's documentation in the releases,
so readers could at least find the already-existing internal information.)


Daniel
-- 
Daniel Barclay
Digital Focus
Daniel.Barclay@digitalfocus.com