[gtk+] Documentation fixes



commit 9bad2f70a4010a36da0064f6a06cc7a16a641595
Author: Matthias Clasen <mclasen redhat com>
Date:   Mon Aug 24 18:17:54 2009 -0400

    Documentation fixes

 gtk/gtkcellrenderer.c |   12 ++++++++----
 gtk/gtkwidget.c       |   29 ++++++++++++++++++-----------
 2 files changed, 26 insertions(+), 15 deletions(-)
---
diff --git a/gtk/gtkcellrenderer.c b/gtk/gtkcellrenderer.c
index f7bc8cd..e4af9a1 100644
--- a/gtk/gtkcellrenderer.c
+++ b/gtk/gtkcellrenderer.c
@@ -887,10 +887,12 @@ gtk_cell_renderer_set_visible (GtkCellRenderer *cell,
  *
  * Returns the cell renderer's visibility.
  *
+ * Returns: %TRUE if the cell renderer is visible
+ *
  * Since: 2.18
- **/
+ */
 gboolean
-gtk_cell_renderer_get_visible  (GtkCellRenderer *cell)
+gtk_cell_renderer_get_visible (GtkCellRenderer *cell)
 {
   g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), FALSE);
 
@@ -925,10 +927,12 @@ gtk_cell_renderer_set_sensitive (GtkCellRenderer *cell,
  *
  * Returns the cell renderer's sensitivity.
  *
+ * Returns: %TRUE if the cell renderer is sensitive
+ *
  * Since: 2.18
- **/
+ */
 gboolean
-gtk_cell_renderer_get_sensitive  (GtkCellRenderer *cell)
+gtk_cell_renderer_get_sensitive (GtkCellRenderer *cell)
 {
   g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), FALSE);
 
diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c
index 23dc17d..cf34d64 100644
--- a/gtk/gtkwidget.c
+++ b/gtk/gtkwidget.c
@@ -5425,17 +5425,17 @@ gtk_widget_get_can_default (GtkWidget *widget)
 }
 
 /**
- * gtk_widget_get_has_default:
+ * gtk_widget_has_default:
  * @widget: a #GtkWidget
  *
  * Determines whether @widget is the current default widget within its
  * toplevel. See gtk_widget_set_can_default().
  *
  * Return value: %TRUE if @widget is the current default widget within
- * its toplevel, %FALSE otherwise
+ *     its toplevel, %FALSE otherwise
  *
  * Since: 2.18
- **/
+ */
 gboolean
 gtk_widget_has_default (GtkWidget *widget)
 {
@@ -5586,10 +5586,12 @@ gtk_widget_set_state (GtkWidget           *widget,
  * gtk_widget_get_state:
  * @widget: a #GtkWidget
  *
- * Returns: the state of @widget. See gtk_widget_set_state().
+ * Returns the widget's state. See gtk_widget_set_state().
+ *
+ * Returns: the state of @widget.
  *
  * Since: 2.18
- **/
+ */
 GtkStateType
 gtk_widget_get_state (GtkWidget *widget)
 {
@@ -5913,13 +5915,16 @@ gtk_widget_set_sensitive (GtkWidget *widget,
  * gtk_widget_get_sensitive:
  * @widget: a #GtkWidget
  *
- * Returns: %TRUE if the widget is sensitive (in the sense of returning
- * the value that has been set using gtk_widget_set_sensitive()). The
- * effective sensitivity of a widget is however determined by both its
+ * Returns the widget's sensitivity (in the sense of returning
+ * the value that has been set using gtk_widget_set_sensitive()).
+ *
+ * The effective sensitivity of a widget is however determined by both its
  * own and its parent widget's sensitivity. See gtk_widget_is_sensitive().
  *
+ * Returns: %TRUE if the widget is sensitive
+ *
  * Since: 2.18
- **/
+ */
 gboolean
 gtk_widget_get_sensitive (GtkWidget *widget)
 {
@@ -5932,11 +5937,13 @@ gtk_widget_get_sensitive (GtkWidget *widget)
  * gtk_widget_is_sensitive:
  * @widget: a #GtkWidget
  *
- * Returns: %TRUE if the widget is effectively sensitive, which means
+ * Returns the widget's effective sensitivity, which means
  * it is sensitive itself and also its parent widget is sensntive
  *
+ * Returns: %TRUE if the widget is effectively sensitive
+ *
  * Since: 2.18
- **/
+ */
 gboolean
 gtk_widget_is_sensitive (GtkWidget *widget)
 {



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