Completed API documentation and Doxygen

[keystone-rtos/rm-lld.git] / src / rm_nameserver.c

diff --git a/src/rm_nameserver.c b/src/rm_nameserver.c
index 2129944614bc027d0e1ed4f1f732c7c4ab1d72b6..e6e765e0a9a0b9d847d009f2bcd5a660092f4552 100644 (file)
--- a/src/rm_nameserver.c
+++ b/src/rm_nameserver.c
@@ -59,6 +59,11 @@
  ******************* Internal NameServer APIs *************************
  **********************************************************************/
 
+/* FUNCTION PURPOSE: Adds an object to the NameServer
+ ***********************************************************************
+ * DESCRIPTION: Adds an object mapping a name to a resource to
+ *              the NameServer tree.
+ */
 int32_t rmNameServerAddObject(Rm_NameServerObjCfg *objCfg)
 {
     Rm_NameServerNode    *newNode = NULL;
@@ -78,6 +83,12 @@ int32_t rmNameServerAddObject(Rm_NameServerObjCfg *objCfg)
     return(retVal);
 }
 
+/* FUNCTION PURPOSE: Finds a NameServer object based on the name
+ ***********************************************************************
+ * DESCRIPTION: Finds the NameServer node with the name specified
+ *              in the objCfg structure and returns the resource
+ *              values mapped to the name via the objCfg structure
+ */
 int32_t rmNameServerFindObject(Rm_NameServerObjCfg *objCfg)
 {
     Rm_NameServerNode  findNode;
@@ -98,6 +109,12 @@ int32_t rmNameServerFindObject(Rm_NameServerObjCfg *objCfg)
     return(retVal);
 }
 
+/* FUNCTION PURPOSE: Deletes an object from the NameServer
+ ***********************************************************************
+ * DESCRIPTION: Deletes the object with the name defined in the
+ *              objCfg structure from the NameServer tree.  Frees the
+ *              memory associated with the NameServer node
+ */
 int32_t rmNameServerDeleteObject(Rm_NameServerObjCfg *objCfg)
 {   
     Rm_NameServerNode  findNode;
@@ -117,6 +134,11 @@ int32_t rmNameServerDeleteObject(Rm_NameServerObjCfg *objCfg)
     return(retVal);
 }
 
+/* FUNCTION PURPOSE: Prints the NameServer objects
+ ***********************************************************************
+ * DESCRIPTION: Prints the names and the resources they're mapped
+ *              to for all objects stored in the NameServer tree.
+ */
 void rmNameServerPrintObjects(Rm_NameServerTree *nameServerTree)
 {
     Rm_NameServerNode *node;
@@ -127,6 +149,11 @@ void rmNameServerPrintObjects(Rm_NameServerTree *nameServerTree)
     }
 }
 
+/* FUNCTION PURPOSE: Initializes the NameServer tree
+ ***********************************************************************
+ * DESCRIPTION: Creates and initializes the NameServer tree
+ *              root entry.
+ */
 Rm_NameServerTree *rmNameServerInit(void)
 {
     Rm_NameServerTree *rootEntry = NULL;