[atk] docs: fix GTK-Doc comment blocks



commit 7ad2a9541940da37e2fee3e869f2c568a186f253
Author: Dieter Verfaillie <dieterv optionexplicit be>
Date:   Thu Mar 19 15:19:17 2015 +0100

    docs: fix GTK-Doc comment blocks
    
    Fixes a couple of warnings emitted by gtkdoc-mkdb
    and g-ir-scanner.

 atk/atkcomponent.c |   10 ++++------
 atk/atkcomponent.h |    5 ++---
 atk/atkdocument.c  |    3 +--
 atk/atkhyperlink.c |    9 +++------
 atk/atkimage.c     |    2 +-
 atk/atkobject.c    |    2 +-
 atk/atktext.c      |    8 +++-----
 atk/atkutil.c      |   21 ++++++++-------------
 8 files changed, 23 insertions(+), 37 deletions(-)
---
diff --git a/atk/atkcomponent.c b/atk/atkcomponent.c
index fc63c9d..fc7f34c 100755
--- a/atk/atkcomponent.c
+++ b/atk/atkcomponent.c
@@ -133,9 +133,8 @@ atk_component_base_init (AtkComponentIface *class)
  * when this object receives focus events (in or out). If the handler is
  * already added it is not added again
  *
- * Deprecated: This method is deprecated since ATK version 2.9.4. If
- * you need to track when an object gains or lose the focus, use
- * state-changed:focused notification instead.
+ * Deprecated: 2.9.4: If you need to track when an object gains or
+ * lose the focus, use state-changed:focused notification instead.
  *
  * Returns: a handler id which can be used in atk_component_remove_focus_handler()
  * or zero if the handler was already added.
@@ -165,9 +164,8 @@ atk_component_add_focus_handler (AtkComponent    *component,
  * functions to be executed when this object receives focus events 
  * (in or out).
  *
- * Deprecated: This method is deprecated since ATK version 2.9.4. If
- * you need to track when an object gains or lose the focus, use
- * state-changed:focused notification instead.
+ * Deprecated: 2.9.4: If you need to track when an object gains or
+ * lose the focus, use state-changed:focused notification instead.
  *
  **/
 void
diff --git a/atk/atkcomponent.h b/atk/atkcomponent.h
index 9a057ef..9cc85ee 100755
--- a/atk/atkcomponent.h
+++ b/atk/atkcomponent.h
@@ -56,9 +56,8 @@ typedef struct _AtkComponentIface  AtkComponentIface;
  * atk_component_add_focus_handler() and
  * atk_component_remove_focus_handler()
  *
- * Deprecated: This type is deprecated since ATK version 2.9.4. as
- * atk_component_add_focus_handler() and
- * atk_component_remove_focus_handler() are deprecated. See those
+ * Deprecated: 2.9.4: Deprecated with atk_component_add_focus_handler()
+ * and atk_component_remove_focus_handler(). See those
  * methods for more information.
  */
 typedef void (*AtkFocusHandler) (AtkObject* object, gboolean focus_in);
diff --git a/atk/atkdocument.c b/atk/atkdocument.c
index dc56eae..17614e6 100755
--- a/atk/atkdocument.c
+++ b/atk/atkdocument.c
@@ -234,8 +234,7 @@ atk_document_get_document (AtkDocument *document)
  *          a different locale, see atk_text_get_attributes and
  *          atk_image_get_image_locale.
  *
- * Deprecated: This method is deprecated since ATK version
- * 2.7.90. Please use atk_object_get_object_locale() instead.
+ * Deprecated: 2.7.90: Please use atk_object_get_object_locale() instead.
  *
  * Returns: a UTF-8 string indicating the POSIX-style LC_MESSAGES
  *          locale of the document content as a whole, or NULL if
diff --git a/atk/atkhyperlink.c b/atk/atkhyperlink.c
index e31f982..ae2e2e7 100755
--- a/atk/atkhyperlink.c
+++ b/atk/atkhyperlink.c
@@ -117,10 +117,8 @@ atk_hyperlink_class_init (AtkHyperlinkClass *klass)
    *
    * Selected link
    *
-   * Deprecated: Since 1.8. This property is deprecated since ATK
-   * version 1.8. Please use ATK_STATE_FOCUSABLE for all links, and
+   * Deprecated: 1.8: Please use ATK_STATE_FOCUSABLE for all links, and
    * ATK_STATE_FOCUSED for focused links.
-   *
    */
   g_object_class_install_property (gobject_class,
                                    PROP_SELECTED_LINK,
@@ -392,9 +390,8 @@ atk_hyperlink_get_n_anchors (AtkHyperlink *link)
  *
  * Since: 1.4
  *
- * Deprecated: This method is deprecated since ATK version 1.8.
- * Please use ATK_STATE_FOCUSABLE for all links, and ATK_STATE_FOCUSED
- * for focused links.
+ * Deprecated: 1.8: Please use ATK_STATE_FOCUSABLE for all links,
+ * and ATK_STATE_FOCUSED for focused links.
  *
  * Returns: True if the AtkHyperlink is selected, False otherwise
  **/
diff --git a/atk/atkimage.c b/atk/atkimage.c
index 9d8a58f..2ba5909 100755
--- a/atk/atkimage.c
+++ b/atk/atkimage.c
@@ -210,7 +210,7 @@ atk_image_get_image_position (AtkImage *image,
  * atk_image_get_image_locale: 
  * @image: An #AtkImage
  *
- * Since ATK 1.12
+ * Since: 1.12
  *
  * Returns: (nullable): a string corresponding to the POSIX
  * LC_MESSAGES locale used by the image description, or %NULL if the
diff --git a/atk/atkobject.c b/atk/atkobject.c
index 3358ea5..e9c5310 100755
--- a/atk/atkobject.c
+++ b/atk/atkobject.c
@@ -568,7 +568,7 @@ atk_object_class_init (AtkObjectClass *klass)
    * The signal "focus-event" is emitted when an object gained or lost
    * focus.
    *
-   * Deprecated: Since 2.9.4. Use #AtkObject::state-change signal instead.
+   * Deprecated: 2.9.4: Use #AtkObject::state-change signal instead.
    */
   atk_object_signals[FOCUS_EVENT] =
     g_signal_new ("focus_event",
diff --git a/atk/atktext.c b/atk/atktext.c
index e4d421d..f18e8cb 100755
--- a/atk/atktext.c
+++ b/atk/atktext.c
@@ -201,7 +201,7 @@ atk_text_base_init (AtkTextIface *class)
        * "delete" which identifies whether the text change was an
        * insertion or a deletion.
        *
-       * Deprecated: Since 2.9.4. Use #AtkObject::text-insert or
+       * Deprecated: 2.9.4: Use #AtkObject::text-insert or
        * #AtkObject::text-remove instead.
        */
       atk_text_signals[TEXT_CHANGED] =
@@ -382,8 +382,7 @@ atk_text_get_character_at_offset (AtkText      *text,
  *
  * Gets the specified text.
  *
- * Deprecated: This method is deprecated since ATK version
- * 2.9.3. Please use atk_text_get_string_at_offset() instead.
+ * Deprecated: 2.9.3: Please use atk_text_get_string_at_offset() instead.
  *
  * Returns: a newly allocated string containing the text after @offset bounded
  *   by the specified @boundary_type. Use g_free() to free the returned string.
@@ -502,8 +501,7 @@ atk_text_get_text_at_offset (AtkText          *text,
  *
  * Gets the specified text.
  *
- * Deprecated: This method is deprecated since ATK version
- * 2.9.3. Please use atk_text_get_string_at_offset() instead.
+ * Deprecated: 2.9.3: Please use atk_text_get_string_at_offset() instead.
  *
  * Returns: a newly allocated string containing the text before @offset bounded
  *   by the specified @boundary_type. Use g_free() to free the returned string.
diff --git a/atk/atkutil.c b/atk/atkutil.c
index f57e2fa..2869b25 100755
--- a/atk/atkutil.c
+++ b/atk/atkutil.c
@@ -100,9 +100,8 @@ struct _FocusTracker {
  * ATK interface if any specific work needs to be done to enable
  * focus tracking.
  *
- * Deprecated: This method is deprecated since ATK version
- * 2.9.4. Focus tracking has been dropped as a feature to be
- * implemented by ATK itself.
+ * Deprecated: 2.9.4: Focus tracking has been dropped as a feature
+ * to be implemented by ATK itself.
  *
  **/
 void
@@ -120,9 +119,8 @@ atk_focus_tracker_init (AtkEventListenerInit    init)
  * Adds the specified function to the list of functions to be called
  * when an object receives focus.
  *
- * Deprecated: This method is deprecated since ATK version
- * 2.9.4. Focus tracking has been dropped as a feature to be
- * implemented by ATK itself. If you need focus tracking on your
+ * Deprecated: 2.9.4: Focus tracking has been dropped as a feature
+ * to be implemented by ATK itself. If you need focus tracking on your
  * implementation, subscribe to the state-changed:focused signal.
  *
  * Returns: added focus tracker id, or 0 on failure.
@@ -160,9 +158,8 @@ atk_add_focus_tracker (AtkEventListener   focus_tracker)
  * atk_remove_focus_tracker:
  * @tracker_id: the id of the focus tracker to remove
  *
- * Deprecated: This method is deprecated since ATK version
- * 2.9.4. Focus tracking has been dropped as a feature to be
- * implemented by ATK itself. If you need focus tracking on your
+ * Deprecated: 2.9.4: Focus tracking has been dropped as a feature
+ * to be implemented by ATK itself. If you need focus tracking on your
  * implementation, subscribe to the state-changed:focused signal.
  *
  * Removes the specified focus tracker from the list of functions
@@ -198,13 +195,11 @@ atk_remove_focus_tracker (guint            tracker_id)
  * Cause the focus tracker functions which have been specified to be
  * executed for the object.
  *
- * Deprecated: This method is deprecated since ATK version
- * 2.9.4. Focus tracking has been dropped as a feature to be
- * implemented by ATK itself. As #AtkObject::focus-event was
+ * Deprecated: 2.9.4: Focus tracking has been dropped as a feature
+ * to be implemented by ATK itself. As #AtkObject::focus-event was
  * deprecated in favor of a #AtkObject::state-change signal, in order
  * to notify a focus change on your implementation, you can use
  * atk_object_notify_state_change() instead.
- *
  **/
 void
 atk_focus_tracker_notify (AtkObject       *object)


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