[Xfce4-commits] [apps/xfdashboard] 02/02: Add missing annotation for API documentation to files already documented

noreply at xfce.org noreply at xfce.org
Tue Jun 21 12:52:23 CEST 2016


This is an automated email from the git hooks/post-receive script.

nomad pushed a commit to branch master
in repository apps/xfdashboard.

commit 867d48154ba9d0a4e3f5b0ad49c51eec00a1b64a
Author: Stephan Haller <nomad at froevel.de>
Date:   Tue Jun 21 12:52:02 2016 +0200

    Add missing annotation for API documentation to files already documented
---
 libxfdashboard/application.h   | 19 +++++++++++++++++++
 libxfdashboard/box-layout.h    | 12 ++++++++++++
 libxfdashboard/view-selector.h | 12 ++++++++++++
 3 files changed, 43 insertions(+)

diff --git a/libxfdashboard/application.h b/libxfdashboard/application.h
index 4faada7..cf51c92 100644
--- a/libxfdashboard/application.h
+++ b/libxfdashboard/application.h
@@ -69,8 +69,15 @@ typedef struct _XfdashboardApplication				XfdashboardApplication;
 typedef struct _XfdashboardApplicationClass			XfdashboardApplicationClass;
 typedef struct _XfdashboardApplicationPrivate		XfdashboardApplicationPrivate;
 
+/**
+ * XfdashboardApplication:
+ *
+ * The #XfdashboardApplication structure contains only private data and
+ * should be accessed using the provided API
+ */
 struct _XfdashboardApplication
 {
+	/*< private >*/
 	/* Parent instance */
 	GApplication					parent_instance;
 
@@ -78,6 +85,18 @@ struct _XfdashboardApplication
 	XfdashboardApplicationPrivate	*priv;
 };
 
+/**
+ * XfdashboardApplicationClass:
+ * @initialized: class handler for the #XfdashboardApplicationClass::initialized signal
+ * @suspend: class handler for the #XfdashboardApplicationClass::suspend signal
+ * @resume: class handler for the #XfdashboardApplicationClass::resume signal
+ * @quit: class handler for the #XfdashboardApplicationClass::quit signal
+ * @shutdown_final: class handler for the #XfdashboardApplicationClass::shutdown_final signal
+ * @theme_changed: class handler for the #XfdashboardApplicationClass::theme_changed signal
+ * @application_launched: class handler for the #XfdashboardApplicationClass::application_launched signal
+ *
+ * The #XfdashboardApplicationClass structure contains only private data
+ */
 struct _XfdashboardApplicationClass
 {
 	/*< private >*/
diff --git a/libxfdashboard/box-layout.h b/libxfdashboard/box-layout.h
index 66cfca2..c5d7206 100644
--- a/libxfdashboard/box-layout.h
+++ b/libxfdashboard/box-layout.h
@@ -44,12 +44,24 @@ G_BEGIN_DECLS
 typedef struct _XfdashboardBoxLayout			XfdashboardBoxLayout;
 typedef struct _XfdashboardBoxLayoutClass		XfdashboardBoxLayoutClass;
 
+/**
+ * XfdashboardBoxLayout:
+ *
+ * The #XfdashboardBoxLayout structure contains only private data and
+ * should be accessed using the provided API
+ */
 struct _XfdashboardBoxLayout
 {
+	/*< private >*/
 	/* Parent instance */
 	ClutterBoxLayout 				parent_instance;
 };
 
+/**
+ * XfdashboardBoxLayoutClass:
+ *
+ * The #XfdashboardBoxLayoutClass structure contains only private data
+ */
 struct _XfdashboardBoxLayoutClass
 {
 	/*< private >*/
diff --git a/libxfdashboard/view-selector.h b/libxfdashboard/view-selector.h
index ec15f3f..70812fc 100644
--- a/libxfdashboard/view-selector.h
+++ b/libxfdashboard/view-selector.h
@@ -47,6 +47,12 @@ typedef struct _XfdashboardViewSelector				XfdashboardViewSelector;
 typedef struct _XfdashboardViewSelectorPrivate		XfdashboardViewSelectorPrivate;
 typedef struct _XfdashboardViewSelectorClass		XfdashboardViewSelectorClass;
 
+/**
+ * XfdashboardViewSelector:
+ *
+ * The #XfdashboardViewSelector structure contains only private data and
+ * should be accessed using the provided API
+ */
 struct _XfdashboardViewSelector
 {
 	/* Parent instance */
@@ -56,6 +62,12 @@ struct _XfdashboardViewSelector
 	XfdashboardViewSelectorPrivate	*priv;
 };
 
+/**
+ * XfdashboardViewSelectorClass:
+ * @state_changed: class handler for the #XfdashboardViewSelectorClass::state_changed signal
+ *
+ * The #XfdashboardViewSelectorClass structure contains only private data
+ */
 struct _XfdashboardViewSelectorClass
 {
 	/*< private >*/

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.


More information about the Xfce4-commits mailing list