Index: /trunk/Nebulous/nebclient/src/nebclient.h
===================================================================
--- /trunk/Nebulous/nebclient/src/nebclient.h	(revision 4660)
+++ /trunk/Nebulous/nebclient/src/nebclient.h	(revision 4661)
@@ -4,5 +4,5 @@
  * Copyright (C) 2005  Joshua Hoblitt
  *
- * $Id: nebclient.h,v 1.27 2005-07-29 02:31:56 jhoblitt Exp $
+ * $Id: nebclient.h,v 1.28 2005-07-29 02:40:24 jhoblitt Exp $
  */
 
@@ -20,4 +20,7 @@
 
 typedef enum { NEB_READ, NEB_WRITE } nebRW;
+
+/** Represent a "connection" to a Nebulous server
+ */
 
 typedef struct {
@@ -28,18 +31,24 @@
 } nebServer;
 
+/** The properties of a storage object
+ */
+
 typedef struct {
-    char            so_id[256];
-    char            ext_id[256];
-    char            class_id[256];
-    char            comment[256];
-    char            read_lock[256];
-    char            write_lock[256];
-    char            epoch[256];
-    char            mtime[256];
+    char            so_id[256];         ///< storage object ID
+    char            ext_id[256];        ///< storage object key (name)
+    char            class_id[256];      ///< storage object class
+    char            comment[256];       ///< storage object comment
+    char            read_lock[256];     ///< read lock value
+    char            write_lock[256];    ///< write lock value
+    char            epoch[256];         ///< creation time stamp
+    char            mtime[256];         ///< modification time stamp
 } nebObjectStat;
 
+/** The storage location of a storage object's instances
+ */
+
 typedef struct {
-    unsigned int    n;
-    char            **URI;
+    unsigned int    n;                  ///< number of instances
+    char            **URI;              ///< URLs of instances 
 } nebObjectInstances;
 
@@ -70,5 +79,5 @@
 int nebCreate(
     nebServer *server,                  ///< nebServer object
-    const char *key,                    ///< storage object ID
+    const char *key,                    ///< storage object key (name)
     unsigned int class,                 ///< storage object storage class
     const char *volume,                 ///< preferred storage location of initial instance
@@ -84,5 +93,5 @@
 bool nebReplicate(
     nebServer *server,                  ///< nebServer object
-    const char *key,                    ///< storage object ID
+    const char *key,                    ///< storage object key (name)
     const char *volume,                 ///< preferred storage location of new instance
     char **URI                          ///< URL of new instance, can be NULL
@@ -98,5 +107,5 @@
 bool nebCull(
     nebServer *server,                  ///< nebServer object
-    const char *key                     ///< storage object ID
+    const char *key                     ///< storage object key (name)
 );
 
@@ -110,5 +119,5 @@
 bool nebLock(
     nebServer *server,                  ///< nebServer object
-    const char *key,                    ///< storage object ID
+    const char *key,                    ///< storage object key (name)
     nebRW flag                          ///< read only or write lock
 );
@@ -120,5 +129,5 @@
 bool nebUnlock(
     nebServer *server,                  ///< nebServer object
-    const char *key,                    ///< storage object ID
+    const char *key,                    ///< storage object key (name)
     nebRW flag                          ///< read only or write lock
 );
@@ -131,5 +140,5 @@
 nebObjectInstances *nebFindInstances(
     nebServer *server,                  ///< nebServer object
-    const char *key,                    ///< storage object ID
+    const char *key,                    ///< storage object key (name)
     const char *volume                  ///< restrict search to this storage volume (non-working)
 );
@@ -149,5 +158,5 @@
 char *nebFind(
     nebServer *server,                  ///< nebServer object
-    const char *key                     ///< storage object ID
+    const char *key                     ///< storage object key (name)
 );
 
@@ -159,5 +168,5 @@
 int nebOpen(
     nebServer *server,                  ///< nebServer object
-    const char *key,                    ///< storage object ID
+    const char *key,                    ///< storage object key (name)
     nebRW flag                          ///< read only or write lock
 );
@@ -170,5 +179,5 @@
 bool nebDelete(
     nebServer *server,                  ///< nebServer object
-    const char *key                     ///< storage object ID
+    const char *key                     ///< storage object key (name)
 );
 
@@ -182,6 +191,6 @@
 bool nebCopy(
     nebServer *server,                  ///< nebServer object
-    const char *key,                    ///< storage object ID
-    const char *newKey                  ///< new storage object ID
+    const char *key,                    ///< storage object key (name)
+    const char *newKey                  ///< new storage object key (name)
 );
 
@@ -193,6 +202,6 @@
 bool nebMove(
     nebServer *server,                  ///< nebServer object
-    const char *key,                    ///< storage object ID
-    const char *newKey                  ///< new storage object ID
+    const char *key,                    ///< storage object key (name)
+    const char *newKey                  ///< new storage object key (name)
 );
 
@@ -217,5 +226,5 @@
 nebObjectStat *nebStat(
     nebServer *server,                  ///< nebServer object
-    const char *key                     /// storage object ID
+    const char *key                     /// storage object key (name)
 );