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

[scm-commit@wald.intevation.org]

Author: mattm
Date: 2009-05-15 17:38:58 +0200 (Fri, 15 May 2009)
New Revision: 3391

Modified:
   trunk/openvas-manager/ChangeLog
   trunk/openvas-manager/src/manage.c
   trunk/openvas-manager/src/tasks_fs.h
   trunk/openvas-manager/src/tasks_sql.h
Log:
	* src/tasks_fs.h, src/tasks_sql.h: Update doc params.

	* src/manage.c (task_run_status_name): Add missing doc.

Modified: trunk/openvas-manager/ChangeLog
===================================================================
--- trunk/openvas-manager/ChangeLog	2009-05-15 15:24:06 UTC (rev 3390)
+++ trunk/openvas-manager/ChangeLog	2009-05-15 15:38:58 UTC (rev 3391)
@@ -1,5 +1,11 @@
 2009-05-15  Matthew Mundell <mmundell at intevation.de>
 
+	* src/tasks_fs.h, src/tasks_sql.h: Update doc params.
+
+	* src/manage.c (task_run_status_name): Add missing doc.
+
+2009-05-15  Matthew Mundell <mmundell at intevation.de>
+
 	* src/tests/common.c (task_status): New function.
 
 	* src/tests/common.h (task_status): New header.

Modified: trunk/openvas-manager/src/manage.c
===================================================================
--- trunk/openvas-manager/src/manage.c	2009-05-15 15:24:06 UTC (rev 3390)
+++ trunk/openvas-manager/src/manage.c	2009-05-15 15:38:58 UTC (rev 3391)
@@ -479,6 +479,14 @@
 
 /* General task facilities. */
 
+/**
+ * @brief Get the name of the status of a task.
+ *
+ * @param[in]  task  The task.
+ *
+ * @return The name of the status of the given task (for example, "Done" or
+ *         "Running").
+ */
 const char*
 task_run_status_name (task_t task)
 {

Modified: trunk/openvas-manager/src/tasks_fs.h
===================================================================
--- trunk/openvas-manager/src/tasks_fs.h	2009-05-15 15:24:06 UTC (rev 3390)
+++ trunk/openvas-manager/src/tasks_fs.h	2009-05-15 15:38:58 UTC (rev 3391)
@@ -208,6 +208,7 @@
  *
  * @param[in]  task         Task.
  * @param[in]  description  Description.  Used directly, freed by free_task.
+ * @param[in]  length       Length of description.
  */
 void
 set_task_description (task_t task, char* description, gsize length)
@@ -1111,7 +1112,7 @@
  *
  * Stop the task beforehand with \ref stop_task, if it is running.
  *
- * @param[in]  task  A pointer to the task.
+ * @param[in]  task_pointer  A pointer to the task.
  *
  * @return 0 on success, -1 if out of space in \ref to_server buffer.
  */

Modified: trunk/openvas-manager/src/tasks_sql.h
===================================================================
--- trunk/openvas-manager/src/tasks_sql.h	2009-05-15 15:24:06 UTC (rev 3390)
+++ trunk/openvas-manager/src/tasks_sql.h	2009-05-15 15:38:58 UTC (rev 3391)
@@ -490,6 +490,7 @@
  *
  * @param[in]  task         Task.
  * @param[in]  description  Description.  Used directly, freed by free_task.
+ * @param[in]  length       Length of description.
  */
 void
 set_task_description (task_t task, char* description, gsize length)
@@ -927,7 +928,7 @@
  *
  * Stop the task beforehand with \ref stop_task, if it is running.
  *
- * @param[in]  task  A pointer to the task.
+ * @param[in]  task_pointer  A pointer to the task.
  *
  * @return 0 on success, -1 if error.
  */
@@ -1084,9 +1085,10 @@
 /**
  * @brief Find a task given an identifier.
  *
- * @param[in]  id  A task identifier.
+ * @param[in]   uuid  A task identifier.
+ * @param[out]  task  Task return.
  *
- * @return A pointer to the task with the given ID.
+ * @return TRUE on success, FALSE on error.
  */
 gboolean
 find_task (const char* uuid, task_t* task)