From 4c77497f5b84a5ced7547155272682dc52746637 Mon Sep 17 00:00:00 2001
From: Tinny Ng <tng@apache.org>
Date: Fri, 31 May 2002 15:14:17 +0000
Subject: [PATCH] Fix doxygen documentation.
git-svn-id: https://svn.apache.org/repos/asf/xerces/c/trunk@173776 13f79535-47bb-0310-9956-ffa450edef68
---
src/xercesc/dom/deprecated/DOMParser.hpp | 4 +++
src/xercesc/framework/XMLEntityHandler.hpp | 42 +++++++++++++---------
src/xercesc/parsers/DOMBuilderImpl.hpp | 6 +++-
src/xercesc/parsers/SAX2XMLReaderImpl.hpp | 7 ++++
src/xercesc/parsers/SAXParser.hpp | 7 ++++
src/xercesc/parsers/XercesDOMParser.hpp | 6 +++-
6 files changed, 54 insertions(+), 18 deletions(-)
diff --git a/src/xercesc/dom/deprecated/DOMParser.hpp b/src/xercesc/dom/deprecated/DOMParser.hpp
index 5001b4883..a12c5cfdb 100644
--- a/src/xercesc/dom/deprecated/DOMParser.hpp
+++ b/src/xercesc/dom/deprecated/DOMParser.hpp
@@ -989,9 +989,13 @@ public :
* public id of the entity just parsed.
* @param systemId A const pointer to a Unicode string representing the
* system id of the entity just parsed.
+ * @param baseURI A const pointer to a Unicode string representing the
+ * base URI of the entity just parsed,
+ * or <code>null</code> if there is no base URI.
* @return The value returned by the user installed resolveEntity
* method or NULL otherwise to indicate no processing was done.
* @see EntityResolver
+ * @see XMLEntityHandler
*/
virtual InputSource* resolveEntity
(
diff --git a/src/xercesc/framework/XMLEntityHandler.hpp b/src/xercesc/framework/XMLEntityHandler.hpp
index 94f057e89..291850fa4 100644
--- a/src/xercesc/framework/XMLEntityHandler.hpp
+++ b/src/xercesc/framework/XMLEntityHandler.hpp
@@ -1,37 +1,37 @@
/*
* The Apache Software License, Version 1.1
- *
+ *
* Copyright (c) 1999-2000 The Apache Software Foundation. All rights
* reserved.
- *
+ *
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
- *
+ *
* 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
+ * notice, this list of conditions and the following disclaimer.
+ *
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
- *
+ *
* 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
+ * if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
- *
+ *
* 4. The names "Xerces" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
- * software without prior written permission. For written
+ * software without prior written permission. For written
* permission, please contact apache\@apache.org.
- *
+ *
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
- *
+ *
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@@ -45,7 +45,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
- *
+ *
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation, and was
* originally based on software copyright (c) 1999, International
@@ -56,6 +56,9 @@
/*
* $Log$
+ * Revision 1.3 2002/05/31 15:14:07 tng
+ * Fix doxygen documentation.
+ *
* Revision 1.2 2002/05/29 21:47:08 knoaman
* DOM L3 LS: DOMInputSource, DOMEntityResolver, DOMImplementationLS and DOMBuilder
*
@@ -120,7 +123,7 @@ public:
/** @name Destructor */
//@{
-
+
/**
* Default destructor
*/
@@ -173,8 +176,15 @@ public:
* application specific entity resolution. This method is defined
* by SAX 1.0 API.
*
- * @param systemId The system id of the external entity reference.
- * @param publicId The public id of the external entity reference.
+ * @param publicId A const pointer to a Unicode string representing the
+ * public id of the entity just parsed.
+ * @param systemId A const pointer to a Unicode string representing the
+ * system id of the entity just parsed.
+ * @param baseURI A const pointer to a Unicode string representing the
+ * base URI of the entity just parsed,
+ * or <code>null</code> if there is no base URI.
+ * @return The value returned by the SAX resolveEntity method or
+ * NULL otherwise to indicate no processing was done.
*/
virtual InputSource* resolveEntity
(
@@ -199,7 +209,7 @@ protected :
// -----------------------------------------------------------------------
/** @name Constructor */
//@{
-
+
/**
* Protected default constructor
*/
diff --git a/src/xercesc/parsers/DOMBuilderImpl.hpp b/src/xercesc/parsers/DOMBuilderImpl.hpp
index f6181d1f1..653a0224d 100644
--- a/src/xercesc/parsers/DOMBuilderImpl.hpp
+++ b/src/xercesc/parsers/DOMBuilderImpl.hpp
@@ -290,7 +290,7 @@ public :
* @return The current state of the feature (true or false)
* @exception DOMException
* NOT_FOUND_ERR: Raised when the DOMBuilder does not recognize
- * the feature name.
+ * the feature name.
*
* @see #getFeature
* @see #canSetFeature
@@ -559,9 +559,13 @@ public :
* public id of the entity just parsed.
* @param systemId A const pointer to a Unicode string representing the
* system id of the entity just parsed.
+ * @param baseURI A const pointer to a Unicode string representing the
+ * base URI of the entity just parsed,
+ * or <code>null</code> if there is no base URI.
* @return The value returned by the user installed resolveEntity
* method or NULL otherwise to indicate no processing was done.
* @see DOMEntityResolver
+ * @see XMLEntityHandler
*/
virtual InputSource* resolveEntity
(
diff --git a/src/xercesc/parsers/SAX2XMLReaderImpl.hpp b/src/xercesc/parsers/SAX2XMLReaderImpl.hpp
index 06929d2a1..b96ed3fe4 100644
--- a/src/xercesc/parsers/SAX2XMLReaderImpl.hpp
+++ b/src/xercesc/parsers/SAX2XMLReaderImpl.hpp
@@ -56,6 +56,9 @@
/*
* $Log$
+ * Revision 1.8 2002/05/31 15:13:53 tng
+ * Fix doxygen documentation.
+ *
* Revision 1.7 2002/05/30 16:39:06 knoaman
* DOM L3 LS.
*
@@ -881,9 +884,13 @@ public :
* public id of the entity just parsed.
* @param systemId A const pointer to a Unicode string representing the
* system id of the entity just parsed.
+ * @param baseURI A const pointer to a Unicode string representing the
+ * base URI of the entity just parsed,
+ * or <code>null</code> if there is no base URI.
* @return The value returned by the SAX resolveEntity method or
* NULL otherwise to indicate no processing was done.
* @see EntityResolver
+ * @see XMLEntityHandler
*/
virtual InputSource* resolveEntity
(
diff --git a/src/xercesc/parsers/SAXParser.hpp b/src/xercesc/parsers/SAXParser.hpp
index c6a981718..4f4e05192 100644
--- a/src/xercesc/parsers/SAXParser.hpp
+++ b/src/xercesc/parsers/SAXParser.hpp
@@ -56,6 +56,9 @@
/*
* $Log$
+ * Revision 1.8 2002/05/31 15:13:53 tng
+ * Fix doxygen documentation.
+ *
* Revision 1.7 2002/05/30 16:39:06 knoaman
* DOM L3 LS.
*
@@ -1522,9 +1525,13 @@ public :
* public id of the entity just parsed.
* @param systemId A const pointer to a Unicode string representing the
* system id of the entity just parsed.
+ * @param baseURI A const pointer to a Unicode string representing the
+ * base URI of the entity just parsed,
+ * or <code>null</code> if there is no base URI.
* @return The value returned by the SAX resolveEntity method or
* NULL otherwise to indicate no processing was done.
* @see EntityResolver
+ * @see XMLEntityHandler
*/
virtual InputSource* resolveEntity
(
diff --git a/src/xercesc/parsers/XercesDOMParser.hpp b/src/xercesc/parsers/XercesDOMParser.hpp
index 8f678b386..d87d34609 100644
--- a/src/xercesc/parsers/XercesDOMParser.hpp
+++ b/src/xercesc/parsers/XercesDOMParser.hpp
@@ -312,9 +312,13 @@ public :
* public id of the entity just parsed.
* @param systemId A const pointer to a Unicode string representing the
* system id of the entity just parsed.
+ * @param baseURI A const pointer to a Unicode string representing the
+ * base URI of the entity just parsed,
+ * or <code>null</code> if there is no base URI.
* @return The value returned by the user installed resolveEntity
* method or NULL otherwise to indicate no processing was done.
- * @see EntityResolver
+ * @see DOMEntityResolver
+ * @see XMLEntityHandler
*/
virtual InputSource* resolveEntity
(
--
GitLab