[beast] BEAST: docu cleanups



commit 02edda1fd76b7142684e333ebff86488acabebe9
Author: Tim Janik <timj gtk org>
Date:   Sun May 8 02:15:22 2011 +0200

    BEAST: docu cleanups

 beast-gtk/bstusermessage.c |   12 ++++++------
 beast-gtk/bstutils.c       |   12 +++++-------
 2 files changed, 11 insertions(+), 13 deletions(-)
---
diff --git a/beast-gtk/bstusermessage.c b/beast-gtk/bstusermessage.c
index 95592e9..7cc1ca6 100644
--- a/beast-gtk/bstusermessage.c
+++ b/beast-gtk/bstusermessage.c
@@ -677,16 +677,16 @@ text_concat (char *prefix,
 
 /**
  * bst_message_dialog_display
- * @log_domain:   log domain
- * @level:        one of %BST_MSG_ERROR, %BST_MSG_WARNING, %BST_MSG_INFO, %BST_MSG_DIAG
- * @n_bits:       number of message bits
- * @bits:         message bits from bst_msg_bit_printf
+ * @param log_domain   log domain
+ * @param level        one of %BST_MSG_ERROR, %BST_MSG_WARNING, %BST_MSG_INFO, %BST_MSG_DIAG
+ * @param n_bits       number of message bits
+ * @param bits         message bits from bst_msg_bit_printf
  *
  * Present a message dialog to the user. The current value of errno
  * is preserved around calls to this function. Usually this function isn't
  * used directly, but bst_msg_dialog() is called instead which does not require
- * %NULL termination of its argument list and automates the @log_domain argument.
- * The @log_domain indicates the calling module and relates to %G_LOG_DOMAIN
+ * %NULL termination of its argument list and automates the @a log_domain argument.
+ * The @a log_domain indicates the calling module and relates to %G_LOG_DOMAIN
  * as used by g_log().
  * The msg bit arguments passed in form various parts of the log message, the
  * following macro set is provided to construct the parts from printf-style
diff --git a/beast-gtk/bstutils.c b/beast-gtk/bstutils.c
index 2fd9b52..f2d5dc1 100644
--- a/beast-gtk/bstutils.c
+++ b/beast-gtk/bstutils.c
@@ -685,16 +685,14 @@ bst_gmask_container_create (guint    border_width,
  * The second auxillary widget will expand if additional
  * space is available. Other layout details are configured
  * through the @a gpack packing type:
- * @itemize
- * @item BST_GMASK_FIT - the action widget is not expanded,
- * @item BST_GMASK_INTERLEAVE - allow the action widget to expand across auxillary
+ * @li @c BST_GMASK_FIT - the action widget is not expanded,
+ * @li @c BST_GMASK_INTERLEAVE - allow the action widget to expand across auxillary
  * columns if it requests that much space,
- * @item BST_GMASK_BIG - force expansion of the action widget across all possible
+ * @li @c BST_GMASK_BIG - force expansion of the action widget across all possible
  * columns up to the prompt,
- * @item BST_GMASK_CENTER - center the action widget within space across all possible
+ * @li @c BST_GMASK_CENTER - center the action widget within space across all possible
  * columns up to the prompt.
- * @item BST_GMASK_MULTI_SPAN - span aux2 widget across multiple gmask columns.
- * @done
+ * @li @c BST_GMASK_MULTI_SPAN - span aux2 widget across multiple gmask columns.
  */
 BstGMask*
 bst_gmask_form (GtkWidget   *gmask_container,



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