javadoc minor fixes
"Pawel S. Veselov" <[email protected]>
| Newsgroups | gmane.text.xml.xmlpull.devel |
|---|---|
| Message-ID | <Pine.GSO.4.50.0301301138000.1295-200000@druid> |
Hi !
I am recently using xml pull APIs, and I was compiling
them as a part of one of the projects, and noticed
that javadoc throws some warning messages. And they
kind of were freaking me out, so I made this small patch
to fix the comments in the API, hoping you may find it
useful, here it is.
Thanks,
Pawel.
Bye.
--
Pawel S. Veselov (MTS, Service Provisioning and OMA) __ __(O) _ __
e-mail: [email protected] \ V /| || ' \
HomePage: http://manticore.2y.net \_/ |_||_|_|_|
To unsubscribe from this group, send an email to:
[email protected]
Your use of Yahoo! Groups is subject to http://docs.yahoo.com/info/terms/
xmlpull.docs.diff
(text/plain, 4.3 KB)
===== XmlPullParser.java 1.1 vs edited =====
--- 1.1/XmlPullParser.java Mon Dec 23 11:01:38 2002
+++ edited/XmlPullParser.java Thu Jan 30 11:03:39 2003
@@ -1019,7 +1019,8 @@
/**
* Test if the current event is of the given type and if the
- * namespace and name do match. null will match any namespace
+ * namespace and name do match.
+ * null will match any namespace
* and any name. If the test is not passed, an exception is
* thrown. The exception text indicates the parser position,
* the expected event and the current event that is not meeting the
@@ -1028,8 +1029,8 @@
* <p>Essentially it does this
* <pre>
* if (type != getEventType()
- * || (namespace != null && !namespace.equals( getNamespace () ) )
- * || (name != null && !name.equals( getName() ) ) )
+ * || (namespace != null && !namespace.equals( getNamespace () ) )
+ * || (name != null && !name.equals( getName() ) ) )
* throw new XmlPullParserException( "expected "+ TYPES[ type ]+getPositionDescription());
* </pre>
*/
@@ -1043,8 +1044,8 @@
*
* <p>The motivation for this function is to allow to parse consistently both
* empty elements and elements that has non empty content, for example for input: <ol>
- * <li><tag>foo</tag>
- * <li><tag></tag> (which is equivalent to <tag/>) </ol>
+ * <li><tag>foo</tag>
+ * <li><tag>lt;/tag> (which is equivalent to <tag/> </ol>
* both input can be parsed with the same code:
* <pre>
* p.nextTag()
@@ -1089,10 +1090,10 @@
* <p>essentially it does this
* <pre>
* int eventType = next();
- * if(eventType == TEXT && isWhitespace()) { // skip whitespace
+ * if(eventType == TEXT && isWhitespace()) { // skip whitespace
* eventType = next();
* }
- * if (eventType != START_TAG && eventType != END_TAG) {
+ * if (eventType != START_TAG && eventType != END_TAG) {
* throw new XmlPullParserException("expected start or end tag", this, null);
* }
* return eventType;
===== XmlSerializer.java 1.1 vs edited =====
--- 1.1/XmlSerializer.java Thu Jan 30 02:57:53 2003
+++ edited/XmlSerializer.java Thu Jan 30 11:34:27 2003
@@ -81,7 +81,7 @@
* Look up the value of a property.
*
* The property name is any fully-qualified URI. I
- * <p><strong>NOTE:</strong> unknown properties are <string>always</strong> returned as null
+ * <p><strong>NOTE:</strong> unknown properties are <strong>always</strong> returned as null
*
* @param name The name of property to be retrieved.
* @return The value of named property.
@@ -96,14 +96,14 @@
throws IOException, IllegalArgumentException, IllegalStateException;
/**
- * Set the output to the given writer;
+ * Set the output to the given writer.
* <p><b>WARNING</b> no information about encoding is available!
*/
public void setOutput (Writer writer)
throws IOException, IllegalArgumentException, IllegalStateException;
/**
- * Write <?xml declaration with encoding (if encoding not null)
+ * Write <?xml declaration with encoding (if encoding not null)
* and standalone flag (if standalone not null)
* This method can only be called just after setOutput.
*/
@@ -134,8 +134,8 @@
* <a href="http://www.w3.org/XML/xml-names-19990114-errata#NE05">Namespaces in XML Errata</a>.
* <p><b>NOTE:</b> to set default namespace use as prefix empty string.
*
- * @argument prefix must be not null (or IllegalArgumentException is thrown)
- * @argument namespace must be not null
+ * @param prefix must be not null (or IllegalArgumentException is thrown)
+ * @param namespace must be not null
*/
public void setPrefix (String prefix, String namespace)
throws IOException, IllegalArgumentException, IllegalStateException;
@@ -164,7 +164,7 @@
*
* <pre>
* <!-- outside --> 0
- * <root> 1
+ * <root> 1
* sometext 1
* <foobar> 2
* </foobar> 2