--- a/finch/libgnt/gntutils.h Fri Jan 31 18:02:20 2014 +0530
+++ b/finch/libgnt/gntutils.h Fri Jan 31 18:22:41 2014 +0530
@@ -35,9 +35,9 @@
/**
* Compute the width and height required to view the text on the screen.
*
- * @param text The text to be displayed.
- * @param width The width required is set here, if not @c NULL.
- * @param height The height required is set here, if not @c NULL.
+ * @text: The text to be displayed.
+ * @width: The width required is set here, if not %NULL.
+ * @height: The height required is set here, if not %NULL.
*/
void gnt_util_get_text_bound(const char *text, int *width, int *height);
@@ -45,23 +45,23 @@
/**
* Get the onscreen width of a string, or a substring.
*
- * @param start The beginning of the string.
- * @param end The end of the string. The width returned is the width
+ * @start: The beginning of the string.
+ * @end: The end of the string. The width returned is the width
* upto (but not including) end. If end is NULL, then start
- * is considered as a @c NULL-terminated string.
+ * is considered as a %NULL-terminated string.
*
- * @return The on-screen width of the string.
+ * Returns: The on-screen width of the string.
*/
int gnt_util_onscreen_width(const char *start, const char *end);
/**
* Computes and returns the string after a specific number of onscreen characters.
*
- * @param str The string.
- * @param len The length to consider. If non-positive, the entire screenlength is used.
- * @param w The actual width of the string upto the returned offset, if not @c NULL.
+ * @str: The string.
+ * @len: The length to consider. If non-positive, the entire screenlength is used.
+ * @w: The actual width of the string upto the returned offset, if not %NULL.
*
- * @return The string after len offset.
+ * Returns: The string after len offset.
*/
const char *gnt_util_onscreen_width_to_pointer(const char *str, int len, int *w);
@@ -69,26 +69,26 @@
* Inserts newlines in 'string' where necessary so that its onscreen width is
* no more than 'maxw'.
*
- * @param string The string.
- * @param maxw The width that the string should fit into. If maxw is <= 0,
+ * @string: The string.
+ * @maxw: The width that the string should fit into. If maxw is <= 0,
* then the available maximum width is used.
*
- * @return A newly allocated string that needs to be freed by the caller.
+ * Returns: A newly allocated string that needs to be freed by the caller.
*/
char * gnt_util_onscreen_fit_string(const char *string, int maxw);
/**
* Duplicate the contents of a hastable.
*
- * @param src The source hashtable.
- * @param hash The hash-function to use.
- * @param equal The hash-equal function to use.
- * @param key_d The key-destroy function to use.
- * @param value_d The value-destroy function to use.
- * @param key_dup The function to use to duplicate the key.
- * @param value_dup The function to use to duplicate the value.
+ * @src: The source hashtable.
+ * @hash: The hash-function to use.
+ * @equal: The hash-equal function to use.
+ * @key_d: The key-destroy function to use.
+ * @value_d: The value-destroy function to use.
+ * @key_dup: The function to use to duplicate the key.
+ * @value_dup: The function to use to duplicate the value.
*
- * @return The new hashtable.
+ * Returns: The new hashtable.
*/
GHashTable * g_hash_table_duplicate(GHashTable *src, GHashFunc hash, GEqualFunc equal, GDestroyNotify key_d, GDestroyNotify value_d, GDupFunc key_dup, GDupFunc value_dup);
@@ -96,21 +96,21 @@
* To be used with g_signal_new. Look in the key_pressed signal-definition in
* gntwidget.c for usage.
*
- * @param ihint NA
- * @param return_accu NA
- * @param handler_return NA
- * @param dummy NA
+ * @ihint: NA
+ * Returns:_accu: NA
+ * @handler_return: NA
+ * @dummy: NA
*
- * @return NA
+ * Returns: NA
*/
gboolean gnt_boolean_handled_accumulator(GSignalInvocationHint *ihint, GValue *return_accu, const GValue *handler_return, gpointer dummy);
/**
* Get a helpful display about the bindings of a widget.
*
- * @param widget The widget to get bindings for.
+ * @widget: The widget to get bindings for.
*
- * @return Returns a GntTree populated with "key" -> "binding" for the widget.
+ * Returns: Returns a GntTree populated with "key" -> "binding" for the widget.
*/
GntWidget * gnt_widget_bindings_view(GntWidget *widget);
@@ -127,8 +127,8 @@
* 2, &win, &button);
* @endcode
*
- * @param string The XML string.
- * @param num The number of widgets to return, followed by 'num' GntWidget **
+ * @string: The XML string.
+ * @num: The number of widgets to return, followed by 'num' GntWidget **
*/
void gnt_util_parse_widgets(const char *string, int num, ...);
@@ -136,9 +136,9 @@
* Parse an XHTML string and add it in a GntTextView with
* appropriate text flags.
*
- * @param string The XHTML string
- * @param tv The GntTextView
- * @return @c TRUE if the string was added to the textview properly, @c FALSE otherwise.
+ * @string: The XHTML string
+ * @tv: The GntTextView
+ * Returns: %TRUE if the string was added to the textview properly, %FALSE otherwise.
*
* @since 2.2.0
*/
@@ -147,9 +147,9 @@
/**
* Make some keypress activate a button when some key is pressed with 'wid' in focus.
*
- * @param widget The widget
- * @param key The key to trigger the button
- * @param button The button to trigger
+ * @widget: The widget
+ * @key: The key to trigger the button
+ * @button: The button to trigger
*
* @since 2.0.0 (gnt), 2.1.0 (pidgin)
*/
