[gnome-keyring] gcr: Fix up GcrViewerWindow documentation



commit 533b8043c55724976f481b1b159c80180e4f798c
Author: Stef Walter <stefw collabora co uk>
Date:   Tue Aug 30 12:27:10 2011 +0200

    gcr: Fix up GcrViewerWindow documentation

 docs/reference/gcr/gcr-sections.txt |   18 +++++++++++++++++
 gcr/gcr-viewer-window.c             |   36 +++++++++++++++++++++++++++++++++++
 gcr/gcr-viewer-window.h             |    2 +
 3 files changed, 56 insertions(+), 0 deletions(-)
---
diff --git a/docs/reference/gcr/gcr-sections.txt b/docs/reference/gcr/gcr-sections.txt
index a1a5944..37a62ac 100644
--- a/docs/reference/gcr/gcr-sections.txt
+++ b/docs/reference/gcr/gcr-sections.txt
@@ -364,6 +364,7 @@ gcr_renderer_popuplate_popup
 gcr_renderer_render
 gcr_renderer_render_view
 gcr_renderer_emit_data_changed
+gcr_renderer_register_well_known
 <SUBSECTION Standard>
 gcr_renderer_get_type
 GCR_IS_RENDERER
@@ -487,6 +488,23 @@ GcrUnlockOptionsWidgetPrivate
 </SECTION>
 
 <SECTION>
+<FILE>gcr-viewer-window</FILE>
+GcrViewerWindow
+GcrViewerWindowClass
+gcr_viewer_window_new
+gcr_viewer_window_load
+<SUBSECTION Private>
+gcr_viewer_window_get_type
+GcrViewerWindowPrivate
+GCR_IS_VIEWER_WINDOW
+GCR_IS_VIEWER_WINDOW_CLASS
+GCR_TYPE_VIEWER_WINDOW
+GCR_VIEWER_WINDOW
+GCR_VIEWER_WINDOW_CLASS
+GCR_VIEWER_WINDOW_GET_CLASS
+</SECTION>
+
+<SECTION>
 <FILE>gcr-private</FILE>
 <SUBSECTION Private>
 GCR_RECORD_SCHEMA_PUB
diff --git a/gcr/gcr-viewer-window.c b/gcr/gcr-viewer-window.c
index c04ca94..a85a757 100644
--- a/gcr/gcr-viewer-window.c
+++ b/gcr/gcr-viewer-window.c
@@ -34,6 +34,27 @@
 #include <locale.h>
 #include <string.h>
 
+/**
+ * SECTION:gcr-viewer-window
+ * @title: GcrViewerWindow
+ * @short_description: A window which shows certificates or keys
+ *
+ * A viewer window which can display certificates and keys that are
+ * located in files.
+ */
+
+/**
+ * GcrViewerWindow:
+ *
+ * A viewer window object.
+ */
+
+/**
+ * GcrViewerWindowClass:
+ *
+ * Class for #GcrViewerWindow
+ */
+
 struct _GcrViewerWindowPrivate {
 	GQueue *files_to_load;
 	GcrParser *parser;
@@ -203,12 +224,27 @@ viewer_load_next_file (GcrViewerWindow *self)
 	                   on_file_read_returned, self);
 }
 
+/**
+ * gcr_viewer_window_new:
+ *
+ * Create a new viewer window.
+ *
+ * Returns: (transfer full): A new #GcrViewerWindow object
+ */
 GcrViewerWindow *
 gcr_viewer_window_new (void)
 {
 	return g_object_new (GCR_TYPE_VIEWER_WINDOW, NULL);
 }
 
+/**
+ * gcr_viewer_window_load:
+ * @self: a viewer window
+ * @file: a file to load
+ *
+ * Display contents of a file in the viewer window. Multiple files can
+ * be loaded.
+ */
 void
 gcr_viewer_window_load (GcrViewerWindow *self, GFile *file)
 {
diff --git a/gcr/gcr-viewer-window.h b/gcr/gcr-viewer-window.h
index 5b94868..d5ac88d 100644
--- a/gcr/gcr-viewer-window.h
+++ b/gcr/gcr-viewer-window.h
@@ -38,11 +38,13 @@ typedef struct _GcrViewerWindowClass GcrViewerWindowClass;
 typedef struct _GcrViewerWindowPrivate GcrViewerWindowPrivate;
 
 struct _GcrViewerWindow {
+	/*< private >*/
 	GtkWindow parent;
 	GcrViewerWindowPrivate *pv;
 };
 
 struct _GcrViewerWindowClass {
+	/*< private >*/
 	GtkWindowClass parent_class;
 };
 



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]