[planner] Move docs from tmpl files to sources.
- From: Alexandre Franke <afranke src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [planner] Move docs from tmpl files to sources.
- Date: Sun, 24 Feb 2019 21:48:33 +0000 (UTC)
commit 6b56aa2eaf6d2702305f748ba38305236ebe07ae
Author: Ahmed Baïzid <ahmed baizid org>
Date: Mon Apr 6 22:20:30 2015 +0200
Move docs from tmpl files to sources.
https://bugzilla.gnome.org/show_bug.cgi?id=747423
docs/libplanner/tmpl/libplanner-unused.sgml | 8 -
docs/libplanner/tmpl/mrp-application.sgml | 44 ---
docs/libplanner/tmpl/mrp-assignment.sgml | 84 ----
docs/libplanner/tmpl/mrp-calendar.sgml | 269 -------------
docs/libplanner/tmpl/mrp-day.sgml | 141 -------
docs/libplanner/tmpl/mrp-error.sgml | 44 ---
docs/libplanner/tmpl/mrp-group.sgml | 78 ----
docs/libplanner/tmpl/mrp-init.sgml | 24 --
docs/libplanner/tmpl/mrp-intl.sgml | 76 ----
docs/libplanner/tmpl/mrp-marshal.sgml | 16 -
docs/libplanner/tmpl/mrp-object.sgml | 138 -------
docs/libplanner/tmpl/mrp-project.sgml | 582 ----------------------------
docs/libplanner/tmpl/mrp-property.sgml | 154 --------
docs/libplanner/tmpl/mrp-relation.sgml | 84 ----
docs/libplanner/tmpl/mrp-resource.sgml | 184 ---------
docs/libplanner/tmpl/mrp-task.sgml | 467 ----------------------
docs/libplanner/tmpl/mrp-time.sgml | 195 ----------
docs/libplanner/tmpl/planner.sgml | 19 -
libplanner/mrp-application.c | 6 +
libplanner/mrp-application.h | 15 +
libplanner/mrp-assignment.c | 5 +
libplanner/mrp-assignment.h | 6 +
libplanner/mrp-calendar.c | 19 +
libplanner/mrp-calendar.h | 16 +
libplanner/mrp-day.c | 9 +
libplanner/mrp-day.h | 5 +
libplanner/mrp-error.c | 5 +
libplanner/mrp-error.h | 22 ++
libplanner/mrp-group.c | 5 +
libplanner/mrp-group.h | 6 +
libplanner/mrp-object.c | 16 +
libplanner/mrp-object.h | 11 +
libplanner/mrp-project.c | 90 +++++
libplanner/mrp-project.h | 23 ++
libplanner/mrp-property.c | 10 +
libplanner/mrp-property.h | 20 +
libplanner/mrp-relation.c | 11 +
libplanner/mrp-relation.h | 13 +
libplanner/mrp-resource.c | 17 +
libplanner/mrp-resource.h | 14 +
libplanner/mrp-task.c | 40 ++
libplanner/mrp-task.h | 6 +
libplanner/mrp-time.c | 5 +
libplanner/mrp-time.h | 20 +
libplanner/mrp-types.h | 47 +++
45 files changed, 462 insertions(+), 2607 deletions(-)
---
diff --git a/docs/libplanner/tmpl/libplanner-unused.sgml b/docs/libplanner/tmpl/libplanner-unused.sgml
index e8bee74..a389b98 100644
--- a/docs/libplanner/tmpl/libplanner-unused.sgml
+++ b/docs/libplanner/tmpl/libplanner-unused.sgml
@@ -131,14 +131,6 @@ mrproject
@Returns:
-<!-- ##### FUNCTION mrp_time_from_tm ##### -->
-<para>
-
-</para>
-
-@tm:
-@Returns:
-
<!-- ##### MACRO textdomain ##### -->
<para>
diff --git a/libplanner/mrp-application.c b/libplanner/mrp-application.c
index 5e1315c..c8537ac 100644
--- a/libplanner/mrp-application.c
+++ b/libplanner/mrp-application.c
@@ -21,6 +21,12 @@
* Boston, MA 02110-1301, USA.
*/
+/**
+ * SECTION:mrp-application
+ * @Short_description: the main project application object.
+ * @Title: MrpApplication
+ */
+
#include <config.h>
#include <stdlib.h>
diff --git a/libplanner/mrp-application.h b/libplanner/mrp-application.h
index 8682ce9..faa94bc 100644
--- a/libplanner/mrp-application.h
+++ b/libplanner/mrp-application.h
@@ -32,8 +32,23 @@
#define MRP_IS_APPLICATION_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), MRP_TYPE_APPLICATION))
#define MRP_APPLICATION_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), MRP_TYPE_APPLICATION,
MrpApplicationClass))
+/**
+ * MrpApplication:
+ * @parent:
+ * @priv:
+ *
+ * Object representing the application using libmrproject. You need to
+ * create an #MrpApplication object to create projects and use
+ * libmrproject.
+ */
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.c b/libplanner/mrp-assignment.c
index a77aae6..b1c924d 100644
--- a/libplanner/mrp-assignment.c
+++ b/libplanner/mrp-assignment.c
@@ -20,6 +20,11 @@
* Boston, MA 02110-1301, USA.
*/
+/**
+ * SECTION:mrp-assignment
+ * @Title: MrpAssignment
+ */
+
#include <config.h>
#include <glib/gi18n.h>
diff --git a/libplanner/mrp-assignment.h b/libplanner/mrp-assignment.h
index 095f0ca..c4d63c5 100644
--- a/libplanner/mrp-assignment.h
+++ b/libplanner/mrp-assignment.h
@@ -35,6 +35,12 @@
#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.c b/libplanner/mrp-calendar.c
index 40eaa12..0d7f40b 100644
--- a/libplanner/mrp-calendar.c
+++ b/libplanner/mrp-calendar.c
@@ -21,6 +21,21 @@
* Boston, MA 02110-1301, USA.
*/
+/**
+ * SECTION:mrp-calendar
+ * @Short_description: represents a calendar in the project.
+ * @Title: MrpCalendar
+ *
+ * A calendar contains the information on working/nonworking time for
+ * resources. A calendar has a default week, specifying the day types
+ * (#MrpDay) used for each day of the week by default.
+ *
+ *
+ * Day types can be overriden so that a working day
+ * has another set of working time intervals per calendar. Certain dates
+ * can be overridden to use another day type as well.
+ */
+
#include <config.h>
#include <string.h>
@@ -139,6 +154,10 @@ 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.
+ */
signals[CALENDAR_CHANGED] =
g_signal_new ("calendar-changed",
G_TYPE_FROM_CLASS (klass),
diff --git a/libplanner/mrp-calendar.h b/libplanner/mrp-calendar.h
index a7d9617..0794ff6 100644
--- a/libplanner/mrp-calendar.h
+++ b/libplanner/mrp-calendar.h
@@ -39,9 +39,25 @@
#define MRP_TYPE_INTERVAL (mrp_interval_get_type ())
+/**
+ * MrpCalendar:
+ *
+ * Object representing a calendar in the project.
+ */
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:
+ *
+ * Represents a time interval.
+ */
typedef struct _MrpInterval MrpInterval;
#include <libplanner/mrp-day.h>
diff --git a/libplanner/mrp-day.c b/libplanner/mrp-day.c
index 9e87845..d898816 100644
--- a/libplanner/mrp-day.c
+++ b/libplanner/mrp-day.c
@@ -20,6 +20,15 @@
* Boston, MA 02110-1301, USA.
*/
+/**
+ * SECTION:mrp-day
+ * @Short_description: represents a day type in the project.
+ * @Title: mrpday
+ *
+ * A day is a specific type of day, such as working day or non-working
+ * day. Other examples might be custom types like half day, or a holiday.
+ */
+
#include "mrp-private.h"
#include <glib/gi18n.h>
#include "mrp-day.h"
diff --git a/libplanner/mrp-day.h b/libplanner/mrp-day.h
index b6a9ae8..1c08a96 100644
--- a/libplanner/mrp-day.h
+++ b/libplanner/mrp-day.h
@@ -25,6 +25,11 @@
#define MRP_TYPE_DAY (mrp_day_get_type ())
+/**
+ * MrpDay:
+ *
+ * Object representing a day in the project.
+ */
typedef struct _MrpDay MrpDay;
#include <libplanner/mrp-project.h>
diff --git a/libplanner/mrp-error.c b/libplanner/mrp-error.c
index 7a794e3..12034ac 100644
--- a/libplanner/mrp-error.c
+++ b/libplanner/mrp-error.c
@@ -20,6 +20,11 @@
* Boston, MA 02110-1301, USA.
*/
+/**
+ * SECTION:mrp-error
+ * @Title: MrpError
+ */
+
#include <config.h>
#include "mrp-error.h"
diff --git a/libplanner/mrp-error.h b/libplanner/mrp-error.h
index 99f62f0..d7201c9 100644
--- a/libplanner/mrp-error.h
+++ b/libplanner/mrp-error.h
@@ -25,8 +25,30 @@
#include <glib.h>
+/**
+ * MRP_ERROR:
+ *
+ * Error domain for libmrproject.
+ */
#define MRP_ERROR mrp_error_quark ()
+/**
+ * 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:
+ *
+ * Error codes returned by libmrproject functions.
+ */
typedef enum {
MRP_ERROR_TASK_RELATION_FAILED,
MRP_ERROR_TASK_MOVE_FAILED,
diff --git a/libplanner/mrp-group.c b/libplanner/mrp-group.c
index 63acb49..9055a48 100644
--- a/libplanner/mrp-group.c
+++ b/libplanner/mrp-group.c
@@ -20,6 +20,11 @@
* Boston, MA 02110-1301, USA.
*/
+/**
+ * SECTION:mrp-group
+ * @Title: MrpGroup
+ */
+
#include <config.h>
#include "string.h"
#include <glib/gi18n.h>
diff --git a/libplanner/mrp-group.h b/libplanner/mrp-group.h
index 6e618de..7a81ea7 100644
--- a/libplanner/mrp-group.h
+++ b/libplanner/mrp-group.h
@@ -34,6 +34,12 @@
#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.c b/libplanner/mrp-object.c
index b8160d4..b7aed70 100644
--- a/libplanner/mrp-object.c
+++ b/libplanner/mrp-object.c
@@ -22,6 +22,11 @@
* Boston, MA 02110-1301, USA.
*/
+/**
+ * SECTION:mrp-object
+ * @Title: MrpObject
+ */
+
#include <config.h>
#include <gobject/gvaluecollector.h>
#include <string.h>
@@ -112,6 +117,11 @@ object_class_init (MrpObjectClass *klass)
klass->removed = NULL;
/* Signals */
+
+ /**
+ * MrpObject::removed:
+ * @mrpobject: the object which received the signal.
+ */
signals[REMOVED] =
g_signal_new ("removed",
G_TYPE_FROM_CLASS (klass),
@@ -122,6 +132,12 @@ object_class_init (MrpObjectClass *klass)
G_TYPE_NONE,
0);
+ /**
+ * MrpObject::prop-changed:
+ * @mrpobject: the object which received the signal.
+ * @arg1:
+ * @arg2:
+ */
signals[PROP_CHANGED] =
g_signal_new ("prop_changed",
G_TYPE_FROM_CLASS (klass),
diff --git a/libplanner/mrp-object.h b/libplanner/mrp-object.h
index d31614d..462c2e4 100644
--- a/libplanner/mrp-object.h
+++ b/libplanner/mrp-object.h
@@ -33,8 +33,19 @@
#define MRP_IS_OBJECT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), MRP_TYPE_OBJECT))
#define MRP_OBJECT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), MRP_TYPE_OBJECT, MrpObjectClass))
+/**
+ * MrpObject:
+ *
+ * The base class for objects in libmrproject.
+ */
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.c b/libplanner/mrp-project.c
index 019ca19..6c9a7c5 100644
--- a/libplanner/mrp-project.c
+++ b/libplanner/mrp-project.c
@@ -22,6 +22,11 @@
* Boston, MA 02110-1301, USA.
*/
+/**
+ * SECTION:mrp-project
+ * @Title: MrpProject
+ */
+
#include <config.h>
#include <string.h>
#include "mrp-error.h"
@@ -175,6 +180,10 @@ project_class_init (MrpProjectClass *klass)
object_class->set_property = project_set_property;
object_class->get_property = project_get_property;
+ /**
+ * MrpProject::loaded:
+ * @mrpproject: the object which received the signal.
+ */
signals[LOADED] = g_signal_new
("loaded",
G_TYPE_FROM_CLASS (klass),
@@ -184,6 +193,11 @@ project_class_init (MrpProjectClass *klass)
mrp_marshal_VOID__VOID,
G_TYPE_NONE, 0);
+ /**
+ * MrpProject::resource-added:
+ * @mrpproject: the object which received the signal.
+ * @arg1:
+ */
signals[RESOURCE_ADDED] = g_signal_new
("resource_added",
G_TYPE_FROM_CLASS (klass),
@@ -194,6 +208,11 @@ project_class_init (MrpProjectClass *klass)
G_TYPE_NONE,
1, MRP_TYPE_RESOURCE);
+ /**
+ * MrpProject::resource-removed:
+ * @mrpproject: the object which received the signal.
+ * @arg1:
+ */
signals[RESOURCE_REMOVED] = g_signal_new
("resource_removed",
G_TYPE_FROM_CLASS (klass),
@@ -204,6 +223,11 @@ project_class_init (MrpProjectClass *klass)
G_TYPE_NONE,
1, MRP_TYPE_RESOURCE);
+ /**
+ * MrpProject::group-added:
+ * @mrpproject: the object which received the signal.
+ * @arg1:
+ */
signals[GROUP_ADDED] = g_signal_new
("group_added",
G_TYPE_FROM_CLASS (klass),
@@ -214,6 +238,11 @@ project_class_init (MrpProjectClass *klass)
G_TYPE_NONE,
1, MRP_TYPE_GROUP);
+ /**
+ * MrpProject::group-removed:
+ * @mrpproject: the object which received the signal.
+ * @arg1:
+ */
signals[GROUP_REMOVED] = g_signal_new
("group_removed",
G_TYPE_FROM_CLASS (klass),
@@ -224,6 +253,11 @@ project_class_init (MrpProjectClass *klass)
G_TYPE_NONE,
1, MRP_TYPE_GROUP);
+ /**
+ * MrpProject::default-group-changed:
+ * @mrpproject: the object which received the signal.
+ * @arg1:
+ */
signals[DEFAULT_GROUP_CHANGED] = g_signal_new
("default_group_changed",
G_TYPE_FROM_CLASS (klass),
@@ -234,6 +268,11 @@ project_class_init (MrpProjectClass *klass)
G_TYPE_NONE,
1, MRP_TYPE_GROUP);
+ /**
+ * MrpProject::task-inserted:
+ * @mrpproject: the object which received the signal.
+ * @arg1:
+ */
signals[TASK_INSERTED] = g_signal_new
("task_inserted",
G_TYPE_FROM_CLASS (klass),
@@ -244,6 +283,11 @@ project_class_init (MrpProjectClass *klass)
G_TYPE_NONE,
1, MRP_TYPE_TASK);
+ /**
+ * MrpProject::task-removed:
+ * @mrpproject: the object which received the signal.
+ * @arg1:
+ */
signals[TASK_REMOVED] = g_signal_new
("task_removed",
G_TYPE_FROM_CLASS (klass),
@@ -254,6 +298,11 @@ project_class_init (MrpProjectClass *klass)
G_TYPE_NONE,
1, MRP_TYPE_TASK);
+ /**
+ * MrpProject::task-moved:
+ * @mrpproject: the object which received the signal.
+ * @arg1:
+ */
signals[TASK_MOVED] = g_signal_new
("task_moved",
G_TYPE_FROM_CLASS (klass),
@@ -264,6 +313,11 @@ project_class_init (MrpProjectClass *klass)
G_TYPE_NONE,
1, MRP_TYPE_TASK);
+ /**
+ * MrpProject::needs-saving-changed:
+ * @mrpproject: the object which received the signal.
+ * @arg1:
+ */
signals[NEEDS_SAVING_CHANGED] = g_signal_new
("needs_saving_changed",
G_TYPE_FROM_CLASS (klass),
@@ -274,6 +328,12 @@ project_class_init (MrpProjectClass *klass)
G_TYPE_NONE,
1, G_TYPE_BOOLEAN);
+ /**
+ * MrpProject::property-added:
+ * @mrpproject: the object which received the signal.
+ * @arg1:
+ * @arg2:
+ */
signals[PROPERTY_ADDED] = g_signal_new
("property_added",
G_TYPE_FROM_CLASS (klass),
@@ -284,6 +344,11 @@ project_class_init (MrpProjectClass *klass)
G_TYPE_NONE,
2, G_TYPE_LONG, G_TYPE_POINTER);
+ /**
+ * MrpProject::property-changed:
+ * @mrpproject: the object which received the signal.
+ * @arg1:
+ */
signals[PROPERTY_CHANGED] = g_signal_new
("property_changed",
G_TYPE_FROM_CLASS (klass),
@@ -294,6 +359,11 @@ project_class_init (MrpProjectClass *klass)
G_TYPE_NONE,
1, G_TYPE_POINTER);
+ /**
+ * MrpProject::property-removed:
+ * @mrpproject: the object which received the signal.
+ * @arg1:
+ */
signals[PROPERTY_REMOVED] = g_signal_new
("property_removed",
G_TYPE_FROM_CLASS (klass),
@@ -304,6 +374,11 @@ project_class_init (MrpProjectClass *klass)
G_TYPE_NONE,
1, G_TYPE_POINTER);
+ /**
+ * MrpProject::calendar-tree-changed:
+ * @mrpproject: the object which received the signal.
+ * @arg1:
+ */
signals[CALENDAR_TREE_CHANGED] = g_signal_new
("calendar_tree_changed",
G_TYPE_FROM_CLASS (klass),
@@ -314,6 +389,11 @@ project_class_init (MrpProjectClass *klass)
G_TYPE_NONE,
1, MRP_TYPE_CALENDAR);
+ /**
+ * MrpProject::day-added:
+ * @mrpproject: the object which received the signal.
+ * @arg1:
+ */
signals[DAY_ADDED] = g_signal_new
("day_added",
G_TYPE_FROM_CLASS (klass),
@@ -324,6 +404,11 @@ project_class_init (MrpProjectClass *klass)
G_TYPE_NONE,
1, G_TYPE_POINTER);
+ /**
+ * MrpProject::day-removed:
+ * @mrpproject: the object which received the signal.
+ * @arg1:
+ */
signals[DAY_REMOVED] = g_signal_new
("day_removed",
G_TYPE_FROM_CLASS (klass),
@@ -334,6 +419,11 @@ project_class_init (MrpProjectClass *klass)
G_TYPE_NONE,
1, G_TYPE_POINTER);
+ /**
+ * MrpProject::day-changed:
+ * @mrpproject: the object which received the signal.
+ * @arg1:
+ */
signals[DAY_CHANGED] = g_signal_new
("day_changed",
G_TYPE_FROM_CLASS (klass),
diff --git a/libplanner/mrp-project.h b/libplanner/mrp-project.h
index acc51db..f30d514 100644
--- a/libplanner/mrp-project.h
+++ b/libplanner/mrp-project.h
@@ -37,12 +37,35 @@
#define MRP_IS_PROJECT_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), MRP_TYPE_PROJECT))
#define MRP_PROJECT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), MRP_TYPE_PROJECT, MrpProjectClass))
+/**
+ * MrpProject:
+ *
+ * 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>
#include <libplanner/mrp-calendar.h>
+/**
+ * MrpTaskTraverseFunc:
+ * @Param1:
+ * @Param2:
+ *
+ * A function to use with mrp_project_task_traverse(). @task is the
+ * currently traversed task, and @data is the user data passed to the
+ * mrp_project_task_traverse(). The traversal can be stopped by returning
+ * %TRUE.
+ *
+ * Returns: %TRUE if the traversal is to be stopped.
+ */
typedef gboolean (*MrpTaskTraverseFunc) (MrpTask*, gpointer);
struct _MrpProject {
diff --git a/libplanner/mrp-property.c b/libplanner/mrp-property.c
index a5fdafb..ec7a2e3 100644
--- a/libplanner/mrp-property.c
+++ b/libplanner/mrp-property.c
@@ -21,6 +21,16 @@
* Boston, MA 02110-1301, USA.
*/
+/**
+ * SECTION:mrp-property
+ * @Short_description: represents a custom property in the project.
+ * @Title: MrpProperty
+ *
+ * MrpProperty is a typedef to #GParamSpec. It is used to add properties to
+ * projects, resources and tasks in run time, for example by the user of a
+ * GUI application, or plugins that add functionality.
+ */
+
#include <config.h>
#include "mrp-private.h"
diff --git a/libplanner/mrp-property.h b/libplanner/mrp-property.h
index a8ce7c4..da15cbb 100644
--- a/libplanner/mrp-property.h
+++ b/libplanner/mrp-property.h
@@ -29,8 +29,28 @@
#define MRP_PROPERTY(x) ((MrpProperty *) x)
#define MRP_TYPE_PROPERTY (mrp_property_get_type ())
+/**
+ * MrpProperty:
+ *
+ * Object representing a custom property in the project.
+ */
typedef GParamSpec MrpProperty;
+/**
+ * MrpPropertyType:
+ * @MRP_PROPERTY_TYPE_NONE: invalid (unset type)
+ * @MRP_PROPERTY_TYPE_INT: integer type
+ * @MRP_PROPERTY_TYPE_FLOAT: float type
+ * @MRP_PROPERTY_TYPE_STRING: string type
+ * @MRP_PROPERTY_TYPE_STRING_LIST: not implemented
+ * @MRP_PROPERTY_TYPE_DATE: date type
+ * @MRP_PROPERTY_TYPE_DURATION: duration type
+ * @MRP_PROPERTY_TYPE_COST: cost type (float)
+ *
+ * The different types of custom properties. Cost and duration are simply
+ * float and integer values, but the extra information provided makes it
+ * possible to format the values properly in a GUI.
+ */
typedef enum {
MRP_PROPERTY_TYPE_NONE,
MRP_PROPERTY_TYPE_INT,
diff --git a/libplanner/mrp-relation.c b/libplanner/mrp-relation.c
index 776b74a..274681b 100644
--- a/libplanner/mrp-relation.c
+++ b/libplanner/mrp-relation.c
@@ -21,6 +21,17 @@
* Boston, MA 02110-1301, USA.
*/
+/**
+ * SECTION:mrp-relation
+ * @Short_description: represents a task predecessor relation in the project.
+ * @Title: MrpRelation
+ *
+ * A predecessor relation is used to affect the scheduling of a task
+ * relative another task. A relation may have a lag time associated to it,
+ * so that a task can be scheduled to start after another task has
+ * finished, plus a lag time.
+ */
+
#include <config.h>
#include <string.h>
#include <glib/gi18n.h>
diff --git a/libplanner/mrp-relation.h b/libplanner/mrp-relation.h
index 3ef4d93..e8e65a0 100644
--- a/libplanner/mrp-relation.h
+++ b/libplanner/mrp-relation.h
@@ -32,7 +32,20 @@
#define MRP_IS_RELATION_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), MRP_TYPE_RELATION))
#define MRP_RELATION_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), MRP_TYPE_RELATION, MrpRelationClass))
+/**
+ * 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.c b/libplanner/mrp-resource.c
index b406af8..82a7cf1 100644
--- a/libplanner/mrp-resource.c
+++ b/libplanner/mrp-resource.c
@@ -22,6 +22,12 @@
* Boston, MA 02110-1301, USA.
*/
+/**
+ * SECTION:mrp-resource
+ * @Short_description: represents a resource in the project.
+ * @Title: MrpResource
+ */
+
#include <config.h>
#include <string.h>
#include "mrp-private.h"
@@ -207,6 +213,12 @@ resource_class_init (MrpResourceClass *klass)
G_PARAM_READWRITE));
/* Signals */
+
+ /**
+ * MrpResource::assignment-added:
+ * @mrpresource: the object which received the signal.
+ * @arg1:
+ */
signals[ASSIGNMENT_ADDED] =
g_signal_new ("assignment_added",
G_TYPE_FROM_CLASS (klass),
@@ -217,6 +229,11 @@ resource_class_init (MrpResourceClass *klass)
G_TYPE_NONE,
1, MRP_TYPE_ASSIGNMENT);
+ /**
+ * MrpResource::assignment-removed:
+ * @mrpresource: the object which received the signal.
+ * @arg1:
+ */
signals[ASSIGNMENT_REMOVED] =
g_signal_new ("assignment_removed",
G_TYPE_FROM_CLASS (klass),
diff --git a/libplanner/mrp-resource.h b/libplanner/mrp-resource.h
index 3c62e1b..d7fdb77 100644
--- a/libplanner/mrp-resource.h
+++ b/libplanner/mrp-resource.h
@@ -36,6 +36,12 @@
#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>
@@ -49,6 +55,14 @@ struct _MrpResourceClass {
MrpObjectClass parent_class;
};
+/**
+ * MrpResourceType:
+ * @MRP_RESOURCE_TYPE_NONE: invalid type (unset)
+ * @MRP_RESOURCE_TYPE_WORK: work resource
+ * @MRP_RESOURCE_TYPE_MATERIAL: material resource
+ *
+ * The type of the resource, work or material.
+ */
typedef enum {
MRP_RESOURCE_TYPE_NONE,
MRP_RESOURCE_TYPE_WORK,
diff --git a/libplanner/mrp-task.c b/libplanner/mrp-task.c
index eab60d3..c6e5e1f 100644
--- a/libplanner/mrp-task.c
+++ b/libplanner/mrp-task.c
@@ -21,6 +21,12 @@
* Boston, MA 02110-1301, USA.
*/
+/**
+ * SECTION:mrp-task
+ * @Short_description: represents a task in the project.
+ * @Title: MrpTask
+ */
+
#include <config.h>
#include <string.h>
#include "mrp-marshal.h"
@@ -215,6 +221,12 @@ task_class_init (MrpTaskClass *klass)
mrp_object_class->removed = task_removed;
+ /**
+ * MrpTask::task-moved:
+ * @mrptask: the object which received the signal.
+ * @arg1:
+ * @arg2:
+ */
signals[TASK_MOVED] =
g_signal_new ("task_moved",
G_TYPE_FROM_CLASS (klass),
@@ -224,6 +236,11 @@ task_class_init (MrpTaskClass *klass)
mrp_marshal_VOID__OBJECT_INT,
G_TYPE_NONE, 2, MRP_TYPE_TASK, G_TYPE_INT);
+ /**
+ * MrpTask::relation-added:
+ * @mrptask: the object which received the signal.
+ * @arg1:
+ */
signals[RELATION_ADDED] =
g_signal_new ("relation_added",
G_TYPE_FROM_CLASS (klass),
@@ -233,6 +250,11 @@ task_class_init (MrpTaskClass *klass)
mrp_marshal_VOID__POINTER,
G_TYPE_NONE, 1, G_TYPE_POINTER);
+ /**
+ * MrpTask::relation-removed:
+ * @mrptask: the object which received the signal.
+ * @arg1:
+ */
signals[RELATION_REMOVED] =
g_signal_new ("relation_removed",
G_TYPE_FROM_CLASS (klass),
@@ -242,6 +264,11 @@ task_class_init (MrpTaskClass *klass)
mrp_marshal_VOID__POINTER,
G_TYPE_NONE, 1, G_TYPE_POINTER);
+ /**
+ * MrpTask::assignment-added:
+ * @mrptask: the object which received the signal.
+ * @arg1:
+ */
signals[ASSIGNMENT_ADDED] =
g_signal_new ("assignment_added",
G_TYPE_FROM_CLASS (klass),
@@ -252,6 +279,11 @@ task_class_init (MrpTaskClass *klass)
G_TYPE_NONE,
1, MRP_TYPE_ASSIGNMENT);
+ /**
+ * MrpTask::assignment-removed:
+ * @mrptask: the object which received the signal.
+ * @arg1:
+ */
signals[ASSIGNMENT_REMOVED] =
g_signal_new ("assignment_removed",
G_TYPE_FROM_CLASS (klass),
@@ -262,6 +294,10 @@ task_class_init (MrpTaskClass *klass)
G_TYPE_NONE,
1, MRP_TYPE_ASSIGNMENT);
+ /**
+ * MrpTask::child-added:
+ * @mrptask: the object which received the signal.
+ */
signals[CHILD_ADDED] =
g_signal_new ("child_added",
G_TYPE_FROM_CLASS (klass),
@@ -271,6 +307,10 @@ task_class_init (MrpTaskClass *klass)
mrp_marshal_VOID__VOID,
G_TYPE_NONE, 0);
+ /**
+ * MrpTask::child-removed:
+ * @mrptask: the object which received the signal.
+ */
signals[CHILD_REMOVED] =
g_signal_new ("child_removed",
G_TYPE_FROM_CLASS (klass),
diff --git a/libplanner/mrp-task.h b/libplanner/mrp-task.h
index 644aec5..e38a68d 100644
--- a/libplanner/mrp-task.h
+++ b/libplanner/mrp-task.h
@@ -40,6 +40,12 @@
#define MRP_TYPE_RELATION (mrp_relation_get_type ())
typedef struct _MrpTaskClass MrpTaskClass;
+/**
+ * MrpTaskPriv:
+ *
+ * A private struct for internal use only. The definition of this
+ * structure is not publically available.
+ */
typedef struct _MrpTaskPriv MrpTaskPriv;
/*
diff --git a/libplanner/mrp-time.c b/libplanner/mrp-time.c
index f07b883..80863a7 100644
--- a/libplanner/mrp-time.c
+++ b/libplanner/mrp-time.c
@@ -21,6 +21,11 @@
* Boston, MA 02110-1301, USA.
*/
+/**
+ * SECTION:mrp-time
+ * @Title: mrptime
+ */
+
#include <config.h>
#include <glib-object.h>
#include <stdio.h>
diff --git a/libplanner/mrp-time.h b/libplanner/mrp-time.h
index 5aca91b..140836e 100644
--- a/libplanner/mrp-time.h
+++ b/libplanner/mrp-time.h
@@ -29,10 +29,30 @@
#include <glib.h>
#include <glib-object.h>
+/**
+ * mrptime:
+ *
+ * Corresponds to the standard C <type>time_t</type> type.
+ */
typedef long mrptime;
+/**
+ * MRP_TIME_INVALID:
+ *
+ * Represents an invalid #mrptime value.
+ */
#define MRP_TIME_INVALID 0
+/**
+ * MRP_TIME_MIN:
+ *
+ * Represents the minimum value for #mrptime.
+ */
#define MRP_TIME_MIN 0
+/**
+ * MRP_TIME_MAX:
+ *
+ * Represents the maximium value for #mrptime.
+ */
#define MRP_TIME_MAX 2147483647
typedef enum {
diff --git a/libplanner/mrp-types.h b/libplanner/mrp-types.h
index 97a4bcb..c6c3d6b 100644
--- a/libplanner/mrp-types.h
+++ b/libplanner/mrp-types.h
@@ -31,6 +31,16 @@
#define MRP_TYPE_PROPERTY_TYPE (mrp_property_type_get_type ())
#define MRP_TYPE_STRING_LIST (mrp_string_list_get_type ())
+/**
+ * MrpRelationType:
+ * @MRP_RELATION_NONE: invalid relation type (unset)
+ * @MRP_RELATION_FS: finish to start
+ * @MRP_RELATION_FF: finish to finish (unimplemented)
+ * @MRP_RELATION_SS: start to start (unimplemented)
+ * @MRP_RELATION_SF: start to finish (unimplemented)
+ *
+ * The type of relation.
+ */
typedef enum {
MRP_RELATION_NONE = 0, /* unset */
MRP_RELATION_FS, /* finish-to-start */
@@ -39,6 +49,16 @@ typedef enum {
MRP_RELATION_SF /* start-to-finish */
} MrpRelationType;
+/**
+ * MrpConstraintType:
+ * @MRP_CONSTRAINT_ASAP: as soon as possible
+ * @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.
+ */
typedef enum {
MRP_CONSTRAINT_ASAP = 0, /* as-soon-as-possible */
MRP_CONSTRAINT_ALAP, /* as-late-as-possible */
@@ -63,10 +83,37 @@ typedef enum {
} MrpTaskSched;
+/**
+ * MrpTask:
+ *
+ * Object representing a task in the project.
+ */
typedef struct _MrpTask MrpTask;
+/**
+ * MrpResource:
+ *
+ * Object representing a task in the project.
+ */
typedef struct _MrpResource MrpResource;
+/**
+ * MrpGroup:
+ *
+ * Object representing a resource group.
+ */
typedef struct _MrpGroup MrpGroup;
+/**
+ * MrpAssignment:
+ *
+ * Represents an assignment, i.e. the assignment of a task to a resource.
+ */
typedef struct _MrpAssignment MrpAssignment;
+/**
+ * MrpConstraint:
+ * @type:
+ * @time:
+ *
+ * A struct representing a scheduling constraint on a task.
+ */
typedef struct _MrpConstraint MrpConstraint;
GType mrp_relation_type_get_type (void) G_GNUC_CONST;
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
