[planner] Even enum comment block.



commit e603cfc6e219f03a9cc38a8ed0b1640cf0789bb8
Author: Ahmed Baïzid <ahmed baizid org>
Date:   Fri Apr 10 11:21:56 2015 +0200

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

 libplanner/mrp-error.h | 25 ++++++++++++-------------
 libplanner/mrp-time.h  | 15 +++++++++++++++
 libplanner/mrp-types.h | 38 ++++++++++++++++++++++++++------------
 3 files changed, 53 insertions(+), 25 deletions(-)
---
diff --git a/libplanner/mrp-error.h b/libplanner/mrp-error.h
index d7201c9..8296074 100644
--- a/libplanner/mrp-error.h
+++ b/libplanner/mrp-error.h
@@ -34,18 +34,18 @@
 
 /**
  * MrpError:
- * @MRP_ERROR_TASK_RELATION_FAILED:
- * @MRP_ERROR_TASK_MOVE_FAILED:
- * @MRP_ERROR_LOAD_FILE_DONT_EXIST:
- * @MRP_ERROR_LOAD_FILE_INVALID:
- * @MRP_ERROR_SAVE_FILE_EXIST:
- * @MRP_ERROR_SAVE_FILE_CHANGED:
- * @MRP_ERROR_EXPORT_UNSUPPORTED:
- * @MRP_ERROR_EXPORT_FAILED:
- * @MRP_ERROR_NO_FILE_MODULE:
- * @MRP_ERROR_SAVE_WRITE_FAILED:
- * @MRP_ERROR_INVALID_URI:
- * @MRP_ERROR_FAILED:
+ * @MRP_ERROR_TASK_RELATION_FAILED: task relation failed.
+ * @MRP_ERROR_TASK_MOVE_FAILED: task move failed.
+ * @MRP_ERROR_LOAD_FILE_DONT_EXIST: load file doesn't exist.
+ * @MRP_ERROR_LOAD_FILE_INVALID: load file is invalid.
+ * @MRP_ERROR_SAVE_FILE_EXIST: save file exists.
+ * @MRP_ERROR_SAVE_FILE_CHANGED: save file changed.
+ * @MRP_ERROR_EXPORT_UNSUPPORTED: export unsupported.
+ * @MRP_ERROR_EXPORT_FAILED: export failed.
+ * @MRP_ERROR_NO_FILE_MODULE: no file module.
+ * @MRP_ERROR_SAVE_WRITE_FAILED: save write failed.
+ * @MRP_ERROR_INVALID_URI: invalid URI.
+ * @MRP_ERROR_FAILED: General error (should avoid using this).
  *
  * Error codes returned by libmrproject functions.
  */
@@ -64,7 +64,6 @@ typedef enum {
 
        MRP_ERROR_INVALID_URI,
 
-       /* General error (should avoid using this). */
         MRP_ERROR_FAILED
 } MrpError;
 
diff --git a/libplanner/mrp-time.h b/libplanner/mrp-time.h
index 140836e..5238cc1 100644
--- a/libplanner/mrp-time.h
+++ b/libplanner/mrp-time.h
@@ -55,6 +55,21 @@ typedef long mrptime;
  */
 #define MRP_TIME_MAX 2147483647
 
+/**
+ * MrpTimeUnit:
+ * @MRP_TIME_UNIT_NONE: none.
+ * @MRP_TIME_UNIT_YEAR: year.
+ * @MRP_TIME_UNIT_HALFYEAR: half year.
+ * @MRP_TIME_UNIT_QUARTER: quarter.
+ * @MRP_TIME_UNIT_MONTH: month.
+ * @MRP_TIME_UNIT_WEEK: week.
+ * @MRP_TIME_UNIT_DAY: day.
+ * @MRP_TIME_UNIT_HALFDAY: half day.
+ * @MRP_TIME_UNIT_TWO_HOURS: two hours.
+ * @MRP_TIME_UNIT_HOUR: hour.
+ *
+ * Time granularity meaningful to humans.
+ */
 typedef enum {
        MRP_TIME_UNIT_NONE,
        MRP_TIME_UNIT_YEAR,
diff --git a/libplanner/mrp-types.h b/libplanner/mrp-types.h
index c6c3d6b..861ddb0 100644
--- a/libplanner/mrp-types.h
+++ b/libplanner/mrp-types.h
@@ -42,29 +42,29 @@
  * The type of relation.
  */
 typedef enum {
-       MRP_RELATION_NONE = 0, /* unset */
-       MRP_RELATION_FS,       /* finish-to-start */
-       MRP_RELATION_FF,       /* finish-to-finish */
-       MRP_RELATION_SS,       /* start-to-start */
-       MRP_RELATION_SF        /* start-to-finish */
+       MRP_RELATION_NONE = 0,
+       MRP_RELATION_FS,
+       MRP_RELATION_FF,
+       MRP_RELATION_SS,
+       MRP_RELATION_SF
 } MrpRelationType;
 
 /**
  * MrpConstraintType:
- * @MRP_CONSTRAINT_ASAP: as soon as possible
+ * @MRP_CONSTRAINT_ASAP: as soon as possible (default)
  * @MRP_CONSTRAINT_ALAP: as late as possible (unimplemented)
  * @MRP_CONSTRAINT_SNET: start no eariler than
  * @MRP_CONSTRAINT_FNLT: finish no later than (unimplemented)
  * @MRP_CONSTRAINT_MSO: must start on
  *
- * The type of constraint for the task. The default is %MRP_CONSTRAINT_ASAP.
+ * The type of constraint for the task. The default is #MRP_CONSTRAINT_ASAP.
  */
 typedef enum {
-       MRP_CONSTRAINT_ASAP = 0, /* as-soon-as-possible */
-       MRP_CONSTRAINT_ALAP,     /* as-late-as-possible */
-       MRP_CONSTRAINT_SNET,     /* start-no-earlier-than */
-       MRP_CONSTRAINT_FNLT,     /* finish-no-later-than */
-       MRP_CONSTRAINT_MSO,      /* must-start-on */
+       MRP_CONSTRAINT_ASAP = 0,
+       MRP_CONSTRAINT_ALAP,
+       MRP_CONSTRAINT_SNET,
+       MRP_CONSTRAINT_FNLT,
+       MRP_CONSTRAINT_MSO,
 } MrpConstraintType;
 
 struct _MrpConstraint {
@@ -72,11 +72,25 @@ struct _MrpConstraint {
        mrptime           time;
 };
 
+/**
+ * MrpTaskType:
+ * @MRP_TASK_TYPE_NORMAL: normal
+ * @MRP_TASK_TYPE_MILESTONE: milestone
+ *
+ * Task types.
+ */
 typedef enum {
        MRP_TASK_TYPE_NORMAL,
        MRP_TASK_TYPE_MILESTONE
 } MrpTaskType;
 
+/**
+ * MrpTaskSched:
+ * @MRP_TASK_SCHED_FIXED_WORK: fixed work
+ * @MRP_TASK_SCHED_FIXED_DURATION: fixed duration
+ *
+ * Task scheduling types.
+ */
 typedef enum {
        MRP_TASK_SCHED_FIXED_WORK,
        MRP_TASK_SCHED_FIXED_DURATION


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]