Commit 6b56aa2e authored by Ahmed Baïzid's avatar Ahmed Baïzid Committed by Andrew Miloradovsky

Move docs from tmpl files to sources.

https://bugzilla.gnome.org/show_bug.cgi?id=747423
parent 76d31def
......@@ -131,14 +131,6 @@ mrproject
@Returns:
<!-- ##### FUNCTION mrp_time_from_tm ##### -->
<para>
</para>
@tm:
@Returns:
<!-- ##### MACRO textdomain ##### -->
<para>
......
<!-- ##### SECTION Title ##### -->
MrpApplication
<!-- ##### SECTION Short_Description ##### -->
the main project application object.
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT MrpApplicationPriv ##### -->
<para>
A private struct for internal use only. The definition of this
structure is not publically available.
</para>
<!-- ##### STRUCT MrpApplication ##### -->
<para>
Object representing the application using libmrproject. You need to
create an #MrpApplication object to create projects and use
libmrproject.
</para>
@parent:
@priv:
<!-- ##### FUNCTION mrp_application_new ##### -->
<para>
</para>
@Returns:
<!-- ##### SECTION Title ##### -->
MrpAssignment
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT MrpAssignmentPriv ##### -->
<para>
A private struct for internal use only. The definition of this
structure is not publically available.
</para>
<!-- ##### STRUCT MrpAssignment ##### -->
<para>
Represents an assignment, i.e. the assignment of a task to a resource.
</para>
<!-- ##### ARG MrpAssignment:resource ##### -->
<para>
</para>
<!-- ##### ARG MrpAssignment:task ##### -->
<para>
</para>
<!-- ##### ARG MrpAssignment:units ##### -->
<para>
</para>
<!-- ##### FUNCTION mrp_assignment_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION mrp_assignment_get_task ##### -->
<para>
</para>
@assignment:
@Returns:
<!-- ##### FUNCTION mrp_assignment_get_resource ##### -->
<para>
</para>
@assignment:
@Returns:
<!-- ##### FUNCTION mrp_assignment_get_units ##### -->
<para>
</para>
@assignment:
@Returns:
<!-- # Unused Parameters # -->
@assignemnt:
<!-- ##### SECTION Title ##### -->
MrpCalendar
<!-- ##### SECTION Short_Description ##### -->
represents a calendar in the project.
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<para>
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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT MrpCalendarPriv ##### -->
<para>
A private struct for internal use only. The definition of this
structure is not publically available.
</para>
<!-- ##### STRUCT MrpCalendar ##### -->
<para>
Object representing a calendar in the project.
</para>
<!-- ##### SIGNAL MrpCalendar::calendar-changed ##### -->
<para>
</para>
@mrpcalendar: the object which received the signal.
<!-- ##### ARG MrpCalendar:name ##### -->
<para>
</para>
<!-- ##### ARG MrpCalendar:project ##### -->
<para>
</para>
<!-- ##### STRUCT MrpInterval ##### -->
<para>
Represents a time interval.
</para>
<!-- ##### FUNCTION mrp_calendar_new ##### -->
<para>
</para>
@name:
@project:
@Returns:
<!-- ##### FUNCTION mrp_calendar_copy ##### -->
<para>
</para>
@name:
@calendar:
@Returns:
<!-- ##### FUNCTION mrp_calendar_derive ##### -->
<para>
</para>
@name:
@parent:
@Returns:
<!-- ##### FUNCTION mrp_calendar_reparent ##### -->
<para>
</para>
@new_parent:
@child:
<!-- ##### FUNCTION mrp_calendar_remove ##### -->
<para>
</para>
@calendar:
<!-- ##### FUNCTION mrp_calendar_get_name ##### -->
<para>
</para>
@calendar:
@Returns:
<!-- ##### FUNCTION mrp_calendar_set_name ##### -->
<para>
</para>
@calendar:
@name:
<!-- ##### FUNCTION mrp_calendar_day_set_intervals ##### -->
<para>
</para>
@calendar:
@day:
@intervals:
<!-- ##### FUNCTION mrp_calendar_day_get_intervals ##### -->
<para>
</para>
@calendar:
@day:
@check_ancestors:
@Returns:
<!-- ##### FUNCTION mrp_calendar_day_get_total_work ##### -->
<para>
</para>
@calendar:
@day:
@Returns:
<!-- ##### FUNCTION mrp_calendar_get_day ##### -->
<para>
</para>
@calendar:
@date:
@check_ancestors:
@Returns:
<!-- # Unused Parameters # -->
@time:
<!-- ##### FUNCTION mrp_calendar_get_default_day ##### -->
<para>
</para>
@calendar:
@week_day:
@Returns:
<!-- # Unused Parameters # -->
@time:
<!-- ##### FUNCTION mrp_calendar_set_default_days ##### -->
<para>
</para>
@calendar:
@week_day:
@Varargs:
<!-- ##### FUNCTION mrp_calendar_set_days ##### -->
<para>
</para>
@calendar:
@date:
@Varargs:
<!-- ##### FUNCTION mrp_calendar_get_parent ##### -->
<para>
</para>
@calendar:
@Returns:
<!-- ##### FUNCTION mrp_calendar_get_children ##### -->
<para>
</para>
@calendar:
@Returns:
<!-- ##### FUNCTION mrp_interval_new ##### -->
<para>
</para>
@start:
@end:
@Returns:
<!-- ##### FUNCTION mrp_interval_copy ##### -->
<para>
</para>
@interval:
@Returns:
<!-- ##### FUNCTION mrp_interval_ref ##### -->
<para>
</para>
@interval:
@Returns:
<!-- ##### FUNCTION mrp_interval_unref ##### -->
<para>
</para>
@interval:
<!-- ##### FUNCTION mrp_interval_get_absolute ##### -->
<para>
</para>
@interval:
@offset:
@start:
@end:
<!-- ##### SECTION Title ##### -->
mrpday
<!-- ##### SECTION Short_Description ##### -->
represents a day type in the project.
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT MrpDay ##### -->
<para>
Object representing a day in the project.
</para>
<!-- ##### FUNCTION mrp_day_add ##### -->
<para>
</para>
@project:
@name:
@description:
@Returns:
<!-- ##### FUNCTION mrp_day_get_all ##### -->
<para>
</para>
@project:
@Returns:
<!-- ##### FUNCTION mrp_day_remove ##### -->
<para>
</para>
@project:
@day:
<!-- ##### FUNCTION mrp_day_get_id ##### -->
<para>
</para>
@day:
@Returns:
<!-- ##### FUNCTION mrp_day_get_name ##### -->
<para>
</para>
@day:
@Returns:
<!-- ##### FUNCTION mrp_day_set_name ##### -->
<para>
</para>
@day:
@name:
<!-- ##### FUNCTION mrp_day_get_description ##### -->
<para>
</para>
@day:
@Returns:
<!-- ##### FUNCTION mrp_day_set_description ##### -->
<para>
</para>
@day:
@description:
<!-- ##### FUNCTION mrp_day_ref ##### -->
<para>
</para>
@day:
@Returns:
<!-- ##### FUNCTION mrp_day_unref ##### -->
<para>
</para>
@day:
<!-- ##### FUNCTION mrp_day_get_work ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION mrp_day_get_nonwork ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION mrp_day_get_use_base ##### -->
<para>
</para>
@Returns:
<!-- ##### SECTION Title ##### -->
MrpError
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO MRP_ERROR ##### -->
<para>
Error domain for libmrproject.
</para>
<!-- ##### ENUM MrpError ##### -->
<para>
Error codes returned by libmrproject functions.
</para>
@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:
<!-- ##### SECTION Title ##### -->
MrpGroup
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT MrpGroupPriv ##### -->
<para>
A private struct for internal use only. The definition of this
structure is not publically available.
</para>
<!-- ##### STRUCT MrpGroup ##### -->
<para>
Object representing a resource group.
</para>
<!-- ##### ARG MrpGroup:manager-email ##### -->
<para>
</para>
<!-- ##### ARG MrpGroup:manager-name ##### -->
<para>
</para>
<!-- ##### ARG MrpGroup:manager-phone ##### -->
<para>
</para>
<!-- ##### ARG MrpGroup:name ##### -->
<para>
</para>
<!-- ##### FUNCTION mrp_group_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION mrp_group_get_name ##### -->
<para>
</para>
@group:
@Returns:
<!-- ##### FUNCTION mrp_group_set_name ##### -->
<para>
</para>
@group:
@name:
<!-- ##### SECTION Title ##### -->
mrp-init
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION mrp_init ##### -->
<para>
</para>
@Returns:
<!-- ##### SECTION Title ##### -->
mrp-intl
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO _ ##### -->
<para>
</para>
@String:
<!-- ##### MACRO N_ ##### -->
<para>
</para>
@String:
<!-- ##### MACRO textdomain ##### -->
<para>
</para>
@String:
<!-- ##### MACRO gettext ##### -->
<para>
</para>
@String:
<!-- ##### MACRO dgettext ##### -->
<para>
</para>
@Domain:
@String: