[network/common] Update Doxygen documentation.
authorMaximilian Wilhelm <max@rfc2324.org>
Thu, 14 Jan 2010 18:25:31 +0000 (19:25 +0100)
committerMaximilian Wilhelm <max@rfc2324.org>
Thu, 14 Jan 2010 18:25:31 +0000 (19:25 +0100)
Signed-off-by: Maximilian Wilhelm <max@rfc2324.org>

backend/network/common/common.c

index eddce59..ef936f2 100644 (file)
@@ -876,7 +876,11 @@ failure:
  *                           private API functions                             *
  ******************************************************************************/
 
-
+/*!
+ * @brief Initialize the common network backend.
+ * @internal
+ * @param config_filename Optional configuration file in ini format which will be scaned for a '[common]' section.
+ */
 void
 _vsc_mgmt_network_common_init (struct VscError *error, const char *config_filename)
 {
@@ -931,6 +935,10 @@ cleanup:
 
 
 
+/*!
+ * @brief Clean up the common network backend
+ * @internal
+ */
 void
 _vsc_mgmt_network_common_cleanup (void)
 {
@@ -958,6 +966,10 @@ _vsc_mgmt_network_common_cleanup (void)
 
 
 
+/*!
+ * @brief Save state of the common network backend to file (XML format)
+ * @internal
+ */
 void
 _vsc_mgmt_network_common_backup (struct VscError *error, FILE *fp)
 {
@@ -1085,6 +1097,15 @@ _vsc_mgmt_network_common_backup (struct VscError *error, FILE *fp)
 
 
 
+/*!
+ * @brief Start recovery of backend state from xmlNode
+ * @internal
+ *
+ * This function will save the current backend state internally and replace
+ * it by the information read from the given node parameter.
+ * The new information has to be commited or the changes have to be rolled
+ * back by the corresponding functions to finish the recovery process.
+ */
 void
 _vsc_mgmt_network_common_recover_start (struct VscError *error,
                                         const xmlNode *node)
@@ -1190,7 +1211,14 @@ restore:
 }
 
 
-
+/*!
+ * @brief Roll back a previously started recovery
+ * @internal
+ *
+ * This function will drop all information read by the 'recover_start()' function
+ * an restore the internally backed up information from before the recovery had
+ * been started. If there is no recovery in process, this function does nothing.
+ */
 void
 _vsc_mgmt_network_common_recover_rollback (void)
 {
@@ -1226,6 +1254,13 @@ _vsc_mgmt_network_common_recover_rollback (void)
 
 
 
+/*!
+ * @brief Commit the information of a previously started recovery.
+ * @internal
+ *
+ * This function will commit the information read by the 'recover_start()' function and
+ * drop all internally backed up information from before the recovery had been started.
+ */
 void
 _vsc_mgmt_network_common_recover_commit (void)
 {
@@ -1256,6 +1291,10 @@ _vsc_mgmt_network_common_recover_commit (void)
 
 
 
+/*!
+ * @brief Forget about all network usage information and mark all networks and IPs as free.
+ * @internal
+ */
 void
 _vsc_mgmt_network_common_tabula_rasa (void)
 {
@@ -1287,6 +1326,10 @@ _vsc_mgmt_network_common_tabula_rasa (void)
 
 
 
+/*!
+ * @brief Synchronize current backend state. Currently no-op.
+ * @internal
+ */
 void
 _vsc_mgmt_network_common_synchronize (struct VscError *error)
 {
@@ -1303,6 +1346,10 @@ _vsc_mgmt_network_common_synchronize (struct VscError *error)
 
 
 
+/*!
+ * @brief Read network information from file.
+ * @internal
+ */
 void
 _vsc_mgmt_common_read_network_list (struct VscError *error,
                                     const char *filename)
@@ -1438,6 +1485,10 @@ unlock:
 
 
 
+/*!
+ * @brief Set up a network.
+ * @internal
+ */
 struct VscMgmtUuid * /* network_uuid */
 _vsc_mgmt_network_common_setup (struct VscError *error)
 {
@@ -1506,6 +1557,10 @@ unlock:
 
 
 
+/*!
+ * @brief Tear down a network.
+ * @internal
+ */
 void
 _vsc_mgmt_network_common_teardown (struct VscError *error,
                                    const struct VscMgmtUuid *network_uuid)
@@ -1576,7 +1631,12 @@ unlock:
 
 
 
-
+/*!
+ * @brief Retrieve information about a VscMgmtNetwork.
+ * @internal
+ * @param network Pointer to VscMgmtNetwork struct to fill with information.
+ * @param network_uuid UUID of the network to retrieve information for.
+ */
 void
 _vsc_mgmt_network_common_getinfo (struct VscError *error,
                                   struct VscMgmtNetwork *network,