Commit f7483d89 authored by Ahmed Baïzid's avatar Ahmed Baïzid Committed by Andrew Miloradovsky
parent 9ae924a8
......@@ -286,7 +286,7 @@ imrp_application_id_set_data (gpointer data,
* @object_id: an object id
*
* Get the object reference in the list of MrpObjects
* using the object_id as locator
* using the object_id as locator.
*
* Return value: a pointer to the data
**/
......
......@@ -512,7 +512,7 @@ mrp_calendar_derive (const gchar *name, MrpCalendar *parent)
* @new_parent: the new parent
* @child: an #MrpCalendar
*
* Changes the parent of @calendar so that it inherits @new_parent, instead of
* Changes the parent of @child so that it inherits @new_parent, instead of
* its old parent.
*
**/
......@@ -919,7 +919,7 @@ mrp_calendar_get_parent (MrpCalendar *calendar)
* mrp_calendar_get_children:
* @calendar: an #MrpCalendar
*
* Retreives a list of the children, i.e. the calenderas that are immediately
* Retrieves a list of the children, i.e. the calendars that are immediately
* derived from @calendar.
*
* Return value: List of @calendar's children.
......@@ -938,7 +938,7 @@ mrp_calendar_get_children (MrpCalendar *calendar)
* @date: an #mrptime
* @check_ancestors: specifies if the whole calendar hierarchy should be checked
*
* Retrieves the day type for the given date and calender. If @check_ancestors
* Retrieves the day type for the given date and calendar. If @check_ancestors
* is %TRUE, the parent and grandparent, and so on, is searched if @calendar
* does not have an overridden day type for the specified date.
*
......@@ -1118,7 +1118,7 @@ foreach_day_interval_add_to_list (MrpDay *day,
* @calendar: an #MrpCalendar
*
* Retrieves the days that are overridden in this calendar, and the intervals
* that they are overriden with. This is mainly used when saving calendar data.
* that they are overridden with. This is mainly used when saving calendar data.
*
* Return value: A list of #MrpDayWithIntervals structs, that must be freed
* (both the list and the data).
......
......@@ -283,7 +283,7 @@ mrp_day_get_work (void)
*
* Fetches the builtin day type nonwork.
*
* Return value: the builtin day type nowork
* Return value: the builtin day type nonwork
**/
MrpDay *
mrp_day_get_nonwork (void)
......
......@@ -306,7 +306,7 @@ mrp_group_new (void)
* mrp_group_get_name:
* @group: an #MrpGroup
*
* Retrives the name of @group.
* Retrieves the name of @group.
*
* Return value: the name
**/
......
......@@ -371,7 +371,7 @@ object_property_removed_cb (MrpProject *project,
* mrp_object_removed:
* @object: an #MrpObject
*
* Emits the signal %removed. This means that any references to the object
* Emits the #MrpObject::removed signal. This means that any references to the object
* should be dropped, since the object is removed from the project.
**/
void
......@@ -386,7 +386,7 @@ mrp_object_removed (MrpObject *object)
* mrp_object_changed:
* @object: an #MrpObject
*
* Emits the signal needs-saving on the project that this object belongs to,
* Emits the #MrpProject::needs-saving-changed on the project @object belongs to,
* indicating that the project has unsaved changes.
**/
void
......@@ -537,7 +537,7 @@ mrp_object_set_valist (MrpObject *object,
g_free (error);
/* we purposely leak the value here, it might not be
* in a sane state if an error condition occoured
* in a sane state if an error condition occurred
*/
break;
}
......@@ -660,7 +660,7 @@ mrp_object_get_properties (MrpObject *object)
*
* Retrieves the unique object id in the application
*
* Return value: 0 if fails, object id if everything is ok.
* Return value: 0 if fails, object id if everything is OK.
**/
guint
mrp_object_get_id (MrpObject *object)
......@@ -683,7 +683,7 @@ mrp_object_get_id (MrpObject *object)
* Change the unique object id in the application.
* This function must be called only from Undo/Redo operations.
*
* Return value: FALSE if fails, TRUE is everything is ok.
* Return value: FALSE if fails, TRUE is everything is OK.
**/
gboolean
mrp_object_set_id (MrpObject *object,
......
......@@ -100,7 +100,7 @@ MrpTaskType imrp_task_get_type (MrpTask *task);
MrpTaskSched imrp_task_get_sched (MrpTask *task);
/* MrpTime funcitons. */
/* MrpTime functions. */
void imrp_time_init (void);
/* MrpStorageModule functions. */
......
......@@ -29,7 +29,7 @@
* @include: libplanner/mrp-project.h
*
* A project has got some properties.
* One can add his own properties.
* One can add custom properties.
*
* A project maintains a list of #MrpGroup and can designates one as the
* default. If you specify a default group, every new #MrpResource that you add
......@@ -2067,7 +2067,7 @@ mrp_project_reschedule (MrpProject *project)
* mrp_project_calculate_summary_duration:
* @project: an #MrpProject
* @task: an #MrpTask
* @start: a start time, or if %-1, the task start time is to be used
* @start: a start time, or if -1, the task start time is to be used
* @finish: a finish time
*
* Calculates the time needed to achieve the given start and finish time,
......@@ -2096,7 +2096,7 @@ mrp_project_calculate_summary_duration (MrpProject *project,
* mrp_project_calculate_task_work:
* @project: an #MrpProject
* @task: an #MrpTask
* @start: a start time, or if %-1, the task start time is to be used
* @start: a start time, or if -1, the task start time is to be used
* @finish: a finish time
*
* Calculates the work needed to achieve the given start and finish time, with
......@@ -2286,7 +2286,7 @@ mrp_project_add_property (MrpProject *project,
/**
* mrp_project_remove_property:
* @project: an #MrpProject
* @object_type: a #GType specifing object type to remove property from
* @object_type: a #GType specifying object type to remove property from
* @name: the name of the property
*
* Removes the property corresponding to @object_type and @name from @project.
......@@ -2324,7 +2324,7 @@ mrp_project_remove_property (MrpProject *project,
/**
* mrp_project_has_property:
* @project: an #MrpProperty
* @owner_type: a #GType specifing object type look for property on
* @owner_type: a #GType specifying object type look for property on
* @name: the name of the property
*
* Checks if @project has a property named @name applying to object of type
......
......@@ -28,7 +28,7 @@
* @include: libplanner/mrp-property.h
*
* 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
* projects, resources and tasks at run time, for example by the user of a
* GUI application, or plugins that add functionality.
*/
......@@ -364,7 +364,7 @@ mrp_property_unref (MrpProperty *property)
* mrp_property_type_as_string:
* @type: an #MrpPropertyType
*
* Transform a #MrpPropertyTYpe into a human readable string.
* Transform a #MrpPropertyType into a human readable string.
*
* Return value: a string representation of @type
**/
......
......@@ -674,7 +674,7 @@ mrp_resource_new (void)
* mrp_resource_get_name:
* @resource: an #MrpResource
*
* Retrives the name of @resource.
* Retrieves the name of @resource.
*
* Return value: the name
**/
......@@ -704,7 +704,7 @@ void mrp_resource_set_name (MrpResource *resource, const gchar *name)
* mrp_resource_get_short_name:
* @resource: an #MrpResource
*
* Retrives the short_name of @resource.
* Retrieves the short_name of @resource.
*
* Return value: the short name
**/
......
......@@ -120,7 +120,7 @@ struct _MrpTaskPriv {
/* Percent complete, 0-100. */
gshort percent_complete;
/* Arbitary range of 0,1..9999. A hint for any (3rd party) resource leveller */
/* Arbitrary range of 0,1..9999. A hint for any (3rd party) resource leveller */
gint priority;
gchar *name;
......@@ -991,7 +991,7 @@ mrp_task_new (void)
* mrp_task_get_name:
* @task: an #MrpTask
*
* Retrives the name of @task.
* Retrieves the name of @task.
*
* Return value: the name
**/
......@@ -1005,7 +1005,7 @@ mrp_task_get_name (MrpTask *task)
/**
* mrp_task_set_name:
* @task: an #MrpResource
* @task: an #MrpTask
* @name: new name of @task
*
* Sets the name of @task.
......@@ -1086,8 +1086,8 @@ task_get_successor_relation (MrpTask *task,
* @task_a: an #MrpTask
* @task_b: an #MrpTask
*
* Checks if @a and @b has a relation, i.e. if a is a predecessor or successor
* of b.
* Checks if @task_a and @task_b has a relation, i.e. if @task_a is a
* predecessor or successor of @task_b.
*
* Return value: %TRUE if @a and @b has a relation
**/
......@@ -1843,7 +1843,7 @@ mrp_task_compare (gconstpointer a, gconstpointer b)
* mrp_task_reset_constraint:
* @task: an #MrpTask
*
* Sets the contraint type to %MRP_CONTRAINT_ASAP and notifies listeners.
* Sets the constraint type to #MRP_CONSTRAINT_ASAP and notifies listeners.
**/
void
mrp_task_reset_constraint (MrpTask *task)
......
......@@ -442,7 +442,7 @@ mrp_time_day_of_week (mrptime t)
*
* Retrieves the week number of the specified time.
*
* Return value: ISO standard week number.
* Return value: ISO 8601 week number.
**/
gint
mrp_time_week_number (mrptime t)
......@@ -463,7 +463,7 @@ mrp_time_week_number (mrptime t)
*
* Convenience function for creating a #GParamSpec carrying an #mrptime value.
*
* Return value: Newly created #GparamSpec.
* Return value: Newly created #GParamSpec.
**/
GParamSpec *
mrp_param_spec_time (const gchar *name,
......@@ -924,30 +924,30 @@ time_format_helper (const gchar *format,
* @format: format string
* @t: an #mrptime value
*
* Formats a string with time values. The following format codes are allowed:
* <informalexample><programlisting>
* %a The abbreviated weekday name (Mon, Tue, ...)
* %A The full weekday name (Monday, Tuesday, ...)
* %b The abbreviated month name (Jan, Feb, ...)
* %B The full month name (January, February, ...)
* %d The day of the month (01 - 31).
* %e The day of the month (1 - 31).
* %H The hour using a 24-hour clock (00 - 23).
* %I The hour using a 12-hour clock (01 - 12).
* %j The day of the year (001 - 366).
* %k The hour using a 24-hour clock (0 to 23).
* %l The hour using a 12-hour clock (1 - 12).
* %m The month number (01 to 12).
* %M The minute (00 - 59).
* %p Either 'AM' or 'PM' according to the given time value.
* %P Like %p but in lowercase.
* %R The time in 24 hour notation (%H:%M).
* %S The second (00 - 61).
* %U The week number, (1 - 53), starting with the first Sunday as the first day of week 1.
* %W The week number, (1 - 53), starting with the first Monday as the first day of week 1.
* %y The year without a century (range 00 to 99).
* %Y The year including the century.
* </programlisting></informalexample>
* Formats a string with time values.
*
* The following format codes are allowed:
* - \%a: the abbreviated weekday name (Mon, Tue, ...)
* - \%A: the full weekday name (Monday, Tuesday, ...)
* - \%b: the abbreviated month name (Jan, Feb, ...)
* - \%B: the full month name (January, February, ...)
* - \%d: the day of the month (01 - 31).
* - \%e: the day of the month (1 - 31).
* - \%H: the hour using a 24-hour clock (00 - 23).
* - \%I: the hour using a 12-hour clock (01 - 12).
* - \%j: the day of the year (001 - 366).
* - \%k: the hour using a 24-hour clock (0 to 23).
* - \%l: the hour using a 12-hour clock (1 - 12).
* - \%m: the month number (01 to 12).
* - \%M: the minute (00 - 59).
* - \%p: either 'AM' or 'PM' according to the given time value.
* - \%P: like \%p but in lowercase.
* - \%R: the time in 24 hour notation (\%H:\%M).
* - \%S: the second (00 - 61).
* - \%U: the week number, (1 - 53), starting with the first Sunday as the first day of week 1.
* - \%W: the week number, (1 - 53), starting with the first Monday as the first day of week 1.
* - \%y: the year without a century (range 00 to 99).
* - \%Y: the year including the century.
*
* Return value: Newly created string that needs to be freed.
**/
......
......@@ -51,7 +51,7 @@ typedef long mrptime;
/**
* MRP_TIME_MAX:
*
* Represents the maximium value for #mrptime.
* Represents the maximum value for #mrptime.
*/
#define MRP_TIME_MAX 2147483647
......
......@@ -53,7 +53,7 @@ typedef enum {
* MrpConstraintType:
* @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_SNET: start no earlier than
* @MRP_CONSTRAINT_FNLT: finish no later than (unimplemented)
* @MRP_CONSTRAINT_MSO: must start on
*
......@@ -106,7 +106,7 @@ typedef struct _MrpTask MrpTask;
/**
* MrpResource:
*
* Object representing a task in the project.
* Object representing a resource in the project.
*/
typedef struct _MrpResource MrpResource;
/**
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment