doc

kristina · kristina · commit 3fb6836fa87f · 2009-02-04T16:03:08.000-05:00
diff --git a/src/main/com/mongodb/DBApiLayer.java b/src/main/com/mongodb/DBApiLayer.java
@@ -15,7 +15,6 @@
  */
 public abstract class DBApiLayer extends DBBase {
 
-    /** @unexpose */
     static final boolean D = Boolean.getBoolean( "DEBUG.DB" );
     /** The maximum number of cursors allowed */
     static final int NUM_CURSORS_BEFORE_KILL = 100;
@@ -54,7 +53,6 @@ protected MyCollection doGetCollection( String name ){
         return c;
     }
 
-    /** @unexpose */
     String _removeRoot( String ns ){
         if ( ! ns.startsWith( _root + "." ) )
             return ns;
diff --git a/src/main/com/mongodb/DBBase.java b/src/main/com/mongodb/DBBase.java
@@ -14,10 +14,17 @@ public void requestStart(){}
     public void requestDone(){}
     public void requestEnsureConnection(){}
     
+    /** Returns the collection represented by the string &lt;dbName&gt;.&lt;collectionName&gt;.
+     * @param fullNameSpace the string
+     * @return the collection
+     */
     public abstract DBCollection getCollectionFromFull( String fullNameSpace );
     protected abstract DBCollection doGetCollection( String name );
     public abstract Set<String> getCollectionNames();
     
+    /** Gets the address of this database.
+     * @return the address
+     */
     public abstract DBAddress getAddress();
     public abstract String getConnectPoint();
     
diff --git a/src/main/com/mongodb/DBMessage.java b/src/main/com/mongodb/DBMessage.java
@@ -4,6 +4,21 @@
 
 import java.nio.*;
 
+/** Creates a message to send to the database.  
+ * Database messages are of the form:
+ * <blockquote>
+ * &lt;length&gt;&lt;id&gt;&lt;respondingTo&gt;&lt;operation&gt;&lt;data&gt;
+ * </blockquote>
+ * The first four variables are the header and the last is the content.
+ * <table border="1"><tr>
+ * <th>Variable</th><th>Type</th><th>Description</th></tr>
+ * <tr><td>length</td><td><code>int</code></td><td>The length of the entire message</td></tr>
+ * <tr><td>id</td><td><code>int</code></td><td>A unique id generated automatically for the message</td></tr>
+ * <tr><td>respondingTo</td><td><code>int</code></td><td>The id of the message this is in response to, or 0 if it isn't a reponse</td></tr>
+ * <tr><td>operation</td><td><code>int</code></td><td>The database operation desired</td></tr>
+ * <tr><td>data</td><td><code>byte[]</code></td><td>The message body</td></tr>
+ * </table>
+ */
 public class DBMessage {
     
     static int ID = 1;
