[beast] GXK: docu fixups



commit 12941f54962c7e673b16fb07da50828ea174e903
Author: Tim Janik <timj gtk org>
Date:   Sun May 8 02:14:36 2011 +0200

    GXK: docu fixups

 beast-gtk/gxk/gxkdialog.c    |   18 ++++++++----------
 beast-gtk/gxk/gxktexttools.c |   24 +++++++++++-------------
 beast-gtk/gxk/gxkutils.c     |   40 +++++++++++++++++++---------------------
 3 files changed, 38 insertions(+), 44 deletions(-)
---
diff --git a/beast-gtk/gxk/gxkdialog.c b/beast-gtk/gxk/gxkdialog.c
index 4067557..b86fa9f 100644
--- a/beast-gtk/gxk/gxkdialog.c
+++ b/beast-gtk/gxk/gxkdialog.c
@@ -244,18 +244,16 @@ gxk_dialog_finalize (GObject *object)
  *
  * Create a new configurable dialog. Possible values for the
  * flags are:
- * @itemize
- * @item GXK_DIALOG_HIDE_ON_DELETE - only hide and not destroy the
+ * @li @c GXK_DIALOG_HIDE_ON_DELETE - only hide and not destroy the
  * dialog upon window manager delete events;
- * @item GXK_DIALOG_IGNORE_ESCAPE - prevents delete event generation on Escape key presses;
- * @item GXK_DIALOG_DELETE_BUTTON - add a "Close" button to the dialog;
- * @item GXK_DIALOG_STATUS_BAR - add a status bar widget to the dialog;
- * @item GXK_DIALOG_WINDOW_GROUP - open up an extra window group for the dialog;
- * @item GXK_DIALOG_MODAL - the dialog is modal while visible;
- * @item GXK_DIALOG_POPUP_POS - popup the dialog below mouse pointer;
- * @item GXK_DIALOG_PRESERVE_STATE - prevents unrealization of the dialog upon hiding,
+ * @li @c GXK_DIALOG_IGNORE_ESCAPE - prevents delete event generation on Escape key presses;
+ * @li @c GXK_DIALOG_DELETE_BUTTON - add a "Close" button to the dialog;
+ * @li @c GXK_DIALOG_STATUS_BAR - add a status bar widget to the dialog;
+ * @li @c GXK_DIALOG_WINDOW_GROUP - open up an extra window group for the dialog;
+ * @li @c GXK_DIALOG_MODAL - the dialog is modal while visible;
+ * @li @c GXK_DIALOG_POPUP_POS - popup the dialog below mouse pointer;
+ * @li @c GXK_DIALOG_PRESERVE_STATE - prevents unrealization of the dialog upon hiding,
  * which preserves properties like the window size.
- * @done
  */
 gpointer
 gxk_dialog_new (gpointer       pointer_loc,
diff --git a/beast-gtk/gxk/gxktexttools.c b/beast-gtk/gxk/gxktexttools.c
index e0fec55..621690a 100644
--- a/beast-gtk/gxk/gxktexttools.c
+++ b/beast-gtk/gxk/gxktexttools.c
@@ -1292,24 +1292,22 @@ tnav_update_vpos (GtkAdjustment  *a,
  *
  * Create a scrollable text view. Behaviour and apperance can
  * be tweaked by specifying various @a flags:
- * @itemize
- * @item GXK_SCROLL_TEXT_MONO - use a fixed width font;
- * @item GXK_SCROLL_TEXT_SANS - use a sans serif font;
- * @item GXK_SCROLL_TEXT_SERIF - use a serif font;
- * @item GXK_SCROLL_TEXT_WRAP - allow word wrapping of @a string;
- * @item GXK_SCROLL_TEXT_CENTER - center @a string;
- * @item GXK_SCROLL_TEXT_WIDGET_BG - do not use white as background,
+ * @li @c GXK_SCROLL_TEXT_MONO - use a fixed width font;
+ * @li @c GXK_SCROLL_TEXT_SANS - use a sans serif font;
+ * @li @c GXK_SCROLL_TEXT_SERIF - use a serif font;
+ * @li @c GXK_SCROLL_TEXT_WRAP - allow word wrapping of @a string;
+ * @li @c GXK_SCROLL_TEXT_CENTER - center @a string;
+ * @li @c GXK_SCROLL_TEXT_WIDGET_BG - do not use white as background,
  * but keep the usual (grey) widget background;
- * @item GXK_SCROLL_TEXT_NAVIGATABLE - add a navigation bar and allow
+ * @li @c GXK_SCROLL_TEXT_NAVIGATABLE - add a navigation bar and allow
  * the user to navigate through clickable links;
- * @item GXK_SCROLL_TEXT_EDITABLE - permit modifications of the text;
- * @item GXK_SCROLL_TEXT_HFIXED - make horizontal dimension unscrollable
- * @item GXK_SCROLL_TEXT_VFIXED - make vertical dimension unscrollable
- * @item GXK_SCROLL_TEXT_WIDGET_LOOK - this is a combination of flags
+ * @li @c GXK_SCROLL_TEXT_EDITABLE - permit modifications of the text;
+ * @li @c GXK_SCROLL_TEXT_HFIXED - make horizontal dimension unscrollable
+ * @li @c GXK_SCROLL_TEXT_VFIXED - make vertical dimension unscrollable
+ * @li @c GXK_SCROLL_TEXT_WIDGET_LOOK - this is a combination of flags
  * to adjust the scroll text to look like an ordinary GtkLabel,
  * which amounts to using a sans serif font, normal widget
  * background and allowing word wrapping.
- * @done
  */
 GtkWidget*
 gxk_scroll_text_create (GxkScrollTextFlags flags,
diff --git a/beast-gtk/gxk/gxkutils.c b/beast-gtk/gxk/gxkutils.c
index e850693..11c6599 100644
--- a/beast-gtk/gxk/gxkutils.c
+++ b/beast-gtk/gxk/gxkutils.c
@@ -1458,9 +1458,9 @@ gxk_widget_activate_accel_group (GtkWidget     *widget,
 }
 
 /**
- * @param sgmode	size group mode, one of GTK_SIZE_GROUP_NONE,
- *          GTK_SIZE_GROUP_HORIZONTAL, GTK_SIZE_GROUP_VERTICAL or
- *	    GTK_SIZE_GROUP_BOTH
+ * @param sgmode	size group mode, one of @c GTK_SIZE_GROUP_NONE,
+ *          @c GTK_SIZE_GROUP_HORIZONTAL, @c GTK_SIZE_GROUP_VERTICAL or
+ *	    @c GTK_SIZE_GROUP_BOTH
  * @param ...:    NULL terminated list of widgets to group together
  *
  * Group horizontal and/or vertical resizing behaviour of
@@ -1621,20 +1621,18 @@ gxk_tree_view_add_column (GtkTreeView       *tree_view,
  * The @a column_flags argument is a combination of letters that
  * are able to switch certain characteristics on or off,
  * currently supported are:
- * @itemize
- * @item F - column is fixed in sizing;
- * @item A - column resizes automatically;
- * @item G - columns sizing behaviour is grow only;
- * @item S - column is sortable;
- * @item s - column is unsortable;
- * @item O - column is reorderable;
- * @item o - column is not reorderable;
- * @item R - column is user-resizable;
- * @item r - column is not user-resizable;
- * @item P - add extra padding between multiple cells of the same column;
- * @item p - cancel a previous #P flag;
- * @item # - automatically popup dialogs for popup cell renderers.
- * @done
+ * @li @c F - column is fixed in sizing;
+ * @li @c A - column resizes automatically;
+ * @li @c G - columns sizing behaviour is grow only;
+ * @li @c S - column is sortable;
+ * @li @c s - column is unsortable;
+ * @li @c O - column is reorderable;
+ * @li @c o - column is not reorderable;
+ * @li @c R - column is user-resizable;
+ * @li @c r - column is not user-resizable;
+ * @li @c P - add extra padding between multiple cells of the same column;
+ * @li @c p - cancel a previous #P flag;
+ * @li @c # - automatically popup dialogs for popup cell renderers.
  */
 void
 gxk_tree_view_append_text_columns (GtkTreeView *tree_view,
@@ -1831,8 +1829,8 @@ gxk_tree_view_add_text_column (GtkTreeView  *tree_view,
  * @param xalign	horizontal text alignment
  * @param title	column title
  * @param tooltip	column tooltip
- * @param edited_callback	edit notification callback 
- * @param popup_callback	popup notification callback 
+ * @param edited_callback	edit notification callback
+ * @param popup_callback	popup notification callback
  * @param data	data passed in to toggled_callback
  * @param cflags	connection flags
  * @return		a newly added GtkTreeViewColumn
@@ -1868,7 +1866,7 @@ gxk_tree_view_add_popup_column (GtkTreeView  *tree_view,
  * @param xalign	horizontal text alignment
  * @param title	column title
  * @param tooltip	column tooltip
- * @param toggled_callback	notification callback 
+ * @param toggled_callback	notification callback
  * @param data	data passed in to toggled_callback
  * @param cflags	connection flags
  * @return		a newly added GtkTreeViewColumn
@@ -2768,7 +2766,7 @@ scrolled_window_size_request_spare_space (GtkScrolledWindow *scwin,
  * @param scwin	valid GtkScrolledWindow
  *
  * A normal GtkScrolledWindow requests extra space for a horizontal scrollbar
- * if the vertical scroll policy is set to GTK_POLICY_NEVER and vice versa,
+ * if the vertical scroll policy is set to @c GTK_POLICY_NEVER and vice versa,
  * regardless of whether the scrollbars have to be shown or not.
  * This function patches up this behaviour to spare the extra requested space
  * from the outer scrolled window requisition if possible (that is, if the



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