Changeset 2108 for trunk/java-client/org/nzdl/gsdl/service/NzdlQuery.java

Timestamp:

2001-03-05T08:44:51+13:00 (23 years ago)

Author:

bas6

Message:

Documenting NzdlQuery, NzdlResponse, NzdlResultSet & NzdlServiceServer (removed some extraneous @see comments)

File:

• trunk/java-client/org/nzdl/gsdl/service/NzdlQuery.java (modified) (2 diffs)

trunk/java-client/org/nzdl/gsdl/service/NzdlQuery.java

@@ -41 +41 @@
   /**      
    * Creates an instance of NzdlQuery with an empty query string.
-   *  Default values are: maxDocs 200, startResults= 1, endResults= 10,
-   *  queryType= "ranked", caseFolding= true, stemming= false, queryTerm= "".
+   * This can then be used as a constructor parameter when creating a
+   * {@link NzdlRequest NzdlRequest} object for servicing by a
+   * {@link NzdlService NzdlService} object.
+   * Default values for a NzdlQuery object are: maxDocs 200, startResults= 1,
+   *  endResults= 10, queryType= "ranked", caseFolding= true, stemming= false,
+   * queryTerm= "".
    */
   public NzdlQuery() {
@@ -101 +105 @@
 
   /**
-  * Sets query to ignore word endings. Default is false.
-  * @param stem if true, sets query to strip endings such as "...ing",
-  * "...ed". If false, sets query to only match whole words.
+  * Sets query to ignore word endings. Default is "false."
+  * @param stem if "true", sets query to strip endings such as "...ing",
+  * "...ed". If "false", sets query to only match whole words.
   */
   public void setStemming(String _stem) {