src/common/ChangeLog:
authorMoritz Schulte <mo@g10code.com>
Sun, 11 Dec 2005 18:52:04 +0000 (18:52 +0000)
committerMoritz Schulte <mo@g10code.com>
Sun, 11 Dec 2005 18:52:04 +0000 (18:52 +0000)
2005-12-11  Moritz Schulte  <moritz@g10code.com>

* usersdb.c, usersdb.h: Added documentation.

src/common/ChangeLog
src/common/usersdb.c
src/common/usersdb.h

index 138fbd0..9d39bac 100644 (file)
@@ -1,3 +1,7 @@
+2005-12-11  Moritz Schulte  <moritz@g10code.com>
+
+       * usersdb.c, usersdb.h: Added documentation.
+
 2005-12-10  Moritz Schulte  <moritz@g10code.com>
 
        * support.c (directory_process): New function.
index b9d5f7d..de67ff3 100644 (file)
@@ -265,6 +265,11 @@ usersdb_lookup_cb (const char *serialno, const char *username, void *opaque)
   return 0;
 }
 
+/* This function tries to lookup a username by it's serial number;
+   this is only possible in case the specified serial number SERIALNO
+   is associated with exactly one username.  The username will be
+   stored in newly allocated memory in *USERNAME.  Returns proper
+   error code.  */
 gcry_error_t
 usersdb_lookup_by_serialno (const char *serialno, char **username)
 {
@@ -306,6 +311,11 @@ usersdb_lookup_by_serialno (const char *serialno, char **username)
   return err;
 }
 
+/* This function tries to lookup a serial number by it's username;
+   this is only possible in case the specified username USERNAME is
+   associated with exactly one serial number.  The serial number will
+   be stored in newly allocated memory in *SERIALNO.  Returns proper
+   error code.  */
 gcry_error_t
 usersdb_lookup_by_username (const char *username, char **serialno)
 {
@@ -405,6 +415,9 @@ usersdb_add_cb (const char *serialno, const char *username, void *opaque)
   return 0;
 }
 
+/* This function adds an entry to the users database; USERNAME and
+   SERIALNO must not be NULL.  This is a no-operation in case USERNAME
+   is already associated with SERIALNO.  */
 gpg_error_t
 usersdb_add (const char *username, const char *serialno)
 {
@@ -511,6 +524,12 @@ usersdb_remove_cb (const char *serialno, const char *username, void *opaque)
   return 0;
 }
 
+/* This function removes entries from the users database.  Either
+   USERNAME or SERIALNO must be non-NULL.  If USERNAME is non-NULL and
+   serialno is NULL, remove all entries for the given username; if
+   USERNAME is NULL and serialno is non-NULL, remove all entries fot
+   the specified serial number; if USERNAME and SERIALNO are non-NULL,
+   remove exactly this entry.  Returns proper error code.  */
 gpg_error_t
 usersdb_remove (const char *username, const char *serialno)
 {
@@ -593,6 +612,8 @@ usersdb_list_cb (const char *serialno, const char *username, void *opaque)
   return 0;
 }
 
+/* This functions lists information from the users database to the
+   stream STREAM.  Return proper error code.  */
 gcry_error_t
 usersdb_list (FILE *stream)
 {
@@ -604,5 +625,4 @@ usersdb_list (FILE *stream)
   return err;
 }
   
-
 /* END */
index 3e7dc3b..9a77cf5 100644 (file)
    pair is contained in the users database.  */
 gcry_error_t usersdb_check (const char *serialno, const char *username);
 
+/* This function tries to lookup a username by it's serial number;
+   this is only possible in case the specified serial number SERIALNO
+   is associated with exactly one username.  The username will be
+   stored in newly allocated memory in *USERNAME.  Returns proper
+   error code.  */
 gcry_error_t usersdb_lookup_by_serialno (const char *serialno, char **username);
 
+/* This function tries to lookup a serial number by it's username;
+   this is only possible in case the specified username USERNAME is
+   associated with exactly one serial number.  The serial number will
+   be stored in newly allocated memory in *SERIALNO.  Returns proper
+   error code.  */
 gcry_error_t usersdb_lookup_by_username (const char *username, char **serialno);
 
+/* This function removes entries from the users database.  Either
+   USERNAME or SERIALNO must be non-NULL.  If USERNAME is non-NULL and
+   serialno is NULL, remove all entries for the given username; if
+   USERNAME is NULL and serialno is non-NULL, remove all entries fot
+   the specified serial number; if USERNAME and SERIALNO are non-NULL,
+   remove exactly this entry.  Returns proper error code.  */
 gcry_error_t usersdb_remove (const char *username, const char *serialno);
 
+/* This function adds an entry to the users database; USERNAME and
+   SERIALNO must not be NULL.  This is a no-operation in case USERNAME
+   is already associated with SERIALNO.  */
 gcry_error_t usersdb_add (const char *username, const char *serialno);
 
+/* This functions lists information from the users database to the
+   stream STREAM.  Return proper error code.  */
 gcry_error_t usersdb_list (FILE *stream);
 
 #endif