[planner] Even struct comment block.
- From: Alexandre Franke <afranke src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [planner] Even struct comment block.
- Date: Sun, 24 Feb 2019 21:49:09 +0000 (UTC)
commit 0cc16cd4bad15e21a1888c2482d6fb6d4866e9cd
Author: Ahmed Baïzid <ahmed baizid org>
Date: Fri Apr 10 12:17:02 2015 +0200
Even struct comment block.
https://bugzilla.gnome.org/show_bug.cgi?id=747423
libplanner/mrp-application.h | 8 --------
libplanner/mrp-assignment.h | 6 ------
libplanner/mrp-calendar.h | 25 +++++++++++++++++++------
libplanner/mrp-group.h | 6 ------
libplanner/mrp-object.h | 6 ------
libplanner/mrp-project.h | 6 ------
libplanner/mrp-relation.h | 8 --------
libplanner/mrp-resource.h | 6 ------
libplanner/mrp-task.h | 32 ++++++++++++++++----------------
libplanner/mrp-time.h | 6 ++++++
libplanner/mrp-types.h | 4 ++--
11 files changed, 43 insertions(+), 70 deletions(-)
---
diff --git a/libplanner/mrp-application.h b/libplanner/mrp-application.h
index faa94bc..8e79581 100644
--- a/libplanner/mrp-application.h
+++ b/libplanner/mrp-application.h
@@ -34,8 +34,6 @@
/**
* MrpApplication:
- * @parent:
- * @priv:
*
* Object representing the application using libmrproject. You need to
* create an #MrpApplication object to create projects and use
@@ -43,12 +41,6 @@
*/
typedef struct _MrpApplication MrpApplication;
typedef struct _MrpApplicationClass MrpApplicationClass;
-/**
- * MrpApplicationPriv:
- *
- * A private struct for internal use only. The definition of this
- * structure is not publically available.
- */
typedef struct _MrpApplicationPriv MrpApplicationPriv;
struct _MrpApplication {
diff --git a/libplanner/mrp-assignment.h b/libplanner/mrp-assignment.h
index c4d63c5..095f0ca 100644
--- a/libplanner/mrp-assignment.h
+++ b/libplanner/mrp-assignment.h
@@ -35,12 +35,6 @@
#define MRP_ASSIGNMENT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), MRP_TYPE_ASSIGNMENT,
MrpAssignmentClass))
typedef struct _MrpAssignmentClass MrpAssignmentClass;
-/**
- * MrpAssignmentPriv:
- *
- * A private struct for internal use only. The definition of this
- * structure is not publically available.
- */
typedef struct _MrpAssignmentPriv MrpAssignmentPriv;
struct _MrpAssignment {
diff --git a/libplanner/mrp-calendar.h b/libplanner/mrp-calendar.h
index 0794ff6..8bf9ce1 100644
--- a/libplanner/mrp-calendar.h
+++ b/libplanner/mrp-calendar.h
@@ -46,12 +46,6 @@
*/
typedef struct _MrpCalendar MrpCalendar;
typedef struct _MrpCalendarClass MrpCalendarClass;
-/**
- * MrpCalendarPriv:
- *
- * A private struct for internal use only. The definition of this
- * structure is not publically available.
- */
typedef struct _MrpCalendarPriv MrpCalendarPriv;
/**
* MrpInterval:
@@ -63,11 +57,30 @@ typedef struct _MrpInterval MrpInterval;
#include <libplanner/mrp-day.h>
/* Used for saving calendar data. */
+
+/**
+ * MrpDayWithIntervals:
+ * @day: a day type.
+ * @intervals: a list of time intervals.
+ *
+ * Used for saving calendar data.
+ *
+ * Associate a @day type and time @intervals.
+ * A day type is composed of working periods.
+ */
typedef struct {
MrpDay *day;
GList *intervals;
} MrpDayWithIntervals;
+/**
+ * MrpDateWithDay:
+ * @date: a date.
+ * @day: a day type.
+ *
+ * Associate a @date and a @day type.
+ * Certain dates can have a peculiar day type.
+ */
typedef struct {
mrptime date;
MrpDay *day;
diff --git a/libplanner/mrp-group.h b/libplanner/mrp-group.h
index 7a81ea7..6e618de 100644
--- a/libplanner/mrp-group.h
+++ b/libplanner/mrp-group.h
@@ -34,12 +34,6 @@
#define MRP_GROUP_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), MRP_TYPE_GROUP, MrpGroupClass))
typedef struct _MrpGroupClass MrpGroupClass;
-/**
- * MrpGroupPriv:
- *
- * A private struct for internal use only. The definition of this
- * structure is not publically available.
- */
typedef struct _MrpGroupPriv MrpGroupPriv;
struct _MrpGroup {
diff --git a/libplanner/mrp-object.h b/libplanner/mrp-object.h
index 462c2e4..525f66e 100644
--- a/libplanner/mrp-object.h
+++ b/libplanner/mrp-object.h
@@ -40,12 +40,6 @@
*/
typedef struct _MrpObject MrpObject;
typedef struct _MrpObjectClass MrpObjectClass;
-/**
- * MrpObjectPriv:
- *
- * A private struct for internal use only. The definition of this
- * structure is not publically available.
- */
typedef struct _MrpObjectPriv MrpObjectPriv;
struct _MrpObject {
diff --git a/libplanner/mrp-project.h b/libplanner/mrp-project.h
index 79f7f9c..0d3bc70 100644
--- a/libplanner/mrp-project.h
+++ b/libplanner/mrp-project.h
@@ -43,12 +43,6 @@
* Object representing a project.
*/
typedef struct _MrpProject MrpProject;
-/**
- * MrpProjectPriv:
- *
- * A private struct for internal use only. The definition of this
- * structure is not publically available.
- */
typedef struct _MrpProjectPriv MrpProjectPriv;
#include <libplanner/mrp-resource.h>
diff --git a/libplanner/mrp-relation.h b/libplanner/mrp-relation.h
index e8e65a0..b0fa2dc 100644
--- a/libplanner/mrp-relation.h
+++ b/libplanner/mrp-relation.h
@@ -34,18 +34,10 @@
/**
* MrpRelation:
- * @parent:
- * @priv:
*
* Object representing a predecessor relation between two tasks.
*/
typedef struct _MrpRelation MrpRelation;
-/**
- * MrpRelationPriv:
- *
- * A private struct for internal use only. The definition of this
- * structure is not publically available.
- */
typedef struct _MrpRelationPriv MrpRelationPriv;
#include <libplanner/mrp-task.h>
diff --git a/libplanner/mrp-resource.h b/libplanner/mrp-resource.h
index d7fdb77..5e6f12e 100644
--- a/libplanner/mrp-resource.h
+++ b/libplanner/mrp-resource.h
@@ -36,12 +36,6 @@
#define MRP_RESOURCE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), MRP_TYPE_RESOURCE, MrpResourceClass))
typedef struct _MrpResourceClass MrpResourceClass;
-/**
- * MrpResourcePriv:
- *
- * A private struct for internal use only. The definition of this
- * structure is not publically available.
- */
typedef struct _MrpResourcePriv MrpResourcePriv;
#include <libplanner/mrp-calendar.h>
diff --git a/libplanner/mrp-task.h b/libplanner/mrp-task.h
index e38a68d..c236a8d 100644
--- a/libplanner/mrp-task.h
+++ b/libplanner/mrp-task.h
@@ -40,25 +40,25 @@
#define MRP_TYPE_RELATION (mrp_relation_get_type ())
typedef struct _MrpTaskClass MrpTaskClass;
+typedef struct _MrpTaskPriv MrpTaskPriv;
+
/**
- * MrpTaskPriv:
+ * MrpUnitsInterval:
+ * @is_start: is start.
+ * @start: start time.
+ * @end: end time.
+ * @units: worked units in the interval.
+ * @units_full: expected worked units in the interval
+ * all resources that are working in the
+ * interval in the right percentage.
+ * @res_n: number of expected resources working
+ * at the task in the interval.
*
- * A private struct for internal use only. The definition of this
- * structure is not publically available.
+ * [2006-04-11T12:42:44Z]
+ * NOTE: moved from libplanner/mrp-task-manager.c to use
+ * the structure in the src/planner-gantt-row.c
+ * new fields are: units, units_full, res_n.
*/
-typedef struct _MrpTaskPriv MrpTaskPriv;
-
-/*
- NOTE: moved from libplanner/mrp-task-manager.c to use
- the structure in the src/planner-gantt-row.c
- new fields are:
- units . worked units in the interval
- units_full . expected worked units in the interval
- all resources that are working in the
- interval in the right percentage
- res_n . number of expected resources working
- at the task in the interval
-*/
typedef struct {
gboolean is_start;
mrptime start;
diff --git a/libplanner/mrp-time.h b/libplanner/mrp-time.h
index 5238cc1..e83c448 100644
--- a/libplanner/mrp-time.h
+++ b/libplanner/mrp-time.h
@@ -126,6 +126,12 @@ mrptime mrp_time_from_tm (struct tm *tm);
* New API here.
*/
+/**
+ * MrpTime:
+ *
+ * Broken-down time.
+ * A kind of standard C <type>struct tm</type>.
+ */
typedef struct _MrpTime MrpTime;
diff --git a/libplanner/mrp-types.h b/libplanner/mrp-types.h
index 861ddb0..5866b5b 100644
--- a/libplanner/mrp-types.h
+++ b/libplanner/mrp-types.h
@@ -123,8 +123,8 @@ typedef struct _MrpGroup MrpGroup;
typedef struct _MrpAssignment MrpAssignment;
/**
* MrpConstraint:
- * @type:
- * @time:
+ * @type: a constraint type.
+ * @time: a time.
*
* A struct representing a scheduling constraint on a task.
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]