Author: veithen
Date: Fri May 14 19:59:40 2010
New Revision: 944431
URL: http://svn.apache.org/viewvc?rev=944431&view=rev
Log:
Yearning for the day people will learn how to write Javadoc comments that
actually generate human readable Javadoc...
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/XMLStreamReaderUtils.java
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/wrapper/XMLStreamReaderContainer.java
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/XMLStreamReaderUtils.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/XMLStreamReaderUtils.java?rev=944431&r1=944430&r2=944431&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/XMLStreamReaderUtils.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/XMLStreamReaderUtils.java
Fri May 14 19:59:40 2010
@@ -117,8 +117,7 @@ public class XMLStreamReaderUtils {
}
/**
- * getOriginalXMLStreamReader
- * Searches the wrapper and delegate classes to find the original
XMLStreamReader
+ * Searches the wrapper and delegate classes to find the original
{...@link XMLStreamReader}.
* This method should only be used when a consumer of Axiom really needs
to
* access the original stream reader.
* @param parser XMLStreamReader used by Axiom
Modified:
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/wrapper/XMLStreamReaderContainer.java
URL:
http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/wrapper/XMLStreamReaderContainer.java?rev=944431&r1=944430&r2=944431&view=diff
==============================================================================
---
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/wrapper/XMLStreamReaderContainer.java
(original)
+++
webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/util/stax/wrapper/XMLStreamReaderContainer.java
Fri May 14 19:59:40 2010
@@ -21,16 +21,17 @@ package org.apache.axiom.util.stax.wrapp
import javax.xml.stream.XMLStreamReader;
/**
- * Marker interface for Axiom XMLStreamReader classes that
+ * Marker interface for Axiom {...@link XMLStreamReader} classes that
* wrap or delegate to another (parent) XMLStreamReader.
- *
+ * <p>
* The marker interface is necessary so that consumers
* can access the original parser.
- * @see XMLStreamReaderUtils
+ * <p>
+ * Note that the only the {...@link #getParent()} method is applicable.
+ * Please do not add a <code>setParent()</code> method since that would
+ * violate the immutable characteristic of the {...@link
XMLStreamReaderWrapper}.
*
- * Note that the only the getParent() method is applicable.
- * Please do not add a setParent() method since that would
- * violate the immutable characteristic of the XMLStreamReaderWrapper
+ * @see org.apache.axiom.util.stax.XMLStreamReaderUtils
*/
public interface XMLStreamReaderContainer {
XMLStreamReader getParent();
