/soc/2013/ankitkv/gobjectification: 5f7ccec14f33: Convert docs f...
Ankit Vani
a at nevitus.org
Sat Feb 1 15:57:52 EST 2014
Changeset: 5f7ccec14f330c4e0920474cd30dcd40715f0bba
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-02 02:27 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/5f7ccec14f33
Description:
Convert docs from doxygen to gtk-doc format for gnt to gntprogressbar
diffstat:
finch/libgnt/gnt.h | 74 +++++++++++++++++++++++++++-----------
finch/libgnt/gntbindable.h | 50 ++++++++++++++------------
finch/libgnt/gntbox.h | 71 ++++++++++++++++++++++--------------
finch/libgnt/gntbutton.h | 7 ++-
finch/libgnt/gntcheckbox.h | 17 +++++---
finch/libgnt/gntclipboard.h | 12 ++++--
finch/libgnt/gntcolors.h | 38 +++++++++++++------
finch/libgnt/gntcombobox.h | 29 ++++++++++-----
finch/libgnt/gntentry.h | 77 ++++++++++++++++++++++++----------------
finch/libgnt/gntfilesel.h | 64 +++++++++++++++++++++------------
finch/libgnt/gntkeys.h | 34 +++++++++++------
finch/libgnt/gntlabel.h | 17 +++++---
finch/libgnt/gntline.h | 7 ++-
finch/libgnt/gntmenu.h | 27 +++++++++----
finch/libgnt/gntmenuitem.h | 57 ++++++++++++++++++------------
finch/libgnt/gntmenuitemcheck.h | 17 +++++---
finch/libgnt/gntprogressbar.h | 49 ++++++++++++++++---------
17 files changed, 407 insertions(+), 240 deletions(-)
diffs (truncated from 1647 to 300 lines):
diff --git a/finch/libgnt/gnt.h b/finch/libgnt/gnt.h
--- a/finch/libgnt/gnt.h
+++ b/finch/libgnt/gnt.h
@@ -40,16 +40,22 @@
#include "gntkeys.h"
/**
+ * gnt_init:
+ *
* Initialize GNT.
*/
void gnt_init(void);
/**
+ * gnt_main:
+ *
* Start running the mainloop for gnt.
*/
void gnt_main(void);
/**
+ * gnt_ascii_only:
+ *
* Check whether the terminal is capable of UTF8 display.
*
* Returns: %FALSE if the terminal is capable of drawing UTF-8, %TRUE otherwise.
@@ -57,98 +63,116 @@ void gnt_main(void);
gboolean gnt_ascii_only(void);
/**
+ * gnt_window_present:
+ * @window: The window the present.
+ *
* Present a window. If the event was triggered because of user interaction,
* the window is moved to the foreground. Otherwise, the Urgent hint is set.
*
- * @window: The window the present.
- *
- * @since 2.0.0 (gnt), 2.1.0 (pidgin)
+ * Since: 2.0.0 (gnt), 2.1.0 (pidgin)
*/
void gnt_window_present(GntWidget *window);
/**
+ * gnt_screen_occupy:
+ *
* @internal
* Use #gnt_widget_show instead.
*/
void gnt_screen_occupy(GntWidget *widget);
/**
+ * gnt_screen_release:
+ *
* @internal
* Use #gnt_widget_hide instead.
*/
void gnt_screen_release(GntWidget *widget);
/**
+ * gnt_screen_update:
+ *
* @internal
* Use #gnt_widget_draw instead.
*/
void gnt_screen_update(GntWidget *widget);
/**
- * Resize a widget.
- *
+ * gnt_screen_resize_widget:
* @widget: The widget to resize.
* @width: The desired width.
* @height: The desired height.
+ *
+ * Resize a widget.
*/
void gnt_screen_resize_widget(GntWidget *widget, int width, int height);
/**
- * Move a widget.
- *
+ * gnt_screen_move_widget:
* @widget: The widget to move.
* @x: The desired x-coordinate.
* @y: The desired y-coordinate.
+ *
+ * Move a widget.
*/
void gnt_screen_move_widget(GntWidget *widget, int x, int y);
/**
- * Rename a widget.
- *
+ * gnt_screen_rename_widget:
* @widget: The widget to rename.
* @text: The new name for the widget.
+ *
+ * Rename a widget.
*/
void gnt_screen_rename_widget(GntWidget *widget, const char *text);
/**
+ * gnt_widget_has_focus:
+ * @widget: The widget.
+ *
* Check whether a widget has focus.
*
- * @widget: The widget.
- *
* Returns: %TRUE if the widget has the current focus, %FALSE otherwise.
*/
gboolean gnt_widget_has_focus(GntWidget *widget);
/**
+ * gnt_widget_set_urgent:
+ * @widget: The widget to set the URGENT hint for.
+ *
* Set the URGENT hint for a widget.
- *
- * @widget: The widget to set the URGENT hint for.
*/
void gnt_widget_set_urgent(GntWidget *widget);
/**
- * Register a global action.
- *
+ * gnt_register_action:
* @label: The user-visible label for the action.
* @callback: The callback function for the action.
+ *
+ * Register a global action.
*/
void gnt_register_action(const char *label, void (*callback)(void));
/**
+ * gnt_screen_menu_show:
+ * @menu: The menu to display.
+ *
* Show a menu.
*
- * @menu: The menu to display.
- *
* Returns: %TRUE if the menu is displayed, %FALSE otherwise (e.g., if another menu is currently displayed).
*/
gboolean gnt_screen_menu_show(gpointer menu);
/**
+ * gnt_quit:
+ *
* Terminate the mainloop of gnt.
*/
void gnt_quit(void);
/**
+ * gnt_get_clipboard:
+ *
* Get the global clipboard.
*
* Returns: The clipboard.
@@ -156,22 +180,24 @@ void gnt_quit(void);
GntClipboard * gnt_get_clipboard(void);
/**
+ * gnt_get_clipboard_string:
+ *
* Get the string in the clipboard.
*
- * Returns: A copy of the string in the clipboard. The caller must @c g_free the string.
+ * Returns: A copy of the string in the clipboard. The caller must g_free() the string.
*/
gchar * gnt_get_clipboard_string(void);
/**
+ * gnt_set_clipboard_string:
+ * @string: The new content of the new clipboard.
+ *
* Set the contents of the global clipboard.
- *
- * @string: The new content of the new clipboard.
*/
void gnt_set_clipboard_string(const gchar *string);
/**
- * Spawn a different application that will consume the console.
- *
+ * gnt_giveup_console:
* @wd: The working directory for the new application.
* @argv: The argument vector.
* @envp: The environment, or %NULL.
@@ -181,6 +207,8 @@ void gnt_set_clipboard_string(const gcha
* @callback: The callback to call after the child exits.
* @data: The data to pass to the callback.
*
+ * Spawn a different application that will consume the console.
+ *
* Returns: %TRUE if the child was successfully spawned, %FALSE otherwise.
*/
gboolean gnt_giveup_console(const char *wd, char **argv, char **envp,
@@ -188,6 +216,8 @@ gboolean gnt_giveup_console(const char *
void (*callback)(int status, gpointer data), gpointer data);
/**
+ * gnt_is_refugee:
+ *
* Check whether a child process is in control of the current terminal.
*
* Returns: %TRUE if a child process (eg., PAGER) is occupying the current
diff --git a/finch/libgnt/gntbindable.h b/finch/libgnt/gntbindable.h
--- a/finch/libgnt/gntbindable.h
+++ b/finch/libgnt/gntbindable.h
@@ -66,11 +66,6 @@ struct _GntBindableClass
G_BEGIN_DECLS
-/**
- *
- *
- * Returns:
- */
GType gnt_bindable_get_gtype(void);
/******************/
@@ -105,84 +100,93 @@ struct _GntBindableActionParam
/*GntBindableAction *gnt_bindable_action_parse(const char *name);*/
/**
+ * gnt_bindable_action_free:
+ * @action: The bindable action.
+ *
* Free a bindable action.
- *
- * @action: The bindable action.
*/
void gnt_bindable_action_free(GntBindableAction *action);
/**
+ * gnt_bindable_action_param_free:
+ * @param: The GntBindableActionParam to free.
+ *
* Free a GntBindableActionParam.
- *
- * @param: The GntBindableActionParam to free.
*/
void gnt_bindable_action_param_free(GntBindableActionParam *param);
/**
- * Register a bindable action for a class.
- *
+ * gnt_bindable_class_register_action:
* @klass: The class the binding is for.
* @name: The name of the binding.
* @callback: The callback for the binding.
* @trigger: The default trigger for the binding, or %NULL, followed by a NULL-terminated
* list of default parameters.
+ *
+ * Register a bindable action for a class.
*/
void gnt_bindable_class_register_action(GntBindableClass *klass, const char *name, GntBindableActionCallback callback, const char *trigger, ...);
/**
- * Register a key-binding to an existing action.
- *
+ * gnt_bindable_register_binding:
* @klass: The class the binding is for.
* @name: The name of the binding.
* @trigger: A new trigger for the binding, followed by a %NULL-terminated list of parameters for the callback.
+ *
+ * Register a key-binding to an existing action.
*/
void gnt_bindable_register_binding(GntBindableClass *klass, const char *name, const char *trigger, ...);
/**
- * Perform an action from a keybinding.
- *
+ * gnt_bindable_perform_action_key:
* @bindable: The bindable object.
* @keys: The key to trigger the action.
*
+ * Perform an action from a keybinding.
+ *
* Returns: %TRUE if the action was performed successfully, %FALSE otherwise.
*/
gboolean gnt_bindable_perform_action_key(GntBindable *bindable, const char *keys);
/**
- * Discover if a key is bound.
- *
+ * gnt_bindable_check_key:
* @bindable: The bindable object.
* @keys: The key to check for.
*
+ * Discover if a key is bound.
+ *
* Returns: %TRUE if the the key has an action associated with it.
*/
gboolean gnt_bindable_check_key(GntBindable *bindable, const char *keys);
/**
- * Perform an action on a bindable object.
More information about the Commits
mailing list