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

[scm-commit@wald.intevation.org]

Author: mattm
Date: 2009-10-20 11:56:48 +0200 (Tue, 20 Oct 2009)
New Revision: 5642

Modified:
   trunk/openvas-manager/ChangeLog
   trunk/openvas-manager/src/tasks_sql.h
Log:
	* src/tasks_sql.h: Bring docs up to date.  Remove docs from DEF_ACCESS
	invocations so that they're all the same.

Modified: trunk/openvas-manager/ChangeLog
===================================================================
--- trunk/openvas-manager/ChangeLog	2009-10-20 09:51:18 UTC (rev 5641)
+++ trunk/openvas-manager/ChangeLog	2009-10-20 09:56:48 UTC (rev 5642)
@@ -1,3 +1,8 @@
+2009-10-20  Matthew Mundell <matthew.mundell at intevation.de>
+
+	* src/tasks_sql.h: Bring docs up to date.  Remove docs from DEF_ACCESS
+	invocations so that they're all the same.
+
 2009-10-19  Matthew Mundell <matthew.mundell at intevation.de>
 
 	* src/tests/omp_get_preferences_0.c: Expect success always, now that the

Modified: trunk/openvas-manager/src/tasks_sql.h
===================================================================
--- trunk/openvas-manager/src/tasks_sql.h	2009-10-20 09:51:18 UTC (rev 5641)
+++ trunk/openvas-manager/src/tasks_sql.h	2009-10-20 09:56:48 UTC (rev 5642)
@@ -196,11 +196,11 @@
 /**
  * @brief Get a particular cell from a SQL query.
  *
- * @param  col          Column.
- * @param  row          Row.
- * @param  sql          Format string for SQL query.
- * @param  args         Arguments for format string.
- * @param  stmt_return  Return from statement.
+ * @param[in]   col          Column.
+ * @param[in]   row          Row.
+ * @param[in]   sql          Format string for SQL query.
+ * @param[in]   args         Arguments for format string.
+ * @param[out]  stmt_return  Return from statement.
  *
  * @return 0 success, 1 too few rows, -1 error.
  */
@@ -317,9 +317,11 @@
 /**
  * @brief Get a particular cell from a SQL query, as an int64.
  *
- * @param  ret    Return value.
- * @param  sql    Format string for SQL query.
- * @param  args   Arguments for format string.
+ * @param[in]  ret    Return value.
+ * @param[in]  col    Column.
+ * @param[in]  row    Row.
+ * @param[in]  sql    Format string for SQL query.
+ * @param[in]  ...    Arguments for format string.
  *
  * @return 0 success, 1 too few rows, -1 error.
  */
@@ -370,8 +372,6 @@
 /**
  * @brief Restore the database from a file.
  *
- * @param Name of backup file.
- *
  * @return 0 success, -1 fail.
  */
 int
@@ -1787,7 +1787,7 @@
  *
  * @param[in]  task         The task associated with the result.
  * @param[in]  subnet       Subnet.
- * @param[in]  subnet       Host.
+ * @param[in]  host         Host.
  * @param[in]  port         The port the result refers to.
  * @param[in]  nvt          The OID of the NVT that produced the result.
  * @param[in]  type         Type of result.  "Security Hole", etc.
@@ -2058,10 +2058,10 @@
 }
 
 /**
- * @brief Read the next task from an iterator.
+ * @brief Read the next report from an iterator.
  *
  * @param[in]   iterator  Task iterator.
- * @param[out]  task      Task.
+ * @param[out]  report    Report.
  *
  * @return TRUE if there was a next task, else FALSE.
  */
@@ -2449,7 +2449,7 @@
  * @brief Return the run status of the scan associated with a report.
  *
  * @param[in]   report  Report.
- * @param[out]  state   Scan run status.
+ * @param[out]  status  Scan run status.
  *
  * @return 0 on success, -1 on error.
  */
@@ -2520,7 +2520,7 @@
 /**
  * @brief Delete a report.
  *
- * @param[in]  report_id  ID of report.
+ * @param[in]  report  Report.
  *
  * @return 0 success, 1 report is hidden.
  */
@@ -2539,7 +2539,7 @@
 /**
  * @brief Set a report parameter.
  *
- * @param[in]  report_id  The ID of the report.
+ * @param[in]  report     The report.
  * @param[in]  parameter  The name of the parameter (in any case): COMMENT.
  * @param[in]  value      The value of the parameter.
  *
@@ -2601,10 +2601,11 @@
 }
 
 /**
- * @brief Set the attack state of a task.
+ * @brief Set the attack state of a scan (given by a report).
  *
- * @param[in]  task   Task.
- * @param[in]  state  New state.
+ * @param[in]  report  Report.
+ * @param[in]  host    Host to which the state refers.
+ * @param[in]  state   New state.
  */
 void
 set_scan_attack_state (report_t report, const char* host, const char* state)
@@ -3347,8 +3348,9 @@
 /**
  * @brief Create a target.
  *
- * @param[in]  name   Name of target.
- * @param[in]  hosts  Host list of target.
+ * @param[in]  name     Name of target.
+ * @param[in]  hosts    Host list of target.
+ * @param[in]  comment  Comment on target.
  *
  * @return 0 success, 1 target exists already.
  */
@@ -3467,15 +3469,7 @@
   init_table_iterator (iterator, "targets");
 }
 
-/**
- * @brief Get the name of a target from an target_iterator.
- *
- * @param[in]  iterator  Iterator.
- *
- * @return Name of the target or NULL if iteration is complete.
- */
 DEF_ACCESS (target_iterator_name, 0);
-
 DEF_ACCESS (target_iterator_hosts, 1);
 
 const char*
@@ -4385,15 +4379,7 @@
     }
 }
 
-/**
- * @brief Get the NVT or family from an NVT selector iterator.
- *
- * @param[in]  iterator  Iterator.
- *
- * @return NVT selector, or NULL if iteration is complete.
- */
 DEF_ACCESS (nvt_iterator_oid, 0);
-
 DEF_ACCESS (nvt_iterator_version, 1);
 DEF_ACCESS (nvt_iterator_name, 2);
 DEF_ACCESS (nvt_iterator_summary, 3);
@@ -4692,10 +4678,7 @@
 }
 
 /**
- * @brief Add an NVT preference.
- *
- * @param[in]  name   The name of the preference.
- * @param[in]  value  The value of the preference.
+ * @brief Enable the NVT preferences.
  */
 void
 manage_nvt_preferences_enable ()