text: Deprecate _END boundaries
authorAlejandro Piñeiro <apinheiro@igalia.com>
Mon, 17 Jun 2013 14:31:36 +0000 (16:31 +0200)
committerAlejandro Piñeiro <apinheiro@igalia.com>
Mon, 17 Jun 2013 17:47:13 +0000 (19:47 +0200)
Right now there isn't any formal way to deprecate only some specific
elements of an enum. So this is just documented.

You can deprecate all the enum using ATK_DISABLE_DEPRECATED like in
other projects, but if you try to do the same for some specific
elements, you will find problems when you compile the glib-mkenum
generated enum types (unless you want to break the ABI).

https://bugzilla.gnome.org/show_bug.cgi?id=697968

atk/atktext.h

index 24a5526..142d9e9 100755 (executable)
@@ -111,21 +111,32 @@ typedef struct _AtkText AtkText;
 #endif
 typedef struct _AtkTextIface AtkTextIface;
 
+
 /**
  *AtkTextBoundary:
- *@ATK_TEXT_BOUNDARY_CHAR: Boundary is the boundary between characters 
+ *@ATK_TEXT_BOUNDARY_CHAR: Boundary is the boundary between characters
  * (including non-printing characters)
- *@ATK_TEXT_BOUNDARY_WORD_START: Boundary is the start (i.e. first character) of a word. 
- *@ATK_TEXT_BOUNDARY_WORD_END: Boundary is the end (i.e. last character) of a word.
+ *@ATK_TEXT_BOUNDARY_WORD_START: Boundary is the start (i.e. first character) of a word.
+ *@ATK_TEXT_BOUNDARY_WORD_END: Boundary is the end (i.e. last
+ * character) of a word. This boundary is deprecated, and should not be
+ * used.
  *@ATK_TEXT_BOUNDARY_SENTENCE_START: Boundary is the first character in a sentence.
- *@ATK_TEXT_BOUNDARY_SENTENCE_END: Boundary is the last (terminal) character in a sentence; 
- * in languages which use "sentence stop" punctuation such as English, the boundary is thus the
- * '.', '?', or similar terminal punctuation character.
- *@ATK_TEXT_BOUNDARY_LINE_START: Boundary is the initial character of the content or a 
+ *@ATK_TEXT_BOUNDARY_SENTENCE_END: Boundary is the last (terminal)
+ * character in a sentence; in languages which use "sentence stop"
+ * punctuation such as English, the boundary is thus the '.', '?', or
+ * similar terminal punctuation character. This boundary is
+ * deprecated, and should not be used.
+ *@ATK_TEXT_BOUNDARY_LINE_START: Boundary is the initial character of the content or a
  * character immediately following a newline, linefeed, or return character.
- *@ATK_TEXT_BOUNDARY_LINE_END: Boundary is the linefeed, or return character.
+ *@ATK_TEXT_BOUNDARY_LINE_END: Boundary is the linefeed, or return
+ * character. This boundary is deprecated, and should not be used.
+ *
+ * Text boundary types used for specifying boundaries for regions of
+ * text. Note that some boundaries are deprecated since 2.9.3., not
+ * marked explicitly due to the lack of a formal method to mark as
+ * deprecated some elements from a enum.
+ *
  *
- *Text boundary types used for specifying boundaries for regions of text
  **/
 typedef enum {
   ATK_TEXT_BOUNDARY_CHAR,