diff options
author | Emmanuele Bassi <ebassi@gnome.org> | 2018-06-26 17:01:18 +0100 |
---|---|---|
committer | Emmanuele Bassi <ebassi@gnome.org> | 2018-06-26 17:01:18 +0100 |
commit | dcf3643cbe2fa4c57b4a86b8af3a33f9b615d097 (patch) | |
tree | c355972d149be64f2051caa21526281879c84bfc | |
parent | b5987690fe500ad6ff8d22f4fcf9fa0474919742 (diff) | |
download | atk-dcf3643cbe2fa4c57b4a86b8af3a33f9b615d097.tar.gz |
Add proper gtk-doc blurbs for AtkDocument methods
We're missing the description from various methods, and the
reference syntax for arguments and symbols is incorrect.
-rw-r--r-- | atk/atkdocument.c | 40 |
1 files changed, 24 insertions, 16 deletions
diff --git a/atk/atkdocument.c b/atk/atkdocument.c index ff08ca8..b661c26 100644 --- a/atk/atkdocument.c +++ b/atk/atkdocument.c @@ -296,13 +296,15 @@ atk_document_get_attributes (AtkDocument *document) * atk_document_get_attribute_value: (virtual get_document_attribute_value) * @document: a #GObject instance that implements AtkDocumentIface * @attribute_name: a character string representing the name of the attribute - * whose value is being queried. + * whose value is being queried. * - * Since: 1.12 + * Retrieves the value of the given @attribute_name inside @document. * * Returns: (nullable): a string value associated with the named - * attribute for this document, or NULL if a value for - * #attribute_name has not been specified for this document. + * attribute for this document, or %NULL if a value for + * @attribute_name has not been specified for this document. + * + * Since: 1.12 */ const gchar * atk_document_get_attribute_value (AtkDocument *document, @@ -326,16 +328,18 @@ atk_document_get_attribute_value (AtkDocument *document, /** * atk_document_set_attribute_value: (virtual set_document_attribute) - * @document: a #GObject instance that implements AtkDocumentIface + * @document: a #GObject instance that implements #AtkDocumentIface * @attribute_name: a character string representing the name of the attribute - * whose value is being set. - * @attribute_value: a string value to be associated with #attribute_name. + * whose value is being set. + * @attribute_value: a string value to be associated with @attribute_name. + * + * Sets the value for the given @attribute_name inside @document. * * Since: 1.12 * - * Returns: TRUE if #value is successfully associated with #attribute_name - * for this document, FALSE otherwise (e.g. if the document does not - * allow the attribute to be modified). + * Returns: %TRUE if @attribute_value is successfully associated + * with @attribute_name for this @document, and %FALSE if if the + * document does not allow the attribute to be modified */ gboolean atk_document_set_attribute_value (AtkDocument *document, @@ -362,10 +366,12 @@ atk_document_set_attribute_value (AtkDocument *document, * atk_document_get_current_page_number: * @document: the #AtkDocument * - * Since: 2.12 + * Retrieves the current page number inside @document. * - * Returns: current page number inside @document. -1 if not - * implemented, not know by the implementor or irrelevant. + * Returns: the current page number inside @document, or -1 if + * not implemented, not know by the implementor, or irrelevant. + * + * Since: 2.12 */ gint atk_document_get_current_page_number (AtkDocument *document) @@ -390,10 +396,12 @@ atk_document_get_current_page_number (AtkDocument *document) * atk_document_get_page_count: * @document: the #AtkDocument * - * Since: 2.12 + * Retrieves the total number of pages inside @document. * - * Returns: total page count of @document. -1 if not implemented, not - * know by the implementor or irrelevant. + * Returns: total page count of @document, or -1 if not implemented, + * not know by the implementor or irrelevant. + * + * Since: 2.12 */ gint atk_document_get_page_count (AtkDocument *document) |