GNOME.org
 

[planner] Update GTK-Doc files. Add checks.

commit 60a349d4ef0a307d84f24e232385244f7ca501ec
Author: Ahmed Baïzid <ahmed baizid org>
Date:   Fri Apr 10 09:19:58 2015 +0200

    Update GTK-Doc files. Add checks.
    
    Inspired by the example Makefile.am from gtkdoc sources.
    Inspired by the generated sections and types files.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=747423

 docs/libplanner/Makefile.am             |  63 +++++---
 docs/libplanner/libplanner-docs.xml     |  18 ++-
 docs/libplanner/libplanner-sections.txt | 266 +++++++++++++++++++-------------
 docs/libplanner/libplanner.types        |  19 ++-
 4 files changed, 231 insertions(+), 135 deletions(-)
---
diff --git a/docs/libplanner/Makefile.am b/docs/libplanner/Makefile.am
index 033a0b0..fc9b1e2 100644
--- a/docs/libplanner/Makefile.am
+++ b/docs/libplanner/Makefile.am
@@ -3,19 +3,23 @@
 # The name of the module.
 DOC_MODULE=libplanner
 
-# The top-level SGML file.
-DOC_MAIN_SGML_FILE=libplanner-docs.xml
+# The top-level XML file (SGML in the past).
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
 
-# The directory containing the source code. Relative to $(srcdir)
-DOC_SOURCE_DIR=../../libplanner
+# Directories containing the source code.
+# gtk-doc will search all .c and .h files beneath these paths
+# for inline comments documenting functions and macros.
+# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
+DOC_SOURCE_DIR=$(top_srcdir)/libplanner
 
-# Extra options to pass to gtkdoc-scangobj
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
 SCANGOBJ_OPTIONS=
 
 # Extra options to supply to gtkdoc-scan
-#SCAN_OPTIONS=--deprecated-guards="GTK_ENABLE_BROKEN|GTK_DISABLE_DEPRECATED" 
+#SCAN_OPTIONS=--deprecated-guards="GTK_ENABLE_BROKEN|GTK_DISABLE_DEPRECATED"
 
-# Extra options to supply to gtkdoc-mkdb
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
 MKDB_OPTIONS=--xml-mode --output-format=xml
 
 # Extra options to supply to gtkdoc-fixref
@@ -25,20 +29,26 @@ MKDB_OPTIONS=--xml-mode --output-format=xml
 HFILE_GLOB=$(top_srcdir)/libplanner/*.h
 CFILE_GLOB=$(top_srcdir)/libplanner/*.c
 
-# Header files to ignore when scanning
-IGNORE_HFILES=  mrp-intl.h                     \
-               mrp-marshal.h                   \
-               mrp-task-manager.h              \
-               mrp-storage-module.h            \
-               mrp-storage-module-factory.h    \
-               mrp-private.h                   \
-               mrp-file-module.h
+# Header files or dirs to ignore when scanning. Use base file/dir names
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
+IGNORE_HFILES = \
+  mrp-file-module.h \
+  mrp-marshal.h \
+  mrp-old-xml.h \
+  mrp-parser.h \
+  mrp-paths.h  \
+  mrp-private.h \
+  mrp-sql.h \
+  mrp-storage-module-factory.h \
+  mrp-storage-module.h  \
+  mrp-storage-module-xml.h  \
+  mrp-storage-mrproject.h \
+  mrp-storage-sql.h \
+  mrp-task-manager.h
 
 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
-content_files =                
-
-# Other files to distribute
-extra_files =
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+content_files=
 
 # CFLAGS and LDFLAGS for compiling scan program. Only needed
 # if $(DOC_MODULE).types is non-empty.
@@ -51,9 +61,14 @@ GTKDOC_LIBS =                                                \
        $(LIBPLANNER_LIBS)                              \
        $(top_builddir)/libplanner/libplanner-1.la
 
-
-GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
-GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
-
-
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
 include $(top_srcdir)/gtk-doc.make
+
+# Comment this out if you want 'make check' to test you doc status
+# and run some sanity checks
+if ENABLE_GTK_DOC
+TESTS_ENVIRONMENT = \
+  DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
+  SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
+TESTS = $(GTKDOC_CHECK)
+endif
diff --git a/docs/libplanner/libplanner-docs.xml b/docs/libplanner/libplanner-docs.xml
index dc6efda..449de34 100644
--- a/docs/libplanner/libplanner-docs.xml
+++ b/docs/libplanner/libplanner-docs.xml
@@ -5,7 +5,6 @@
   <bookinfo>
     <title>Libplanner Reference Manual</title>
   </bookinfo>
-
   <chapter>
     <title>Libplanner API</title>
     <xi:include href="xml/mrp-application.xml"/>
@@ -21,5 +20,22 @@
     <xi:include href="xml/mrp-property.xml"/>
     <xi:include href="xml/mrp-time.xml"/>
     <xi:include href="xml/mrp-day.xml"/>
+    <xi:include href="xml/mrp-types.xml"/>
   </chapter>
+  <chapter id="object-tree">
+    <title>Object Hierarchy</title>
+    <xi:include href="xml/tree_index.sgml"/>
+  </chapter>
+  <index id="api-index-full">
+    <title>API Index</title>
+    <xi:include href="xml/api-index-full.xml">
+      <xi:fallback/>
+    </xi:include>
+  </index>
+  <index id="deprecated-api-index" role="deprecated">
+    <title>Index of deprecated API</title>
+    <xi:include href="xml/api-index-deprecated.xml">
+      <xi:fallback/>
+    </xi:include>
+  </index>
 </book>
diff --git a/docs/libplanner/libplanner-sections.txt b/docs/libplanner/libplanner-sections.txt
index 40b3d38..1511850 100644
--- a/docs/libplanner/libplanner-sections.txt
+++ b/docs/libplanner/libplanner-sections.txt
@@ -1,53 +1,51 @@
-<INCLUDE>libplanner/planner.h</INCLUDE>
-
 <SECTION>
 <FILE>mrp-application</FILE>
-MrpApplicationPriv
-MrpApplication
 <TITLE>MrpApplication</TITLE>
+MrpApplication
 mrp_application_new
+mrp_application_get_unique_id
+mrp_application_id_get_data
 <SUBSECTION Standard>
-MrpApplicationClass
 MRP_APPLICATION
-MRP_IS_APPLICATION
-MRP_TYPE_APPLICATION
 MRP_APPLICATION_CLASS
-MRP_IS_APPLICATION_CLASS
 MRP_APPLICATION_GET_CLASS
-
-<SUBSECTION Private>
+MRP_IS_APPLICATION
+MRP_IS_APPLICATION_CLASS
+MRP_TYPE_APPLICATION
+MrpApplicationClass
 mrp_application_get_type
+MrpApplicationPriv
 </SECTION>
 
 <SECTION>
 <FILE>mrp-assignment</FILE>
-MrpAssignmentPriv
-MrpAssignment
 <TITLE>MrpAssignment</TITLE>
+MrpAssignment
 mrp_assignment_new
 mrp_assignment_get_task
 mrp_assignment_get_resource
 mrp_assignment_get_units
 <SUBSECTION Standard>
-MrpAssignmentClass
 MRP_ASSIGNMENT
-MRP_IS_ASSIGNMENT
-MRP_TYPE_ASSIGNMENT
 MRP_ASSIGNMENT_CLASS
-MRP_IS_ASSIGNMENT_CLASS
 MRP_ASSIGNMENT_GET_CLASS
-
-<SUBSECTION Private>
+MRP_IS_ASSIGNMENT
+MRP_IS_ASSIGNMENT_CLASS
+MRP_TYPE_ASSIGNMENT
+MrpAssignmentClass
 mrp_assignment_get_type
+MrpAssignmentPriv
 </SECTION>
 
 <SECTION>
 <FILE>mrp-calendar</FILE>
-MrpCalendarPriv
+<TITLE>MrpCalendar</TITLE>
 MrpCalendar
 MrpInterval
-<TITLE>MrpCalendar</TITLE>
+MrpDayWithIntervals
+MrpDateWithDay
 mrp_calendar_new
+mrp_calendar_add
 mrp_calendar_copy
 mrp_calendar_derive
 mrp_calendar_reparent
@@ -63,165 +61,164 @@ mrp_calendar_set_default_days
 mrp_calendar_set_days
 mrp_calendar_get_parent
 mrp_calendar_get_children
+mrp_calendar_get_overridden_days
+mrp_calendar_get_all_overridden_dates
 mrp_interval_new
 mrp_interval_copy
 mrp_interval_ref
 mrp_interval_unref
 mrp_interval_get_absolute
+mrp_interval_set_absolute
 <SUBSECTION Standard>
-MrpCalendarClass
 MRP_CALENDAR
-MRP_IS_CALENDAR
-MRP_TYPE_CALENDAR
 MRP_CALENDAR_CLASS
-MRP_IS_CALENDAR_CLASS
 MRP_CALENDAR_GET_CLASS
-
-<SUBSECTION Private>
+MRP_IS_CALENDAR
+MRP_IS_CALENDAR_CLASS
+MRP_TYPE_CALENDAR
+MRP_TYPE_INTERVAL
 mrp_calendar_get_type
 mrp_interval_get_type
-MRP_TYPE_INTERVAL
-mrp_calendar_get_overridden_days
-MrpDateWithDay
-mrp_calendar_get_all_overridden_dates
-MrpDayWithIntervals
+MrpCalendarClass
+MrpCalendarPriv
 </SECTION>
 
 <SECTION>
 <FILE>mrp-group</FILE>
-MrpGroupPriv
-MrpGroup
 <TITLE>MrpGroup</TITLE>
+MrpGroup
 mrp_group_new
 mrp_group_get_name
 mrp_group_set_name
 <SUBSECTION Standard>
-MrpGroupClass
 MRP_GROUP
-MRP_IS_GROUP
-MRP_TYPE_GROUP
 MRP_GROUP_CLASS
-MRP_IS_GROUP_CLASS
 MRP_GROUP_GET_CLASS
-
-<SUBSECTION Private>
+MRP_IS_GROUP
+MRP_IS_GROUP_CLASS
+MRP_TYPE_GROUP
+MrpGroupClass
 mrp_group_get_type
+MrpGroupPriv
 </SECTION>
 
 <SECTION>
 <FILE>mrp-object</FILE>
-MrpObjectPriv
-MrpObject
 <TITLE>MrpObject</TITLE>
+MrpObject
 mrp_object_removed
 mrp_object_changed
 mrp_object_set
 mrp_object_get
+mrp_object_set_property
+mrp_object_get_property
 mrp_object_set_valist
 mrp_object_get_valist
 mrp_object_get_properties
-mrp_object_get_property
-mrp_object_set_property
+mrp_object_get_id
+mrp_object_set_id
+mrp_object_get_project
 <SUBSECTION Standard>
-MrpObjectClass
-MRP_OBJECT
 MRP_IS_OBJECT
-MRP_TYPE_OBJECT
-MRP_OBJECT_CLASS
 MRP_IS_OBJECT_CLASS
+MRP_OBJECT
+MRP_OBJECT_CLASS
 MRP_OBJECT_GET_CLASS
-
-<SUBSECTION Private>
+MRP_TYPE_OBJECT
+MrpObjectClass
 mrp_object_get_type
+MrpObjectPriv
 </SECTION>
 
 <SECTION>
 <FILE>mrp-project</FILE>
-MrpProjectPriv
+<TITLE>MrpProject</TITLE>
 MrpProject
 MrpTaskTraverseFunc
-<TITLE>MrpProject</TITLE>
 mrp_project_new
 mrp_project_is_empty
 mrp_project_needs_saving
 mrp_project_get_project_start
 mrp_project_set_project_start
+mrp_project_get_uri
+mrp_project_set_uri
+mrp_project_get_root_calendar
+mrp_project_get_calendar
+mrp_project_get_calendar_day_by_id
 mrp_project_load
 mrp_project_save
+mrp_project_save_as
+mrp_project_export
 mrp_project_save_to_xml
 mrp_project_load_from_xml
-mrp_project_save_as
 mrp_project_close
-mrp_project_get_uri
-mrp_project_get_resource_by_name
 mrp_project_get_resources
+mrp_project_get_resource_by_name
 mrp_project_add_resource
 mrp_project_remove_resource
-mrp_project_get_group_by_name
 mrp_project_get_groups
+mrp_project_get_group_by_name
 mrp_project_add_group
 mrp_project_remove_group
-mrp_project_get_task_by_name
 mrp_project_get_all_tasks
+mrp_project_get_task_by_name
 mrp_project_insert_task
 mrp_project_remove_task
 mrp_project_move_task
 mrp_project_get_root_task
 mrp_project_task_traverse
 mrp_project_reschedule
+mrp_project_calculate_summary_duration
 mrp_project_calculate_task_work
 mrp_project_get_properties_from_type
 mrp_project_add_property
 mrp_project_remove_property
-mrp_project_get_property
 mrp_project_has_property
-mrp_project_get_root_calendar
-mrp_project_get_calendar
+mrp_project_get_property
+mrp_project_set_block_scheduling
+mrp_project_get_block_scheduling
 <SUBSECTION Standard>
-MrpProjectClass
-MRP_PROJECT
 MRP_IS_PROJECT
-MRP_PROJECT_CLASS
 MRP_IS_PROJECT_CLASS
+MRP_PROJECT
+MRP_PROJECT_CLASS
 MRP_PROJECT_GET_CLASS
-
-<SUBSECTION Private>
-mrp_project_get_type
 MRP_TYPE_PROJECT
+MrpProjectClass
+mrp_project_get_type
+MrpProjectPriv
 </SECTION>
 
 <SECTION>
 <FILE>mrp-relation</FILE>
-MrpRelationPriv
-MrpRelation
-MrpRelationType
 <TITLE>MrpRelation</TITLE>
+MrpRelation
 mrp_relation_get_predecessor
 mrp_relation_get_successor
 mrp_relation_get_lag
 mrp_relation_get_relation_type
 <SUBSECTION Standard>
-MrpRelationClass
-MRP_RELATION
 MRP_IS_RELATION
-MRP_RELATION_CLASS
 MRP_IS_RELATION_CLASS
+MRP_RELATION
+MRP_RELATION_CLASS
 MRP_RELATION_GET_CLASS
-
-<SUBSECTION Private>
-mrp_relation_get_type
 MRP_TYPE_RELATION
+MrpRelationClass
+mrp_relation_get_type
+MrpRelationPriv
 </SECTION>
 
 <SECTION>
 <FILE>mrp-resource</FILE>
-MrpResourcePriv
-MrpResource
 <TITLE>MrpResource</TITLE>
+MrpResource
 MrpResourceType
 mrp_resource_new
 mrp_resource_get_name
 mrp_resource_set_name
+mrp_resource_get_short_name
+mrp_resource_set_short_name
 mrp_resource_assign
 mrp_resource_get_assignments
 mrp_resource_get_assigned_tasks
@@ -229,28 +226,32 @@ mrp_resource_compare
 mrp_resource_get_calendar
 mrp_resource_set_calendar
 <SUBSECTION Standard>
-MrpResourceClass
-MRP_RESOURCE
 MRP_IS_RESOURCE
-MRP_RESOURCE_CLASS
 MRP_IS_RESOURCE_CLASS
+MRP_RESOURCE
+MRP_RESOURCE_CLASS
 MRP_RESOURCE_GET_CLASS
-
-<SUBSECTION Private>
-mrp_resource_get_type
 MRP_TYPE_RESOURCE
+MrpResourceClass
+mrp_resource_get_type
+MrpResourcePriv
 </SECTION>
 
 <SECTION>
 <FILE>mrp-task</FILE>
-MrpTaskPriv
+<TITLE>MrpTask</TITLE>
 MrpTask
 MrpConstraint
 MrpConstraintType
-<TITLE>MrpTask</TITLE>
+MrpRelationType
+MrpTaskSched
+MrpTaskType
+MrpUnitsInterval
+UNIT_IVAL_GET_TIME
+MRP_DOMINANT_PRIORITY
 mrp_task_new
-mrp_task_set_name
 mrp_task_get_name
+mrp_task_set_name
 mrp_task_add_predecessor
 mrp_task_remove_predecessor
 mrp_task_get_relation
@@ -263,6 +264,7 @@ mrp_task_has_relation
 mrp_task_get_parent
 mrp_task_get_first_child
 mrp_task_get_next_sibling
+mrp_task_get_prev_sibling
 mrp_task_get_n_children
 mrp_task_get_nth_child
 mrp_task_get_position
@@ -273,33 +275,43 @@ mrp_task_get_latest_start
 mrp_task_get_latest_finish
 mrp_task_get_duration
 mrp_task_get_work
+mrp_task_get_priority
+mrp_task_is_dominant
+mrp_task_get_unit_ivals
+mrp_task_set_unit_ivals
 mrp_task_get_assignments
+mrp_task_get_nres
+mrp_task_get_fullwork
 mrp_task_get_assignment
 mrp_task_reset_constraint
 mrp_task_get_cost
+mrp_task_invalidate_cost
 mrp_task_get_assigned_resources
 mrp_task_compare
+mrp_task_get_task_type
+mrp_task_get_sched
+mrp_task_get_percent_complete
+mrp_task_get_critical
 <SUBSECTION Standard>
-MrpTaskClass
-MRP_TASK
 MRP_IS_TASK
-MRP_TYPE_TASK
-MRP_TASK_CLASS
 MRP_IS_TASK_CLASS
+MRP_TASK
+MRP_TASK_CLASS
 MRP_TASK_GET_CLASS
-
-<SUBSECTION Private>
 MRP_TYPE_CONSTRAINT
+MRP_TYPE_RELATION
+MRP_TYPE_TASK
+MrpTaskClass
 mrp_constraint_get_type
+mrp_relation_get_type
 mrp_task_get_type
+MrpTaskPriv
 </SECTION>
 
 <SECTION>
 <FILE>mrp-error</FILE>
 MRP_ERROR
 MrpError
-
-<SUBSECTION Private>
 mrp_error_quark
 </SECTION>
 
@@ -319,44 +331,75 @@ mrp_property_get_user_defined
 mrp_property_ref
 mrp_property_unref
 mrp_property_type_as_string
-<SUBSECTION Private>
+<SUBSECTION Standard>
 MRP_PROPERTY
 MRP_TYPE_PROPERTY
-mrp_day_get_type
 mrp_property_get_type
 </SECTION>
 
 <SECTION>
 <FILE>mrp-time</FILE>
 mrptime
+MrpTime
+MrpTimeUnit
 MRP_TIME_INVALID
 MRP_TIME_MIN
 MRP_TIME_MAX
 mrp_time_current_time
-mrp_time_from_tm
 mrp_time_compose
 mrp_time_decompose
 mrp_time_from_string
 mrp_time_to_string
 mrp_time_from_msdate_string
 mrp_time_align_day
+mrp_time_align_prev
+mrp_time_align_next
 mrp_time_day_of_week
 mrp_time_week_number
 mrp_time_day_name
 mrp_time_month_name
 mrp_time_month_name_initial
 mrp_time_format
+mrp_time_format_locale
 mrp_time_debug_print
 mrp_param_spec_time
-</SECTION>
-
-<SECTION>
-<FILE>planner</FILE>
+mrp_time_from_tm
+mrp_time2_new
+mrp_time2_free
+mrp_time2_set_date
+mrp_time2_set_time
+mrp_time2_get_date
+mrp_time2_get_time
+mrp_time2_add_years
+mrp_time2_add_months
+mrp_time2_add_days
+mrp_time2_add_seconds
+mrp_time2_add_minutes
+mrp_time2_add_hours
+mrp_time2_subtract_years
+mrp_time2_subtract_months
+mrp_time2_subtract_days
+mrp_time2_subtract_hours
+mrp_time2_subtract_minutes
+mrp_time2_subtract_seconds
+mrp_time2_debug_print
+mrp_time2_set_from_string
+mrp_time2_to_string
+mrp_time2_set_epoch
+mrp_time2_get_epoch
+mrp_time2_get_day_name
+mrp_time2_get_month_name
+mrp_time2_get_month_initial
+mrp_time2_get_week_number
+mrp_time2_align_prev
+mrp_time2_align_next
+mrp_time2_copy
+mrp_time2_clear
+mrp_time2_compare
 </SECTION>
 
 <SECTION>
 <FILE>mrp-day</FILE>
-MrpDay
 mrp_day_add
 mrp_day_get_all
 mrp_day_remove
@@ -370,9 +413,26 @@ mrp_day_unref
 mrp_day_get_work
 mrp_day_get_nonwork
 mrp_day_get_use_base
-
-<SUBSECTION Private>
+MrpDay
+<SUBSECTION Standard>
 MRP_DAY
 MRP_TYPE_DAY
 mrp_day_get_type
 </SECTION>
+
+<SECTION>
+<FILE>mrp-types</FILE>
+mrp_string_list_copy
+mrp_string_list_free
+<SUBSECTION Standard>
+MRP_TYPE_PROPERTY_TYPE
+MRP_TYPE_RELATION_TYPE
+MRP_TYPE_TASK_SCHED
+MRP_TYPE_TASK_TYPE
+mrp_property_type_get_type
+mrp_relation_type_get_type
+mrp_task_sched_get_type
+mrp_task_type_get_type
+<SUBSECTION Private>
+MRP_TYPE_STRING_LIST
+</SECTION>
diff --git a/docs/libplanner/libplanner.types b/docs/libplanner/libplanner.types
index 1b4ea15..0fe75a3 100644
--- a/docs/libplanner/libplanner.types
+++ b/docs/libplanner/libplanner.types
@@ -1,9 +1,14 @@
-#include <libplanner/planner.h>
-
-mrp_project_get_type
-mrp_task_get_type
-mrp_resource_get_type
-mrp_object_get_type
-mrp_group_get_type
+mrp_application_get_type
 mrp_assignment_get_type
 mrp_calendar_get_type
+mrp_constraint_get_type
+mrp_day_get_type
+mrp_group_get_type
+mrp_interval_get_type
+mrp_object_get_type
+mrp_project_get_type
+mrp_relation_get_type
+mrp_resource_get_type
+mrp_task_get_type
+mrp_task_sched_get_type
+mrp_task_type_get_type
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]