GNOME.org
 

[planner] Even signals comment block.

commit 1ca509cab386711bd9fd577afc1e84cbddc49276
Author: Ahmed Baïzid <ahmed baizid org>
Date:   Fri Apr 10 12:32:18 2015 +0200

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

 libplanner/mrp-calendar.c |  10 +++--
 libplanner/mrp-object.c   |  24 ++++++-----
 libplanner/mrp-project.c  | 102 ++++++++++++++++++++++++++++++----------------
 libplanner/mrp-relation.c |   6 +++
 libplanner/mrp-resource.c |  12 ++++--
 libplanner/mrp-task.c     |  39 ++++++++++++------
 6 files changed, 128 insertions(+), 65 deletions(-)
---
diff --git a/libplanner/mrp-calendar.c b/libplanner/mrp-calendar.c
index 8d5ef7d..a813658 100644
--- a/libplanner/mrp-calendar.c
+++ b/libplanner/mrp-calendar.c
@@ -155,10 +155,12 @@ calendar_class_init (MrpCalendarClass *klass)
        object_class->get_property = calendar_get_property;
        object_class->set_property = calendar_set_property;
 
-    /**
-     * MrpCalendar::calendar-changed:
-     * @mrpcalendar: the object which received the signal.
-     */
+       /**
+        * MrpCalendar::calendar-changed:
+        * @calendar: the object which received the signal.
+        *
+        * emitted when @calendar changes.
+        */
        signals[CALENDAR_CHANGED] =
                g_signal_new ("calendar-changed",
                              G_TYPE_FROM_CLASS (klass),
diff --git a/libplanner/mrp-object.c b/libplanner/mrp-object.c
index 0479c2c..332ef5c 100644
--- a/libplanner/mrp-object.c
+++ b/libplanner/mrp-object.c
@@ -138,10 +138,12 @@ object_class_init (MrpObjectClass *klass)
 
        /* Signals */
 
-    /**
-     * MrpObject::removed:
-     * @mrpobject: the object which received the signal.
-     */
+       /**
+        * MrpObject::removed:
+        * @object: the object which received the signal.
+        *
+        * emitted when @object is removed.
+        */
        signals[REMOVED] =
                g_signal_new ("removed",
                              G_TYPE_FROM_CLASS (klass),
@@ -152,12 +154,14 @@ object_class_init (MrpObjectClass *klass)
                              G_TYPE_NONE,
                              0);
 
-    /**
-     * MrpObject::prop-changed:
-     * @mrpobject: the object which received the signal.
-     * @arg1:
-     * @arg2:
-     */
+       /**
+        * MrpObject::prop-changed:
+        * @object: a libplanner object.
+        * @property: the property that changed.
+        * @new_value: the new value.
+        *
+        * emitted when @property changes.
+        */
        signals[PROP_CHANGED] =
                g_signal_new ("prop_changed",
                              G_TYPE_FROM_CLASS (klass),
diff --git a/libplanner/mrp-project.c b/libplanner/mrp-project.c
index 49b34e2..5b83c1c 100644
--- a/libplanner/mrp-project.c
+++ b/libplanner/mrp-project.c
@@ -203,7 +203,9 @@ project_class_init (MrpProjectClass *klass)
 
     /**
      * MrpProject::loaded:
-     * @mrpproject: the object which received the signal.
+     * @project: the object which received the signal.
+     *
+     * emitted when @project is loaded.
      */
        signals[LOADED] = g_signal_new
                ("loaded",
@@ -216,8 +218,10 @@ project_class_init (MrpProjectClass *klass)
 
     /**
      * MrpProject::resource-added:
-     * @mrpproject: the object which received the signal.
-     * @arg1:
+     * @project: the object which received the signal.
+     * @resource: the added #MrpResource.
+     *
+     * emitted when @resource is added.
      */
        signals[RESOURCE_ADDED] = g_signal_new
                ("resource_added",
@@ -231,8 +235,10 @@ project_class_init (MrpProjectClass *klass)
 
     /**
      * MrpProject::resource-removed:
-     * @mrpproject: the object which received the signal.
-     * @arg1:
+     * @project: the object which received the signal.
+     * @resource: the removed #MrpResource.
+     *
+     * emitted when @resource is removed.
      */
        signals[RESOURCE_REMOVED] = g_signal_new
                ("resource_removed",
@@ -246,8 +252,10 @@ project_class_init (MrpProjectClass *klass)
 
     /**
      * MrpProject::group-added:
-     * @mrpproject: the object which received the signal.
-     * @arg1:
+     * @project: the object which received the signal.
+     * @group: the added #MrpGroup.
+     *
+     * emitted when @group is added.
      */
        signals[GROUP_ADDED] = g_signal_new
                ("group_added",
@@ -261,8 +269,10 @@ project_class_init (MrpProjectClass *klass)
 
     /**
      * MrpProject::group-removed:
-     * @mrpproject: the object which received the signal.
-     * @arg1:
+     * @project: the object which received the signal.
+     * @group: the removed #MrpGroup.
+     *
+     * emitted when @group is removed.
      */
        signals[GROUP_REMOVED] = g_signal_new
                ("group_removed",
@@ -276,8 +286,10 @@ project_class_init (MrpProjectClass *klass)
 
     /**
      * MrpProject::default-group-changed:
-     * @mrpproject: the object which received the signal.
-     * @arg1:
+     * @project: the object which received the signal.
+     * @group: the changed #MrpGroup.
+     *
+     * emitted when default @group changes.
      */
        signals[DEFAULT_GROUP_CHANGED] = g_signal_new
                ("default_group_changed",
@@ -291,8 +303,10 @@ project_class_init (MrpProjectClass *klass)
 
     /**
      * MrpProject::task-inserted:
-     * @mrpproject: the object which received the signal.
-     * @arg1:
+     * @project: the object which received the signal.
+     * @task: the inserted #MrpTask.
+     *
+     * emitted when @task is inserted.
      */
        signals[TASK_INSERTED] = g_signal_new
                ("task_inserted",
@@ -306,8 +320,10 @@ project_class_init (MrpProjectClass *klass)
 
     /**
      * MrpProject::task-removed:
-     * @mrpproject: the object which received the signal.
-     * @arg1:
+     * @project: the object which received the signal.
+     * @task: the removed #MrpTask.
+     *
+     * emitted when @task is removed.
      */
        signals[TASK_REMOVED] = g_signal_new
                ("task_removed",
@@ -321,8 +337,10 @@ project_class_init (MrpProjectClass *klass)
 
     /**
      * MrpProject::task-moved:
-     * @mrpproject: the object which received the signal.
-     * @arg1:
+     * @project: the object which received the signal.
+     * @task: the moved #MrpTask.
+     *
+     * emitted when @task is moved.
      */
        signals[TASK_MOVED] = g_signal_new
                ("task_moved",
@@ -336,8 +354,10 @@ project_class_init (MrpProjectClass *klass)
 
     /**
      * MrpProject::needs-saving-changed:
-     * @mrpproject: the object which received the signal.
-     * @arg1:
+     * @project: the object which received the signal.
+     * @needs_saving: does @project need saving?
+     *
+     * emitted when @project need saving.
      */
        signals[NEEDS_SAVING_CHANGED] = g_signal_new
                ("needs_saving_changed",
@@ -351,9 +371,11 @@ project_class_init (MrpProjectClass *klass)
 
     /**
      * MrpProject::property-added:
-     * @mrpproject: the object which received the signal.
-     * @arg1:
-     * @arg2:
+     * @project: the object which received the signal.
+     * @object_type: an #MrpPropertyType.
+     * @property: the added #MrpProperty.
+     *
+     * emitted when @property is added.
      */
        signals[PROPERTY_ADDED] = g_signal_new
                ("property_added",
@@ -367,8 +389,10 @@ project_class_init (MrpProjectClass *klass)
 
     /**
      * MrpProject::property-changed:
-     * @mrpproject: the object which received the signal.
-     * @arg1:
+     * @project: the object which received the signal.
+     * @property: the changed #MrpProperty.
+     *
+     * emitted when @property is changed.
      */
        signals[PROPERTY_CHANGED] = g_signal_new
                ("property_changed",
@@ -382,8 +406,10 @@ project_class_init (MrpProjectClass *klass)
 
     /**
      * MrpProject::property-removed:
-     * @mrpproject: the object which received the signal.
-     * @arg1:
+     * @project: the object which received the signal.
+     * @property: the removed #MrpProperty.
+     *
+     * emitted when @property is removed.
      */
        signals[PROPERTY_REMOVED] = g_signal_new
                ("property_removed",
@@ -397,8 +423,10 @@ project_class_init (MrpProjectClass *klass)
 
     /**
      * MrpProject::calendar-tree-changed:
-     * @mrpproject: the object which received the signal.
-     * @arg1:
+     * @project: the object which received the signal.
+     * @calendar: the changed #MrpCalendar.
+     *
+     * emitted when @calendar is changed.
      */
        signals[CALENDAR_TREE_CHANGED] = g_signal_new
                ("calendar_tree_changed",
@@ -412,8 +440,10 @@ project_class_init (MrpProjectClass *klass)
 
     /**
      * MrpProject::day-added:
-     * @mrpproject: the object which received the signal.
-     * @arg1:
+     * @project: the object which received the signal.
+     * @day: the added #MrpDay.
+     *
+     * emitted when @day is added.
      */
        signals[DAY_ADDED] = g_signal_new
                ("day_added",
@@ -427,8 +457,10 @@ project_class_init (MrpProjectClass *klass)
 
     /**
      * MrpProject::day-removed:
-     * @mrpproject: the object which received the signal.
-     * @arg1:
+     * @project: the object which received the signal.
+     * @day: the removed #MrpDay.
+     *
+     * emitted when @day is removed.
      */
        signals[DAY_REMOVED] = g_signal_new
                ("day_removed",
@@ -442,8 +474,10 @@ project_class_init (MrpProjectClass *klass)
 
     /**
      * MrpProject::day-changed:
-     * @mrpproject: the object which received the signal.
-     * @arg1:
+     * @project: the object which received the signal.
+     * @day: the changed #MrpDay.
+     *
+     * emitted when @day is changed.
      */
        signals[DAY_CHANGED] = g_signal_new
                ("day_changed",
diff --git a/libplanner/mrp-relation.c b/libplanner/mrp-relation.c
index 6b6b254..f9c4c3e 100644
--- a/libplanner/mrp-relation.c
+++ b/libplanner/mrp-relation.c
@@ -117,6 +117,12 @@ relation_class_init (MrpRelationClass *klass)
        object_class->set_property = relation_set_property;
        object_class->get_property = relation_get_property;
 
+    /**
+     * MrpRelation::changed:
+     * @relation: an #MrpRelation.
+     *
+     * emitted when @relation changes.
+     */
        signals[CHANGED] = g_signal_new
                ("changed",
                 G_TYPE_FROM_CLASS (klass),
diff --git a/libplanner/mrp-resource.c b/libplanner/mrp-resource.c
index d64b851..6793688 100644
--- a/libplanner/mrp-resource.c
+++ b/libplanner/mrp-resource.c
@@ -238,8 +238,10 @@ resource_class_init (MrpResourceClass *klass)
 
     /**
      * MrpResource::assignment-added:
-     * @mrpresource: the object which received the signal.
-     * @arg1:
+     * @resource: the object which received the signal.
+     * @assignment: the added #MrpAssignment.
+     *
+     * emitted when @assignment is added.
      */
        signals[ASSIGNMENT_ADDED] =
                g_signal_new ("assignment_added",
@@ -253,8 +255,10 @@ resource_class_init (MrpResourceClass *klass)
 
     /**
      * MrpResource::assignment-removed:
-     * @mrpresource: the object which received the signal.
-     * @arg1:
+     * @resource: the object which received the signal.
+     * @assignment: the removed #MrpAssignment.
+     *
+     * emitted when @assignment is removed.
      */
        signals[ASSIGNMENT_REMOVED] =
                g_signal_new ("assignment_removed",
diff --git a/libplanner/mrp-task.c b/libplanner/mrp-task.c
index 9830636..73f49f7 100644
--- a/libplanner/mrp-task.c
+++ b/libplanner/mrp-task.c
@@ -255,9 +255,10 @@ task_class_init (MrpTaskClass *klass)
 
     /**
      * MrpTask::task-moved:
-     * @mrptask: the object which received the signal.
-     * @arg1:
-     * @arg2:
+     * @task: the object which received the signal.
+     * @other_task: another #MrpTask.
+     *
+     * emitted when @other_task is moved.
      */
        signals[TASK_MOVED] =
                g_signal_new ("task_moved",
@@ -270,8 +271,10 @@ task_class_init (MrpTaskClass *klass)
 
     /**
      * MrpTask::relation-added:
-     * @mrptask: the object which received the signal.
-     * @arg1:
+     * @task: the object which received the signal.
+     * @relation: the added #MrpRelation.
+     *
+     * emitted when @relation is added.
      */
        signals[RELATION_ADDED] =
                g_signal_new ("relation_added",
@@ -284,8 +287,10 @@ task_class_init (MrpTaskClass *klass)
 
     /**
      * MrpTask::relation-removed:
-     * @mrptask: the object which received the signal.
-     * @arg1:
+     * @task: the object which received the signal.
+     * @relation: the removed #MrpRelation
+     *
+     * emitted when @relation is removed.
      */
        signals[RELATION_REMOVED] =
                g_signal_new ("relation_removed",
@@ -298,8 +303,10 @@ task_class_init (MrpTaskClass *klass)
 
     /**
      * MrpTask::assignment-added:
-     * @mrptask: the object which received the signal.
-     * @arg1:
+     * @task: the object which received the signal.
+     * @assignment: the added #MrpAssignment.
+     *
+     * emitted when @assignment is added.
      */
        signals[ASSIGNMENT_ADDED] =
                g_signal_new ("assignment_added",
@@ -313,8 +320,10 @@ task_class_init (MrpTaskClass *klass)
 
     /**
      * MrpTask::assignment-removed:
-     * @mrptask: the object which received the signal.
-     * @arg1:
+     * @task: the object which received the signal.
+     * @assignment: the removed #MrpAssignment.
+     *
+     * emitted when @assignment is removed.
      */
        signals[ASSIGNMENT_REMOVED] =
                g_signal_new ("assignment_removed",
@@ -328,7 +337,9 @@ task_class_init (MrpTaskClass *klass)
 
     /**
      * MrpTask::child-added:
-     * @mrptask: the object which received the signal.
+     * @task: the object which received the signal.
+     *
+     * emitted when a child is added.
      */
        signals[CHILD_ADDED] =
                g_signal_new ("child_added",
@@ -341,7 +352,9 @@ task_class_init (MrpTaskClass *klass)
 
     /**
      * MrpTask::child-removed:
-     * @mrptask: the object which received the signal.
+     * @task: the object which received the signal.
+     *
+     * emitted when a child is removed.
      */
        signals[CHILD_REMOVED] =
                g_signal_new ("child_removed",
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]