[gcr] gcr: minor gtk-doc fixes



commit 547c74f75bc2f592ade7d46971b2806e07698763
Author: Dan Winship <danw gnome org>
Date:   Tue Jul 31 11:32:57 2012 -0400

    gcr: minor gtk-doc fixes

 gcr/gcr-collection.c      |    4 ++--
 gcr/gcr-parser.c          |   22 +++++++++++-----------
 gcr/gcr-renderer.c        |    2 +-
 gcr/gcr-system-prompter.c |    2 +-
 4 files changed, 15 insertions(+), 15 deletions(-)
---
diff --git a/gcr/gcr-collection.c b/gcr/gcr-collection.c
index 08bbedb..cb0c29b 100644
--- a/gcr/gcr-collection.c
+++ b/gcr/gcr-collection.c
@@ -152,7 +152,7 @@ gcr_collection_contains (GcrCollection *self,
  * @self: The collection
  * @object: The object that was added
  *
- * Emit the GcrCollection::added signal for the given object. This function
+ * Emit the #GcrCollection::added signal for the given object. This function
  * is used by implementors of this interface.
  */
 void
@@ -167,7 +167,7 @@ gcr_collection_emit_added (GcrCollection *self, GObject *object)
  * @self: The collection
  * @object: The object that was removed
  *
- * Emit the GcrCollection::removed signal for the given object. This function
+ * Emit the #GcrCollection::removed signal for the given object. This function
  * is used by implementors of this interface.
  */
 void
diff --git a/gcr/gcr-parser.c b/gcr/gcr-parser.c
index 0f81397..8074e36 100644
--- a/gcr/gcr-parser.c
+++ b/gcr/gcr-parser.c
@@ -55,11 +55,11 @@
  * format is identified by a value in the #GcrDataFormat enumeration.
  *
  * In order to parse data, a new parser is created with gcr_parser_new() and
- * then the GcrParser::authenticate and GcrParser::parsed signals should be
+ * then the #GcrParser::authenticate and #GcrParser::parsed signals should be
  * 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 #GcrParsed::parsed signal the attributes that make up the currently
  * parsed item can be retrieved using the gcr_parser_get_parsed_attributes()
  * function.
  */
@@ -2362,7 +2362,7 @@ gcr_parser_new (void)
  * @password: (allow-none): a password to try
  *
  * Add a password to the set of passwords to try when parsing locked or encrypted
- * items. This is usually called from the GcrParser::authenticate signal.
+ * items. This is usually called from the #GcrParser::authenticate signal.
  */
 void
 gcr_parser_add_password (GcrParser *self, const gchar *password)
@@ -2378,7 +2378,7 @@ gcr_parser_add_password (GcrParser *self, const gchar *password)
  * @n_data: The length of the data
  * @error: A location to raise an error on failure.
  *
- * Parse the data. The GcrParser::parsed and GcrParser::authenticate signals
+ * Parse the data. The #GcrParser::parsed and #GcrParser::authenticate signals
  * may fire during the parsing.
  *
  * Returns: Whether the data was parsed successfully or not.
@@ -2626,7 +2626,7 @@ gcr_parsed_unref (gpointer parsed)
  * @self: The parser
  *
  * Get a description for the type of the currently parsed item. This is generally
- * only valid during the GcrParser::parsed signal.
+ * only valid during the #GcrParser::parsed signal.
  *
  * Returns: (allow-none): the description for the current item; this is owned by
  *          the parser and should not be freed
@@ -2665,7 +2665,7 @@ gcr_parsed_get_description (GcrParsed *parsed)
  * @self: The parser
  *
  * Get the attributes which make up the currently parsed item. This is generally
- * only valid during the GcrParser::parsed signal.
+ * only valid during the #GcrParser::parsed signal.
  *
  * Returns: (transfer none) (allow-none): the attributes for the current item,
  *          which are owned by the parser and should not be freed
@@ -2705,7 +2705,7 @@ gcr_parsed_get_attributes (GcrParsed *parsed)
  * @self: The parser
  *
  * Get the label of the currently parsed item. This is generally only valid
- * during the GcrParser::parsed signal.
+ * during the #GcrParser::parsed signal.
  *
  * Returns: (allow-none): the label of the currently parsed item. The value is
  *          owned by the parser and should not be freed.
@@ -2745,7 +2745,7 @@ gcr_parsed_get_label (GcrParsed *parsed)
  * @n_block: a location to place the size of the block
  *
  * Get the raw data block that represents this parsed object. This is only
- * valid during the GcrParser::parsed signal.
+ * valid during the #GcrParser::parsed signal.
  *
  * Returns: (transfer none) (array length=n_block) (allow-none): the raw data
  *          block of the currently parsed item; the value is owned by the parser
@@ -2795,7 +2795,7 @@ gcr_parsed_get_data (GcrParsed *parsed,
  * Get the format of the raw data block that represents this parsed object.
  * This corresponds with the data returned from gcr_parser_get_parsed_block().
  *
- * This is only valid during the GcrParser::parsed signal.
+ * This is only valid during the #GcrParser::parsed signal.
  *
  * Returns: the data format of the currently parsed item
  */
@@ -3085,7 +3085,7 @@ gcr_parsing_new (GcrParser *parser, GInputStream *input, GCancellable *cancel)
  * reading from the input stream. Use gcr_parser_parse_stream_async() for
  * a non-blocking variant.
  *
- * The GcrParser::parsed and GcrParser::authenticate signals
+ * The #GcrParser::parsed and #GcrParser::authenticate signals
  * may fire during the parsing.
  *
  * Returns: Whether the parsing completed successfully or not.
@@ -3120,7 +3120,7 @@ gcr_parser_parse_stream (GcrParser *self, GInputStream *input, GCancellable *can
  * Parse items from the data in a #GInputStream. This function completes
  * asyncronously and doesn't block.
  *
- * The GcrParser::parsed and GcrParser::authenticate signals
+ * The #GcrParser::parsed and #GcrParser::authenticate signals
  * may fire during the parsing.
  */
 void
diff --git a/gcr/gcr-renderer.c b/gcr/gcr-renderer.c
index 71c84c0..30ce91f 100644
--- a/gcr/gcr-renderer.c
+++ b/gcr/gcr-renderer.c
@@ -176,7 +176,7 @@ gcr_renderer_popuplate_popup (GcrRenderer *self, GcrViewer *viewer,
  * gcr_renderer_emit_data_changed:
  * @self: The renderer
  *
- * Emit the GcrRenderer::data-changed signal on the renderer. This is used by
+ * Emit the #GcrRenderer::data-changed signal on the renderer. This is used by
  * renderer implementations.
  */
 void
diff --git a/gcr/gcr-system-prompter.c b/gcr/gcr-system-prompter.c
index d07be52..fb03ec8 100644
--- a/gcr/gcr-system-prompter.c
+++ b/gcr/gcr-system-prompter.c
@@ -63,7 +63,7 @@
 /**
  * GcrSystemPrompterClass:
  * @parent_class: parent class
- * @new_prompt: default handler for the GcrSystemPrompter::new-prompt signal
+ * @new_prompt: default handler for the #GcrSystemPrompter::new-prompt signal
  *
  * The class for #GcrSystemPrompter.
  */



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