Miroirs/arabica
1
0
Fork 0
mirror of https://github.com/jezhiggins/arabica synced 2025-01-29 08:36:45 +01:00
Code Issues Projects Releases Packages Wiki Activity

Fixed errors in documentation. Fixed:

Browse source 
* "null" where "an empty string" was appropriate
* mis-spellings of parameters.
* cut-and-paste mistakes.
This commit is contained in:
pwalford 2002-10-08 01:00:22 +00:00
parent 1a9b0fc214
commit c13a04b386
20 changed files with 151 additions and 133 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
SAX/AttributeList.h
View file

@ -104,7 +104,7 @@ public:
* will still be attached.</p>
*
* @param i The index of the attribute in the list (starting at 0).
* @return The name of the indexed attribute, or null
* @return The name of the indexed attribute, or an empty string
* if the index is out of range.
* @see #getLength
*/
@ -126,7 +126,7 @@ public:
*
* @param i The index of the attribute in the list (starting at 0).
* @return The attribute type as a string, or
* null if the index is out of range.
* an empty string if the index is out of range.
* @see #getLength
* @see #getType(java.lang.String)
*/
@ -140,9 +140,9 @@ public:
*
* @param i The index of the attribute in the list (starting at 0).
* @return The attribute value as a string, or
* null if the index is out of range.
* an empty string if the index is out of range.
* @see #getLength
* @see #getValue(java.lang.String)
* @see #getValue(stringT)
*/
virtual const stringT& getValue(int i) const = 0;
@ -159,7 +159,7 @@ public:
* the application must include the prefix here.</p>
*
* @param name The name of the attribute.
* @return The attribute type as a string, or null if no
* @return The attribute type as a string, or an empty string if no
* such attribute exists.
* @see #getType(int)
*/
@ -173,10 +173,10 @@ public:
* <p>If the attribute name has a namespace prefix in the document,
* the application must include the prefix here.</p>
*
* @param i The index of the attribute in the list.
* @return The attribute value as a string, or null if
* @param name The name of the attribute in the list.
* @return The attribute value as a string, or an empty string if
* no such attribute exists.
* @see #getValue(int)
* @see #getValue(stringT)
*/
virtual const stringT& getValue(const stringT& name) const = 0;
@ -189,3 +189,4 @@ typedef basic_AttributeList<std::wstring> wAttributeList;
#endif
// end of file

36
SAX/Attributes.h
View file

@ -73,36 +73,39 @@ public:
* @see #getValue(int)
*/
virtual int getLength() const = 0;
/**
* Look up an attribute's Namespace URI by index.
*
* @param index The attribute index (zero-based).
* @return The Namespace URI, or the empty string if none
* is available, or null if the index is out of
* range.
* is available, or if the index is out of range.
* @see #getLength
*/
virtual stringT getURI(unsigned int index) const = 0;
/**
* Look up an attribute's local name by index.
*
* @param index The attribute index (zero-based).
* @return The local name, or the empty string if Namespace
* processing is not being performed, or null
* processing is not being performed, or
* if the index is out of range.
* @see #getLength
*/
virtual stringT getLocalName(unsigned int index) const = 0;
/**
* Look up an attribute's XML 1.0 qualified name by index.
*
* @param index The attribute index (zero-based).
* @return The XML 1.0 qualified name, or the empty string
* if none is available, or null if the index
* if none is available, or if the index
* is out of range.
* @see #getLength
*/
virtual stringT getQName(unsigned int index) const = 0;
/**
* Look up an attribute's type by index.
*
@ -119,11 +122,12 @@ public:
* parser will report the type as "NMTOKEN".</p>
*
* @param index The attribute index (zero-based).
* @return The attribute's type as a string, or null if the
* @return The attribute's type as a string, or an empty string if the
* index is out of range.
* @see #getLength
*/
virtual stringT getType(unsigned int index) const = 0;
/**
* Look up an attribute's value by index.
*
@ -133,7 +137,7 @@ public:
* single space.</p>
*
* @param index The attribute index (zero-based).
* @return The attribute's value as a string, or null if the
* @return The attribute's value as a string, or an empty string if the
* index is out of range.
* @see #getLength
*/
@ -160,6 +164,7 @@ public:
* appear in the list.
*/
virtual int getIndex(const stringT& qName) const = 0;
/**
* Look up an attribute's type by Namespace name.
*
@ -169,11 +174,12 @@ public:
* @param uri The Namespace URI, or the empty String if the
* name has no Namespace URI.
* @param localName The local name of the attribute.
* @return The attribute type as a string, or null if the
* @return The attribute type as a string, or an empty string if the
* attribute is not in the list or if Namespace
* processing is not being performed.
*/
virtual stringT getType(const stringT& uri, const stringT& localName) const = 0;
/**
* Look up an attribute's type by XML 1.0 qualified name.
*
@ -181,32 +187,34 @@ public:
* of the possible types.</p>
*
* @param qName The XML 1.0 qualified name.
* @return The attribute type as a string, or null if the
* @return The attribute type as a string, or an empty string if the
* attribute is not in the list or if qualified names
* are not available.
*/
virtual stringT getType(const stringT& qName) const = 0;
/**
* Look up an attribute's value by Namespace name.
*
* <p>See {@link #getValue(unsigned int) getValue(unsigned int)} for a description
* of the possible values.</p>
* <p>See {@link #getValue(unsigned int) getValue(unsigned int)} for a
* description of the possible values.</p>
*
* @param uri The Namespace URI, or the empty String if the
* name has no Namespace URI.
* @param localName The local name of the attribute.
* @return The attribute value as a string, or null if the
* @return The attribute value as a string, or an empty string if the
* attribute is not in the list.
*/
virtual stringT getValue(const stringT& uri, const stringT& localName) const = 0;
/**
* Look up an attribute's value by XML 1.0 qualified name.
*
* <p>See {@link #getValue(unsigned int) getValue(unsigned int)} for a description
* of the possible values.</p>
* <p>See {@link #getValue(unsigned int) getValue(unsigned int)} for a
* description of the possible values.</p>
*
* @param qName The XML 1.0 qualified name.
* @return The attribute value as a string, or null if the
* @return The attribute value as a string, or an empty string if the
* attribute is not in the list or if qualified names
* are not available.
*/

6
SAX/ContentHandler.h
View file

@ -201,7 +201,7 @@ public:
* property is true (it is false by default, and support for a
* true value is optional).</p>
*
* @param uri The Namespace URI, or the empty string if the
* @param namespaceURI The Namespace URI, or the empty string if the
* element has no Namespace URI or if Namespace
* processing is not being performed.
* @param localName The local name (without prefix), or the
@ -229,7 +229,7 @@ public:
*
* <p>For information on the names, see startElement.</p>
*
* @param uri The Namespace URI, or the empty string if the
* @param namespaceURI The Namespace URI, or the empty string if the
* element has no Namespace URI or if Namespace
* processing is not being performed.
* @param localName The local name (without prefix), or the
@ -301,7 +301,7 @@ public:
* using this method.</p>
*
* @param target The processing instruction target.
* @param data The processing instruction data, or null if
* @param data The processing instruction data, or an empty string if
* none was supplied. The data does not include any
* whitespace separating it from the target.
* @exception SAXException Any SAX exception.

6
SAX/DTDHandler.h
View file

@ -75,9 +75,9 @@ public:
* reported before any unparsed entities that use it.</p>
*
* @param name The notation name.
* @param publicId The notation's public identifier, or null if
* @param publicId The notation's public identifier, or an empty string if
* none was given.
* @param systemId The notation's system identifier, or null if
* @param systemId The notation's system identifier, or an empty string if
* none was given.
* @exception SAXException Any SAX exception.
* @see #unparsedEntityDecl
@ -103,7 +103,7 @@ public:
*
* @exception SAXException Any SAX exception.
* @param name The unparsed entity's name.
* @param publicId The entity's public identifier, or null if none
* @param publicId The entity's public identifier, or an empty string if none
* was given.
* @param systemId The entity's system identifier.
* @param notationName The name of the associated notation.

6
SAX/EntityResolver.h
View file

@ -94,12 +94,12 @@ public:
* resolve it fully before reporting it to the application.</p>
*
* @param publicId The public identifier of the external entity
* being referenced, or null if none was supplied.
* being referenced, or an empty string if none was supplied.
* @param systemId The system identifier of the external entity
* being referenced.
* @return An InputSource object describing the new input source,
* or null to request that the parser open a regular
* URI connection to the system identifier.
* or a default-constructed <code>InputSource</code> to request that
* the parser open a regular URI connection to the system identifier.
* @exception SAXException Any SAX exception.
* @see basic_InputSource
*/

21
SAX/HandlerBase.h
View file

@ -65,17 +65,17 @@ public:
/**
* Resolve an external entity.
*
* <p>Always return null, so that the parser will use the system
* identifier provided in the XML document. This method implements
* the SAX default behaviour: application writers can override it
* in a subclass to do special translations such as catalog lookups
* or URI redirection.</p>
* <p>Always return a default-constructed <code>InputSourceT</code>, so that
* the parser will use the system identifier provided in the XML document.
* This method implements the SAX default behaviour: application writers can
* override it in a subclass to do special translations such as catalog
* lookups or URI redirection.</p>
*
* @param publicId The public identifer, or null if none is
* @param publicId The public identifer, or an empty string if none is
* available.
* @param systemId The system identifier provided in the XML
* document.
* @return The new input source, or null to require the
* @return The new input source, or an empty string to require the
* default behaviour.
* @see basic_EntityResolver#resolveEntity
*/
@ -95,7 +95,7 @@ public:
* declared in a document.</p>
*
* @param name The notation name.
* @param publicId The notation public identifier, or null if not
* @param publicId The notation public identifier, or an empty string if not
* available.
* @param systemId The notation system identifier.
* @see basic_DTDHandler#notationDecl
@ -112,7 +112,7 @@ public:
* declared in a document.</p>
*
* @param name The entity name.
* @param publicId The entity public identifier, or null if not
* @param publicId The entity public identifier, or an empty string if not
* available.
* @param systemId The entity system identifier.
* @param notationName The name of the associated notation.
@ -184,7 +184,6 @@ public:
* output to a file).</p>
*
* @param name The element type name.
* @param attributes The specified or defaulted attributes.
* @see basic_DocumentHandler#endElement
*/
virtual void endElement(const stringT&) { }
@ -223,7 +222,7 @@ public:
* invoking other methods.</p>
*
* @param target The processing instruction target.
* @param data The processing instruction data, or null if
* @param data The processing instruction data, or an empty string if
* none is supplied.
* @see basic_DocumentHandler#processingInstruction
*/

6
SAX/InputSource.h
View file

@ -128,7 +128,7 @@ public:
/**
* Get the public identifier for this input source.
*
* @return The public identifier, or null if none was supplied.
* @return The public identifier, or an empty string if none was supplied.
* @see #setPublicId
*/
const stringT& getPublicId() const { return publicId_; }
@ -160,7 +160,7 @@ public:
* Get the system identifier for this input source.
*
* <p>The getEncoding method will return the character encoding
* of the object pointed to, or null if unknown.</p>
* of the object pointed to, or an empty string if unknown.</p>
*
* <p>If the system ID is a URL, it will be fully resolved.</p>
*
@ -221,7 +221,7 @@ public:
/**
* Get the character encoding for a byte stream or URI.
*
* @return The encoding, or null if none was supplied.
* @return The encoding, or an empty string if none was supplied.
* @see #setByteStream
* @see #getSystemId
* @see #getByteStream

4
SAX/SAXParseException.h
View file

@ -93,7 +93,7 @@ public:
/**
* Get the public identifier of the entity where the exception occurred.
*
* @return A string containing the public identifier, or null
* @return A string containing the public identifier, or an empty string
* if none is available.
* @see basic_Locator#getPublicId
*/
@ -104,7 +104,7 @@ public:
* <p>If the system identifier is a URL, it will be resolved
* fully.</p>
*
* @return A string containing the system identifier, or null
* @return A string containing the system identifier, or an empty string
* if none is available.
* @see basic_Locator#getSystemId
*/

11
SAX/XMLReader.h
View file

@ -137,13 +137,15 @@ public:
* a parse.</p>
*
* @param name The feature name, which is a fully-qualified URI.
* @param state The requested state of the feature (true or false).
* @param value The requested value of the feature (true or false).
* @exception SAXNotRecognizedException When the
* XMLReader does not recognize the feature name.
* @exception SAXNotSupportedException When the
* XMLReader recognizes the feature name but
* cannot set the requested value.
* @see #getFeature
* @see FeatureNames
* @see http://www.saxproject.org/apidoc/org/xml/sax/package-summary.html#package_description for a list of SAX2 features.
*/
virtual void setFeature(const stringT& name, bool value) = 0;
@ -291,7 +293,7 @@ public:
* has ended. If a client application wants to terminate
* parsing early, it should throw an exception.</p>
*
* @param source The input source for the top-level of the
* @param input The input source for the top-level of the
* XML document.
* @see basic_InputSource
* @see #parse(const stringT&)
@ -388,7 +390,7 @@ public:
* extended handlers.</p>
*
* @param name The property name, which is a fully-qualified URI.
* @param state The requested value for the property.
* @param value The requested value for the property.
* @exception SAXNotRecognizedException When the
* XMLReader does not recognize the property name.
* @exception SAXNotSupportedException When the
@ -405,6 +407,9 @@ public:
}; // namespace SAX
/* Included to ensure that #include<SAX/XMLReader.h> defines a class called
* XMLReader.
*/
#include <SAX/ParserConfig.h>
#endif

10
SAX/ext/Attributes2.h
View file

@ -36,27 +36,31 @@ public:
/**
* Returns true unless the attribute value was provided by DTD defaulting.
*
* @param index - The attribute index (zero-based).
* @param index The attribute index (zero-based).
* @return true if the value was found in the XML text,
* false if the value was provided by DTD defaulting.
* @throws std::out_of_range exception when the supplied index
* does not identify an attribute
*/
virtual bool isSpecified(unsigned int index) const = 0;
/**
* Returns true unless the attribute value was provided by DTD defaulting.
*
* @param index - The attribute index (zero-based).
* @param qName The XML 1.0 qualified name.
* @return true if the value was found in the XML text,
* false if the value was provided by DTD defaulting.
* @throws std::invalid_argument exception when the supplied name
* does not identify an attribute
*/
virtual bool isSpecified(const stringT& qName) const = 0;
/**
* Returns true unless the attribute value was provided by DTD defaulting.
*
* @param index - The attribute index (zero-based).
* @param uri The Namespace URI, or the empty string if the name has no
* Namespace URI.
* @param localName The attribute's local name.
* @return true if the value was found in the XML text,
* false if the value was provided by DTD defaulting.
* @throws std::invalid_argument exception when the supplied names

6
SAX/ext/DeclHandler.h
View file

@ -78,8 +78,8 @@ public:
* <p>Any parameter entities in the attribute value will be
* expanded, but general entities will not.</p>
*
* @param eName The name of the associated element.
* @param aName The name of the attribute.
* @param elementName The name of the associated element.
* @param attributeName The name of the attribute.
* @param type A string representing the attribute type.
* @param valueDefault A string representing the attribute default
* ("#IMPLIED", "#REQUIRED", or "#FIXED") or empty string if
@ -115,7 +115,7 @@ public:
* @param name The name of the entity. If it is a parameter
* entity, the name will begin with '%'.
* @param publicId The declared public identifier of the entity, or
* null if none was declared.
* an empty string if none was declared.
* @param systemId The declared system identifier of the entity.
* @see #internalEntityDecl
* @see basic_DTDHandler#unparsedEntityDecl

12
SAX/ext/DefaultHandler2.h
View file

@ -75,9 +75,9 @@ public:
*
* @param name The document type name.
* @param publicId The declared public identifier for the
* external DTD subset, or null if none was declared.
* external DTD subset, or an empty string if none was declared.
* @param systemId The declared system identifier for the
* external DTD subset, or null if none was declared.
* external DTD subset, or an empty string if none was declared.
* @see #endDTD
* @see #startEntity
*/
@ -180,7 +180,7 @@ public:
* nested inside start/endDTD and start/endEntity events (if
* used).</p>
*
* @param ch An holding the comment.
* @param text A string holding the comment.
*/
virtual void comment(const stringT& text) { }
@ -216,8 +216,8 @@ public:
* <p>Any parameter entities in the attribute value will be
* expanded, but general entities will not.</p>
*
* @param eName The name of the associated element.
* @param aName The name of the attribute.
* @param elementName The name of the associated element.
* @param attributeName The name of the attribute.
* @param type A string representing the attribute type.
* @param valueDefault A string representing the attribute default
* ("#IMPLIED", "#REQUIRED", or "#FIXED") or empty string if
@ -253,7 +253,7 @@ public:
* @param name The name of the entity. If it is a parameter
* entity, the name will begin with '%'.
* @param publicId The declared public identifier of the entity, or
* null if none was declared.
* an empty string if none was declared.
* @param systemId The declared system identifier of the entity.
* @see #internalEntityDecl
* @see basic_DTDHandler#unparsedEntityDecl

6
SAX/ext/LexicalHandler.h
View file

@ -76,9 +76,9 @@ public:
*
* @param name The document type name.
* @param publicId The declared public identifier for the
* external DTD subset, or null if none was declared.
* external DTD subset, or an empty string if none was declared.
* @param systemId The declared system identifier for the
* external DTD subset, or null if none was declared.
* external DTD subset, or an empty string if none was declared.
* @see #endDTD
* @see #startEntity
*/
@ -180,7 +180,7 @@ public:
* nested inside start/endDTD and start/endEntity events (if
* used).</p>
*
* @param ch An holding the comment.
* @param text A string holding the comment.
*/
virtual void comment(const stringT& text) = 0;
}; // class basic_LexicalHandler

8
SAX/helpers/AttributeListImpl.h
View file

@ -127,7 +127,7 @@ public:
*
* @param name The attribute name.
* @param type The attribute type ("NMTOKEN" for an enumeration).
* @param value The attribute value (must not be null).
* @param value The attribute value.
* @see #removeAttribute
* @see basic_DocumentHandler#startElement
*/
@ -196,7 +196,7 @@ public:
* Get the name of an attribute (by position).
*
* @param i The position of the attribute in the list.
* @return The attribute name as a string, or null if there
* @return The attribute name as a string, or an empty string if there
* is no attribute at that position.
* @see basic_AttributeList#getName(int)
*/
@ -213,7 +213,7 @@ public:
* @param i The position of the attribute in the list.
* @return The attribute type as a string ("NMTOKEN" for an
* enumeration, and "CDATA" if no declaration was
* read), or null if there is no attribute at
* read), or an empty string if there is no attribute at
* that position.
* @see basic_AttributeList#getType(int)
*/
@ -228,7 +228,7 @@ public:
* Get the value of an attribute (by position).
*
* @param i The position of the attribute in the list.
* @return The attribute value as a string, or null if
* @return The attribute value as a string, or an empty string if
* there is no attribute at that position.
* @see basic_AttributeList#getValue(int)
*/

20
SAX/helpers/AttributesImpl.h
View file

@ -69,7 +69,7 @@ public:
*
* @param index The attribute's index (zero-based).
* @return The Namespace URI, the empty string if none is
* available, or null if the index is out of range.
* available, or if the index is out of range.
* @see basic_Attributes#getURI
*/
virtual stringT getURI(unsigned int index) const
@ -84,7 +84,7 @@ public:
*
* @param index The attribute's index (zero-based).
* @return The attribute's local name, the empty string if
* none is available, or null if the index if out of range.
* none is available, or if the index if out of range.
* @see basic_Attributes#getLocalName
*/
virtual stringT getLocalName(unsigned int index) const
@ -100,7 +100,7 @@ public:
*
* @param index The attribute's index (zero-based).
* @return The attribute's qualified name, the empty string if
* none is available, or null if the index is out of bounds.
* none is available, or if the index is out of bounds.
* @see basic_Attributes#getQName
*/
virtual stringT getQName(unsigned int index) const
@ -115,8 +115,8 @@ public:
* Return an attribute's type by index.
*
* @param index The attribute's index (zero-based).
* @return The attribute's type, "CDATA" if the type is unknown, or null
* if the index is out of bounds.
* @return The attribute's type, "CDATA" if the type is unknown, or an empty
* empty string if the index is out of bounds.
* @see basic_Attributes#getType(int)
*/
virtual stringT getType(unsigned int index) const
@ -131,7 +131,7 @@ public:
* Return an attribute's value by index.
*
* @param index The attribute's index (zero-based).
* @return The attribute's value or null if the index is out of bounds.
* @return The attribute's value or an empty string if the index is out of bounds.
* @see basic_Attributes#getValue(int)
*/
virtual stringT getValue(unsigned int index) const
@ -191,7 +191,7 @@ public:
* @param uri The Namespace URI, or the empty string for a name
* with no explicit Namespace URI.
* @param localName The local name.
* @return The attribute's type, or null if there is no
* @return The attribute's type, or an empty string if there is no
* matching attribute.
* @see basic_Attributes#getType(const stringT&,const stringT&)
*/
@ -211,7 +211,7 @@ public:
* Look up an attribute's type by qualified (prefixed) name.
*
* @param qName The qualified name.
* @return The attribute's type, or null if there is no
* @return The attribute's type, or an empty string if there is no
* matching attribute.
* @see basic_Attributes#getType(const stringT&)
*/
@ -232,7 +232,7 @@ public:
* @param uri The Namespace URI, or the empty string for a name
* with no explicit Namespace URI.
* @param localName The local name.
* @return The attribute's value, or null if there is no
* @return The attribute's value, or an empty string if there is no
* matching attribute.
* @see basic_Attributes#getValue(const stringT&,const stringT&)
*/
@ -252,7 +252,7 @@ public:
* Look up an attribute's value by qualified (prefixed) name.
*
* @param qName The qualified name.
* @return The attribute's value, or null if there is no
* @return The attribute's value, or an empty string if there is no
* matching attribute.
* @see basic_Attributes#getValue(const stringT&)
*/

44
SAX/helpers/DefaultHandler.h
View file

@ -66,13 +66,13 @@ public:
/**
* Resolve an external entity.
*
* <p>Always return null, so that the parser will use the system
* identifier provided in the XML document. This method implements
* the SAX default behaviour: application writers can override it
* in a subclass to do special translations such as catalog lookups
* or URI redirection.</p>
* <p>Always return a default-constructed <code>InputSourceT</code>, so that
* the parser will use the system identifier provided in the XML document.
* This method implements the SAX default behaviour: application writers can
* override it in a subclass to do special translations such as catalog
* lookups or URI redirection.</p>
*
* @param publicId The public identifer, or null if none is
* @param publicId The public identifer, or an empty string if none is
* available.
* @param systemId The system identifier provided in the XML
* document.
@ -96,7 +96,7 @@ public:
* declared in a document.</p>
*
* @param name The notation name.
* @param publicId The notation public identifier, or null if not
* @param publicId The notation public identifier, or an empty string if not
* available.
* @param systemId The notation system identifier.
* @exception SAXException Any SAX exception, possibly
@ -117,7 +117,7 @@ public:
* declared in a document.</p>
*
* @param name The entity name.
* @param publicId The entity public identifier, or null if not
* @param publicId The entity public identifier, or an empty string if not
* available.
* @param systemId The entity system identifier.
* @param notationName The name of the associated notation.
@ -210,8 +210,15 @@ public:
* each element (such as allocating a new tree node or writing
* output to a file).</p>
*
* @param name The element type name.
* @param attributes The specified or defaulted attributes.
* @param namespaceURI The Namespace URI, or the empty string if the element
* has no Namespace URI or if Namespace processing is not
* being performed.
* @param localName The local name (without prefix), or the empty string if
* Namespace processing is not being performed.
* @param qName The qualified name (with prefix), or the empty string if
* qualified names are not available.
* @param atts The attributes attached to the element. If there are no
* attributes, it shall be an empty Attributes object.
* @exception SAXException Any SAX exception, possibly
* wrapping another exception.
* @see basic_ContentHandler#startElement
@ -226,8 +233,13 @@ public:
* each element (such as finalising a tree node or writing
* output to a file).</p>
*
* @param name The element type name.
* @param attributes The specified or defaulted attributes.
* @param namespaceURI The Namespace URI, or the empty string if the element
* has no Namespace URI or if Namespace processing is not
* being performed.
* @param localName The local name (without prefix), or the empty string if
* Namespace processing is not being performed.
* @param qName The qualified name (with prefix), or the empty string if
* qualified names are not available.
* @exception SAXException Any SAX exception, possibly
* wrapping another exception.
* @see basic_ContentHandler#endElement
@ -244,9 +256,6 @@ public:
* a file).</p>
*
* @param ch The characters.
* @param start The start position in the character array.
* @param length The number of characters to use from the
* character array.
* @exception SAXException Any SAX exception, possibly
* wrapping another exception.
* @see basic_ContentHandler#characters
@ -261,9 +270,6 @@ public:
* it to a file).</p>
*
* @param ch The whitespace characters.
* @param start The start position in the character array.
* @param length The number of characters to use from the
* character array.
* @exception SAXException Any SAX exception, possibly
* wrapping another exception.
* @see basic_ContentHandler#ignorableWhitespace
@ -279,7 +285,7 @@ public:
* invoking other methods.</p>
*
* @param target The processing instruction target.
* @param data The processing instruction data, or null if
* @param data The processing instruction data, or an empty string if
* none is supplied.
* @exception SAXException Any SAX exception, possibly
* wrapping another exception.

8
SAX/helpers/LocatorImpl.h
View file

@ -83,7 +83,7 @@ public:
/**
* Return the saved public identifier.
*
* @return The public identifier as a string, or null if none
* @return The public identifier as a string, or an empty string if none
* is available.
* @see basic_Locator#getPublicId
* @see #setPublicId
@ -92,7 +92,7 @@ public:
/**
* Return the saved system identifier.
*
* @return The system identifier as a string, or null if none
* @return The system identifier as a string, or an empty string if none
* is available.
* @see basic_Locator#getSystemId
* @see #setSystemId
@ -120,7 +120,7 @@ public:
/**
* Set the public identifier for this locator.
*
* @param publicId The new public identifier, or null
* @param publicId The new public identifier, or an empty string
* if none is available.
* @see #getPublicId
*/
@ -128,7 +128,7 @@ public:
/**
* Set the system identifier for this locator.
*
* @param systemId The new system identifier, or null
* @param systemId The new system identifier, or an empty string
* if none is available.
* @see #getSystemId
*/

16
SAX/helpers/NamespaceSupport.h
View file

@ -172,8 +172,7 @@ class basic_NamespaceSupport
* This asymmetry exists to make it easier to look up prefixes
* for attribute names, where the default prefix is not allowed.</p>
*
* @param prefix The prefix to declare, or null for the empty
* string.
* @param prefix The prefix to declare, or the empty string.
* @param uri The Namespace URI to associate with the prefix.
* @return true if the prefix was legal, false otherwise
* @see #processName
@ -206,14 +205,11 @@ class basic_NamespaceSupport
* will not.</p>
*
* @param qName The raw XML 1.0 name to be processed.
* @param parts An array supplied by the caller, capable of
* holding at least three members.
* @param isAttribute A flag indicating whether this is an
* attribute name (true) or an element name (false).
* @return The supplied array holding three internalized strings
* representing the Namespace URI (or empty string), the
* local name, and the raw XML 1.0 name; or null if there
* is an undeclared prefix.
* @return A <code>Parts</code> holding three strings representing the
* Namespace URI (or empty string), the local name, and the raw XML
* 1.0 name.
* @see #declarePrefix
*/
Parts processName(const stringT& qName, bool isAttribute) const
@ -278,10 +274,8 @@ class basic_NamespaceSupport
* method with an argument of "".</p>
*
* @param uri The Namespace URI.
* @param isAttribute true if this prefix is for an attribute
* (and the default Namespace is not allowed).
* @return One of the prefixes currently mapped to the URI supplied,
* or null if none is mapped or if the URI is assigned to
* or an empty string if none is mapped or if the URI is assigned to
* the default Namespace.
* @see #getPrefixes(const stringT&)
* @see #getURI

10
SAX/helpers/ParserAdaptor.h
View file

@ -77,7 +77,7 @@ public:
* namespace-prefixes.</p>
*
* @param name The feature name, as a complete URI.
* @param state The requested feature state.
* @param value The requested feature value.
* @exception SAXNotRecognizedException If the feature
* name is not known.
* @exception SAXNotSupportedException If the feature
@ -178,7 +178,7 @@ public:
/**
* Set the DTD handler.
*
* @param resolver The new DTD handler.
* @param handler The new DTD handler.
* @see basic_XMLReader#setEntityResolver
*/
virtual void setDTDHandler(DTDHandlerT& handler) { dtdHandler_ = &handler; }
@ -193,7 +193,7 @@ public:
/**
* Set the content handler.
*
* @param resolver The new content handler.
* @param handler The new content handler.
* @see basic_XMLReader#setEntityResolver
*/
virtual void setContentHandler(ContentHandlerT& handler) { contentHandler_ = &handler; }
@ -208,7 +208,7 @@ public:
/**
* Set the error handler.
*
* @param resolver The new error handler.
* @param handler The new error handler.
* @see basic_XMLReader#setEntityResolver
*/
virtual void setErrorHandler(ErrorHandler& handler) { errorHandler_ = &handler; }
@ -546,4 +546,4 @@ typedef basic_ParserAdaptor<std::wstring, wchar_t> wParserAdaptor;
} // namespace SAX
#endif
#endif

31
SAX/helpers/XMLFilterImpl.h
View file

@ -94,7 +94,7 @@ public:
* <p>This will always fail if the parent is null.</p>
*
* @param name The feature name.
* @param state The requested feature state.
* @param value The requested feature value.
* @exception SAXNotRecognizedException When the
* XMLReader does not recognize the feature name.
* @exception SAXNotSupportedException When the
@ -148,7 +148,7 @@ public:
/**
* Set the DTD event handler.
*
* @param resolver The new DTD handler.
* @param handler The new DTD handler.
* @see basic_XMLReader#setDTDHandler
*/
virtual void setDTDHandler(DTDHandlerT& handler) { dtdHandler_ = &handler; }
@ -162,7 +162,7 @@ public:
/**
* Set the content event handler.
*
* @param resolver The new content handler.
* @param handler The new content handler.
* @see basic_XMLReader#setContentHandler
*/
virtual void setContentHandler(ContentHandler& handler) { contentHandler_ = &handler; }
@ -176,7 +176,7 @@ public:
/**
* Set the error event handler.
*
* @param handle The new error handler.
* @param handler The new error handler.
* @see basic_XMLReader#setErrorHandler
*/
virtual void setErrorHandler(ErrorHandler& handler) { errorHandler_ = &handler; }
@ -225,9 +225,10 @@ public:
/**
* Filter an external entity resolution.
*
* @param publicId The entity's public identifier, or null.
* @param publicId The entity's public identifier, or an empty string.
* @param systemId The entity's system identifier.
* @return A new InputSource or null for the default.
* @return A new InputSource or a default-constructed
* <code>InputSourceT</code> for the default.
* @see basic_EntityResolver#resolveEntity
*/
virtual InputSourceT resolveEntity(const stringT& publicId, const stringT& systemId)
@ -243,8 +244,8 @@ public:
* Filter a notation declaration event.
*
* @param name The notation name.
* @param publicId The notation's public identifier, or null.
* @param systemId The notation's system identifier, or null.
* @param publicId The notation's public identifier, or an empty string.
* @param systemId The notation's system identifier, or an empty string.
* @see basic_DTDHandler#notationDecl
*/
virtual void notationDecl(const stringT& name,
@ -259,8 +260,8 @@ public:
* Filter an unparsed entity declaration event.
*
* @param name The entity name.
* @param publicId The entity's public identifier, or null.
* @param systemId The entity's system identifier, or null.
* @param publicId The entity's public identifier, or an empty string.
* @param systemId The entity's system identifier, or an empty string.
* @param notationName The name of the associated notation.
* @see basic_DTDHandler#unparsedEntityDecl
*/
@ -338,7 +339,7 @@ public:
/**
* Filter a start element event.
*
* @param uri The element's Namespace URI, or the empty string.
* @param namespaceURI The element's Namespace URI, or the empty string.
* @param localName The element's local name, or the empty string.
* @param qName The element's qualified (prefixed) name, or the empty
* string.
@ -355,7 +356,7 @@ public:
/**
* Filter an end element event.
*
* @param uri The element's Namespace URI, or the empty string.
* @param namespaceURI The element's Namespace URI, or the empty string.
* @param localName The element's local name, or the empty string.
* @param qName The element's qualified (prefixed) name, or the empty
* string.
@ -422,7 +423,7 @@ public:
/**
* Filter a warning event.
*
* @param e The warning as an exception.
* @param exception The warning as an exception.
* @see basic_ErrorHandler#warning
*/
virtual void warning(const SAXException& exception)
@ -434,7 +435,7 @@ public:
/**
* Filter an error event.
*
* @param e The error as an exception.
* @param exception The error as an exception.
* @see basic_ErrorHandler#error
*/
virtual void error(const SAXException& exception)
@ -446,7 +447,7 @@ public:
/**
* Filter a fatal error event.
*
* @param e The error as an exception.
* @param exception The error as an exception.
* @see basic_ErrorHandler#fatalError
*/
virtual void fatalError(const SAXException& exception)