[Xfce4-commits] [xfce/exo] 01/01: gtk-doc: Resolve undocumented symbols. 100% symbol docs coverage. 435 symbols documented. 0 symbols incomplete. 0 not documented.
noreply at xfce.org
noreply at xfce.org
Sat Jun 17 06:54:56 CEST 2017
This is an automated email from the git hooks/post-receive script.
b l u e s a b r e p u s h e d a c o m m i t t o b r a n c h m a s t e r
in repository xfce/exo.
commit 54102cea15d9b7b372b57e29e20fef093134b4e7
Author: Sean Davis <smd.seandavis at gmail.com>
Date: Sat Jun 17 00:54:21 2017 -0400
gtk-doc: Resolve undocumented symbols.
100% symbol docs coverage.
435 symbols documented.
0 symbols incomplete.
0 not documented.
---
exo-desktop-item-edit/exo-die-enum-types.h | 3 ++
exo-desktop-item-edit/exo-die-utils.c | 6 +--
exo/exo-config.h.in | 5 +-
exo/exo-gtk-extensions.h | 2 +-
exo/exo-icon-bar.h | 4 +-
exo/exo-icon-chooser-dialog.h | 7 +++
exo/exo-icon-view.c | 79 +++++++++++++++++++++++++++---
exo/exo-icon-view.h | 10 ++++
exo/exo-job.c | 4 +-
exo/exo-toolbars-model.c | 9 ++++
exo/exo-toolbars-model.h | 2 +
exo/exo-toolbars-private.c | 7 +++
exo/exo-toolbars-view.c | 3 ++
13 files changed, 125 insertions(+), 16 deletions(-)
diff --git a/exo-desktop-item-edit/exo-die-enum-types.h b/exo-desktop-item-edit/exo-die-enum-types.h
index cc668a3..7aa99e0 100644
--- a/exo-desktop-item-edit/exo-die-enum-types.h
+++ b/exo-desktop-item-edit/exo-die-enum-types.h
@@ -31,6 +31,9 @@ G_BEGIN_DECLS
* @EXO_DIE_EDITOR_MODE_APPLICATION : application launcher editing.
* @EXO_DIE_EDITOR_MODE_LINK : link editing.
* @EXO_DIE_EDITOR_MODE_DIRECTORY : menu directory editing.
+ *
+ * Editing mode for exo-desktop-item-edit
+ *
**/
typedef enum
{
diff --git a/exo-desktop-item-edit/exo-die-utils.c b/exo-desktop-item-edit/exo-die-utils.c
index 9bd0d37..274bd97 100644
--- a/exo-desktop-item-edit/exo-die-utils.c
+++ b/exo-desktop-item-edit/exo-die-utils.c
@@ -81,6 +81,8 @@ exo_die_g_key_file_set_locale_value (GKeyFile *key_file,
* @mode : file mode for .directory or .desktop suffix.
* @error : return location for errors or %NULL.
*
+ * Writes changes to the @key_file .desktop or .directory file.
+ *
* Return value: %TRUE if successfull, %FALSE otherwise.
**/
gboolean
@@ -208,7 +210,3 @@ exo_die_g_key_file_save (GKeyFile *key_file,
return result;
}
-
-
-
-
diff --git a/exo/exo-config.h.in b/exo/exo-config.h.in
index e78a414..183f3c7 100644
--- a/exo/exo-config.h.in
+++ b/exo/exo-config.h.in
@@ -63,10 +63,12 @@ G_BEGIN_DECLS
* @minor: minor version (e.g. 2 for version 1.2.3)
* @micro: micro version (e.g. 3 for version 1.2.3)
*
+ * Checks the exo version.
+ *
* Returns: %TRUE if the version of the exo header files is equal or
* better than the passed-in version.
**/
-#define EXO_CHECK_VERSION(major,minor,micro) \
+#define EXO_CHECK_VERSION(major, minor, micro) \
(EXO_MAJOR_VERSION > (major) \
|| (EXO_MAJOR_VERSION == (major) \
&& EXO_MINOR_VERSION > (minor)) \
@@ -108,4 +110,3 @@ const gchar *exo_check_version (guint required_major,
G_END_DECLS
#endif /* !__EXO_CONFIG_H__ */
-
diff --git a/exo/exo-gtk-extensions.h b/exo/exo-gtk-extensions.h
index d0488c4..cbc419c 100644
--- a/exo/exo-gtk-extensions.h
+++ b/exo/exo-gtk-extensions.h
@@ -39,7 +39,7 @@ void exo_gtk_object_destroy_later (GtkObject *object);
void exo_gtk_file_chooser_add_thumbnail_preview (GtkFileChooser *chooser);
void exo_gtk_url_about_dialog_hook (GtkAboutDialog *about_dialog,
- const gchar *link,
+ const gchar *address,
gpointer user_data);
G_END_DECLS
diff --git a/exo/exo-icon-bar.h b/exo/exo-icon-bar.h
index 495cd4c..dbd29ff 100644
--- a/exo/exo-icon-bar.h
+++ b/exo/exo-icon-bar.h
@@ -45,6 +45,9 @@ typedef struct _ExoIconBar ExoIconBar;
* ExoIconBarClass:
* @set_scroll_adjustments : Used internally to make the ExoIconBar scrollable.
* @selection_changed : This signal is emitted whenever the currently selected icon changes.
+ *
+ * The #ExoIconBar class contains only private fields and should not
+ * be directly accessed.
**/
struct _ExoIconBarClass
{
@@ -110,4 +113,3 @@ void exo_icon_bar_set_active_iter (ExoIconBar *icon_bar,
G_END_DECLS
#endif /* !__EXO_ICON_BAR_H__ */
-
diff --git a/exo/exo-icon-chooser-dialog.h b/exo/exo-icon-chooser-dialog.h
index 89521d0..32cde2f 100644
--- a/exo/exo-icon-chooser-dialog.h
+++ b/exo/exo-icon-chooser-dialog.h
@@ -55,6 +55,13 @@ struct _ExoIconChooserDialogClass
void (*reserved6) (void);
};
+/**
+ * ExoIconChooserDialog:
+ *
+ * The #ExoIconChooserDialog class provides an easy to use dialog to ask
+ * the user to select either a named icon from the selected icon theme,
+ * or an image file from the local file system.
+ **/
struct _ExoIconChooserDialog
{
/*< private >*/
diff --git a/exo/exo-icon-view.c b/exo/exo-icon-view.c
index 2d413f5..f7613e6 100644
--- a/exo/exo-icon-view.c
+++ b/exo/exo-icon-view.c
@@ -1054,6 +1054,13 @@ exo_icon_view_class_init (ExoIconViewClass *klass)
* ExoIconView::item-activated:
* @icon_view : a #ExoIconView.
* @path : the #GtkTreePath of the activated item.
+ *
+ * The ::item-activated signal is emitted when the method
+ * exo_icon_view_item_activated() is called, when the user double clicks
+ * an item with the "activate-on-single-click" property set to %FALSE, or
+ * when the user single clicks an item when the "activate-on-single-click"
+ * property set to %TRUE. It is also emitted when a non-editable item is
+ * selected and one of the keys: Space, Return or Enter is pressed.
**/
icon_view_signals[ITEM_ACTIVATED] =
g_signal_new (I_("item-activated"),
@@ -1068,6 +1075,9 @@ exo_icon_view_class_init (ExoIconViewClass *klass)
/**
* ExoIconView::selection-changed:
* @icon_view : a #ExoIconView.
+ *
+ * The ::selection-changed signal is emitted when the selection
+ * (i.e. the set of selected items) changes.
**/
icon_view_signals[SELECTION_CHANGED] =
g_signal_new (I_("selection-changed"),
@@ -1084,6 +1094,9 @@ exo_icon_view_class_init (ExoIconViewClass *klass)
* @icon_view : a #ExoIconView.
* @hadjustment : the new horizontal #GtkAdjustment.
* @vadjustment : the new vertical #GtkAdjustment.
+ *
+ * The ::set-scroll-adjustments signal is emitted when the scroll
+ * adjustments have changed.
**/
gtkwidget_class->set_scroll_adjustments_signal =
g_signal_new (I_("set-scroll-adjustments"),
@@ -1099,6 +1112,14 @@ exo_icon_view_class_init (ExoIconViewClass *klass)
/**
* ExoIconView::select-all:
* @icon_view : a #ExoIconView.
+ *
+ * A #GtkBindingSignal which gets emitted when the user selects all items.
+ *
+ * Applications should not connect to it, but may emit it with
+ * g_signal_emit_by_name() if they need to control selection
+ * programmatically.
+ *
+ * The default binding for this signal is Ctrl-a.
**/
icon_view_signals[SELECT_ALL] =
g_signal_new (I_("select-all"),
@@ -1112,6 +1133,14 @@ exo_icon_view_class_init (ExoIconViewClass *klass)
/**
* ExoIconView::unselect-all:
* @icon_view : a #ExoIconView.
+ *
+ * A #GtkBindingSignal which gets emitted when the user unselects all items.
+ *
+ * Applications should not connect to it, but may emit it with
+ * g_signal_emit_by_name() if they need to control selection
+ * programmatically.
+ *
+ * The default binding for this signal is Ctrl-Shift-a.
**/
icon_view_signals[UNSELECT_ALL] =
g_signal_new (I_("unselect-all"),
@@ -1125,6 +1154,15 @@ exo_icon_view_class_init (ExoIconViewClass *klass)
/**
* ExoIconView::select-cursor-item:
* @icon_view : a #ExoIconView.
+ *
+ * A #GtkBindingSignal which gets emitted when the user selects the item
+ * that is currently focused.
+ *
+ * Applications should not connect to it, but may emit it with
+ * g_signal_emit_by_name() if they need to control selection
+ * programmatically.
+ *
+ * There is no default binding for this signal.
**/
icon_view_signals[SELECT_CURSOR_ITEM] =
g_signal_new (I_("select-cursor-item"),
@@ -1138,6 +1176,16 @@ exo_icon_view_class_init (ExoIconViewClass *klass)
/**
* ExoIconView::toggle-cursor-item:
* @icon_view : a #ExoIconView.
+ *
+ * A #GtkBindingSignal which gets emitted when the user toggles whether
+ * the currently focused item is selected or not. The exact effect of
+ * this depend on the selection mode.
+ *
+ * Applications should not connect to it, but may emit it with
+ * g_signal_emit_by_name() if they need to control selection
+ * programmatically.
+ *
+ * There is no default binding for this signal is Ctrl-Space.
**/
icon_view_signals[TOGGLE_CURSOR_ITEM] =
g_signal_new (I_("toggle-cursor-item"),
@@ -1152,7 +1200,14 @@ exo_icon_view_class_init (ExoIconViewClass *klass)
* ExoIconView::activate-cursor-item:
* @icon_view : a #ExoIconView.
*
- * Returns:
+ * A #GtkBindingSignal which gets emitted when the user activates the
+ * currently focused item.
+ *
+ * Applications should not connect to it, but may emit it with
+ * g_signal_emit_by_name() if they need to control activation
+ * programmatically.
+ *
+ * The default bindings for this signal are Space, Return and Enter.
**/
icon_view_signals[ACTIVATE_CURSOR_ITEM] =
g_signal_new (I_("activate-cursor-item"),
@@ -1165,9 +1220,10 @@ exo_icon_view_class_init (ExoIconViewClass *klass)
/**
* ExoIconView::start-interactive-search:
- * @iconb_view : a #ExoIconView.
+ * @icon_view : a #ExoIconView.
*
- * Returns:
+ * The ::start-interative-search signal is emitted when the user starts
+ * typing to jump to an item in the icon view.
**/
icon_view_signals[START_INTERACTIVE_SEARCH] =
g_signal_new (I_("start-interactive-search"),
@@ -1181,10 +1237,21 @@ exo_icon_view_class_init (ExoIconViewClass *klass)
/**
* ExoIconView::move-cursor:
* @icon_view : a #ExoIconView.
- * @step :
- * @count :
+ * @step : the granularity of the move, as a #GtkMovementStep
+ * @count : the number of @step units to move
+ *
+ * The ::move-cursor signal is a keybinding signal which gets emitted when
+ * the user initiates a cursor movement.
+ *
+ * Applications should not connect to it, but may emit it with
+ * g_signal_emit_by_name() if they need to control the cursor
+ * programmatically.
*
- * Returns:
+ * The default bindings for this signal include
+ * * Arrow keys which move by individual steps
+ * * Home/End keys which move to the first/last item
+ * * PageUp/PageDown which move by "pages" All of these will extend the
+ * selection when combined with the Shift modifier.
**/
icon_view_signals[MOVE_CURSOR] =
g_signal_new (I_("move-cursor"),
diff --git a/exo/exo-icon-view.h b/exo/exo-icon-view.h
index 7fdf583..5fea2c7 100644
--- a/exo/exo-icon-view.h
+++ b/exo/exo-icon-view.h
@@ -125,6 +125,16 @@ typedef enum
EXO_ICON_VIEW_LAYOUT_COLS
} ExoIconViewLayoutMode;
+/**
+ * ExoIconView:
+ *
+ * #ExoIconView provides an alternative view on a list model.
+ * It displays the model as a grid of icons with labels. Like
+ * #GtkTreeView, it allows to select one or multiple items
+ * (depending on the selection mode, see exo_icon_view_set_selection_mode()).
+ * In addition to selection with the arrow keys, #ExoIconView supports
+ * rubberband selection, which is controlled by dragging the pointer.
+ **/
struct _ExoIconView
{
GtkContainer __parent__;
diff --git a/exo/exo-job.c b/exo/exo-job.c
index eae11dc..3794fb4 100644
--- a/exo/exo-job.c
+++ b/exo/exo-job.c
@@ -573,7 +573,7 @@ exo_job_set_error_if_cancelled (ExoJob *job,
* @job : an #ExoJob.
* @signal_id : the signal id.
* @signal_detail : the signal detail.
- * @Varargs : a list of parameters to be passed to the signal,
+ * @... : a list of parameters to be passed to the signal,
* followed by a location for the return value. If the
* return type of the signal is G_TYPE_NONE, the return
* value location can be omitted.
@@ -602,7 +602,7 @@ exo_job_emit (ExoJob *job,
* exo_job_info_message:
* @job : an #ExoJob.
* @format : a format string.
- * @Varargs : parameters for the format string.
+ * @... : parameters for the format string.
*
* Generates and emits an "info-message" signal and sends it to the
* application's main loop.
diff --git a/exo/exo-toolbars-model.c b/exo/exo-toolbars-model.c
index b0b6842..1bf8578 100644
--- a/exo/exo-toolbars-model.c
+++ b/exo/exo-toolbars-model.c
@@ -289,6 +289,9 @@ exo_toolbars_model_class_init (ExoToolbarsModelClass *klass)
/**
* ExoToolbarsModel::get-item-type:
+ *
+ * This signal is emitted whenever the exo_toolbars_model_get_item_type()
+ * method is called.
**/
toolbars_model_signals[GET_ITEM_TYPE] =
g_signal_new (I_("get-item-type"),
@@ -302,6 +305,9 @@ exo_toolbars_model_class_init (ExoToolbarsModelClass *klass)
/**
* ExoToolbarsModel::get-item-id:
+ *
+ * This signal is emitted whenever the exo_toolbars_model_get_item_id()
+ * method is called.
**/
toolbars_model_signals[GET_ITEM_ID] =
g_signal_new (I_("get-item-id"),
@@ -316,6 +322,9 @@ exo_toolbars_model_class_init (ExoToolbarsModelClass *klass)
/**
* ExoToolbarsModel::get-item-data:
+ *
+ * This signal is emitted whenever the exo_toolbars_model_get_item_data()
+ * method is called.
**/
toolbars_model_signals[GET_ITEM_DATA] =
g_signal_new (I_("get-item-data"),
diff --git a/exo/exo-toolbars-model.h b/exo/exo-toolbars-model.h
index f27d3e6..7499517 100644
--- a/exo/exo-toolbars-model.h
+++ b/exo/exo-toolbars-model.h
@@ -50,6 +50,8 @@ typedef struct _ExoToolbarsModel ExoToolbarsModel;
* @EXO_TOOLBARS_MODEL_OVERRIDE_STYLE : If set, the #ExoToolbarsModel
* accepts a custom #GtkToolbarStyle. See
* exo_toolbars_model_set_style().
+ *
+ * Flags available for #ExoToolbarsModel.
*/
typedef enum
{
diff --git a/exo/exo-toolbars-private.c b/exo/exo-toolbars-private.c
index deca5c2..3ec4419 100644
--- a/exo/exo-toolbars-private.c
+++ b/exo/exo-toolbars-private.c
@@ -190,6 +190,9 @@ _exo_toolbars_new_separator_image (void)
* @ui_manager : A #GtkUIManager.
* @name : The name of an action in @ui_manager.
*
+ * Searches for the last #GtkAction named @name in @ui_manager, returning
+ * %NULL on failure.
+ *
* Returns: The last #GtkAction named @name in @ui_manager or %NULL.
**/
GtkAction*
@@ -334,6 +337,8 @@ static const guint8 drag_cursor_data[] =
/**
* _exo_toolbars_set_drag_cursor:
* @widget : A #GtkWidget.
+ *
+ * Changes the #GdkCursor to the dragging appearance.
**/
void
_exo_toolbars_set_drag_cursor (GtkWidget *widget)
@@ -357,6 +362,8 @@ _exo_toolbars_set_drag_cursor (GtkWidget *widget)
/**
* _exo_toolbars_unset_drag_cursor:
* @widget : A #GtkWidget.
+ *
+ * Restores the #GdkCursor to it's default appearance.
**/
void
_exo_toolbars_unset_drag_cursor (GtkWidget *widget)
diff --git a/exo/exo-toolbars-view.c b/exo/exo-toolbars-view.c
index 269a314..6d8ef21 100644
--- a/exo/exo-toolbars-view.c
+++ b/exo/exo-toolbars-view.c
@@ -258,6 +258,9 @@ exo_toolbars_view_class_init (ExoToolbarsViewClass *klass)
/**
* ExoToolbarsView::action-request:
* @view : An #ExoToolbarsView.
+ *
+ * This signal is emitted when a new #GtkToolItem is created from a
+ * #GtkAction in the #ExoToolbarsView.
**/
toolbars_view_signals[ACTION_REQUEST] =
g_signal_new (I_("action-request"),
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the Xfce4-commits
mailing list