GNOME.org
 

[gdl] Improve presentation of the manual

commit 8f2f9198594ef8914b3e9e0b035d4c301a1abe84
Author: SÃbastien Granjoux <seb sfo free fr>
Date:   Wed May 23 22:45:12 2012 +0200

    Improve presentation of the manual

 configure.in                    |    1 +
 docs/reference/Makefile.am      |   11 ++--
 docs/reference/gdl-docs.sgml    |   59 ++++++++++++-----
 docs/reference/gdl-sections.txt |  133 +++++++++++++++++---------------------
 docs/reference/version.xml.in   |    1 +
 gdl/gdl-dock-item-grip.c        |    1 +
 gdl/gdl-dock-item.c             |    1 +
 gdl/gdl-dock-layout.c           |    1 +
 gdl/gdl-dock-master.c           |    2 +-
 gdl/gdl-dock.c                  |    1 +
 10 files changed, 114 insertions(+), 97 deletions(-)
---
diff --git a/configure.in b/configure.in
index 5c78f00..8f78637 100644
--- a/configure.in
+++ b/configure.in
@@ -151,6 +151,7 @@ gdl/Makefile
 po/Makefile.in 
 docs/Makefile
 docs/reference/Makefile
+docs/reference/version.xml
 gdl.spec
 gdl-3.0.pc
 ])
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 1204ea1..e5dc924 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -28,7 +28,7 @@ SCANGOBJ_OPTIONS=
 
 # Extra options to supply to gtkdoc-scan.
 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS=--rebuild-sections --rebuild-types
+SCAN_OPTIONS= --rebuild-types
 
 # Extra options to supply to gtkdoc-mkdb.
 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
@@ -50,7 +50,7 @@ CFILE_GLOB=$(top_srcdir)/gdl/*.c
 
 # Header files to ignore when scanning.
 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES=gdl-data-* gdl-i18n.h libgdl* gdl-preview-window.h
+IGNORE_HFILES=gdl-data-* gdl-i18n.h libgdl*
 
 # Images to copy into HTML directory.
 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
@@ -58,7 +58,8 @@ HTML_IMAGES=
 
 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
 # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
-content_files=
+content_files= \
+	version.xml
 
 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
 # These files must be listed here *and* in content_files
@@ -86,12 +87,12 @@ include $(top_srcdir)/gtk-doc.make
 
 # Other files to distribute
 # e.g. EXTRA_DIST += version.xml.in
-EXTRA_DIST +=
+EXTRA_DIST += version.xml.in
 
 # Files not to distribute
 # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
 # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
-#DISTCLEANFILES +=
+DISTCLEANFILES = $(DOC_MODULE).types
 
 # Comment this out if you want your docs-status tested during 'make check'
 #TESTS = $(GTKDOC_CHECK)
diff --git a/docs/reference/gdl-docs.sgml b/docs/reference/gdl-docs.sgml
index 3ffb6d0..6a3f8d4 100644
--- a/docs/reference/gdl-docs.sgml
+++ b/docs/reference/gdl-docs.sgml
@@ -1,26 +1,49 @@
 <?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"; [
+<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+<!ENTITY version SYSTEM "version.xml">
+]>
 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude";>
   <bookinfo>
-    <title>GDL Reference Manual</title>
+    <title>GNOME Docking Library Reference Manual</title>
     <releaseinfo>
-      for gdl 1.0
+      for libgdl &version;
     </releaseinfo>
   </bookinfo>
 
-  <chapter id="gdl-main">
-    <title>GDL - Gnome Development/Docking library</title>
-    <xi:include href="xml/gdl-dock-master.xml" />
-    <xi:include href="xml/gdl-dock-object.xml" />
-    <xi:include href="xml/gdl-dock.xml" />
-    <xi:include href="xml/gdl-dock-notebook.xml" />
-    <xi:include href="xml/gdl-dock-paned.xml" />
-    <xi:include href="xml/gdl-dock-item.xml" />
-    <xi:include href="xml/gdl-dock-item-grip.xml" />
-    <xi:include href="xml/gdl-dock-item-button-image.xml" />
-    <xi:include href="xml/gdl-dock-bar.xml" />
-    <xi:include href="xml/gdl-dock-placeholder.xml" />
-    <xi:include href="xml/gdl-dock-layout.xml" />
-  </chapter>
+  <part id="api">
+    <title>API Reference</title>
+    <chapter id="core">
+      <title>Core Classes</title>
+      <xi:include href="xml/gdl-dock-object.xml" />
+      <xi:include href="xml/gdl-dock-master.xml" />
+      <xi:include href="xml/gdl-dock-layout.xml" />
+    </chapter>
+    <chapter id="widget">
+      <title>Widgets</title>
+      <xi:include href="xml/gdl-dock.xml" />
+      <xi:include href="xml/gdl-dock-notebook.xml" />
+      <xi:include href="xml/gdl-dock-paned.xml" />
+      <xi:include href="xml/gdl-dock-item.xml" />
+      <xi:include href="xml/gdl-dock-bar.xml" />
+    </chapter>
+    <chapter id="private">
+      <title>Private Classes</title>
+      <xi:include href="xml/gdl-dock-item-grip.xml" />
+      <xi:include href="xml/gdl-dock-item-button-image.xml" />
+      <xi:include href="xml/gdl-dock-placeholder.xml" />
+      <xi:include href="xml/gdl-preview-window.xml" />
+      <xi:include href="xml/gdl-switcher.xml" />
+      <xi:include href="xml/gdl-dock-tablabel.xml" />
+    </chapter>
+  </part>
+
+  <index id="api-index-full">
+    <title>API Index</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+  </index>
+
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+
 </book>
diff --git a/docs/reference/gdl-sections.txt b/docs/reference/gdl-sections.txt
index c3fa373..ad288e4 100644
--- a/docs/reference/gdl-sections.txt
+++ b/docs/reference/gdl-sections.txt
@@ -8,16 +8,17 @@
 <TITLE>GdlDock</TITLE>
 GdlDock
 GdlDockClass
-gdl_dock_add_floating_item
+gdl_dock_new
+gdl_dock_new_from
 gdl_dock_add_item
+gdl_dock_add_floating_item
+gdl_dock_hide_preview
+gdl_dock_show_preview
+gdl_dock_set_skip_taskbar
 gdl_dock_get_item_by_name
 gdl_dock_get_named_items
 gdl_dock_get_placeholder_by_name
-gdl_dock_new
-gdl_dock_new_from
 gdl_dock_object_get_toplevel
-gdl_dock_xor_rect
-gdl_dock_xor_rect_hide
 <SUBSECTION Standard>
 GDL_DOCK
 GDL_DOCK_CLASS
@@ -34,14 +35,14 @@ gdl_dock_get_type
 <FILE>gdl-dock-bar</FILE>
 <TITLE>GdlDockBar</TITLE>
 GdlDockBar
-GdlDockBarClass
 GdlDockBarStyle
-gdl_dock_bar_get_orientation
-gdl_dock_bar_get_style
 gdl_dock_bar_new
 gdl_dock_bar_set_orientation
+gdl_dock_bar_get_orientation
 gdl_dock_bar_set_style
+gdl_dock_bar_get_style
 <SUBSECTION Standard>
+GdlDockBarClass
 GDL_DOCK_BAR
 GDL_DOCK_BAR_CLASS
 GDL_DOCK_BAR_GET_CLASS
@@ -70,30 +71,29 @@ GDL_DOCK_ITEM_USER_ACTION
 GdlDockItem
 GdlDockItemBehavior
 GdlDockItemClass
-GdlDockItemClassPrivate
 GdlDockItemFlags
+gdl_dock_item_new
+gdl_dock_item_new_with_pixbuf_icon
+gdl_dock_item_new_with_stock
 gdl_dock_item_bind
-gdl_dock_item_dock_to
-gdl_dock_item_get_grip
-gdl_dock_item_get_tablabel
+gdl_dock_item_unbind
+gdl_dock_item_show_grip
 gdl_dock_item_hide_grip
+gdl_dock_item_show_item
 gdl_dock_item_hide_item
 gdl_dock_item_iconify_item
+gdl_dock_item_dock_to
 gdl_dock_item_lock
-gdl_dock_item_new
-gdl_dock_item_new_with_pixbuf_icon
-gdl_dock_item_new_with_stock
+gdl_dock_item_unlock
 gdl_dock_item_notify_deselected
 gdl_dock_item_notify_selected
+gdl_dock_item_get_grip
+gdl_dock_item_get_tablabel
 gdl_dock_item_or_child_has_focus
 gdl_dock_item_preferred_size
 gdl_dock_item_set_default_position
 gdl_dock_item_set_orientation
 gdl_dock_item_set_tablabel
-gdl_dock_item_show_grip
-gdl_dock_item_show_item
-gdl_dock_item_unbind
-gdl_dock_item_unlock
 <SUBSECTION Standard>
 GDL_DOCK_ITEM
 GDL_DOCK_ITEM_CLASS
@@ -102,6 +102,7 @@ GDL_IS_DOCK_ITEM
 GDL_IS_DOCK_ITEM_CLASS
 GDL_TYPE_DOCK_ITEM
 GdlDockItemPrivate
+GdlDockItemClassPrivate
 gdl_dock_item_get_type
 </SECTION>
 
@@ -109,7 +110,6 @@ gdl_dock_item_get_type
 <FILE>gdl-dock-item-button-image</FILE>
 <TITLE>GdlDockItemButtonImage</TITLE>
 GdlDockItemButtonImage
-GdlDockItemButtonImageClass
 GdlDockItemButtonImageType
 gdl_dock_item_button_image_new
 <SUBSECTION Standard>
@@ -119,6 +119,7 @@ GDL_DOCK_ITEM_BUTTON_IMAGE_GET_CLASS
 GDL_IS_DOCK_ITEM_BUTTON_IMAGE
 GDL_IS_DOCK_ITEM_BUTTON_IMAGE_CLASS
 GDL_TYPE_DOCK_ITEM_BUTTON_IMAGE
+GdlDockItemButtonImageClass
 gdl_dock_item_button_image_get_type
 </SECTION>
 
@@ -126,11 +127,10 @@ gdl_dock_item_button_image_get_type
 <FILE>gdl-dock-item-grip</FILE>
 <TITLE>GdlDockItemGrip</TITLE>
 GdlDockItemGrip
-GdlDockItemGripClass
-gdl_dock_item_grip_hide_handle
 gdl_dock_item_grip_new
 gdl_dock_item_grip_set_label
 gdl_dock_item_grip_show_handle
+gdl_dock_item_grip_hide_handle
 <SUBSECTION Standard>
 GDL_DOCK_ITEM_GRIP
 GDL_DOCK_ITEM_GRIP_CLASS
@@ -139,6 +139,7 @@ GDL_IS_DOCK_ITEM_GRIP
 GDL_IS_DOCK_ITEM_GRIP_CLASS
 GDL_TYPE_DOCK_ITEM_GRIP
 GdlDockItemGripPrivate
+GdlDockItemGripClass
 gdl_dock_item_grip_get_type
 </SECTION>
 
@@ -146,15 +147,13 @@ gdl_dock_item_grip_get_type
 <FILE>gdl-dock-layout</FILE>
 <TITLE>GdlDockLayout</TITLE>
 GdlDockLayout
-GdlDockLayoutClass
+gdl_dock_layout_new
 gdl_dock_layout_attach
 gdl_dock_layout_delete_layout
 gdl_dock_layout_get_layouts
-gdl_dock_layout_get_layouts_ui
 gdl_dock_layout_is_dirty
-gdl_dock_layout_load_from_file
 gdl_dock_layout_load_layout
-gdl_dock_layout_new
+gdl_dock_layout_load_from_file
 gdl_dock_layout_save_layout
 gdl_dock_layout_save_to_file
 <SUBSECTION Standard>
@@ -165,6 +164,7 @@ GDL_IS_DOCK_LAYOUT
 GDL_IS_DOCK_LAYOUT_CLASS
 GDL_TYPE_DOCK_LAYOUT
 GdlDockLayoutPrivate
+GdlDockLayoutClass
 gdl_dock_layout_get_type
 </SECTION>
 
@@ -173,15 +173,14 @@ gdl_dock_layout_get_type
 <TITLE>GdlDockMaster</TITLE>
 GDL_DOCK_OBJECT_GET_MASTER
 GdlDockMaster
-GdlDockMasterClass
 GdlSwitcherStyle
 gdl_dock_master_add
-gdl_dock_master_foreach
-gdl_dock_master_foreach_toplevel
-gdl_dock_master_get_controller
-gdl_dock_master_get_object
 gdl_dock_master_remove
 gdl_dock_master_set_controller
+gdl_dock_master_get_controller
+gdl_dock_master_get_object
+gdl_dock_master_foreach
+gdl_dock_master_foreach_toplevel
 <SUBSECTION Standard>
 GDL_DOCK_MASTER
 GDL_DOCK_MASTER_CLASS
@@ -197,10 +196,10 @@ gdl_dock_master_get_type
 <FILE>gdl-dock-notebook</FILE>
 <TITLE>GdlDockNotebook</TITLE>
 GdlDockNotebook
-GdlDockNotebookClass
-GdlDockNotebookClassPrivate
 gdl_dock_notebook_new
 <SUBSECTION Standard>
+GdlDockNotebookClass
+GdlDockNotebookClassPrivate
 GDL_DOCK_NOTEBOOK
 GDL_DOCK_NOTEBOOK_CLASS
 GDL_DOCK_NOTEBOOK_GET_CLASS
@@ -213,8 +212,6 @@ gdl_dock_notebook_get_type
 <SECTION>
 <FILE>gdl-dock-object</FILE>
 <TITLE>GdlDockObject</TITLE>
-GDL_DOCK_MASTER_PROPERTY
-GDL_DOCK_NAME_PROPERTY
 GDL_DOCK_OBJECT_ATTACHED
 GDL_DOCK_OBJECT_AUTOMATIC
 GDL_DOCK_OBJECT_FLAGS
@@ -258,15 +255,18 @@ GDL_TYPE_DOCK_OBJECT
 GDL_TYPE_DOCK_PARAM
 gdl_dock_object_get_type
 gdl_dock_param_get_type
+<SUBSECTION Private>
+GDL_DOCK_MASTER_PROPERTY
+GDL_DOCK_NAME_PROPERTY
 </SECTION>
 
 <SECTION>
 <FILE>gdl-dock-paned</FILE>
 <TITLE>GdlDockPaned</TITLE>
 GdlDockPaned
-GdlDockPanedClass
 gdl_dock_paned_new
 <SUBSECTION Standard>
+GdlDockPanedClass
 GDL_DOCK_PANED
 GDL_DOCK_PANED_CLASS
 GDL_DOCK_PANED_GET_CLASS
@@ -280,10 +280,10 @@ gdl_dock_paned_get_type
 <FILE>gdl-dock-placeholder</FILE>
 <TITLE>GdlDockPlaceholder</TITLE>
 GdlDockPlaceholder
-GdlDockPlaceholderClass
-gdl_dock_placeholder_attach
 gdl_dock_placeholder_new
+gdl_dock_placeholder_attach
 <SUBSECTION Standard>
+GdlDockPlaceholderClass
 GDL_DOCK_PLACEHOLDER
 GDL_DOCK_PLACEHOLDER_CLASS
 GDL_DOCK_PLACEHOLDER_GET_CLASS
@@ -298,11 +298,11 @@ gdl_dock_placeholder_get_type
 <FILE>gdl-dock-tablabel</FILE>
 <TITLE>GdlDockTablabel</TITLE>
 GdlDockTablabel
-GdlDockTablabelClass
+gdl_dock_tablabel_new
 gdl_dock_tablabel_activate
 gdl_dock_tablabel_deactivate
-gdl_dock_tablabel_new
 <SUBSECTION Standard>
+GdlDockTablabelClass
 GDL_DOCK_TABLABEL
 GDL_DOCK_TABLABEL_CLASS
 GDL_DOCK_TABLABEL_GET_CLASS
@@ -313,14 +313,31 @@ gdl_dock_tablabel_get_type
 </SECTION>
 
 <SECTION>
+<FILE>gdl-preview-window</FILE>
+<TITLE>GdlPreviewWindow</TITLE>
+GdlPreviewWindow
+gdl_preview_window_new
+gdl_preview_window_update
+<SUBSECTION Standard>
+GdlPreviewWindowClass
+GDL_IS_PREVIEW_WINDOW
+GDL_IS_PREVIEW_WINDOW_CLASS
+GDL_PREVIEW_WINDOW
+GDL_PREVIEW_WINDOW_CLASS
+GDL_PREVIEW_WINDOW_GET_CLASS
+GDL_TYPE_PREVIEW_WINDOW
+gdl_preview_window_get_type
+</SECTION>
+
+<SECTION>
 <FILE>gdl-switcher</FILE>
 <TITLE>GdlSwitcher</TITLE>
 GdlSwitcher
-GdlSwitcherClass
-GdlSwitcherClassPrivate
-gdl_switcher_insert_page
 gdl_switcher_new
+gdl_switcher_insert_page
 <SUBSECTION Standard>
+GdlSwitcherClass
+GdlSwitcherClassPrivate
 GDL_IS_SWITCHER
 GDL_IS_SWITCHER_CLASS
 GDL_SWITCHER
@@ -330,33 +347,3 @@ GdlSwitcherPrivate
 gdl_switcher_get_type
 </SECTION>
 
-<SECTION>
-<FILE>libgdlmarshal</FILE>
-gdl_marshal_VOID__BOOLEAN
-gdl_marshal_VOID__BOXED
-gdl_marshal_VOID__ENUM
-gdl_marshal_VOID__INT_INT
-gdl_marshal_VOID__OBJECT_ENUM_BOXED
-gdl_marshal_VOID__UINT_UINT
-gdl_marshal_VOID__VOID
-</SECTION>
-
-<SECTION>
-<FILE>libgdltypebuiltins</FILE>
-<SUBSECTION Standard>
-GDL_TYPE_DOCK_BAR_STYLE
-GDL_TYPE_DOCK_ITEM_BEHAVIOR
-GDL_TYPE_DOCK_ITEM_FLAGS
-GDL_TYPE_DOCK_OBJECT_FLAGS
-GDL_TYPE_DOCK_PARAM_FLAGS
-GDL_TYPE_DOCK_PLACEMENT
-GDL_TYPE_SWITCHER_STYLE
-gdl_dock_bar_style_get_type
-gdl_dock_item_behavior_get_type
-gdl_dock_item_flags_get_type
-gdl_dock_object_flags_get_type
-gdl_dock_param_flags_get_type
-gdl_dock_placement_get_type
-gdl_switcher_style_get_type
-</SECTION>
-
diff --git a/docs/reference/version.xml.in b/docs/reference/version.xml.in
new file mode 100644
index 0000000..1c3355a
--- /dev/null
+++ b/docs/reference/version.xml.in
@@ -0,0 +1 @@
+ GDL_VERSION@
diff --git a/gdl/gdl-dock-item-grip.c b/gdl/gdl-dock-item-grip.c
index 84d055c..1bd7fdc 100644
--- a/gdl/gdl-dock-item-grip.c
+++ b/gdl/gdl-dock-item-grip.c
@@ -45,6 +45,7 @@
  * @title: GdlDockItemGrip
  * @short_description: A grip for dock widgets.
  * @see_also: GtlDockItem, GdlDockItemButtonImage
+ * @stability: Internal
  *
  * This widget contains an area where the user can click to drag the dock item
  * and two buttons. The first button allows to iconify the dock item.
diff --git a/gdl/gdl-dock-item.c b/gdl/gdl-dock-item.c
index fa8ec8e..56db7b4 100644
--- a/gdl/gdl-dock-item.c
+++ b/gdl/gdl-dock-item.c
@@ -53,6 +53,7 @@
  * @title: GdlDockItem
  * @short_description: Adds docking capability to its child widget.
  * @see_also: #GdlDockItem
+ * @stability: Unstable
  *
  * A dock item is a container widget that can be docked at different place.
  * It accepts a single child and adds a grip allowing the user to click on it
diff --git a/gdl/gdl-dock-layout.c b/gdl/gdl-dock-layout.c
index 9ea71d3..d3a99d4 100644
--- a/gdl/gdl-dock-layout.c
+++ b/gdl/gdl-dock-layout.c
@@ -36,6 +36,7 @@
  * SECTION:gdl-dock-layout
  * @title: GdlDockLayout
  * @short_description: save and restore dock widgets.
+ * @stability: Unstable
  *
  * The layout of all docking widgets can be saved using this #GdlDockLayout
  * object. It automatically monitors the layout_changed signal of the
diff --git a/gdl/gdl-dock-master.c b/gdl/gdl-dock-master.c
index c2b5157..a9312fe 100644
--- a/gdl/gdl-dock-master.c
+++ b/gdl/gdl-dock-master.c
@@ -40,7 +40,7 @@
  * SECTION:gdl-dock-master
  * @title: GdlDockMaster
  * @short_description: Manage all dock widgets
- * @stability: Internal
+ * @stability: Unstable
  * @see_also: #GdlDockObject, #GdlDockNotebook, #GdlDockPaned
  *
  * For the toplevel docks to be able to interact with each other, when the user
diff --git a/gdl/gdl-dock.c b/gdl/gdl-dock.c
index d84cef2..be4b3d7 100644
--- a/gdl/gdl-dock.c
+++ b/gdl/gdl-dock.c
@@ -42,6 +42,7 @@
  * @title: GdlDock
  * @short_description: A docking area widget.
  * @see_also: #GdlDockItem, #GdlDockMaster
+ * @stability: Unstable
  *
  * A #GdlDock is the toplevel widget which in turn hold a tree of #GdlDockItem
  * widgets. Each #GdlDock widget is bound to a #GdlDockMaster object.
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]