[gtk-mac-integration] Clean up documentation so that gtk-docs check passes.
- From: John Ralls <jralls src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk-mac-integration] Clean up documentation so that gtk-docs check passes.
- Date: Thu, 14 Jan 2021 19:19:05 +0000 (UTC)
commit 657d917747d94d0eeb6aa12e2853f6d7c8a7a4b4
Author: John Ralls <jralls ceridwen us>
Date: Tue Jan 12 21:43:50 2021 -0800
Clean up documentation so that gtk-docs check passes.
docs/reference/gtk-mac-integration-docs.xml | 2 +-
docs/reference/gtk-mac-integration-sections.txt | 16 +---------------
src/gtkosx-image.c | 11 ++++++++++-
src/gtkosxapplication.c | 5 ++++-
src/gtkosxapplication.h | 4 +++-
src/gtkosxapplication_quartz.c | 4 ++--
6 files changed, 21 insertions(+), 21 deletions(-)
---
diff --git a/docs/reference/gtk-mac-integration-docs.xml b/docs/reference/gtk-mac-integration-docs.xml
index 72d38ec..e8135d2 100644
--- a/docs/reference/gtk-mac-integration-docs.xml
+++ b/docs/reference/gtk-mac-integration-docs.xml
@@ -32,5 +32,5 @@
<title>Index of deprecated API</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
</index>
-
+ <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</book>
diff --git a/docs/reference/gtk-mac-integration-sections.txt b/docs/reference/gtk-mac-integration-sections.txt
index a2fa3d5..070ae8a 100644
--- a/docs/reference/gtk-mac-integration-sections.txt
+++ b/docs/reference/gtk-mac-integration-sections.txt
@@ -10,6 +10,7 @@ gtkosx_application_use_quartz_accelerators
gtkosx_application_set_menu_bar
gtkosx_application_sync_menubar
gtkosx_application_insert_app_menu_item
+gtkosx_application_set_about_item
gtkosx_application_set_window_menu
gtkosx_application_set_help_menu
gtkosx_application_set_dock_menu
@@ -41,18 +42,3 @@ nsimage_from_resource
nsimage_from_pixbuf
</SECTION>
-<SECTION>
-<FILE>GNSMenuBar</FILE>
-initWithTitle
-initWithGtkMenuBar
-addGroup
-app_menu_groups
-resync
-dealloc
-</SECTION>
-
-<SECTION>
-<FILE>GNSMenuItem</FILE>
-initWithTitle
-activate
-</SECTION>
diff --git a/src/gtkosx-image.c b/src/gtkosx-image.c
index da2612d..bf387a3 100644
--- a/src/gtkosx-image.c
+++ b/src/gtkosx-image.c
@@ -29,6 +29,15 @@
#include "gtkosx-image.h"
#include "gtk-mac-image-utils.h"
+/**
+ * SECTION:gtkosx-image
+ * @short_description: Convert image resourcess to NSImage
+ *
+ * Quartz requires icon resources for the dock or menu items to be
+ * NSImages while Gnome uses either GdkPixbuf or image files such as
+ * jpeg or png. The functions in this section convert those resources
+ * into NSImage.
+ */
/**
* nsimage_from_resource:
* @name: The filename
@@ -60,7 +69,7 @@ nsimage_from_resource (const gchar *name, const gchar* type, const gchar* subdir
return image;
}
-/*
+/**
* nsimage_from_pixbuf:
* @pixbuf: The GdkPixbuf* to convert
*
diff --git a/src/gtkosxapplication.c b/src/gtkosxapplication.c
index 23c7d06..a6c5fad 100644
--- a/src/gtkosxapplication.c
+++ b/src/gtkosxapplication.c
@@ -250,7 +250,10 @@
/**
* gtkosx_application_get:
*
- * Returns: (transfer none) the singleton application object.
+ * Get the singleton NSApplication object.
+ *
+ * Returns: (transfer none): the singleton application object.
+ *
*/
GtkosxApplication *
gtkosx_application_get (void)
diff --git a/src/gtkosxapplication.h b/src/gtkosxapplication.h
index ddd0dc2..5b93b6f 100644
--- a/src/gtkosxapplication.h
+++ b/src/gtkosxapplication.h
@@ -94,9 +94,11 @@ void gtkosx_application_set_help_menu (GtkosxApplication *self,
/*Dock Functions*/
/**
- * GtkosxApplicationAttentionType
+ * GtkosxApplicationAttentionType:
* @CRITICAL_REQUEST: Bounce the icon until the app is activated.
* @INFO_REQUEST: Bounce the icon for one second.
+ *
+ * The possible values for dock attention requests.
*/
typedef enum {
CRITICAL_REQUEST = 0,
diff --git a/src/gtkosxapplication_quartz.c b/src/gtkosxapplication_quartz.c
index ed04ea6..f64d369 100644
--- a/src/gtkosxapplication_quartz.c
+++ b/src/gtkosxapplication_quartz.c
@@ -863,11 +863,11 @@ gtkosx_application_insert_app_menu_item (GtkosxApplication* self,
}
/**
- * gtkosx_application_set_about_item
+ * gtkosx_application_set_about_item:
* @self: The application object
* @item: The about menu item
*
- * Sets the designated menu item as the "About <appname>", the first
+ * Sets the designated menu item as the "About <appname>", the first
* one on the App Menu. We take a GtkMenuItem* because it's less work
* for app developers than unwrapping a GtkAction for us to wrap in an
* NSAction.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]