You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xerces.apache.org by kn...@apache.org on 2002/05/30 21:24:48 UTC
cvs commit: xml-xerces/c/src/xercesc/dom DOMBuilder.hpp DOMEntityResolver.hpp DOMError.hpp DOMErrorHandler.hpp DOMImplementationLS.hpp DOMInputSource.hpp DOMLocator.hpp
knoaman 02/05/30 12:24:48
Modified: c/src/xercesc/dom DOMBuilder.hpp DOMEntityResolver.hpp
DOMError.hpp DOMErrorHandler.hpp
DOMImplementationLS.hpp DOMInputSource.hpp
DOMLocator.hpp
Log:
documentation update
Revision Changes Path
1.2 +67 -17 xml-xerces/c/src/xercesc/dom/DOMBuilder.hpp
Index: DOMBuilder.hpp
===================================================================
RCS file: /home/cvs/xml-xerces/c/src/xercesc/dom/DOMBuilder.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DOMBuilder.hpp 29 May 2002 21:28:02 -0000 1.1
+++ DOMBuilder.hpp 30 May 2002 19:24:48 -0000 1.2
@@ -55,7 +55,7 @@
*/
/*
- * $Id: DOMBuilder.hpp,v 1.1 2002/05/29 21:28:02 knoaman Exp $
+ * $Id: DOMBuilder.hpp,v 1.2 2002/05/30 19:24:48 knoaman Exp $
*
*/
@@ -73,6 +73,8 @@
class DOMDocument;
/**
+ * Introduced in DOM Level 3
+ *
* DOMBuilder provides an API for parsing XML documents and building the
* corresponding DOM document tree. A DOMBuilder instance is obtained from
* the DOMImplementationLS interface by invoking its createDOMBuilder method.
@@ -126,7 +128,10 @@
/** @name Getter methods */
//@{
- /** Get a pointer to the error handler
+ /**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
+ * Get a pointer to the error handler
*
* This method returns the installed error handler. If no handler
* has been installed, then it will be a zero pointer.
@@ -135,7 +140,10 @@
*/
virtual DOMErrorHandler* getErrorHandler() = 0;
- /** Get a const pointer to the error handler
+ /**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
+ * Get a const pointer to the error handler
*
* This method returns the installed error handler. If no handler
* has been installed, then it will be a zero pointer.
@@ -144,7 +152,10 @@
*/
virtual const DOMErrorHandler* getErrorHandler() const = 0;
- /** Get a pointer to the entity resolver
+ /**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
+ * Get a pointer to the entity resolver
*
* This method returns the installed entity resolver. If no resolver
* has been installed, then it will be a zero pointer.
@@ -153,7 +164,10 @@
*/
virtual DOMEntityResolver* getEntityResolver() = 0;
- /** Get a const pointer to the entity resolver
+ /**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
+ * Get a const pointer to the entity resolver
*
* This method returns the installed entity resolver. If no resolver
* has been installed, then it will be a zero pointer.
@@ -162,7 +176,10 @@
*/
virtual const DOMEntityResolver* getEntityResolver() const = 0;
- /** Get a pointer to the application filter
+ /**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
+ * Get a pointer to the application filter
*
* This method returns the installed application filter. If no filter
* has been installed, then it will be a zero pointer.
@@ -171,7 +188,10 @@
*/
virtual DOMBuilderFilter* getFilter() = 0;
- /** Get a const pointer to the application filter
+ /**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
+ * Get a const pointer to the application filter
*
* This method returns the installed application filter. If no filter
* has been installed, then it will be a zero pointer.
@@ -190,7 +210,10 @@
/** @name Setter methods */
//@{
- /** Set the error handler
+ /**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
+ * Set the error handler
*
* This method allows applications to install their own error handler
* to trap error and warning messages.
@@ -205,7 +228,10 @@
*/
virtual void setErrorHandler(DOMErrorHandler* const handler) = 0;
- /** Set the entity resolver
+ /**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
+ * Set the entity resolver
*
* This method allows applications to install their own entity
* resolver. By installing an entity resolver, the applications
@@ -222,7 +248,10 @@
*/
virtual void setEntityResolver(DOMEntityResolver* const handler) = 0;
- /** Set the application filter
+ /**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
+ * Set the application filter
*
* When the application provides a filter, the parser will call out to
* the filter at the completion of the construction of each Element node.
@@ -250,7 +279,10 @@
/** @name Feature methods */
//@{
- /** Set the state of a feature
+ /**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
+ * Set the state of a feature
*
* It is possible for a DOMBuilder to recognize a feature name but to be
* unable to set its value.
@@ -268,7 +300,10 @@
*/
virtual void setFeature(const XMLCh* const name, const bool state) = 0;
- /** Look up the value of a feature.
+ /**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
+ * Look up the value of a feature.
*
* @param name The feature name.
* @return The current state of the feature (true or false)
@@ -281,7 +316,10 @@
*/
virtual bool getFeature(const XMLCh* const name) = 0;
- /** Query whether setting a feature to a specific value is supported.
+ /**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
+ * Query whether setting a feature to a specific value is supported.
*
* @param name The feature name.
* @param state The requested state of the feature (true or false).
@@ -303,7 +341,10 @@
/** @name Parsing methods */
//@{
- /** Parse via an input source object
+ /**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
+ * Parse via an input source object
*
* This method invokes the parsing process on the XML file specified
* by the DOMInputSource parameter. This API is borrowed from the
@@ -330,7 +371,10 @@
*/
virtual DOMDocument* parse(const DOMInputSource& source, const bool reuseGrammar = false) = 0;
- /** Parse via a file path or URL
+ /**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
+ * Parse via a file path or URL
*
* This method invokes the parsing process on the XML file specified by
* the Unicode string parameter 'systemId'.
@@ -354,7 +398,10 @@
*/
virtual DOMDocument* parseURI(const XMLCh* const systemId, const bool reuseGrammar = false) = 0;
- /** Parse via a file path or URL (in the local code page)
+ /**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
+ * Parse via a file path or URL (in the local code page)
*
* This method invokes the parsing process on the XML file specified by
* the native char* string parameter 'systemId'.
@@ -378,7 +425,10 @@
*/
virtual DOMDocument* parseURI(const char* const systemId, const bool reuseGrammar = false) = 0;
- /** Parse via an input source object
+ /**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
+ * Parse via an input source object
*
* This method invokes the parsing process on the XML file specified
* by the DOMInputSource parameter, and inserts the content into an
1.2 +8 -1 xml-xerces/c/src/xercesc/dom/DOMEntityResolver.hpp
Index: DOMEntityResolver.hpp
===================================================================
RCS file: /home/cvs/xml-xerces/c/src/xercesc/dom/DOMEntityResolver.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DOMEntityResolver.hpp 29 May 2002 21:28:02 -0000 1.1
+++ DOMEntityResolver.hpp 30 May 2002 19:24:48 -0000 1.2
@@ -56,6 +56,9 @@
/*
* $Log: DOMEntityResolver.hpp,v $
+ * Revision 1.2 2002/05/30 19:24:48 knoaman
+ * documentation update
+ *
* Revision 1.1 2002/05/29 21:28:02 knoaman
* DOM L3 LS: DOMInputSource, DOMEntityResolver, DOMImplementationLS and DOMBuilder
*
@@ -70,6 +73,8 @@
class DOMInputSource;
/**
+ * Introduced in DOM Level 3
+ *
* DOMEntityResolver provides a way for applications to redirect references
* to external entities.
*
@@ -113,6 +118,8 @@
//@{
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Allow the application to resolve external entities.
*
* <p>The DOMBuilder will call this method before opening any external
1.2 +18 -1 xml-xerces/c/src/xercesc/dom/DOMError.hpp
Index: DOMError.hpp
===================================================================
RCS file: /home/cvs/xml-xerces/c/src/xercesc/dom/DOMError.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DOMError.hpp 23 May 2002 15:47:24 -0000 1.1
+++ DOMError.hpp 30 May 2002 19:24:48 -0000 1.2
@@ -56,6 +56,9 @@
/*
* $Log: DOMError.hpp,v $
+ * Revision 1.2 2002/05/30 19:24:48 knoaman
+ * documentation update
+ *
* Revision 1.1 2002/05/23 15:47:24 knoaman
* DOM L3 core - support for DOMError, DOMErrorHandler and DOMLocator
*
@@ -71,6 +74,8 @@
/**
+ * Introduced in DOM Level 3
+ *
* DOMError is an interface that describes an error.
*
* @see DOMErrorHandler#handleError
@@ -114,16 +119,22 @@
//@{
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Get the severity of the error
*/
virtual short getSeverity() const = 0;
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Get the message describing the error that occured.
*/
virtual const XMLCh* getMessage() const = 0;
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Get the location of the error
*/
virtual DOMLocator* getLocation() const = 0;
@@ -135,6 +146,8 @@
//@{
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Set the severity of the error
*
* @param severity the type of the error to set
@@ -142,6 +155,8 @@
virtual void setSeverity(const short severity) = 0;
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Set the error message
*
* @param message the error message to set.
@@ -149,6 +164,8 @@
virtual void setMessage(const XMLCh* const message) = 0;
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Set the location of the error
*
* @param location the location of the error to set.
1.2 +8 -1 xml-xerces/c/src/xercesc/dom/DOMErrorHandler.hpp
Index: DOMErrorHandler.hpp
===================================================================
RCS file: /home/cvs/xml-xerces/c/src/xercesc/dom/DOMErrorHandler.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DOMErrorHandler.hpp 23 May 2002 15:47:24 -0000 1.1
+++ DOMErrorHandler.hpp 30 May 2002 19:24:48 -0000 1.2
@@ -56,6 +56,9 @@
/*
* $Log: DOMErrorHandler.hpp,v $
+ * Revision 1.2 2002/05/30 19:24:48 knoaman
+ * documentation update
+ *
* Revision 1.1 2002/05/23 15:47:24 knoaman
* DOM L3 core - support for DOMError, DOMErrorHandler and DOMLocator
*
@@ -71,6 +74,8 @@
/**
+ * Introduced in DOM Level 3
+ *
* Basic interface for DOM error handlers.
*
* <p>DOMErrorHandler is a callback interface that the DOM implementation
@@ -108,6 +113,8 @@
/** @name The error handler interface */
//@{
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* This method is called on the error handler when an error occures.
*
* @param domError The error object that describes the error, this object
1.3 +10 -0 xml-xerces/c/src/xercesc/dom/DOMImplementationLS.hpp
Index: DOMImplementationLS.hpp
===================================================================
RCS file: /home/cvs/xml-xerces/c/src/xercesc/dom/DOMImplementationLS.hpp,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DOMImplementationLS.hpp 30 May 2002 16:39:06 -0000 1.2
+++ DOMImplementationLS.hpp 30 May 2002 19:24:48 -0000 1.3
@@ -56,6 +56,9 @@
/*
* $Log: DOMImplementationLS.hpp,v $
+ * Revision 1.3 2002/05/30 19:24:48 knoaman
+ * documentation update
+ *
* Revision 1.2 2002/05/30 16:39:06 knoaman
* DOM L3 LS.
*
@@ -76,6 +79,7 @@
/**
+ * Introduced in DOM Level 3
*
* <p><code>DOMImplementationLS</code> contains the factory methods for
* creating objects that implement the <code>DOMBuilder</code> (parser) and
@@ -129,6 +133,8 @@
/** @name Virtual DOMImplementation LS interface */
//@{
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* <p>Create a new DOMBuilder. The newly constructed parser may then be
* configured by means of its setFeature method, and used to parse
* documents by means of its parse method.</p>
@@ -158,6 +164,8 @@
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* <p>Create a new DOMWriter. DOMWriters are used to serialize a DOM tree
* back into an XML document.</p>
*
@@ -168,6 +176,8 @@
virtual DOMWriter* createDOMWriter() = 0;
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* <p>Create a new "empty" DOMInputSource.</p>
*
* @return The newly created <code>DOMInputSource<code> object.
1.2 +29 -5 xml-xerces/c/src/xercesc/dom/DOMInputSource.hpp
Index: DOMInputSource.hpp
===================================================================
RCS file: /home/cvs/xml-xerces/c/src/xercesc/dom/DOMInputSource.hpp,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DOMInputSource.hpp 29 May 2002 21:28:02 -0000 1.1
+++ DOMInputSource.hpp 30 May 2002 19:24:48 -0000 1.2
@@ -56,6 +56,9 @@
/*
* $Log: DOMInputSource.hpp,v $
+ * Revision 1.2 2002/05/30 19:24:48 knoaman
+ * documentation update
+ *
* Revision 1.1 2002/05/29 21:28:02 knoaman
* DOM L3 LS: DOMInputSource, DOMEntityResolver, DOMImplementationLS and DOMBuilder
*
@@ -71,6 +74,7 @@
/**
+ * Introduced in DOM Level 3
* This interface represents a single input source for an XML entity.
*
* <p>This interface allows an application to encapsulate information about
@@ -128,6 +132,8 @@
/** @name Virtual input source interface */
//@{
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Makes the byte stream for this input source.
*
* <p>The derived class must create and return a binary input stream of an
@@ -146,6 +152,8 @@
/** @name Getter methods */
//@{
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* An input source can be set to force the parser to assume a particular
* encoding for the data that input source reprsents, via the setEncoding()
* method. This method returns name of the encoding that is to be forced.
@@ -158,6 +166,8 @@
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Get the public identifier for this input source.
*
* @return The public identifier, or null if none was supplied.
@@ -167,6 +177,8 @@
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Get the system identifier for this input source.
*
* <p>If the system ID is a URL, it will be fully resolved.</p>
@@ -178,6 +190,8 @@
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Get the base URI to be used for resolving relative URIs to absolute
* URIs. If the baseURI is itself a relative URI, the behavior is
* implementation dependent.
@@ -189,6 +203,8 @@
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Get the flag that indicates if the parser should issue fatal error if this input source
* is not found.
*
@@ -206,6 +222,8 @@
//@{
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Set the encoding which will be required for use with the XML text read
* via a stream opened by this input source.
*
@@ -220,6 +238,8 @@
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Set the public identifier for this input source.
*
* <p>The public identifier is always optional: if the application writer
@@ -231,13 +251,13 @@
virtual void setPublicId(const XMLCh* const publicId) = 0;
/**
- * Set the system identifier for this input source.
+ * <p><b>"Experimental - subject to change"</b></p>
*
- * <p>Set the system identifier for this input source.
+ * Set the system identifier for this input source.
*
- * </p>The system id is always required. The public id may be used to map
+ * <p>The system id is always required. The public id may be used to map
* to another system id, but the system id must always be present as a fall
- * back.
+ * back.</p>
*
* <p>If the system ID is a URL, it must be fully resolved.</p>
*
@@ -247,6 +267,8 @@
virtual void setSystemId(const XMLCh* const systemId) = 0;
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Set the base URI to be used for resolving relative URIs to absolute
* URIs. If the baseURI is itself a relative URI, the behavior is
* implementation dependent.
@@ -257,6 +279,8 @@
virtual void setBaseURI(const XMLCh* const baseURI) = 0;
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Indicates if the parser should issue fatal error if this input source
* is not found. If set to false, the parser issue warning message instead.
*
1.3 +31 -6 xml-xerces/c/src/xercesc/dom/DOMLocator.hpp
Index: DOMLocator.hpp
===================================================================
RCS file: /home/cvs/xml-xerces/c/src/xercesc/dom/DOMLocator.hpp,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DOMLocator.hpp 27 May 2002 18:28:26 -0000 1.2
+++ DOMLocator.hpp 30 May 2002 19:24:48 -0000 1.3
@@ -56,6 +56,9 @@
/*
* $Log: DOMLocator.hpp,v $
+ * Revision 1.3 2002/05/30 19:24:48 knoaman
+ * documentation update
+ *
* Revision 1.2 2002/05/27 18:28:26 tng
* To get ready for 64 bit large file, use XMLSSize_t to represent line and column number.
*
@@ -74,6 +77,8 @@
/**
+ * Introduced in DOM Level 3
+ *
* DOMLocator is an interface that describes a location (e.g. where an error
* occured).
*
@@ -106,6 +111,8 @@
//@{
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Get the line number where the error occured. The value is -1 if there is
* no line number available.
*
@@ -114,6 +121,8 @@
virtual XMLSSize_t getLineNumber() const = 0;
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Get the column number where the error occured. The value is -1 if there
* is no column number available.
*
@@ -122,6 +131,8 @@
virtual XMLSSize_t getColumnNumber() const = 0;
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Get the byte or character offset into the input source, if we're parsing
* a file or a byte stream then this will be the byte offset into that
* stream, but if a character media is parsed then the offset will be the
@@ -132,6 +143,8 @@
virtual XMLSSize_t getOffset() const = 0;
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Get the DOM Node where the error occured, or <code>null</code> if there
* is no node available.
*
@@ -140,6 +153,8 @@
virtual DOMNode* getErrorNode() const = 0;
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Get the URI where the error occured, or <code>null</code> if there is no
* URI available.
*
@@ -154,6 +169,8 @@
//@{
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Set the line number of the error
*
* @param lineNumber the line number to set
@@ -163,6 +180,8 @@
virtual void setLineNumber(const XMLSSize_t lineNumber) = 0;
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Set the column number of the error
*
* @param columnNumber the column number to set.
@@ -172,6 +191,8 @@
virtual void setColumnNumber(const XMLSSize_t columnNumber) = 0;
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Set the byte/character offset.
*
* @param offset the byte/characte offset to set.
@@ -181,6 +202,8 @@
virtual void setOffset(const XMLSSize_t offset) = 0;
/**
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
* Set the DOM Node where the error occured
*
* @param errorNode the DOM Node to set
@@ -190,12 +213,14 @@
virtual void setErrorNode(DOMNode* const errorNode) = 0;
/**
- * Set the URI where the error occured
- *
- * @param uri the URI to set.
- *
- * @see #getURI
- */
+ * <p><b>"Experimental - subject to change"</b></p>
+ *
+ * Set the URI where the error occured
+ *
+ * @param uri the URI to set.
+ *
+ * @see #getURI
+ */
virtual void setURI(const XMLCh* const uri) = 0;
//@}
---------------------------------------------------------------------
To unsubscribe, e-mail: xerces-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: xerces-cvs-help@xml.apache.org