[gtk+] [docs] Move documentation to inline comments: GailTextUtil and GailMisc



commit 72d5cc8cd51f8bc3f66186c668f2d4cfd191f6ca
Author: Javier Jardón <jjardon gnome org>
Date:   Sun Apr 18 19:40:17 2010 +0200

    [docs] Move documentation to inline comments: GailTextUtil and GailMisc

 docs/reference/libgail-util/tmpl/gailmisc.sgml     |  125 --------------------
 docs/reference/libgail-util/tmpl/gailtextutil.sgml |   95 ---------------
 modules/other/gail/libgail-util/gailmisc.c         |   12 ++
 modules/other/gail/libgail-util/gailtextutil.c     |   15 +++
 4 files changed, 27 insertions(+), 220 deletions(-)
---
diff --git a/modules/other/gail/libgail-util/gailmisc.c b/modules/other/gail/libgail-util/gailmisc.c
index ade1288..81b1382 100644
--- a/modules/other/gail/libgail-util/gailmisc.c
+++ b/modules/other/gail/libgail-util/gailmisc.c
@@ -28,6 +28,18 @@
  */
 
 /**
+ * SECTION:gailmisc
+ * @Short_description: GailMisc is a set of utility functions which may be
+ *   useful to implementors of Atk interfaces for custom widgets.
+ * @Title: GailMisc
+ *
+ * GailMisc is a set of utility function which are used in the implemementation
+ * of Atk interfaces for GTK+ widgets. They may be useful to implementors of
+ * Atk interfaces for custom widgets.
+ */
+
+
+/**
  * gail_misc_get_extents_from_pango_rectangle:
  * @widget: The widget that contains the PangoLayout, that contains
  *   the PangoRectangle
diff --git a/modules/other/gail/libgail-util/gailtextutil.c b/modules/other/gail/libgail-util/gailtextutil.c
index 5ef7f69..ecfd8ef 100644
--- a/modules/other/gail/libgail-util/gailtextutil.c
+++ b/modules/other/gail/libgail-util/gailtextutil.c
@@ -22,6 +22,21 @@
 #include <stdlib.h>
 #include "gailtextutil.h"
 
+/**
+ * SECTION:gailtextutil
+ * @Short_description: GailTextUtil is a utility class which can be used to
+ *   implement some of the #AtkText functions for accessible objects
+ *   which implement #AtkText.
+ * @Title: GailTextUtil
+ *
+ * GailTextUtil is a utility class which can be used to implement the
+ * #AtkText functions which get text for accessible objects which implement
+ * #AtkText.
+ *
+ * In GAIL it is used by the accsesible objects for #GnomeCanvasText, #GtkEntry,
+ * #GtkLabel, #GtkCellRendererText and #GtkTextView.
+ */
+
 static void gail_text_util_class_init      (GailTextUtilClass *klass);
 
 static void gail_text_util_init            (GailTextUtil      *textutil);



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