vgritsenko 2003/08/08 18:43:37
Modified: java/src/org/apache/xindice/client/xmldb DatabaseImpl.java
Log:
Improve javadoc
Revision Changes Path
1.20 +16 -13
xml-xindice/java/src/org/apache/xindice/client/xmldb/DatabaseImpl.java
Index: DatabaseImpl.java
===================================================================
RCS file:
/home/cvs/xml-xindice/java/src/org/apache/xindice/client/xmldb/DatabaseImpl.java,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- DatabaseImpl.java 7 Aug 2003 20:13:20 -0000 1.19
+++ DatabaseImpl.java 9 Aug 2003 01:43:37 -0000 1.20
@@ -129,23 +129,26 @@
/**
* Creates a Collection instance using the URI to locate the collection
in
* the Xindice instance. Applications should not call this method
directly.
- * Instead they should call
org.xmldb.api.base.DatabaseManager.getCollection().
- * <p />
+ * Instead they should call [EMAIL PROTECTED]
org.xmldb.api.DatabaseManager#getCollection(String, String, String)}.
+ *
+ * <p>
* The URI format accepted by this method:
- * xindice:/[Nameservice host]//[Database Instance Name in the CORBA
Name Service]/[collection path]
- * <p />
+ * <code>xindice:/[Nameservice Host]//[Database Instance
Name]/[Collection Path]</code>
+ *
+ * <p>
* Nameservice host is optional.
*
* This usually looks something like this:
- * xindice:///db/root/ocs. or
- * xindice://some.host.com:8309/db/root/ocs
- * <p />
+ * <code>xindice:///db/root/ocs</code> or
+ * <code>xindice://some.host.com:8309/db/root/ocs</code>
+ *
+ * <p>
* When you pass the URI to DatabaseManager.getCollection(uri) you must
- * prepend an xmldb: to the beginning to make it a valid XML:DB URI.
+ * prepend an <code>xmldb:</code> to the beginning to make it a valid
XML:DB URI.
* So to normal users of the API URIs will look like this:
- * xmldb:xindice:///db/root/ocs. DatabaseManager will strip the
- * xmldb: before handing the URI to this getCollection implementation.
- * <p />
+ * <code>xmldb:xindice:///db/root/ocs</code>. DatabaseManager will strip
the
+ * <code>xmldb:</code> before handing the URI to this getCollection
implementation.
+ *
* @param uri The URI specifing the location of the collection.
* @return The Collection value
* @exception XMLDBException
