[Openvas-commits] r3315 - in trunk/openvas-manager: . doc src

scm-commit@wald.intevation.org scm-commit at wald.intevation.org
Mon May 11 10:21:33 CEST 2009


Author: mattm
Date: 2009-05-11 10:21:32 +0200 (Mon, 11 May 2009)
New Revision: 3315

Modified:
   trunk/openvas-manager/ChangeLog
   trunk/openvas-manager/doc/Doxyfile
   trunk/openvas-manager/src/file.c
   trunk/openvas-manager/src/manage.c
   trunk/openvas-manager/src/omp.c
   trunk/openvas-manager/src/ompd.c
   trunk/openvas-manager/src/otp.c
Log:
	* doc/Doxyfile (EXTRACT_STATIC): Enable.

	* src/ompd.c (serve_omp): Doc missing params.

	* src/file.c (G_LOG_DOMAIN): Add doc.

	* src/ompd.c (error_send_to_client): Add doc.

	* src/otp.c, src/manage.c: Add missing docs.


Modified: trunk/openvas-manager/ChangeLog
===================================================================
--- trunk/openvas-manager/ChangeLog	2009-05-11 07:56:42 UTC (rev 3314)
+++ trunk/openvas-manager/ChangeLog	2009-05-11 08:21:32 UTC (rev 3315)
@@ -1,3 +1,15 @@
+2009-05-11  Matthew Mundell <mmundell at intevation.de>
+
+	* doc/Doxyfile (EXTRACT_STATIC): Enable.
+
+	* src/ompd.c (serve_omp): Doc missing params.
+
+	* src/file.c (G_LOG_DOMAIN): Add doc.
+
+	* src/ompd.c (error_send_to_client): Add doc.
+
+	* src/otp.c, src/manage.c: Add missing docs.
+
 2009-05-08  Matthew Mundell <mmundell at intevation.de>
 
 	* src/CMakeLists.txt (install): Create PREFIX/var/lib/openvas/mgr/.

Modified: trunk/openvas-manager/doc/Doxyfile
===================================================================
--- trunk/openvas-manager/doc/Doxyfile	2009-05-11 07:56:42 UTC (rev 3314)
+++ trunk/openvas-manager/doc/Doxyfile	2009-05-11 08:21:32 UTC (rev 3315)
@@ -238,7 +238,7 @@
 # If the EXTRACT_STATIC tag is set to YES all static members of a file
 # will be included in the documentation.
 
-EXTRACT_STATIC         = NO
+EXTRACT_STATIC         = YES
 
 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
 # defined locally in source files will be included in the documentation.

Modified: trunk/openvas-manager/src/file.c
===================================================================
--- trunk/openvas-manager/src/file.c	2009-05-11 07:56:42 UTC (rev 3314)
+++ trunk/openvas-manager/src/file.c	2009-05-11 08:21:32 UTC (rev 3315)
@@ -35,6 +35,9 @@
  */
 #define TRACE 0
 
+/**
+ * @brief GLib log domain for the file library.
+ */
 #define G_LOG_DOMAIN "OpenVAS-File"
 
 #include "tracef.h"

Modified: trunk/openvas-manager/src/manage.c
===================================================================
--- trunk/openvas-manager/src/manage.c	2009-05-11 07:56:42 UTC (rev 3314)
+++ trunk/openvas-manager/src/manage.c	2009-05-11 08:21:32 UTC (rev 3315)
@@ -69,9 +69,19 @@
 
 /* Functions defined in task_*.h and used before the include. */
 
+/**
+ * @brief Increment report count.
+ *
+ * @param[in]  task  Task.
+ */
 void
 inc_task_report_count (task_t task);
 
+/**
+ * @brief Decrement report count.
+ *
+ * @param[in]  task  Task.
+ */
 void
 dec_task_report_count (task_t task);
 
@@ -243,8 +253,8 @@
 /**
  * @brief Get the task associated with a report.
  *
- * @param[in]   report_id  ID of report.
- * @param[out]  task       The task return.
+ * @param[in]   report_id    ID of report.
+ * @param[out]  task_return  The task return.
  *
  * @return TRUE on error, else FALSE.
  */
@@ -380,7 +390,7 @@
 /**
  * @brief Set a report parameter.
  *
- * @param[in]  report     The ID of the report.
+ * @param[in]  report_id  The ID of the report.
  * @param[in]  parameter  The name of the parameter (in any case): COMMENT.
  * @param[in]  value      The value of the parameter.
  *
@@ -617,6 +627,14 @@
   return 0;
 }
 
+/**
+ * @brief Return a task preference.
+ *
+ * @param[in]  task  The task.
+ * @param[in]  name  The name of the preference.
+ *
+ * @return The preference on success, else NULL.
+ */
 static char*
 task_preference (task_t task, const char* name)
 {
@@ -669,6 +687,14 @@
   return NULL;
 }
 
+/**
+ * @brief Return the plugins of a task, as a semicolon separated string.
+ *
+ * @param[in]  task  Task.
+ *
+ * @return A string of semi-colon separated plugin IDS, or the empty string
+ *         if the task is to invoke all plugins.
+ */
 static char*
 task_plugins (task_t task)
 {

Modified: trunk/openvas-manager/src/omp.c
===================================================================
--- trunk/openvas-manager/src/omp.c	2009-05-11 07:56:42 UTC (rev 3314)
+++ trunk/openvas-manager/src/omp.c	2009-05-11 08:21:32 UTC (rev 3315)
@@ -198,6 +198,11 @@
   return FALSE;
 }
 
+/**
+ * @brief Set an out of space parse error on a GError.
+ *
+ * @param [out]  error  The error.
+ */
 static void
 error_send_to_client (GError** error)
 {

Modified: trunk/openvas-manager/src/ompd.c
===================================================================
--- trunk/openvas-manager/src/ompd.c	2009-05-11 07:56:42 UTC (rev 3314)
+++ trunk/openvas-manager/src/ompd.c	2009-05-11 08:21:32 UTC (rev 3315)
@@ -374,10 +374,11 @@
  * If compiled with logging (\ref LOG) then log all input and output
  * with \ref logf.
  *
- * @param[in]  client_session  The TLS session with the client.
- * @param[in]  server_session  The TLS session with the server.
- * @param[in]  client_socket   The socket connected to the client.
- * @param[in]  server_socket   The socket connected to the server.
+ * @param[in]  client_session      The TLS session with the client.
+ * @param[in]  server_session      The TLS session with the server.
+ * @param[in]  server_credentials  The TSL server credentials.
+ * @param[in]  client_socket       The socket connected to the client.
+ * @param[in]  server_socket_addr  The socket connected to the server.
  *
  * @return 0 on success, -1 on error.
  */

Modified: trunk/openvas-manager/src/otp.c
===================================================================
--- trunk/openvas-manager/src/otp.c	2009-05-11 07:56:42 UTC (rev 3314)
+++ trunk/openvas-manager/src/otp.c	2009-05-11 08:21:32 UTC (rev 3315)
@@ -103,12 +103,35 @@
 } port_t;
 #endif
 
-/*@shared@*/ static char* tcp_string = "tcp";
-/*@shared@*/ static char* udp_string = "tcp";
-/*@shared@*/ static char* other_string = "???";
-/*@shared@*/ static char* empty_string = "";
+/**
+ * @brief String for TCP ports.
+ */
+/*@shared@*/
+static char*
+tcp_string = "tcp";
 
 /**
+ * @brief String for UDP ports.
+ */
+/*@shared@*/
+static char*
+udp_string = "udp";
+
+/**
+ * @brief String for other ports.
+ */
+/*@shared@*/
+static char*
+other_string = "???";
+
+/**
+ * @brief Empty string for ports.
+ */
+/*@shared@*/
+static char*
+empty_string = "";
+
+/**
  * @brief Get the name of the protocol of a port.
  *
  * @param[in]  port  The port.
@@ -197,7 +220,6 @@
  * @brief Free a message for g_ptr_array_foreach.
  *
  * @param[in]  message       Pointer to the message.
- * @param[in]  dummy         Dummy parameter.
  */
 static void
 free_message (/*@out@*/ /*@only@*/ message_t* message)
@@ -247,8 +269,9 @@
 /**
  * @brief Write a message for g_ptr_array_foreach.
  *
- * @param[in]  message       The message.
- * @param[in]  message_data  The stream and message type.
+ * @param[in]  message  The message.
+ * @param[in]  stream   The stream to write the message to.
+ * @param[in]  type     The message type (for example "Security Warning").
  */
 static void
 write_message (message_t* message, FILE* stream, char* type)
@@ -262,8 +285,9 @@
  * @brief Write a timestamp to a stream.
  *
  * @param[in]  file       The stream.
- * @param[in]  type       Type of timestamp.
- * @param[in]  time       The time.
+ * @param[in]  host       The host.
+ * @param[in]  type       The type of the timestamp (for example, "host_end").
+ * @param[in]  time       The time to stamp.
  */
 static void
 write_timestamp (FILE* file, const char* host, const char* type,
@@ -311,8 +335,10 @@
 /**
  * @brief Append a timestamp to a report.
  *
- * @param[in]  task         Task.
- * @param[in]  message      Message.
+ * @param[in]  task  Task.
+ * @param[in]  host  Host.
+ * @param[in]  type  Type of timestamp.
+ * @param[in]  time  Time.
  */
 static void
 append_timestamp (task_t task, const char* host, const char* type,



More information about the Openvas-commits mailing list