[gedit] More annotation fixes.



commit f89bef27272765e1b459b91135f9e4c5cf9c0708
Author: Ignacio Casal Quinteiro <icq gnome org>
Date:   Wed Jun 30 20:09:17 2010 +0200

    More annotation fixes.

 gedit/gedit-document.c    |   12 +++++++++---
 gedit/gedit-message-bus.c |    8 ++++----
 gedit/gedit-tab.c         |    4 ++--
 3 files changed, 15 insertions(+), 9 deletions(-)
---
diff --git a/gedit/gedit-document.c b/gedit/gedit-document.c
index eafda53..3155a7d 100644
--- a/gedit/gedit-document.c
+++ b/gedit/gedit-document.c
@@ -1190,6 +1190,12 @@ set_location (GeditDocument *doc,
 	}
 }
 
+/**
+ * gedit_document_get_location:
+ * @doc: a #GeditDocument
+ *
+ * Returns: (allow-none): a copy of the internal #GFile
+ */
 GFile *
 gedit_document_get_location (GeditDocument *doc)
 {
@@ -2121,7 +2127,7 @@ gedit_document_get_can_search_again (GeditDocument *doc)
  * @start: (allow-none):
  * @end: (allow-none):
  * @match_start: (allow-none):
- * @match_end: (allow=none):
+ * @match_end: (allow-none):
  **/
 gboolean
 gedit_document_search_forward (GeditDocument     *doc,
@@ -2202,7 +2208,7 @@ gedit_document_search_forward (GeditDocument     *doc,
  * @start: (allow-none):
  * @end: (allow-none):
  * @match_start: (allow-none):
- * @match_end: (allow=none):
+ * @match_end: (allow-none):
  **/
 gboolean
 gedit_document_search_backward (GeditDocument     *doc,
@@ -3005,7 +3011,7 @@ set_attributes_cb (GObject      *source,
  * gedit_document_set_metadata:
  * @doc: a #GeditDocument
  * @first_key: name of the first key to set
- * @...: value for the first key, followed optionally by more key/value pairs,
+ * @...: (allow-none): value for the first key, followed optionally by more key/value pairs,
  * followed by %NULL.
  *
  * Sets metadata on a document.
diff --git a/gedit/gedit-message-bus.c b/gedit/gedit-message-bus.c
index 5c44d3a..4594657 100644
--- a/gedit/gedit-message-bus.c
+++ b/gedit/gedit-message-bus.c
@@ -1148,16 +1148,16 @@ gedit_message_bus_send (GeditMessageBus *bus,
  * @bus: a #GeditMessageBus
  * @object_path: the object path
  * @method: the method
- * @...: NULL terminated list of key/value pairs
+ * @...: (allow-none): %NULL terminated list of key/value pairs
  *
  * This provides a convenient way to quickly send a message @method at 
  * @object_path synchronously over the bus. The variable argument list 
  * specifies key (string) value pairs used to construct the message 
  * arguments. To send a message asynchronously use gedit_message_bus_send().
  *
- * Return value: the constructed #GeditMessage. The caller owns a reference
- *               to the #GeditMessage and should call g_object_unref() when
- *               it is no longer needed
+ * Return value: (allow-none): the constructed #GeditMessage. The caller owns a 
+ *               reference to the #GeditMessage and should call g_object_unref()
+ *               when it is no longer needed
  */
 GeditMessage *
 gedit_message_bus_send_sync (GeditMessageBus *bus,
diff --git a/gedit/gedit-tab.c b/gedit/gedit-tab.c
index 245f5d2..1ca5380 100644
--- a/gedit/gedit-tab.c
+++ b/gedit/gedit-tab.c
@@ -1700,7 +1700,7 @@ _gedit_tab_new_from_stream (GInputStream        *stream,
  *
  * Gets the #GeditView inside @tab.
  *
- * Returns: the #GeditView inside @tab
+ * Returns: (transfer none): the #GeditView inside @tab
  */
 GeditView *
 gedit_tab_get_view (GeditTab *tab)
@@ -1714,7 +1714,7 @@ gedit_tab_get_view (GeditTab *tab)
  *
  * Gets the #GeditDocument associated to @tab.
  *
- * Returns: the #GeditDocument associated to @tab
+ * Returns: (transfer none): the #GeditDocument associated to @tab
  */
 GeditDocument *
 gedit_tab_get_document (GeditTab *tab)



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