[planner] Even functions comment block.

[Alexandre Franke <afranke src gnome org>]

commit c4fc82a373151ffef139549998432b74970a76fa
Author: Ahmed Baïzid <ahmed baizid org>
Date:   Fri Apr 10 12:17:51 2015 +0200

    Even functions comment block.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=747423

 libplanner/mrp-calendar.c |  2 --
 libplanner/mrp-error.c    |  6 ++++++
 libplanner/mrp-object.c   |  8 ++++++++
 libplanner/mrp-project.c  | 16 ++++++++++++++++
 libplanner/mrp-sql.c      |  2 +-
 libplanner/mrp-task.c     | 35 +++++++++++++++++++++++++++++++++++
 libplanner/mrp-task.h     |  7 +++++++
 libplanner/mrp-types.c    | 13 +++++++++++++
 8 files changed, 86 insertions(+), 3 deletions(-)
---
diff --git a/libplanner/mrp-calendar.c b/libplanner/mrp-calendar.c
index 9066537..8d5ef7d 100644
--- a/libplanner/mrp-calendar.c
+++ b/libplanner/mrp-calendar.c
@@ -427,8 +427,6 @@ foreach_copy_days (gpointer     key,
  * @parent: a #MrpCalendar to inherit from
  *
  * Add @calendar to the project
- *
- * Return value:
  **/
 void
 mrp_calendar_add (MrpCalendar *calendar, MrpCalendar *parent)
diff --git a/libplanner/mrp-error.c b/libplanner/mrp-error.c
index 9b1c085..b14592b 100644
--- a/libplanner/mrp-error.c
+++ b/libplanner/mrp-error.c
@@ -37,6 +37,12 @@
 #include <config.h>
 #include "mrp-error.h"
 
+/**
+ * mrp_error_quark:
+ * @Returns: a #GQuark
+ *
+ * Get libplanner error domain.
+ */
 GQuark
 mrp_error_quark (void)
 {
diff --git a/libplanner/mrp-object.c b/libplanner/mrp-object.c
index ca48ca2..0479c2c 100644
--- a/libplanner/mrp-object.c
+++ b/libplanner/mrp-object.c
@@ -674,6 +674,7 @@ mrp_object_get_id (MrpObject *object)
 /**
  * mrp_object_set_id:
  * @object: an #MrpObject
+ * @id: an id
  *
  * Change the unique object id in the application.
  * This function must be called only from Undo/Redo operations.
@@ -698,6 +699,13 @@ mrp_object_set_id (MrpObject *object,
        }
 }
 
+/**
+ * mrp_object_get_project:
+ * @object: a libplanner object
+ * @Returns: The project @object belongs to
+ *
+ * to which project does @object belongs to?
+ */
 gpointer
 mrp_object_get_project (MrpObject *object)
 {
diff --git a/libplanner/mrp-project.c b/libplanner/mrp-project.c
index de77f48..49b34e2 100644
--- a/libplanner/mrp-project.c
+++ b/libplanner/mrp-project.c
@@ -1552,6 +1552,7 @@ mrp_project_get_uri (MrpProject *project)
 /**
  * mrp_project_set_uri:
  * @project: an #MrpProject
+ * @uri: an URI
  *
  * Sets the URI on @project.
  **/
@@ -1642,6 +1643,7 @@ imrp_project_add_calendar_day (MrpProject *project, MrpDay *day)
 /**
  * mrp_project_get_calendar_day_by_id:
  * @project: an #MrpProject
+ * @id: an id
  *
  * Semi-private function. You most likely won't need this outside of
  * Planner. Returns the day type associated with @id.
@@ -2425,6 +2427,13 @@ project_set_calendar (MrpProject  *project,
        mrp_task_manager_recalc (priv->task_manager, TRUE);
 }
 
+/**
+ * mrp_project_set_block_scheduling:
+ * @project: an MrpProject.
+ * @block: new value.
+ *
+ * set block scheduling.
+ */
 void
 mrp_project_set_block_scheduling (MrpProject *project, gboolean block)
 {
@@ -2437,6 +2446,13 @@ mrp_project_set_block_scheduling (MrpProject *project, gboolean block)
        mrp_task_manager_set_block_scheduling (priv->task_manager, block);
 }
 
+/**
+ * mrp_project_get_block_scheduling:
+ * @project: an MrpProject.
+ * @Returns: a boolean
+ *
+ * get block scheduling.
+ */
 gboolean
 mrp_project_get_block_scheduling (MrpProject *project)
 {
diff --git a/libplanner/mrp-sql.c b/libplanner/mrp-sql.c
index 3841421..fc27b8a 100644
--- a/libplanner/mrp-sql.c
+++ b/libplanner/mrp-sql.c
@@ -1872,7 +1872,7 @@ sql_read_relations (SQLData *data, gint task_id)
        return FALSE;
 }
 
-/**
+/*
  * Insert a task from the GNode tree into the project.
  */
 static gboolean
diff --git a/libplanner/mrp-task.c b/libplanner/mrp-task.c
index 590a7f8..9830636 100644
--- a/libplanner/mrp-task.c
+++ b/libplanner/mrp-task.c
@@ -1694,6 +1694,7 @@ mrp_task_get_unit_ivals (MrpTask *task)
 /**
  * mrp_task_set_unit_ivals:
  * @task: an #MrpTask
+ * @ivals: a list of intervals.
  *
  * Set the list of intervals of @task.
  *
@@ -1892,6 +1893,12 @@ mrp_task_get_cost (MrpTask *task)
        return total;
 }
 
+/**
+ * mrp_task_invalidate_cost:
+ * @task: a task.
+ *
+ * invalidates @task cost.
+ */
 void
 mrp_task_invalidate_cost (MrpTask *task)
 {
@@ -2061,6 +2068,13 @@ imrp_task_peek_successors (MrpTask *task)
        return task->priv->successors;
 }
 
+/**
+ * mrp_task_get_task_type:
+ * @task: a task.
+ * @Returns: a #MrpTaskType.
+ *
+ * get @task type.
+ */
 MrpTaskType
 mrp_task_get_task_type (MrpTask *task)
 {
@@ -2069,6 +2083,13 @@ mrp_task_get_task_type (MrpTask *task)
        return task->priv->type;
 }
 
+/**
+ * mrp_task_get_sched:
+ * @task: a task.
+ * @Returns: a #MrpTaskSched.
+ *
+ * get @task scheduling type.
+ */
 MrpTaskSched
 mrp_task_get_sched (MrpTask *task)
 {
@@ -2077,6 +2098,13 @@ mrp_task_get_sched (MrpTask *task)
        return task->priv->sched;
 }
 
+/**
+ * mrp_task_get_percent_complete:
+ * @task: a task.
+ * @Returns: a integer.
+ *
+ * get @task percent complete.
+ */
 gshort
 mrp_task_get_percent_complete (MrpTask *task)
 {
@@ -2085,6 +2113,13 @@ mrp_task_get_percent_complete (MrpTask *task)
        return task->priv->percent_complete;
 }
 
+/**
+ * mrp_task_get_critical:
+ * @task: a task.
+ * @Returns: a boolean.
+ *
+ * is @task critical?
+ */
 gboolean
 mrp_task_get_critical (MrpTask *task)
 {
diff --git a/libplanner/mrp-task.h b/libplanner/mrp-task.h
index c236a8d..82568df 100644
--- a/libplanner/mrp-task.h
+++ b/libplanner/mrp-task.h
@@ -138,6 +138,13 @@ GList *          mrp_task_set_unit_ivals            (MrpTask          *task,
 GList           *mrp_task_get_assignments           (MrpTask          *task);
 gint             mrp_task_get_nres                  (MrpTask          *task);
 
+/**
+ * mrp_task_get_fullwork:
+ * @task: a #MrpTask
+ * @Returns: an integer
+ *
+ * <warning>Unimplemented.</warning>
+ */
 gint             mrp_task_get_fullwork              (MrpTask          *task);
 MrpAssignment   *mrp_task_get_assignment            (MrpTask          *task,
                                                     MrpResource      *resource);
diff --git a/libplanner/mrp-types.c b/libplanner/mrp-types.c
index d4617dd..d501717 100644
--- a/libplanner/mrp-types.c
+++ b/libplanner/mrp-types.c
@@ -103,6 +103,13 @@ mrp_property_type_get_type (void)
        return etype;
 }
 
+/**
+ * mrp_string_list_copy:
+ * @list: a list.
+ * @Returns: a copy.
+ *
+ * Copy a list of strings.
+ */
 GList *
 mrp_string_list_copy (const GList *list)
 {
@@ -121,6 +128,12 @@ mrp_string_list_copy (const GList *list)
        return g_list_reverse (copy);
 }
 
+/**
+ * mrp_string_list_free:
+ * @list: a list
+ *
+ * Free a list of strings.
+ */
 void
 mrp_string_list_free (GList *list)
 {