[gnome-panel] docs: fix distcheck
- From: Alberts Muktupāvels <muktupavels src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-panel] docs: fix distcheck
- Date: Fri, 20 Dec 2019 18:07:04 +0000 (UTC)
commit 6a35dccfa94d614e57d4fb7ae80ca5ca07699030
Author: Alberts Muktupāvels <alberts muktupavels gmail com>
Date: Fri Dec 20 20:03:18 2019 +0200
docs: fix distcheck
docs/reference/libgnome-panel/Makefile.am | 8 +++++++-
docs/reference/libgnome-panel/libgnome-panel-docs.xml | 1 -
libgnome-panel/gp-applet.c | 2 +-
libgnome-panel/gp-module.c | 11 +++++++++--
libgnome-panel/gp-module.h | 13 ++++++++++---
5 files changed, 27 insertions(+), 8 deletions(-)
---
diff --git a/docs/reference/libgnome-panel/Makefile.am b/docs/reference/libgnome-panel/Makefile.am
index 9a7d8d555..0e942da0c 100644
--- a/docs/reference/libgnome-panel/Makefile.am
+++ b/docs/reference/libgnome-panel/Makefile.am
@@ -46,10 +46,16 @@ EXTRA_HFILES =
# Header files or dirs to ignore when scanning. Use base file/dir names
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
IGNORE_HFILES = \
+ gp-action-private.h \
+ gp-action.h \
gp-applet-info-private.h \
gp-applet-private.h \
gp-enum-types.h \
- gp-module-info-private.h \
+ gp-image-menu-item.h \
+ gp-initial-setup-dialog-private.h \
+ gp-initial-setup-dialog.h \
+ gp-module-private.h \
+ gp-utils.h \
$(NULL)
# Images to copy into HTML directory.
diff --git a/docs/reference/libgnome-panel/libgnome-panel-docs.xml
b/docs/reference/libgnome-panel/libgnome-panel-docs.xml
index 515902919..59b91435e 100644
--- a/docs/reference/libgnome-panel/libgnome-panel-docs.xml
+++ b/docs/reference/libgnome-panel/libgnome-panel-docs.xml
@@ -20,7 +20,6 @@
<title>API Reference</title>
<xi:include href="xml/gp-applet.xml"/>
<xi:include href="xml/gp-applet-info.xml"/>
- <xi:include href="xml/gp-module-info.xml"/>
<xi:include href="xml/gp-module.xml"/>
</chapter>
diff --git a/libgnome-panel/gp-applet.c b/libgnome-panel/gp-applet.c
index 9aa4bd894..cd3897830 100644
--- a/libgnome-panel/gp-applet.c
+++ b/libgnome-panel/gp-applet.c
@@ -670,7 +670,7 @@ install_properties (GObjectClass *object_class)
/**
* GpApplet:menu-icon-size:
*
- * The size of icons in panels.
+ * The size of icons in menus.
*/
properties[PROP_MENU_ICON_SIZE] =
g_param_spec_uint ("menu-icon-size", "Menu Icon Size", "Menu Icon Size",
diff --git a/libgnome-panel/gp-module.c b/libgnome-panel/gp-module.c
index fbad87e3f..63cd53eac 100644
--- a/libgnome-panel/gp-module.c
+++ b/libgnome-panel/gp-module.c
@@ -99,6 +99,13 @@
* ]|
*/
+/**
+ * GpModule:
+ *
+ * #GpModule is an opaque data structure and can only be accessed using
+ * the following functions.
+ */
+
#include "config.h"
#include <gtk/gtk.h>
@@ -462,8 +469,8 @@ gp_module_set_version (GpModule *module,
}
/**
- * gp_module_info_set_applets:
- * @info: a #GpModuleInfo
+ * gp_module_set_applet_ids:
+ * @module: a #GpModuleInfo
* @...: a %NULL-terminated list of applet ids in this module
*
* Sets the applets available in this module.
diff --git a/libgnome-panel/gp-module.h b/libgnome-panel/gp-module.h
index 0aa70fbd3..9cd79ebe4 100644
--- a/libgnome-panel/gp-module.h
+++ b/libgnome-panel/gp-module.h
@@ -34,6 +34,8 @@ G_BEGIN_DECLS
* GpGetAppletInfoFunc:
* @id: the applet id
*
+ * Returns a #GpAppletInfo.
+ *
* Returns: (transfer full): returns a #GpAppletInfo.
*/
typedef GpAppletInfo * (* GpGetAppletInfoFunc) (const gchar *id);
@@ -51,9 +53,9 @@ typedef const gchar * (* GetAppletIdFromIidFunc) (const gchar *iid);
/**
* GetStandaloneMenuFunc:
- * @enable_tooltips:
- * @locked_down:
- * @menu_icon_size:
+ * @enable_tooltips: Whether the applet should show tooltips
+ * @locked_down: Whether the applet is on locked down panel
+ * @menu_icon_size: The size of icons in menus
*
* Specifies the type of the module function called to create a
* standalone menu.
@@ -64,6 +66,11 @@ typedef GtkWidget * (* GetStandaloneMenuFunc) (gboolean enable_tooltips,
gboolean locked_down,
guint menu_icon_size);
+/**
+ * GP_TYPE_MODULE:
+ *
+ * The type for GpModule.
+ */
#define GP_TYPE_MODULE (gp_module_get_type ())
G_DECLARE_FINAL_TYPE (GpModule, gp_module, GP, MODULE, GObject)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]