[glide] gtk-doc fixes



commit 6b4c3e5d748f49e2b198f4e004c6003bf570ef5c
Author: Robert Carr <racarr Valentine localdomain>
Date:   Fri May 7 12:39:00 2010 -0400

    gtk-doc fixes

 docs/reference/glide-docs.sgml    |   90 ++++++++++++++++++++++++-------------
 docs/reference/glide-sections.txt |   16 -------
 docs/reference/glide.types        |    1 -
 3 files changed, 58 insertions(+), 49 deletions(-)
---
diff --git a/docs/reference/glide-docs.sgml b/docs/reference/glide-docs.sgml
index 56bf3dd..41d737f 100644
--- a/docs/reference/glide-docs.sgml
+++ b/docs/reference/glide-docs.sgml
@@ -6,46 +6,72 @@
 ]>
 <book id="index">
   <bookinfo>
-    <title>glide Reference Manual</title>
+    <title>glide API Reference Manual</title>
     <releaseinfo>
-      for glide [VERSION].
+      Documentation for Glide 0.1.
       The latest version of this documentation can be found on-line at
       <ulink role="online-location" url="http://[SERVER]/glide/index.html";>http://[SERVER]/glide/</ulink>.
     </releaseinfo>
   </bookinfo>
 
-  <chapter>
-    <title>Glide 0.1 Reference</title>
+  <part id="api">
+    <title>Glide API Reference </title>
+    <para>This is documentation for the libglide API, containing the Glide application logic</para>
     <xi:include href="xml/glide.xml"/>
-    <xi:include href="xml/glide-slide.xml"/>
-    <xi:include href="xml/glide-document.xml"/>
-    <xi:include href="xml/glide-window.xml"/>
-    <xi:include href="xml/glide-inspector-text.xml"/>
-    <xi:include href="xml/glide-inspector-slide.xml"/>
-    <xi:include href="xml/glide-stage-manager.xml"/>
-    <xi:include href="xml/glide-inspector-notebook.xml"/>
-    <xi:include href="xml/glide-slide-box.xml"/>
-    <xi:include href="xml/glide-animation-manager.xml"/>
-    <xi:include href="xml/glide-actor.xml"/>
-    <xi:include href="xml/glide-inspector-actor.xml"/>
-    <xi:include href="xml/glide-rectangle.xml"/>
-    <xi:include href="xml/glide-inspector-animation.xml"/>
-    <xi:include href="xml/glide-manipulator.xml"/>
-    <xi:include href="xml/glide-slide-button.xml"/>
-    <xi:include href="xml/glide-text.xml"/>
-    <xi:include href="xml/glide-image.xml"/>
-    <xi:include href="xml/glide-inspector-image.xml"/>
-    <xi:include href="xml/glide-undo-manager.xml"/>
-    <xi:include href="xml/glide-gtk-util.xml"/>
-    <xi:include href="xml/glide-json-util.xml"/>
-    <xi:include href="xml/glide-animations.xml"/>
-    <xi:include href="xml/glide-vala-animations.xml"/>
-    <xi:include href="xml/glide-debug.xml"/>
-    <xi:include href="xml/glide-cairo-util.xml"/>
-    <xi:include href="xml/glide-pdf-exporter.xml"/>
-    <xi:include href="xml/glide-dirs.xml"/>
+    <chapter id="actors">
+      <title>Glide Actor Types</title>
+      <xi:include href="xml/glide-actor.xml"/>
+      <xi:include href="xml/glide-text.xml"/>
+      <xi:include href="xml/glide-image.xml"/>
+      <xi:include href="xml/glide-slide.xml"/>
+      <xi:include href="xml/glide-manipulator.xml"/>
+    </chapter>
+    <chapter id="main-window">
+      <title>Main Window Types</title>
+      <xi:include href="xml/glide-window.xml"/>
+      <xi:include href="xml/glide-document.xml"/>
+      <xi:include href="xml/glide-stage-manager.xml"/>
+      <xi:include href="xml/glide-slide-box.xml"/>
+      <xi:include href="xml/glide-slide-button.xml"/>
+      <xi:include href="xml/glide-undo-manager.xml"/>
+    </chapter>
+    <chapter id="inspector">
+      <title>Inspector Window Types</title>
+      <xi:include href="xml/glide-inspector-notebook.xml"/>
+      <xi:include href="xml/glide-inspector-text.xml"/>
+      <xi:include href="xml/glide-inspector-slide.xml"/>
+      <xi:include href="xml/glide-inspector-actor.xml"/>
+      <xi:include href="xml/glide-inspector-animation.xml"/>
+      <xi:include href="xml/glide-inspector-image.xml"/>
+    </chapter>
+    <chapter id="animations">
+      <title>Animation Files</title>
+      <xi:include href="xml/glide-animation-manager.xml"/>
+      <xi:include href="xml/glide-animations.xml"/>
+      <xi:include href="xml/glide-vala-animations.xml"/>
+    </chapter>
+    <chapter id="util">
+      <title>Glide Utility Functions</title>
+      <xi:include href="xml/glide-gtk-util.xml"/>
+      <xi:include href="xml/glide-json-util.xml"/>
+      <xi:include href="xml/glide-cairo-util.xml"/>
+      <xi:include href="xml/glide-dirs.xml"/>
+    </chapter>
 
-  </chapter>
+    <chapter id="exporters">
+      <title>Glide Document Exporters</title>
+      <xi:include href="xml/glide-pdf-exporter.xml"/>
+    </chapter>
+
+
+    
+    <chapter id="debug">
+      <title>Glide Debug Functions</title>
+      <xi:include href="xml/glide-debug.xml"/>
+    </chapter>
+
+
+  </part>
   <chapter id="object-tree">
     <title>Object Hierarchy</title>
      <xi:include href="xml/tree_index.sgml"/>
diff --git a/docs/reference/glide-sections.txt b/docs/reference/glide-sections.txt
index eb105cb..6092c03 100644
--- a/docs/reference/glide-sections.txt
+++ b/docs/reference/glide-sections.txt
@@ -281,22 +281,6 @@ GLIDE_INSPECTOR_ACTOR_GET_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>glide-rectangle</FILE>
-<TITLE>GlideRectangle</TITLE>
-GlideRectangle
-GlideRectangleClass
-glide_rectangle_new
-<SUBSECTION Standard>
-GLIDE_RECTANGLE
-GLIDE_IS_RECTANGLE
-GLIDE_TYPE_RECTANGLE
-glide_rectangle_get_type
-GLIDE_RECTANGLE_CLASS
-GLIDE_IS_RECTANGLE_CLASS
-GLIDE_RECTANGLE_GET_CLASS
-</SECTION>
-
-<SECTION>
 <FILE>glide-inspector-animation</FILE>
 <TITLE>GlideInspectorAnimation</TITLE>
 GlideInspectorAnimationPrivate
diff --git a/docs/reference/glide.types b/docs/reference/glide.types
index 9d0af79..6b1fed1 100644
--- a/docs/reference/glide.types
+++ b/docs/reference/glide.types
@@ -10,7 +10,6 @@ glide_inspector_slide_get_type
 glide_inspector_text_get_type
 glide_manipulator_get_type
 glide_param_animation_info_get_type
-glide_rectangle_get_type
 glide_slide_box_get_type
 glide_slide_button_get_type
 glide_slide_get_type



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]