A little developer docs update in header files.
authorAndriy Grytsenko <andrej@rep.kiev.ua>
Sat, 15 Nov 2014 23:14:16 +0000 (01:14 +0200)
committerAndriy Grytsenko <andrej@rep.kiev.ua>
Sat, 15 Nov 2014 23:14:16 +0000 (01:14 +0200)
src/icon-grid.h
src/misc.h
src/panel.h.in
src/plugin.h

index ece85d0..0a61390 100644 (file)
@@ -43,8 +43,25 @@ extern GtkWidget * panel_icon_grid_new(
                                                /* Create an icon grid */
 extern void panel_icon_grid_set_constrain_width(PanelIconGrid * ig, gboolean constrain_width);
                                                /* Set the constrain-width property */
+/**
+ * panel_icon_grid_set_aspect_width
+ * @ig: a widget
+ * @aspect_width: value to set
+ *
+ * Changes #PanelIconGrid::aspect-width property on the @ig. The property
+ * enables or disables taking icons aspect into consideration for @ig.
+ * If disabled then all icons will have the same size (child_width) as
+ * defined for widget. If enabled then child_width will be ignored but
+ * icons aspect will be taken into consideration when children space is
+ * allocated.
+ * Note that if #PanelIconGrid::constrain-width is set to %TRUE then the
+ * #PanelIconGrid::aspect-width is ignored and behavior of widget is that
+ * if #PanelIconGrid::aspect-width is set to %FALSE.
+ *
+ * Since: 0.8.0
+ */
 extern void panel_icon_grid_set_aspect_width(PanelIconGrid * ig, gboolean aspect_width);
-                                               /* Set the aspect-width property */
+
 /* extern void panel_icon_grid_set_fill_width(PanelIconGrid * ig, gboolean fill_width);
                                                 Set the fill-width property */
 extern void panel_icon_grid_set_geometry(PanelIconGrid * ig,
index e21cafe..cc7358f 100644 (file)
@@ -153,6 +153,8 @@ guint32 gcolor2rgb24(GdkColor *color);
  * Creates new #GtkEventBox button which will follow theme and icon size
  * changes on @panel. If icon name is not found in theme then fallback
  * name "application-x-executable" will be used.
+ *
+ * Returns: (transfer full): a new #GtkEventBox widget.
  */
 GtkWidget *lxpanel_button_new_for_icon(LXPanel *panel, const gchar *name, GdkColor *color, const gchar *label);
 GtkWidget *lxpanel_button_new_for_fm_icon(LXPanel *panel, FmIcon *icon, GdkColor *color, const gchar *label);
@@ -182,6 +184,10 @@ void lxpanel_button_update_icon(GtkWidget* btn, FmIcon *icon, gint size);
  * size changes on @panel. If icon not found in theme and @fallback is
  * not %NULL then it will be used to load icon or image. Otherwise the
  * "application-x-executable" will be used as fallback.
+ *
+ * Returns: (transfer full): a new #GtkImage widget.
+ *
+ * Since: 0.8.0
  */
 GtkWidget *lxpanel_image_new_for_icon(LXPanel *panel, const gchar *name,
                                       gint height, const gchar *fallback);
@@ -194,6 +200,10 @@ GtkWidget *lxpanel_image_new_for_icon(LXPanel *panel, const gchar *name,
  *
  * Changes an image @img created by lxpanel_image_new_for_icon() to use
  * new icon @name and @fallback.
+ *
+ * Returns: %TRUE.
+ *
+ * Since: 0.8.0
  */
 gboolean lxpanel_image_change_icon(GtkWidget *img, const gchar *name,
                                    const char *fallback);
index 685c1a3..520808b 100644 (file)
 
 G_BEGIN_DECLS
 
+/**
+ * LXPANEL_CHECK_VERSION
+ *
+ * A simple macro for plugins to check features.
+ *
+ * Since: 0.8.0
+ */
 #define LXPANEL_CHECK_VERSION(_a,_b,_c) \
     (@VERSION_MAJOR@ > _a || \
     (@VERSION_MAJOR@ == _a && @VERSION_MINOR@ > _b) || \
index 583f2bd..6becc62 100644 (file)
@@ -285,6 +285,8 @@ extern GtkWidget *lxpanel_generic_config_dlg(const char *title, LXPanel *panel,
  * emits "changed" signal: void callback(PanelCfgInputButton *, char *, gpointer);
  * caller should test if keybinding can be used in the callback
  * widget can be used for lxpanel_generic_config_dlg as CONF_TYPE_EXTERNAL
+ *
+ * Since: 0.8.0
  */
 GtkWidget *panel_config_hotkey_button_new(const char *label, const char *hotkey);
 GtkWidget *panel_config_click_button_new(const char *label, const char *click);