[pisa-src] r1197 - trunk/pairing/management.c

From: Jan Marten <jan.marten@xxxxxxxxxxxxxx>
To: pisa-src@xxxxxxxxxxxxx
Date: Thu, 15 Oct 2009 19:24:57 +0200
Author: marten
Date: Thu Oct 15 19:24:56 2009
New Revision: 1197

Log:
Added doxygen documentation

Modified:
   trunk/pairing/management.c

Modified: trunk/pairing/management.c
==============================================================================
--- trunk/pairing/management.c  Thu Oct 15 19:19:19 2009        (r1196)
+++ trunk/pairing/management.c  Thu Oct 15 19:24:56 2009        (r1197)
@@ -97,8 +97,12 @@
 }
 
 /**
- * Comparing userlist_entries means comparing their HITs
- * TODO JAN
+ * Compares two pisa_userlist_entries by their HIT
+ * @param p1 First pisa_userlist_entry that should be compared
+ * @param p2 Second pisa_userlist_entry that should be compared
+ * @return <0 if p1 is less than p2
+ * @return 0 if p1 equals p2
+ * @return >0 if p1 is greater than p2
  */
 static int pisa_userlist_entry_compare_hit(const void *p1, const void *p2)
 {
@@ -115,8 +119,12 @@
 }
 
 /**
- * Comparing userlist_entries means comparing the user_names
- * TODO JAN
+ * Compares two pisa_userlist_entries by their names
+ * @param p1 First pisa_userlist_entry that should be compared
+ * @param p2 Second pisa_userlist_entry that should be compared
+ * @return <0 if p1 is less than p2
+ * @return 0 if p1 equals p2
+ * @return >0 if p1 is greater than p2
  */
 static int pisa_userlist_entry_compare_name(const void *p1, const void *p2)
 {
@@ -1018,15 +1026,12 @@
     }
 }
 
-/** Writes the users configuration to config file.
- *
- *  @param hit HIT
- *  @param user_name User_name
- *  @param expiration Expiration of the Hit
- *  @param active The active status of the Entry (0: Deactivated, 1:Activated, 
2:No Change)
- *
- * TODO JAN
- *  @return 0 on failure; 1 on success; -1 on write error
+/** 
+ * Adds or updates an entry in the authorizedcfg and
+ * userscfg configuration files
+ * @param new_entry The new pisa_userhitlist_entry which should be
+ * written to the configuration file
+ * @return 0 on failure; 1 on success; -1 on write error
  */
 int pisa_mgmt_users_config_write(pisa_userhitlist_entry *new_entry)
 {
[pisa-src] r1197 - trunk/pairing/management.c

Other related posts:
