mrglavas 2003/11/14 08:54:05
Modified: java/src/org/apache/xerces/xni/grammars
XMLSchemaDescription.java XMLGrammarPool.java
XMLDTDDescription.java Grammar.java
XMLGrammarDescription.java
java/src/org/apache/xerces/xni XMLResourceIdentifier.java
Log:
Fixing XNI Javadocs.
Documentation was missing in many classes.
The reason why some of the docs were missing
is because the intended javadoc is either being
wrapped in C++ style comments // or is missing
the leading /**, and there's also few places with
unintended markup that was meant to be just
character data.
Revision Changes Path
1.2 +5 -5
xml-xerces/java/src/org/apache/xerces/xni/grammars/XMLSchemaDescription.java
Index: XMLSchemaDescription.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/xni/grammars/XMLSchemaDescription.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XMLSchemaDescription.java 7 Jan 2003 22:46:15 -0000 1.1
+++ XMLSchemaDescription.java 14 Nov 2003 16:54:05 -0000 1.2
@@ -60,7 +60,7 @@
import org.apache.xerces.xni.QName;
import org.apache.xerces.xni.XMLAttributes;
-/*
+/**
* All information specific to XML Schema grammars.
*
* @author Sandy Gao, IBM
@@ -71,17 +71,17 @@
// used to indicate what triggered the call
/**
- * Indicate that the current schema document is <include>d by another
+ * Indicate that the current schema document is <include>d by another
* schema document.
*/
public final static short CONTEXT_INCLUDE = 0;
/**
- * Indicate that the current schema document is <redefine>d by another
+ * Indicate that the current schema document is <redefine>d by another
* schema document.
*/
public final static short CONTEXT_REDEFINE = 1;
/**
- * Indicate that the current schema document is <import>ed by another
+ * Indicate that the current schema document is <import>ed by another
* schema document.
*/
public final static short CONTEXT_IMPORT = 2;
1.3 +35 -29
xml-xerces/java/src/org/apache/xerces/xni/grammars/XMLGrammarPool.java
Index: XMLGrammarPool.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/xni/grammars/XMLGrammarPool.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- XMLGrammarPool.java 16 May 2002 19:56:09 -0000 1.2
+++ XMLGrammarPool.java 14 Nov 2003 16:54:05 -0000 1.3
@@ -56,7 +56,7 @@
*/
package org.apache.xerces.xni.grammars;
-/*
+/**
* <p> This interface specifies how the parser and the application
* interact with respect to Grammar objects that the application
* possesses--either by having precompiled them or by having stored them
@@ -88,49 +88,55 @@
// grammars, so we have a parameter "grammarType" for each of the
// methods. </p>
- // <p> retrieve the initial known set of grammars. this method is
- // called by a validator before the validation starts. the application
- // can provide an initial set of grammars available to the current
- // validation attempt. </p>
- // @param grammarType the type of the grammar, from the
- // <code>org.apache.xerces.xni.grammars.Grammar</code> interface.
- // @return the set of grammars the validator may put in its "bucket"
+ /**
+ * <p> retrieve the initial known set of grammars. this method is
+ * called by a validator before the validation starts. the application
+ * can provide an initial set of grammars available to the current
+ * validation attempt. </p>
+ * @param grammarType the type of the grammar, from the
+ * <code>org.apache.xerces.xni.grammars.Grammar</code> interface.
+ * @return the set of grammars the validator may put in its "bucket"
+ */
public Grammar[] retrieveInitialGrammarSet(String grammarType);
- // <p>return the final set of grammars that the validator ended up
- // with.
- // This method is called after the
- // validation finishes. The application may then choose to cache some
- // of the returned grammars. </p>
- // @param grammarType the type of the grammars being returned;
- // @param grammars an array containing the set of grammars being
- // returned; order is not significant.
+ /**
+ * <p>return the final set of grammars that the validator ended up
+ * with.
+ * This method is called after the
+ * validation finishes. The application may then choose to cache some
+ * of the returned grammars. </p>
+ * @param grammarType the type of the grammars being returned;
+ * @param grammars an array containing the set of grammars being
+ * returned; order is not significant.
+ */
public void cacheGrammars(String grammarType, Grammar[] grammars);
- // <p> This method requests that the application retrieve a grammar
- // corresponding to the given GrammarIdentifier from its cache.
- // If it cannot do so it must return null; the parser will then
- // call the EntityResolver. <strong>An application must not call its
- // EntityResolver itself from this method; this may result in infinite
- // recursions.</strong>
- // @param desc The description of the Grammar being requested.
- // @return the Grammar corresponding to this description or null if
- // no such Grammar is known.
+ /**
+ * <p> This method requests that the application retrieve a grammar
+ * corresponding to the given GrammarIdentifier from its cache.
+ * If it cannot do so it must return null; the parser will then
+ * call the EntityResolver. <strong>An application must not call its
+ * EntityResolver itself from this method; this may result in infinite
+ * recursions.</strong>
+ * @param desc The description of the Grammar being requested.
+ * @return the Grammar corresponding to this description or null if
+ * no such Grammar is known.
+ */
public Grammar retrieveGrammar(XMLGrammarDescription desc);
- /*
+ /**
* Causes the XMLGrammarPool not to store any grammars when
* the cacheGrammars(String, Grammar[[]) method is called.
*/
public void lockPool();
- /*
+ /**
* Allows the XMLGrammarPool to store grammars when its cacheGrammars(String,
Grammar[])
* method is called. This is the default state of the object.
*/
public void unlockPool();
- /*
+ /**
* Removes all grammars from the pool.
*/
public void clear();
1.2 +2 -2
xml-xerces/java/src/org/apache/xerces/xni/grammars/XMLDTDDescription.java
Index: XMLDTDDescription.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/xni/grammars/XMLDTDDescription.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- XMLDTDDescription.java 7 Jan 2003 22:46:15 -0000 1.1
+++ XMLDTDDescription.java 14 Nov 2003 16:54:05 -0000 1.2
@@ -57,7 +57,7 @@
package org.apache.xerces.xni.grammars;
-/*
+/**
* All information specific to DTD grammars.
*
* @author Sandy Gao, IBM
1.5 +5 -3 xml-xerces/java/src/org/apache/xerces/xni/grammars/Grammar.java
Index: Grammar.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/xerces/xni/grammars/Grammar.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Grammar.java 27 May 2002 23:00:25 -0000 1.4
+++ Grammar.java 14 Nov 2003 16:54:05 -0000 1.5
@@ -85,8 +85,10 @@
public interface Grammar {
- // get the <code>XMLGrammarDescription</code> associated with this
- // object
+ /**
+ * get the <code>XMLGrammarDescription</code> associated with this
+ * object
+ */
public XMLGrammarDescription getGrammarDescription ();
} // interface Grammar
1.6 +2 -2
xml-xerces/java/src/org/apache/xerces/xni/grammars/XMLGrammarDescription.java
Index: XMLGrammarDescription.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/xni/grammars/XMLGrammarDescription.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- XMLGrammarDescription.java 7 Jan 2003 22:46:15 -0000 1.5
+++ XMLGrammarDescription.java 14 Nov 2003 16:54:05 -0000 1.6
@@ -59,7 +59,7 @@
import org.apache.xerces.xni.XMLResourceIdentifier;
-/*
+/**
* <p> This interface describes basic attributes of XML grammars--their
* physical location and their type. </p>
*
1.4 +2 -2
xml-xerces/java/src/org/apache/xerces/xni/XMLResourceIdentifier.java
Index: XMLResourceIdentifier.java
===================================================================
RCS file:
/home/cvs/xml-xerces/java/src/org/apache/xerces/xni/XMLResourceIdentifier.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- XMLResourceIdentifier.java 24 Mar 2003 21:10:59 -0000 1.3
+++ XMLResourceIdentifier.java 14 Nov 2003 16:54:05 -0000 1.4
@@ -57,7 +57,7 @@
package org.apache.xerces.xni;
-/*
+/**
* <p> This represents the basic physical description of the location of any
* XML resource (a Schema grammar, a DTD, a general entity etc.) </p>
*
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
