[Openvas-commits] r7995 - in trunk/openvas-manager: . doc src
scm-commit@wald.intevation.org
scm-commit at wald.intevation.org
Thu Jun 10 13:31:02 CEST 2010
Author: felix
Date: 2010-06-10 13:31:00 +0200 (Thu, 10 Jun 2010)
New Revision: 7995
Modified:
trunk/openvas-manager/ChangeLog
trunk/openvas-manager/doc/Doxyfile.in
trunk/openvas-manager/src/manage.c
trunk/openvas-manager/src/manage_sql.c
trunk/openvas-manager/src/ompd.c
trunk/openvas-manager/src/openvasmd.c
Log:
Updated documentation.
* doc/Doxyfile.in: Updated file list.
* src/manage.c (resume_paused_task, send_file, send_config_rules):
Added missing parameter documentation.
* src/manage_sql.c, src/ompd.c, src/openvasmd.c: Updated documentation.
Modified: trunk/openvas-manager/ChangeLog
===================================================================
--- trunk/openvas-manager/ChangeLog 2010-06-10 11:12:10 UTC (rev 7994)
+++ trunk/openvas-manager/ChangeLog 2010-06-10 11:31:00 UTC (rev 7995)
@@ -1,10 +1,21 @@
-2010-06-09 Matthew Mundell <matthew.mundell at greenbone.net>
+2010-06-10 Felix Wolfsteller <felix.wolfsteller at greenbone.net>
+ Updated documentation.
+
+ * doc/Doxyfile.in: Updated file list.
+
+ * src/manage.c (resume_paused_task, send_file, send_config_rules):
+ Added missing parameter documentation.
+
+ * src/manage_sql.c, src/ompd.c, src/openvasmd.c: Updated documentation.
+
+2010-06-10 Matthew Mundell <matthew.mundell at greenbone.net>
+
* src/omp.c (omp_xml_handle_end_element): In CLIENT_CREATE_TASK free
description if the initial check fails and cleanup properly in the
escalator and schedule fail cases.
-2010-06-09 Matthew Mundell <matthew.mundell at greenbone.net>
+2010-06-10 Matthew Mundell <matthew.mundell at greenbone.net>
Add config UUIDs.
Modified: trunk/openvas-manager/doc/Doxyfile.in
===================================================================
--- trunk/openvas-manager/doc/Doxyfile.in 2010-06-10 11:12:10 UTC (rev 7994)
+++ trunk/openvas-manager/doc/Doxyfile.in 2010-06-10 11:31:00 UTC (rev 7995)
@@ -462,9 +462,9 @@
INPUT = src/tests/common.c \
src/logf.h \
src/tracef.h \
+ src/manage.h \
src/manage.c \
src/manage_sql.c \
- src/tasks_sql.h \
src/ovas-mngr-comm.c \
src/otp.c \
src/omp.c \
Modified: trunk/openvas-manager/src/manage.c
===================================================================
--- trunk/openvas-manager/src/manage.c 2010-06-10 11:12:10 UTC (rev 7994)
+++ trunk/openvas-manager/src/manage.c 2010-06-10 11:31:00 UTC (rev 7995)
@@ -764,7 +764,6 @@
/**
* @brief Send the rules listed in the users directory.
*
- * @param[in] config Config.
* @param[in] stopped_report Report whose finished hosts to deny.
*
* @return 0 on success, -1 on failure.
@@ -925,10 +924,10 @@
}
/**
- * @brief Send a file from a config to the scanner.
+ * @brief Send a file from a task to the scanner.
*
- * @param[in] config Config.
- * @param[in] file File name.
+ * @param[in] task The task.
+ * @param[in] file File name.
*
* @return 0 on success, -1 on failure.
*/
@@ -1568,7 +1567,8 @@
/**
* @brief Resume a stopped task.
*
- * @param[in] task A pointer to the task.
+ * @param[in] task A pointer to the task.
+ * @param[out] report_id If successful, ID of the resultant report.
*
* @return 22 caller error (task must be in "stopped" state), -1 error or any
* start_task error.
Modified: trunk/openvas-manager/src/manage_sql.c
===================================================================
--- trunk/openvas-manager/src/manage_sql.c 2010-06-10 11:12:10 UTC (rev 7994)
+++ trunk/openvas-manager/src/manage_sql.c 2010-06-10 11:31:00 UTC (rev 7995)
@@ -146,7 +146,7 @@
* @brief Quotes a string of a known length to be passed to sql statements.
*
* @param[in] string String to quote.
- * @param[in] length Size of \ref length.
+ * @param[in] length Size of \param length.
*
* @return Freshly allocated, quoted string. Free with g_free.
*/
@@ -189,7 +189,7 @@
/**
* @brief Quotes a string to be passed to sql statements.
*
- * @param[in] string String to quote, has to be \0 terminated.
+ * @param[in] string String to quote, has to be \\0 terminated.
*
* @return Freshly allocated, quoted string. Free with g_free.
*/
@@ -208,7 +208,7 @@
* including SQL quotation marks.
*/
static gchar *
-sql_insert (const char *value)
+sql_insert (const char *string)
{
if (value)
{
@@ -2801,8 +2801,8 @@
/**
* @brief Compare two number strings for collate_ip.
*
- * @param[in] one First string.
- * @param[in] two Second string.
+ * @param[in] one_arg First string.
+ * @param[in] two_arg Second string.
*
* @return -1, 0 or 1 if first is less than, equal to or greater than second.
*/
@@ -2919,9 +2919,9 @@
* @param[in] comment Comment on escalator.
* @param[in] event Type of event.
* @param[in] event_data Type-specific event data.
- * @param[in] condition_data Event condition.
+ * @param[in] condition Event condition.
* @param[in] condition_data Condition-specific data.
- * @param[in] method_data Escalation method.
+ * @param[in] method Escalation method.
* @param[in] method_data Data for escalation method.
*
* @return 0 success, 1 escalation exists already.
@@ -3257,7 +3257,9 @@
*
* @param[in] iterator Iterator.
* @param[in] escalator Escalator.
- * @param[in] type Type of data: "condition", "event" or "method".
+ * @param[in] table Type of data: "condition", "event" or "method",
+ * corresponds to substring of the table to select
+ * from.
*/
void
init_escalator_data_iterator (iterator_t *iterator, escalator_t escalator,
@@ -7761,8 +7763,8 @@
/**
* @brief Create a target.
*
- * The \ref hosts and \ref target_locator parameters are mutually exclusive,
- * if target_locator is not NULL, always try to import from source.
+ * The \param hosts and \param target_locator parameters are mutually
+ * exclusive, if target_locator is not NULL, always try to import from source.
*
* @param[in] name Name of target.
* @param[in] hosts Host list of target.
@@ -7771,7 +7773,7 @@
* @param[in] target_locator Name of target_locator to import target(s)
* from.
* @param[in] username Username to authenticate with against source.
- * @param[in] password Password for user \ref username.
+ * @param[in] password Password for user \param username.
* @param[out] target Created target.
*
* @return 0 success, 1 target exists already, -1 if import from target locator
@@ -8001,7 +8003,7 @@
/**
* @brief Return the credential associated with a target, if any.
*
- * @param[in] name Target name.
+ * @param[in] target Target (corresponds to rowid).
*
* @return Credential if any, else 0.
*/
@@ -8321,9 +8323,9 @@
/**
* @brief Get the value of a config preference.
*
- * @param[in] config Config.
- * @param[in] type Preference category, NULL for general preferences.
- * @param[in] name Name of the preference.
+ * @param[in] config Config.
+ * @param[in] type Preference category, NULL for general preferences.
+ * @param[in] preference Name of the preference.
*
* @return If there is such a preference, the value of the preference as a
* newly allocated string, else NULL.
@@ -8369,7 +8371,7 @@
*
* @param[in] nvt_selector NVT selector name.
* @param[in] array Array of OIDs of NVTs.
- * @param[in] array_size Size of \ref array.
+ * @param[in] array_size Size of \param array.
* @param[in] exclude If true exclude, else include.
*/
static void
@@ -10003,7 +10005,7 @@
*
* It's up to the caller to organise a transaction.
*
- * @param[in] iterator Config to update.
+ * @param[in] configs Config to update.
*/
static void
update_config_cache (iterator_t *configs)
@@ -10894,7 +10896,7 @@
* @brief Remove all selectors of a certain type from a NVT selector.
*
* @param[in] quoted_selector SQL-quoted selector name.
- * @param[in] quoted_family SQL-quoted family name or NVT UUID.
+ * @param[in] family_or_nvt SQL-quoted family name or NVT UUID.
* @param[in] type Selector type to remove.
*
* @return 0 success, -1 error.
@@ -11720,13 +11722,13 @@
/**
* @brief Create an LSC credential.
*
- * @param[in] name Name of LSC credential. Must be at least one
- * character long.
- * @param[in] comment Comment on LSC credential.
- * @param[in] login Name of LSC credential user. Must be at least one
- * character long.
- * @param[in] password Password for password-only credential, NULL to
- * generate credentials.
+ * @param[in] name Name of LSC credential. Must be at least one
+ * character long.
+ * @param[in] comment Comment on LSC credential.
+ * @param[in] login Name of LSC credential user. Must be at least
+ * one character long.
+ * @param[in] given_password Password for password-only credential, NULL to
+ * generate credentials.
*
* @return 0 success, 1 LSC credential exists already, 2 name contains space,
* -1 error.
@@ -12084,10 +12086,10 @@
/**
* @brief Initialise an LSC Credential iterator.
*
- * @param[in] iterator Iterator.
- * @param[in] credential Single LSC credential to iterate, 0 for all.
- * @param[in] ascending Whether to sort ascending or descending.
- * @param[in] sort_field Field to sort on, or NULL for "ROWID".
+ * @param[in] iterator Iterator.
+ * @param[in] lsc_credential Single LSC credential to iterate, 0 for all.
+ * @param[in] ascending Whether to sort ascending or descending.
+ * @param[in] sort_field Field to sort on, or NULL for "ROWID".
*/
void
init_lsc_credential_iterator (iterator_t* iterator,
Modified: trunk/openvas-manager/src/ompd.c
===================================================================
--- trunk/openvas-manager/src/ompd.c 2010-06-10 11:12:10 UTC (rev 7994)
+++ trunk/openvas-manager/src/ompd.c 2010-06-10 11:31:00 UTC (rev 7995)
@@ -199,7 +199,8 @@
// FIX combine with read_from_client
/**
- * @brief Read as much from the server as the \ref from_server buffer will hold.
+ * @brief Read as much from the server as the \ref from_scanner buffer will
+ * @brief hold.
*
* @param[in] server_session The TLS session with the server.
* @param[in] server_socket The socket connected to the server.
@@ -306,8 +307,8 @@
/**
* @brief Write as much as possible from \ref to_scanner to the scanner.
*
- * @param[in] server_socket The server socket.
- * @param[in] server_session The server session.
+ * @param[in] scanner_socket The server socket.
+ * @param[in] scanner_session The server session.
*
* @return 0 wrote everything, -1 error, -2 wrote as much as scanner accepted,
* -3 did an initialisation step.
Modified: trunk/openvas-manager/src/openvasmd.c
===================================================================
--- trunk/openvas-manager/src/openvasmd.c 2010-06-10 11:12:10 UTC (rev 7994)
+++ trunk/openvas-manager/src/openvasmd.c 2010-06-10 11:31:00 UTC (rev 7995)
@@ -472,6 +472,8 @@
/**
* @brief Fork a child connected to the Manager.
*
+ * @param[in] uuid UUID of schedule user.
+ *
* @return 0 parent on success, 1 child on success, -1 error.
*/
static int
@@ -712,7 +714,7 @@
* @param[in] update_nvt_cache Whether the nvt cache should be updated
* (1) or rebuilt (0).
* @param[in] scanner_address_string Adress of the scanner as string.
- * @param[in] port Port of the scanner.
+ * @param[in] scanner_port Port of the scanner.
*
* @return If this function did not exit itself, returns exit code.
*/
More information about the Openvas-commits
mailing list