A little documentation update in header files.
authorAndriy Grytsenko <andrej@rep.kiev.ua>
Sun, 23 Nov 2014 17:06:57 +0000 (19:06 +0200)
committerAndriy Grytsenko <andrej@rep.kiev.ua>
Sun, 23 Nov 2014 17:06:57 +0000 (19:06 +0200)
src/misc.h
src/plugin.h

index 8c0dd2a..b462028 100644 (file)
@@ -138,6 +138,15 @@ GPid get_net_wm_pid(Window win);
 extern int panel_handle_x_error(Display * d, XErrorEvent * ev);
 extern int panel_handle_x_error_swallow_BadWindow_BadDrawable(Display * d, XErrorEvent * ev);
 
+/**
+ * expand_tilda
+ * @file: file path
+ *
+ * If first char of @file is a tilda (~) then replaces it with content of
+ * environment variable HOME.
+ *
+ * Returns: (transfer full): new allocated path string.
+ */
 gchar *expand_tilda(const gchar *file);
 
 void get_button_spacing(GtkRequisition *req, GtkContainer *parent, gchar *name);
index 9391c5c..39ee10c 100644 (file)
@@ -271,6 +271,8 @@ typedef enum {
  *   - const char* name: text representing the option in dialog
  *   - gpointer ret_value: (in out): pointer to the option value
  *   - PluginConfType type: type of the option
+ * Note that for type CONF_TYPE_EXTERNAL the name argument is ignored and
+ * therefore empty string ("") have to be passed.
  *
  * Returns: (tranfer full): new created dialog widget.
  */