GNOME.org
 

[glib-controller] Add API reference

commit 46622d1d748ab6302abbb572544bc18bee1eb987
Author: Emmanuele Bassi <ebassi linux intel com>
Date:   Fri Apr 30 13:21:27 2010 +0100

    Add API reference

 .gitignore                                 |   15 ++++
 doc/reference/glib-controller-docs.xml     |   51 +++++++++++
 doc/reference/glib-controller-sections.txt |  127 ++++++++++++++++++++++++++++
 doc/reference/glib-controller.types        |    5 +
 glib-controller/garraycontroller.c         |    2 +-
 glib-controller/ghashcontroller.c          |    2 +-
 glib-controller/gptrarraycontroller.c      |    2 +-
 7 files changed, 201 insertions(+), 3 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index 999a390..e720d4a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -25,6 +25,21 @@ doc/Makefile
 doc/Makefile.in
 doc/reference/Makefile
 doc/reference/Makefile.in
+doc/reference/*.stamp
+doc/reference/glib-controller-decl-list.txt
+doc/reference/glib-controller-decl.txt
+doc/reference/glib-controller-overrides.txt
+doc/reference/glib-controller-undeclared.txt
+doc/reference/glib-controller-undocumented.txt
+doc/reference/glib-controller-unused.txt
+doc/reference/glib-controller.args
+doc/reference/glib-controller.hierarchy
+doc/reference/glib-controller.interfaces
+doc/reference/glib-controller.prerequisites
+doc/reference/glib-controller.signals
+doc/reference/html/
+doc/reference/tmpl/
+doc/reference/xml/
 doc/reference/version.xml
 GController-1.0.*
 glib-controller-1.0.pc
diff --git a/doc/reference/glib-controller-docs.xml b/doc/reference/glib-controller-docs.xml
new file mode 100644
index 0000000..2534de6
--- /dev/null
+++ b/doc/reference/glib-controller-docs.xml
@@ -0,0 +1,51 @@
+<?xml version="1.0"?>
+<!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'">
+]>
+<book id="index">
+  <bookinfo>
+    <title>GLib-Controller Reference Manual</title>
+  </bookinfo>
+
+  <part id="glib-controller">
+    <title>GLib Controller</title>
+
+    <chapter>
+      <title>Base Classes</title>
+
+      <xi:include href="xml/gcontroller.xml"/>
+      <xi:include href="xml/gcontrollerreference.xml"/>
+    </chapter>
+
+    <chapter>
+      <title>Controllers</title>
+
+      <xi:include href="xml/garraycontroller.xml"/>
+      <xi:include href="xml/gptrarraycontroller.xml"/>
+      <xi:include href="xml/ghashcontroller.xml"/>
+    </chapter>
+
+    <chapter>
+      <title>Utilities</title>
+
+      <xi:include href="xml/gcontrollerutils.xml"/>
+    </chapter>
+
+  </part>
+
+  <part id="glib-controller-indices">
+    <chapter id="object-tree">
+      <title>Object Hierarchy</title>
+        <xi:include href="xml/tree_index.sgml"/>
+    </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/doc/reference/glib-controller-sections.txt b/doc/reference/glib-controller-sections.txt
new file mode 100644
index 0000000..4c95f53
--- /dev/null
+++ b/doc/reference/glib-controller-sections.txt
@@ -0,0 +1,127 @@
+<SECTION>
+<FILE>ghashcontroller</FILE>
+<TITLE>GHashController</TITLE>
+GHashController
+GHashControllerClass
+g_hash_controller_new
+g_hash_controller_set_hash
+g_hash_controller_get_hash
+
+<SUBSECTION Standard>
+g_hash_controller_get_type
+G_HASH_CONTROLLER
+G_IS_HASH_CONTROLLER
+G_HASH_CONTROLLER_CLASS
+G_IS_HASH_CONTROLLER_CLASS
+G_HASH_CONTROLLER_GET_CLASS
+G_TYPE_HASH_CONTROLLER
+
+<SUBSECTION Private>
+GHashControllerPrivate
+</SECTION>
+
+<SECTION>
+<FILE>gptrarraycontroller</FILE>
+<TITLE>GPtrArrayController</TITLE>
+GPtrArrayController
+GPtrArrayControllerClass
+g_ptr_array_controller_new
+g_ptr_array_controller_set_array
+g_ptr_array_controller_get_array
+
+<SUBSECTION Standard>
+g_ptr_array_controller_get_type
+G_PTR_ARRAY_CONTROLLER
+G_IS_PTR_ARRAY_CONTROLLER
+G_PTR_ARRAY_CONTROLLER_CLASS
+G_IS_PTR_ARRAY_CONTROLLER_CLASS
+G_PTR_ARRAY_CONTROLLER_GET_CLASS
+G_TYPE_PTR_ARRAY_CONTROLLER
+
+<SUBSECTION Private>
+GPtrArrayControllerPrivate
+</SECTION>
+
+<SECTION>
+<FILE>gcontroller</FILE>
+<TITLE>GController</TITLE>
+GController
+GControllerClass
+GControllerAction
+g_controller_create_reference
+g_controller_create_referencev
+g_controller_emit_changed
+
+<SUBSECTION Standard>
+g_controller_get_type
+G_CONTROLLER
+G_IS_CONTROLLER
+G_TYPE_CONTROLLER
+G_CONTROLLER_CLASS
+G_IS_CONTROLLER_CLASS
+G_CONTROLLER_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>garraycontroller</FILE>
+<TITLE>GArrayController</TITLE>
+GArrayController
+GArrayControllerClass
+g_array_controller_new
+g_array_controller_set_array
+g_array_controller_get_array
+
+<SUBSECTION Standard>
+g_array_controller_get_type
+G_ARRAY_CONTROLLER
+G_IS_ARRAY_CONTROLLER
+G_ARRAY_CONTROLLER_CLASS
+G_IS_ARRAY_CONTROLLER_CLASS
+G_ARRAY_CONTROLLER_GET_CLASS
+G_TYPE_ARRAY_CONTROLLER
+
+<SUBSECTION Private>
+GArrayControllerPrivate
+</SECTION>
+
+<SECTION>
+<FILE>gcontrollerreference</FILE>
+<TITLE>GControllerReference</TITLE>
+GControllerReference
+GControllerReferenceClass
+g_controller_reference_get_controller
+g_controller_reference_get_action
+g_controller_reference_get_n_indices
+g_controller_reference_get_index_type
+
+<SUBSECTION>
+g_controller_reference_add_index_value
+g_controller_reference_get_index_value
+g_controller_reference_add_index
+g_controller_reference_get_index_int
+g_controller_reference_get_index_uint
+g_controller_reference_get_index_string
+g_controller_reference_get_index_pointer
+
+<SUBSECTION Standard>
+g_controller_reference_get_type
+G_CONTROLLER_REFERENCE
+G_IS_CONTROLLER_REFERENCE
+G_CONTROLLER_REFERENCE_CLASS
+G_IS_CONTROLLER_REFERENCE_CLASS
+G_CONTROLLER_REFERENCE_GET_CLASS
+G_TYPE_CONTROLLER_REFERENCE
+
+<SUBSECTION Private>
+GControllerReferencePrivate
+</SECTION>
+
+<SECTION>
+<FILE>gcontrollerutils</FILE>
+<TITLE>GController Utilities</TITLE>
+G_CONTROLLER_MAJOR_VERSION
+G_CONTROLLER_MINOR_VERSION
+G_CONTROLLER_MICRO_VERSION
+G_CONTROLLER_VERSION_S
+G_CONTROLLER_VERSION_HEX
+</SECTION>
diff --git a/doc/reference/glib-controller.types b/doc/reference/glib-controller.types
new file mode 100644
index 0000000..c43c6da
--- /dev/null
+++ b/doc/reference/glib-controller.types
@@ -0,0 +1,5 @@
+g_array_controller_get_type
+g_controller_get_type
+g_controller_reference_get_type
+g_hash_controller_get_type
+g_ptr_array_controller_get_type
diff --git a/glib-controller/garraycontroller.c b/glib-controller/garraycontroller.c
index eb4bd9b..45c1096 100644
--- a/glib-controller/garraycontroller.c
+++ b/glib-controller/garraycontroller.c
@@ -5,7 +5,7 @@
 #include "garraycontroller.h"
 
 /**
- * SECTION:g-array-controller
+ * SECTION:garraycontroller
  * @Title: GArrayController
  * @Short_Description: A controller for GLib arrays
  * @See_Also: #GController, #GArray
diff --git a/glib-controller/ghashcontroller.c b/glib-controller/ghashcontroller.c
index 80e8f8b..b5ec6ca 100644
--- a/glib-controller/ghashcontroller.c
+++ b/glib-controller/ghashcontroller.c
@@ -5,7 +5,7 @@
 #include "ghashcontroller.h"
 
 /**
- * SECTION:g-hash-controller
+ * SECTION:ghashcontroller
  * @Title: GHashController
  * @Short_Description: A controller for GLib hash tables
  * @See_Also: #GController, #GHashTable
diff --git a/glib-controller/gptrarraycontroller.c b/glib-controller/gptrarraycontroller.c
index e6447c5..e752f42 100644
--- a/glib-controller/gptrarraycontroller.c
+++ b/glib-controller/gptrarraycontroller.c
@@ -5,7 +5,7 @@
 #include "gptrarraycontroller.h"
 
 /**
- * SECTION:g-array-controller
+ * SECTION:gptrarraycontroller
  * @Title: GPtrArrayController
  * @Short_Description: A controller for GLib arrays
  * @See_Also: #GController, #GPtrArray
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]