[gcr] Fix up documentation warnings



commit cbd62a66041b851dc7ff2c3e541ca393cef9e34c
Author: Stef Walter <stefw gnome org>
Date:   Fri Oct 18 23:22:32 2013 +0200

    Fix up documentation warnings

 docs/reference/gcr/Makefile.am      |    3 ++-
 docs/reference/gcr/gcr-sections.txt |    3 +++
 gcr/gcr-mock-prompter.c             |    5 +++++
 gcr/gcr-parser.c                    |    2 +-
 gcr/gcr-prompt.c                    |   12 +++++++++---
 ui/gcr-collection-model.c           |    7 +++++++
 6 files changed, 27 insertions(+), 5 deletions(-)
---
diff --git a/docs/reference/gcr/Makefile.am b/docs/reference/gcr/Makefile.am
index 72eeaed..4e56eb8 100644
--- a/docs/reference/gcr/Makefile.am
+++ b/docs/reference/gcr/Makefile.am
@@ -21,7 +21,7 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
 # gtk-doc will search all .c & .h files beneath here for inline comments
 # documenting the functions and macros.
 # e.g. DOC_SOURCE_DIR=../../../gtk
-DOC_SOURCE_DIR=$(top_srcdir)/$(DOC_MODULE)
+DOC_SOURCE_DIR=$(top_srcdir)/$(DOC_MODULE) $(top_srcdir)/ui
 
 # Extra options to pass to gtkdoc-scangobj. Not normally needed.
 SCANGOBJ_OPTIONS=
@@ -79,6 +79,7 @@ IGNORE_HFILES= \
        gcr-live-search.h \
        gcr-marshal.h \
        gcr-menu-button.h \
+       gcr-oids.h \
        gcr-openpgp.h \
        gcr-pkcs11-importer.h \
        gcr-pkcs11-import-interaction.h \
diff --git a/docs/reference/gcr/gcr-sections.txt b/docs/reference/gcr/gcr-sections.txt
index 547a1dd..7962dfd 100644
--- a/docs/reference/gcr/gcr-sections.txt
+++ b/docs/reference/gcr/gcr-sections.txt
@@ -484,6 +484,8 @@ GcrRenderer
 GcrRendererIface
 gcr_renderer_create
 gcr_renderer_register
+gcr_renderer_get_attributes
+gcr_renderer_set_attributes
 gcr_renderer_popuplate_popup
 gcr_renderer_render_view
 gcr_renderer_emit_data_changed
@@ -851,6 +853,7 @@ GCR_TYPE_SYSTEM_PROMPTER_MODE
 <FILE>gcr-mock-prompter</FILE>
 gcr_mock_prompter_start
 gcr_mock_prompter_stop
+gcr_mock_prompter_disconnect
 gcr_mock_prompter_expect_confirm_cancel
 gcr_mock_prompter_expect_confirm_ok
 gcr_mock_prompter_expect_password_cancel
diff --git a/gcr/gcr-mock-prompter.c b/gcr/gcr-mock-prompter.c
index f8e49b8..fa5155e 100644
--- a/gcr/gcr-mock-prompter.c
+++ b/gcr/gcr-mock-prompter.c
@@ -1042,6 +1042,11 @@ gcr_mock_prompter_start (void)
        return g_dbus_connection_get_unique_name (running->connection);
 }
 
+/**
+ * gcr_mock_prompter_disconnect:
+ *
+ * Disconnect the mock prompter
+ */
 void
 gcr_mock_prompter_disconnect (void)
 {
diff --git a/gcr/gcr-parser.c b/gcr/gcr-parser.c
index 109d2d7..13e1556 100644
--- a/gcr/gcr-parser.c
+++ b/gcr/gcr-parser.c
@@ -59,7 +59,7 @@
  * connected to. Data is then fed to the parser via gcr_parser_parse_data()
  * or gcr_parser_parse_stream().
  *
- * During the #GcrParsed::parsed signal the attributes that make up the currently
+ * During the #GcrParser::parsed signal the attributes that make up the currently
  * parsed item can be retrieved using the gcr_parser_get_parsed_attributes()
  * function.
  */
diff --git a/gcr/gcr-prompt.c b/gcr/gcr-prompt.c
index 033d536..3b7be73 100644
--- a/gcr/gcr-prompt.c
+++ b/gcr/gcr-prompt.c
@@ -292,6 +292,12 @@ on_run_complete (GObject *source,
        g_main_loop_quit (closure->loop);
 }
 
+/**
+ * gcr_prompt_reset:
+ * @prompt: the prompt
+ *
+ * Reset the contents and properties of the prompt.
+ */
 void
 gcr_prompt_reset (GcrPrompt *prompt)
 {
@@ -942,7 +948,7 @@ gcr_prompt_confirm_async (GcrPrompt *prompt,
  *
  * Complete an operation to prompt for confirmation.
  *
- * %GCR_PROMPT_REPLY_OK will be returned if the user confirms the prompt. The
+ * %GCR_PROMPT_REPLY_CONTINUE will be returned if the user confirms the prompt. The
  * return value will also be %GCR_PROMPT_REPLY_CANCEL if the user cancels or if
  * an error occurs. Check the @error argument to tell the difference.
  *
@@ -977,7 +983,7 @@ gcr_prompt_confirm_finish (GcrPrompt *prompt,
  *
  * This method will block until the a response is returned from the prompter.
  *
- * %GCR_PROMPT_REPLY_OK will be returned if the user confirms the prompt. The
+ * %GCR_PROMPT_REPLY_CONTINUE will be returned if the user confirms the prompt. The
  * return value will also be %GCR_PROMPT_REPLY_CANCEL if the user cancels or if
  * an error occurs. Check the @error argument to tell the difference.
  *
@@ -1021,7 +1027,7 @@ gcr_prompt_confirm (GcrPrompt *prompt,
  * and will run a main loop similar to a gtk_dialog_run(). The application
  * will remain responsive but care must be taken to handle reentrancy issues.
  *
- * %GCR_PROMPT_REPLY_OK will be returned if the user confirms the prompt. The
+ * %GCR_PROMPT_REPLY_CONTINUE will be returned if the user confirms the prompt. The
  * return value will also be %GCR_PROMPT_REPLY_CANCEL if the user cancels or if
  * an error occurs. Check the @error argument to tell the difference.
  *
diff --git a/ui/gcr-collection-model.c b/ui/gcr-collection-model.c
index d9bd688..91002f9 100644
--- a/ui/gcr-collection-model.c
+++ b/ui/gcr-collection-model.c
@@ -1386,6 +1386,13 @@ gcr_collection_model_get_collection (GcrCollectionModel *self)
        return self->pv->collection;
 }
 
+/**
+ * gcr_collection_model_set_collection:
+ * @self: a collection model
+ * @collection: (allow-none): the collection or %NULL
+ *
+ * Set the collection which this model represents
+ */
 void
 gcr_collection_model_set_collection (GcrCollectionModel *self,
                                      GcrCollection *collection)


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