cargilld 2004/12/21 08:02:51
Modified: c/src/xercesc/dom DOMDocument.hpp DOMNode.hpp
DOMXPathResult.hpp
c/src/xercesc/framework XMLGrammarPool.hpp
c/src/xercesc/framework/psvi PSVIItem.hpp
c/src/xercesc/util XMLResourceIdentifier.hpp XMLString.hpp
Log:
Attempt to fix various apidoc problems.
Revision Changes Path
1.21 +3 -1 xml-xerces/c/src/xercesc/dom/DOMDocument.hpp
Index: DOMDocument.hpp
===================================================================
RCS file: /home/cvs/xml-xerces/c/src/xercesc/dom/DOMDocument.hpp,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
--- DOMDocument.hpp 2 Nov 2004 21:16:48 -0000 1.20
+++ DOMDocument.hpp 21 Dec 2004 16:02:51 -0000 1.21
@@ -809,6 +809,8 @@
*/
virtual DOMConfiguration* getDOMConfiguration() const = 0;
+ //@}
+
//
-----------------------------------------------------------------------
// Non-standard extension
//
-----------------------------------------------------------------------
1.18 +11 -18 xml-xerces/c/src/xercesc/dom/DOMNode.hpp
Index: DOMNode.hpp
===================================================================
RCS file: /home/cvs/xml-xerces/c/src/xercesc/dom/DOMNode.hpp,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- DOMNode.hpp 8 Sep 2004 13:55:39 -0000 1.17
+++ DOMNode.hpp 21 Dec 2004 16:02:51 -0000 1.18
@@ -60,43 +60,38 @@
* </tr>
* <tr>
* <td valign='top' rowspan='1' colspan='1'>DOMAttr</td>
- * <td valign='top' rowspan='1' colspan='1'>name of
- * attribute</td>
+ * <td valign='top' rowspan='1' colspan='1'>name of attribute</td>
* <td valign='top' rowspan='1' colspan='1'>value of attribute</td>
* <td valign='top' rowspan='1' colspan='1'>null</td>
* </tr>
* <tr>
* <td valign='top' rowspan='1' colspan='1'>DOMCDATASection</td>
- * <td valign='top' rowspan='1'
colspan='1'><code>"#cdata-section"</code></td>
- * <td valign='top' rowspan='1' colspan='1'>
- * content of the CDATA Section</td>
+ * <td valign='top' rowspan='1' colspan='1'>"#cdata-section"</td>
+ * <td valign='top' rowspan='1' colspan='1'>content of the CDATA Section</td>
* <td valign='top' rowspan='1' colspan='1'>null</td>
* </tr>
* <tr>
* <td valign='top' rowspan='1' colspan='1'>DOMComment</td>
- * <td valign='top' rowspan='1' colspan='1'><code>"#comment"</code></td>
- * <td valign='top' rowspan='1' colspan='1'>content of
- * the comment</td>
+ * <td valign='top' rowspan='1' colspan='1'>"#comment"</td>
+ * <td valign='top' rowspan='1' colspan='1'>content of the comment</td>
* <td valign='top' rowspan='1' colspan='1'>null</td>
* </tr>
* <tr>
* <td valign='top' rowspan='1' colspan='1'>DOMDocument</td>
- * <td valign='top' rowspan='1' colspan='1'><code>"#document"</code></td>
+ * <td valign='top' rowspan='1' colspan='1'>"#document"</td>
* <td valign='top' rowspan='1' colspan='1'>null</td>
* <td valign='top' rowspan='1' colspan='1'>null</td>
* </tr>
* <tr>
* <td valign='top' rowspan='1' colspan='1'>DOMDocumentFragment</td>
- * <td valign='top' rowspan='1' colspan='1'>
- * <code>"#document-fragment"</code></td>
+ * <td valign='top' rowspan='1'
colspan='1'>"#document-fragment"</td>
* <td valign='top' rowspan='1' colspan='1'>null</td>
* <td valign='top' rowspan='1' colspan='1'>null</td>
* </tr>
* <tr>
* <td valign='top' rowspan='1' colspan='1'>DOMDocumentType</td>
* <td valign='top' rowspan='1' colspan='1'>document type name</td>
- * <td valign='top' rowspan='1' colspan='1'>
- * null</td>
+ * <td valign='top' rowspan='1' colspan='1'>null</td>
* <td valign='top' rowspan='1' colspan='1'>null</td>
* </tr>
* <tr>
@@ -121,8 +116,7 @@
* <td valign='top' rowspan='1' colspan='1'>DOMNotation</td>
* <td valign='top' rowspan='1' colspan='1'>notation name</td>
* <td valign='top' rowspan='1' colspan='1'>null</td>
- * <td valign='top' rowspan='1' colspan='1'>
- * null</td>
+ * <td valign='top' rowspan='1' colspan='1'>null</td>
* </tr>
* <tr>
* <td valign='top' rowspan='1' colspan='1'>DOMProcessingInstruction</td>
@@ -132,8 +126,7 @@
* </tr>
* <tr>
* <td valign='top' rowspan='1' colspan='1'>DOMText</td>
- * <td valign='top' rowspan='1' colspan='1'>
- * <code>"#text"</code></td>
+ * <td valign='top' rowspan='1' colspan='1'>"#text"</td>
* <td valign='top' rowspan='1' colspan='1'>content of the text node</td>
* <td valign='top' rowspan='1' colspan='1'>null</td>
* </tr>
1.3 +21 -20 xml-xerces/c/src/xercesc/dom/DOMXPathResult.hpp
Index: DOMXPathResult.hpp
===================================================================
RCS file: /home/cvs/xml-xerces/c/src/xercesc/dom/DOMXPathResult.hpp,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DOMXPathResult.hpp 8 Sep 2004 13:55:39 -0000 1.2
+++ DOMXPathResult.hpp 21 Dec 2004 16:02:51 -0000 1.3
@@ -73,16 +73,17 @@
//
-----------------------------------------------------------------------
/** @name Public Contants */
//@{
- /** ANY_TYPE
- * This code does not represent a specific type. An evaluation of an
XPath
+ /**
+ * <p>ANY_TYPE
+ * <br>This code does not represent a specific type. An evaluation of an
XPath
* expression will never produce this type. If this type is requested,
then
* the evaluation returns whatever type naturally results from
evaluation
* of the expression.
* If the natural result is a node set when ANY_TYPE was requested, then
* UNORDERED_NODE_ITERATOR_TYPE is always the resulting type. Any other
* representation of a node set must be explicitly requested.
- * ANY_UNORDERED_NODE_TYPE
- * The result is a node set as defined by [XPath 1.0] and will be
accessed
+ * <p>ANY_UNORDERED_NODE_TYPE
+ * <br>The result is a node set as defined by [XPath 1.0] and will be
accessed
* as a single node, which may be nullif the node set is empty. Document
* modification does not invalidate the node, but may mean that the
result
* node no longer corresponds to the current document. This is a
convenience
@@ -90,12 +91,12 @@
* in the resulting set has been found.
* If there is more than one node in the actual result, the single node
* returned might not be the first in document order.
- * BOOLEAN_TYPE
- * The result is a boolean as defined by [XPath 1.0]. Document
modification
+ * <p>BOOLEAN_TYPE
+ * <br>The result is a boolean as defined by [XPath 1.0]. Document
modification
* does not invalidate the boolean, but may mean that reevaluation would
not
* yield the same boolean.
- * FIRST_ORDERED_NODE_TYPE
- * The result is a node set as defined by [XPath 1.0] and will be
accessed
+ * <p>FIRST_ORDERED_NODE_TYPE
+ * <br>The result is a node set as defined by [XPath 1.0] and will be
accessed
* as a single node, which may be null if the node set is empty.
Document
* modification does not invalidate the node, but may mean that the
result
* node no longer corresponds to the current document. This is a
convenience
@@ -103,30 +104,30 @@
* node in document order of the resulting set has been found.
* If there are more than one node in the actual result, the single node
* returned will be the first in document order.
- * NUMBER_TYPE
- * The result is a number as defined by [XPath 1.0]. Document
modification does
+ * <p>NUMBER_TYPE
+ * <br>The result is a number as defined by [XPath 1.0]. Document
modification does
* not invalidate the number, but may mean that reevaluation would not
yield the
* same number.
- * ORDERED_NODE_ITERATOR_TYPE
- * The result is a node set as defined by [XPath 1.0] that will be
accessed
+ * <p>ORDERED_NODE_ITERATOR_TYPE
+ * <br>The result is a node set as defined by [XPath 1.0] that will be
accessed
* iteratively, which will produce document-ordered nodes. Document
modification
* invalidates the iteration.
- * ORDERED_NODE_SNAPSHOT_TYPE
- * The result is a node set as defined by [XPath 1.0] that will be
accessed as a
+ * <p>ORDERED_NODE_SNAPSHOT_TYPE
+ * <br>The result is a node set as defined by [XPath 1.0] that will be
accessed as a
* snapshot list of nodes that will be in original document order.
Document
* modification does not invalidate the snapshot but may mean that
reevaluation would
* not yield the same snapshot and nodes in the snapshot may have been
altered, moved,
* or removed from the document.
- * STRING_TYPE
- * The result is a string as defined by [XPath 1.0]. Document
modification does not
+ * <p>STRING_TYPE
+ * <br>The result is a string as defined by [XPath 1.0]. Document
modification does not
* invalidate the string, but may mean that the string no longer
corresponds to the
* current document.
- * UNORDERED_NODE_ITERATOR_TYPE
- * The result is a node set as defined by [XPath 1.0] that will be
accessed iteratively,
+ * <p>UNORDERED_NODE_ITERATOR_TYPE
+ * <br>The result is a node set as defined by [XPath 1.0] that will be
accessed iteratively,
* which may not produce nodes in a particular order. Document
modification invalidates the iteration.
* This is the default type returned if the result is a node set and
ANY_TYPE is requested.
- * UNORDERED_NODE_SNAPSHOT_TYPE
- * The result is a node set as defined by [XPath 1.0] that will be
accessed as a
+ * <p>UNORDERED_NODE_SNAPSHOT_TYPE
+ * <br>The result is a node set as defined by [XPath 1.0] that will be
accessed as a
* snapshot list of nodes that may not be in a particular order.
Document modification
* does not invalidate the snapshot but may mean that reevaluation would
not yield the same
* snapshot and nodes in the snapshot may have been altered, moved, or
removed from the document.
1.15 +7 -4 xml-xerces/c/src/xercesc/framework/XMLGrammarPool.hpp
Index: XMLGrammarPool.hpp
===================================================================
RCS file: /home/cvs/xml-xerces/c/src/xercesc/framework/XMLGrammarPool.hpp,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- XMLGrammarPool.hpp 29 Sep 2004 19:27:07 -0000 1.14
+++ XMLGrammarPool.hpp 21 Dec 2004 16:02:51 -0000 1.15
@@ -16,6 +16,9 @@
/*
* $Log$
+ * Revision 1.15 2004/12/21 16:02:51 cargilld
+ * Attempt to fix various apidoc problems.
+ *
* Revision 1.14 2004/09/29 19:27:07 cargilld
* Fix for Jira-1217: fixing problems with getXSModel.
*
@@ -113,7 +116,7 @@
* it should return false; otherwise, it should return true, so that
* the caller knows whether the grammar has been adopted.
*
- * @param gramToCache: the Grammar to be cached in the grammar pool
+ * @param gramToCache the Grammar to be cached in the grammar pool
* @return true if the grammar pool has elected to cache the grammar
(in which case
* it is assumed to have adopted it); false if it does not cache it
*
@@ -123,7 +126,7 @@
/**
* retrieveGrammar
*
- * @param gramDesc: the Grammar Description used to search for grammar
+ * @param gramDesc the Grammar Description used to search for grammar
* cached in the grammar pool
*
*/
@@ -135,7 +138,7 @@
*
* grammar removed from the grammar pool and owned by the caller
*
- * @param nameSpaceKey: Key used to search for grammar in the grammar
pool
+ * @param nameSpaceKey Key used to search for grammar in the grammar
pool
* @return the grammar that was removed from the pool (0 if none)
*/
virtual Grammar* orphanGrammar(const XMLCh* const nameSpaceKey) =
0;
1.11 +7 -4 xml-xerces/c/src/xercesc/framework/psvi/PSVIItem.hpp
Index: PSVIItem.hpp
===================================================================
RCS file: /home/cvs/xml-xerces/c/src/xercesc/framework/psvi/PSVIItem.hpp,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- PSVIItem.hpp 13 Sep 2004 21:22:42 -0000 1.10
+++ PSVIItem.hpp 21 Dec 2004 16:02:51 -0000 1.11
@@ -16,6 +16,9 @@
/*
* $Log$
+ * Revision 1.11 2004/12/21 16:02:51 cargilld
+ * Attempt to fix various apidoc problems.
+ *
* Revision 1.10 2004/09/13 21:22:42 peiyongz
* new method: getActualValue()
*
@@ -241,10 +244,10 @@
void setValidity(PSVIItem::VALIDITY_STATE validity);
/** reset the object
- * @param validationContext: corresponds to schema validation context
property
- * @param normalizedValue: corresponds to schema normalized value
property
- * @param validityState: state of item's validity
- * @param assessmentType: type of assessment carried out on item
+ * @param validationContext corresponds to schema validation context
property
+ * @param normalizedValue corresponds to schema normalized value
property
+ * @param validityState state of item's validity
+ * @param assessmentType type of assessment carried out on item
*/
void reset(
const XMLCh* const validationContext
1.9 +7 -2 xml-xerces/c/src/xercesc/util/XMLResourceIdentifier.hpp
Index: XMLResourceIdentifier.hpp
===================================================================
RCS file: /home/cvs/xml-xerces/c/src/xercesc/util/XMLResourceIdentifier.hpp,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- XMLResourceIdentifier.hpp 3 Dec 2004 19:40:32 -0000 1.8
+++ XMLResourceIdentifier.hpp 21 Dec 2004 16:02:51 -0000 1.9
@@ -16,6 +16,9 @@
/*
* $Log$
+ * Revision 1.9 2004/12/21 16:02:51 cargilld
+ * Attempt to fix various apidoc problems.
+ *
* Revision 1.8 2004/12/03 19:40:32 cargilld
* Change call to resolveEntity to pass in public id so that only one call
to resolveEntity is needed (a follow-on to Alberto's fix).
*
@@ -121,14 +124,14 @@
{
public:
+ //@{
enum ResourceIdentifierType {
SchemaGrammar = 0,
SchemaImport,
SchemaInclude,
SchemaRedefine ,
ExternalEntity,
- UnKnown = 255
- //@{
+ UnKnown = 255
};
/** @name Constructors and Destructor */
@@ -157,6 +160,8 @@
const XMLCh* getSchemaLocation() const;
const XMLCh* getBaseURI() const;
const XMLCh* getNameSpace() const;
+
+ //@}
private :
1.31 +4 -0 xml-xerces/c/src/xercesc/util/XMLString.hpp
Index: XMLString.hpp
===================================================================
RCS file: /home/cvs/xml-xerces/c/src/xercesc/util/XMLString.hpp,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -r1.30 -r1.31
--- XMLString.hpp 14 Dec 2004 02:09:20 -0000 1.30
+++ XMLString.hpp 21 Dec 2004 16:02:51 -0000 1.31
@@ -16,6 +16,9 @@
/*
* $Log$
+ * Revision 1.31 2004/12/21 16:02:51 cargilld
+ * Attempt to fix various apidoc problems.
+ *
* Revision 1.30 2004/12/14 02:09:20 cargilld
* Performance update from Christian Will.
*
@@ -1558,6 +1561,7 @@
* The implementation will call MemoryManager::deallocate and then turn
the string to a null pointer.
*
* @param buf The string to be deleted and become a null pointer.
+ * @param manager The MemoryManager to use to allocate objects
*/
static void release
(
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
