/soc/2013/ankitkv/gobjectification: 2c495383415e: Convert docs f...
Ankit Vani
a at nevitus.org
Sat Feb 1 17:19:51 EST 2014
Changeset: 2c495383415ee08145096654f206ca9f4554238f
Author: Ankit Vani <a at nevitus.org>
Date: 2014-02-02 03:34 +0530
Branch: gtkdoc-conversion
URL: https://hg.pidgin.im/soc/2013/ankitkv/gobjectification/rev/2c495383415e
Description:
Convert docs from doxygen to gtk-doc format for gnt-skel to gntws
diffstat:
finch/libgnt/gnt-skel.h | 10 -
finch/libgnt/gntslider.h | 69 +++++----
finch/libgnt/gntstyle.h | 57 +++++--
finch/libgnt/gnttextview.h | 86 +++++++-----
finch/libgnt/gnttree.h | 306 +++++++++++++++++++++++++++-----------------
finch/libgnt/gntutils.h | 67 +++++----
finch/libgnt/gntwidget.h | 92 +++++++++----
finch/libgnt/gntwindow.h | 35 +++-
finch/libgnt/gntwm.h | 117 +++++++++++-----
finch/libgnt/gntws.h | 73 ++++++----
10 files changed, 559 insertions(+), 353 deletions(-)
diffs (truncated from 2205 to 300 lines):
diff --git a/finch/libgnt/gnt-skel.h b/finch/libgnt/gnt-skel.h
--- a/finch/libgnt/gnt-skel.h
+++ b/finch/libgnt/gnt-skel.h
@@ -60,18 +60,8 @@ struct _GntSkelClass
G_BEGIN_DECLS
-/**
- *
- *
- * Returns:
- */
GType gnt_skel_get_gtype(void);
-/**
- *
- *
- * Returns:
- */
GntWidget * gnt_skel_new();
G_END_DECLS
diff --git a/finch/libgnt/gntslider.h b/finch/libgnt/gntslider.h
--- a/finch/libgnt/gntslider.h
+++ b/finch/libgnt/gntslider.h
@@ -74,9 +74,11 @@ struct _GntSliderClass
G_BEGIN_DECLS
/**
+ * gnt_slider_get_gtype:
+ *
* Returns: The GType for GntSlider
*
- * @since 2.0.0 (gnt), 2.1.0 (pidgin)
+ * Since: 2.0.0 (gnt), 2.1.0 (pidgin)
*/
GType gnt_slider_get_gtype(void);
@@ -84,103 +86,110 @@ GType gnt_slider_get_gtype(void);
#define gnt_vslider_new(max, min) gnt_slider_new(TRUE, max, min)
/**
- * Create a new slider.
- *
+ * gnt_slider_new:
* @orient: A vertical slider is created if %TRUE, otherwise the slider is horizontal.
* @max: The maximum value for the slider
* @min: The minimum value for the slider
*
+ * Create a new slider.
+ *
* Returns: The newly created slider
*
- * @since 2.0.0 (gnt), 2.1.0 (pidgin)
+ * Since: 2.0.0 (gnt), 2.1.0 (pidgin)
*/
GntWidget * gnt_slider_new(gboolean orient, int max, int min);
/**
- * Set the range of the slider.
- *
+ * gnt_slider_set_range:
* @slider: The slider
* @max: The maximum value
* @min: The minimum value
*
- * @since 2.0.0 (gnt), 2.1.0 (pidgin)
+ * Set the range of the slider.
+ *
+ * Since: 2.0.0 (gnt), 2.1.0 (pidgin)
*/
void gnt_slider_set_range(GntSlider *slider, int max, int min);
/**
- * Sets the amount of change at each step.
- *
+ * gnt_slider_set_step:
* @slider: The slider
* @step: The amount for each step
*
- * @since 2.0.0 (gnt), 2.1.0 (pidgin)
+ * Sets the amount of change at each step.
+ *
+ * Since: 2.0.0 (gnt), 2.1.0 (pidgin)
*/
void gnt_slider_set_step(GntSlider *slider, int step);
/**
- * Sets the amount of change a small step.
- *
+ * gnt_slider_set_small_step:
* @slider: The slider
* @step: The amount for a small step (for the slider)
*
- * @since 2.2.0
+ * Sets the amount of change a small step.
+ *
+ * Since: 2.2.0
*/
void gnt_slider_set_small_step(GntSlider *slider, int step);
/**
- * Sets the amount of change a large step.
- *
+ * gnt_slider_set_large_step:
* @slider: The slider
* @step: The amount for a large step (for the slider)
*
- * @since 2.2.0
+ * Sets the amount of change a large step.
+ *
+ * Since: 2.2.0
*/
void gnt_slider_set_large_step(GntSlider *slider, int step);
/**
- * Advance the slider forward or backward.
- *
+ * gnt_slider_advance_step:
* @slider: The slider
* @steps: The number of amounts to change, positive to change
* forward, negative to change backward
*
+ * Advance the slider forward or backward.
+ *
* Returns: The value of the slider after the change
*
- * @since 2.0.0 (gnt), 2.1.0 (pidgin)
+ * Since: 2.0.0 (gnt), 2.1.0 (pidgin)
*/
int gnt_slider_advance_step(GntSlider *slider, int steps);
/**
- * Set the current value for the slider.
- *
+ * gnt_slider_set_value:
* @slider: The slider
* @value: The current value
*
- * @since 2.0.0 (gnt), 2.1.0 (pidgin)
+ * Set the current value for the slider.
+ *
+ * Since: 2.0.0 (gnt), 2.1.0 (pidgin)
*/
void gnt_slider_set_value(GntSlider *slider, int value);
/**
+ * gnt_slider_get_value:
+ * @slider: The slider
+ *
* Get the current value for the slider.
*
- * @slider: The slider
- *
- *
- * @since 2.0.0 (gnt), 2.1.0 (pidgin)
+ * Since: 2.0.0 (gnt), 2.1.0 (pidgin)
*/
int gnt_slider_get_value(GntSlider *slider);
/**
- * Update a label with the value of the slider whenever the value changes.
- *
+ * gnt_slider_reflect_label:
* @slider: The slider
* @label: The label to update
*
- * @since 2.0.0 (gnt), 2.1.0 (pidgin)
+ * Update a label with the value of the slider whenever the value changes.
+ *
+ * Since: 2.0.0 (gnt), 2.1.0 (pidgin)
*/
void gnt_slider_reflect_label(GntSlider *slider, GntLabel *label);
-
G_END_DECLS
#endif /* GNT_SLIDER_H */
diff --git a/finch/libgnt/gntstyle.h b/finch/libgnt/gntstyle.h
--- a/finch/libgnt/gntstyle.h
+++ b/finch/libgnt/gntstyle.h
@@ -38,113 +38,134 @@ typedef enum
} GntStyle;
/**
+ * gnt_style_read_configure_file:
+ * @filename: The filename to read configuration from.
+ *
* Read configuration from a file.
- *
- * @filename: The filename to read configuration from.
*/
void gnt_style_read_configure_file(const char *filename);
/**
+ * gnt_style_get:
+ * @style: The style.
+ *
* Get the user-setting for a style.
- * @style: The style.
+ *
* Returns: The user-setting, or %NULL.
*/
const char *gnt_style_get(GntStyle style);
/**
- * Get the value of a preference in ~/.gntrc.
- *
+ * gnt_style_get_from_name:
* @group: The name of the group in the keyfile. If %NULL, the prgname
* will be used first, if available. Otherwise, "general" will be used.
* @key: The key
*
+ * Get the value of a preference in ~/.gntrc.
+ *
* Returns: The value of the setting as a string, or %NULL
*
- * @since 2.0.0 (gnt), 2.1.0 (pidgin)
+ * Since: 2.0.0 (gnt), 2.1.0 (pidgin)
*/
char *gnt_style_get_from_name(const char *group, const char *key);
/**
- * Get the value of a preference in ~/.gntrc.
- *
+ * gnt_style_get_string_list:
* @group: The name of the group in the keyfile. If %NULL, the prgname
* will be used first, if available. Otherwise, "general" will be used.
* @key: The key
* @length: Return location for the number of strings returned, or NULL
*
+ * Get the value of a preference in ~/.gntrc.
+ *
* Returns: NULL terminated string array. The array should be freed with g_strfreev().
*
- * @since 2.4.0
+ * Since: 2.4.0
*/
char **gnt_style_get_string_list(const char *group, const char *key, gsize *length);
/**
- * Get the value of a color pair in ~/.gntrc.
- *
+ * gnt_style_get_color:
* @group: The name of the group in the keyfile. If %NULL, the prgname
* will be used first, if available. Otherwise, "general" will be used.
* @key: The key
*
+ * Get the value of a color pair in ~/.gntrc.
+ *
* Returns: The value of the color as an int, or 0 on error.
*
- * @since 2.4.0
+ * Since: 2.4.0
*/
int gnt_style_get_color(char *group, char *key);
/**
+ * gnt_style_parse_bool:
+ * @value: The value of the boolean setting as a string
+ *
* Parse a boolean preference. For example, if 'value' is "false" (ignoring case)
* or "0", the return value will be %FALSE, otherwise %TRUE.
*
- * @value: The value of the boolean setting as a string
* Returns: The boolean value
*
- * @since 2.0.0 (gnt), 2.1.0 (pidgin)
+ * Since: 2.0.0 (gnt), 2.1.0 (pidgin)
*/
gboolean gnt_style_parse_bool(const char *value);
/**
- * Get the boolean value for a user-setting.
- *
+ * gnt_style_get_bool:
* @style: The style.
* @def: The default value (i.e, the value if the user didn't define
* any value)
*
+ * Get the boolean value for a user-setting.
+ *
* Returns: The value of the setting.
*/
gboolean gnt_style_get_bool(GntStyle style, gboolean def);
/**
+ * gnt_styles_get_keyremaps:
+ *
* @internal
*/
void gnt_styles_get_keyremaps(GType type, GHashTable *hash);
/**
+ * gnt_style_read_actions:
+ *
* @internal
*/
void gnt_style_read_actions(GType type, GntBindableClass *klass);
More information about the Commits
mailing list