[Openvas-commits] r5639 - in trunk/openvas-client: . openvas

[scm-commit@wald.intevation.org]

Author: felix
Date: 2009-10-20 11:37:56 +0200 (Tue, 20 Oct 2009)
New Revision: 5639

Modified:
   trunk/openvas-client/ChangeLog
   trunk/openvas-client/openvas/comm.c
Log:
* openvas/comm.c: Doc.


Modified: trunk/openvas-client/ChangeLog
===================================================================
--- trunk/openvas-client/ChangeLog	2009-10-20 07:59:18 UTC (rev 5638)
+++ trunk/openvas-client/ChangeLog	2009-10-20 09:37:56 UTC (rev 5639)
@@ -1,5 +1,9 @@
 2009-10-20  Felix Wolfsteller <felix.wolfsteller at intevation.de>
 
+	* openvas/comm.c: Documentation added.
+
+2009-10-20  Felix Wolfsteller <felix.wolfsteller at intevation.de>
+
 	* openvas/openvas_plugin.c (openvas_plugin_list_length): New. Counts
 	the number of plugins in a list.
 

Modified: trunk/openvas-client/openvas/comm.c
===================================================================
--- trunk/openvas-client/openvas/comm.c	2009-10-20 07:59:18 UTC (rev 5638)
+++ trunk/openvas-client/openvas/comm.c	2009-10-20 09:37:56 UTC (rev 5639)
@@ -64,7 +64,14 @@
 
 int comm_send_file (struct context * context, char * file);
 
-/* caller must free return */
+/**
+ * @brief Issue an OMP \<get_nvt_all\/\> command and wait for the response.
+ *
+ * @param[in]  session   Session to the server.
+ * @param[out] response  Entity containing the response, must be freed.
+ *
+ * @return 0 in case of success. -1 otherwise (e.g. invalid session).
+ */
 int
 omp_get_nvt_all (gnutls_session_t* session, entity_t* response)
 {
@@ -101,7 +108,15 @@
     }
 }
 
-/* caller must free return */
+/**
+ * @brief Issue an OMP \<get_nvt_feed_checksum algoithm=md5/\> command and
+ * @brief wait for the response.
+ *
+ * @param[in]  session   Session to the server.
+ * @param[out] response  Entity containing the response, must be freed.
+ *
+ * @return 0 in case of success. -1 otherwise (e.g. invalid session).
+ */
 int
 omp_get_nvt_feed_checksum (gnutls_session_t* session, entity_t* response)
 {
@@ -139,7 +154,14 @@
     }
 }
 
-/* caller must free return */
+/**
+ * @brief Issue an OMP \<get_preferences\/\> command and wait for the response.
+ *
+ * @param[in]  session   Session to the server.
+ * @param[out] response  Entity containing the response, must be freed.
+ *
+ * @return 0 in case of success. -1 otherwise (e.g. invalid session).
+ */
 int
 omp_get_preferences_503 (gnutls_session_t* session, entity_t* response)
 {