[pango] Clean up docs a bit



commit c8212c485827cddd3c9a6a7c2a57e54d9254a10c
Author: Matthias Clasen <mclasen redhat com>
Date:   Sat Jul 13 20:02:57 2019 -0400

    Clean up docs a bit
    
    Avoid duplicate comments in struct defintions.

 pango/pango-break.h | 58 ++++++++++++-----------------------------------------
 pango/pango-glyph.h |  6 ------
 pango/pango-item.h  |  4 ++--
 3 files changed, 15 insertions(+), 53 deletions(-)
---
diff --git a/pango/pango-break.h b/pango/pango-break.h
index 92af390b..b035506e 100644
--- a/pango/pango-break.h
+++ b/pango/pango-break.h
@@ -71,7 +71,7 @@ G_BEGIN_DECLS
  * those following Latin, Cyrillic or Greek base characters.
  * @is_expandable_space: is a whitespace character that can possibly be
  * expanded for justification purposes. (Since: 1.18)
- * @is_word_boundary: is a word boundary.
+ * @is_word_boundary: is a word boundary, as defined by UAX#29.
  * More specifically, means that this is not a position in the middle
  * of a word.  For example, both sides of a punctuation mark are
  * considered word boundaries.  This flag is particularly useful when
@@ -85,51 +85,19 @@ G_BEGIN_DECLS
  */
 struct _PangoLogAttr
 {
-  guint is_line_break : 1;      /* Can break line in front of character */
-
-  guint is_mandatory_break : 1; /* Must break line in front of character */
-
-  guint is_char_break : 1;      /* Can break here when doing char wrap */
-
-  guint is_white : 1;           /* Whitespace character */
-
-  /* Cursor can appear in front of character (i.e. this is a grapheme
-   * boundary, or the first character in the text).
-   */
-  guint is_cursor_position : 1;
-
-  /* Note that in degenerate cases, you could have both start/end set on
-   * some text, most likely for sentences (e.g. no space after a period, so
-   * the next sentence starts right away).
-   */
-
-  guint is_word_start : 1;      /* first character in a word */
-  guint is_word_end   : 1;      /* is first non-word char after a word */
-
-  /* There are two ways to divide sentences. The first assigns all
-   * intersentence whitespace/control/format chars to some sentence,
-   * so all chars are in some sentence; is_sentence_boundary denotes
-   * the boundaries there. The second way doesn't assign
-   * between-sentence spaces, etc. to any sentence, so
-   * is_sentence_start/is_sentence_end mark the boundaries of those
-   * sentences.
-   */
-  guint is_sentence_boundary : 1;
-  guint is_sentence_start : 1;  /* first character in a sentence */
-  guint is_sentence_end : 1;    /* first non-sentence char after a sentence */
-
-  /* If set, backspace deletes one character rather than
-   * the entire grapheme cluster.
-   */
+  guint is_line_break               : 1;
+  guint is_mandatory_break          : 1;
+  guint is_char_break               : 1;
+  guint is_white                    : 1;
+  guint is_cursor_position          : 1;
+  guint is_word_start               : 1;
+  guint is_word_end                 : 1;
+  guint is_sentence_boundary        : 1;
+  guint is_sentence_start           : 1;
+  guint is_sentence_end             : 1;
   guint backspace_deletes_character : 1;
-
-  /* Only few space variants (U+0020 and U+00A0) have variable
-   * width during justification.
-   */
-  guint is_expandable_space : 1;
-
-  /* Word boundary as defined by UAX#29 */
-  guint is_word_boundary : 1;  /* is NOT in the middle of a word */
+  guint is_expandable_space         : 1;
+  guint is_word_boundary            : 1;
 };
 
 /* Determine information about cluster/word/line breaks in a string
diff --git a/pango/pango-glyph.h b/pango/pango-glyph.h
index f24812cf..917ec570 100644
--- a/pango/pango-glyph.h
+++ b/pango/pango-glyph.h
@@ -122,12 +122,6 @@ struct _PangoGlyphString {
   gint num_glyphs;
 
   PangoGlyphInfo *glyphs;
-
-  /* This is a memory inefficient way of representing the information
-   * here - each value gives the byte index within the text
-   * corresponding to the glyph string of the start of the cluster to
-   * which the glyph belongs.
-   */
   gint *log_clusters;
 
   /*< private >*/
diff --git a/pango/pango-item.h b/pango/pango-item.h
index 2d7e58a1..55be4c67 100644
--- a/pango/pango-item.h
+++ b/pango/pango-item.h
@@ -72,10 +72,10 @@ struct _PangoAnalysis
   PangoFont *font;
 
   guint8 level;
-  guint8 gravity; /* PangoGravity */
+  guint8 gravity;
   guint8 flags;
 
-  guint8 script; /* PangoScript */
+  guint8 script;
   PangoLanguage *language;
 
   GSList *extra_attrs;


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