summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Clasen <maclas@gmx.de>2003-06-25 19:14:24 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2003-06-25 19:14:24 +0000
commit32f67b6e306da21dc6aab4a8eaa096e73971a938 (patch)
tree9f2575033cd57b2a92ae07169ecb90c89a4f8776
parent5720851fb829053f3f76a36926792fa8145d628d (diff)
downloadpango-32f67b6e306da21dc6aab4a8eaa096e73971a938.tar.gz
Doc markup and typo fixes.
2003-06-25 Matthias Clasen <maclas@gmx.de> * pango/pango-layout.c: * pango/pango-tabs.c: * pango/pango-attributes.c: * docs/tmpl/layout.sgml: * docs/tmpl/text-attributes.sgml: Doc markup and typo fixes.
-rw-r--r--ChangeLog9
-rw-r--r--ChangeLog.pre-1-109
-rw-r--r--ChangeLog.pre-1-49
-rw-r--r--ChangeLog.pre-1-69
-rw-r--r--ChangeLog.pre-1-89
-rw-r--r--docs/tmpl/layout.sgml7
-rw-r--r--docs/tmpl/text-attributes.sgml2
-rw-r--r--pango/pango-attributes.c8
-rw-r--r--pango/pango-layout.c84
-rw-r--r--pango/pango-tabs.c6
10 files changed, 99 insertions, 53 deletions
diff --git a/ChangeLog b/ChangeLog
index de5d2724..3b14ecdc 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2003-06-25 Matthias Clasen <maclas@gmx.de>
+
+
+ * pango/pango-layout.c:
+ * pango/pango-tabs.c:
+ * pango/pango-attributes.c:
+ * docs/tmpl/layout.sgml:
+ * docs/tmpl/text-attributes.sgml: Doc markup and typo fixes.
+
2003-06-17 Matthias Clasen <maclas@gmx.de>
* docs/Makefile.am: Add rule to regenerate man pages from
diff --git a/ChangeLog.pre-1-10 b/ChangeLog.pre-1-10
index de5d2724..3b14ecdc 100644
--- a/ChangeLog.pre-1-10
+++ b/ChangeLog.pre-1-10
@@ -1,3 +1,12 @@
+2003-06-25 Matthias Clasen <maclas@gmx.de>
+
+
+ * pango/pango-layout.c:
+ * pango/pango-tabs.c:
+ * pango/pango-attributes.c:
+ * docs/tmpl/layout.sgml:
+ * docs/tmpl/text-attributes.sgml: Doc markup and typo fixes.
+
2003-06-17 Matthias Clasen <maclas@gmx.de>
* docs/Makefile.am: Add rule to regenerate man pages from
diff --git a/ChangeLog.pre-1-4 b/ChangeLog.pre-1-4
index de5d2724..3b14ecdc 100644
--- a/ChangeLog.pre-1-4
+++ b/ChangeLog.pre-1-4
@@ -1,3 +1,12 @@
+2003-06-25 Matthias Clasen <maclas@gmx.de>
+
+
+ * pango/pango-layout.c:
+ * pango/pango-tabs.c:
+ * pango/pango-attributes.c:
+ * docs/tmpl/layout.sgml:
+ * docs/tmpl/text-attributes.sgml: Doc markup and typo fixes.
+
2003-06-17 Matthias Clasen <maclas@gmx.de>
* docs/Makefile.am: Add rule to regenerate man pages from
diff --git a/ChangeLog.pre-1-6 b/ChangeLog.pre-1-6
index de5d2724..3b14ecdc 100644
--- a/ChangeLog.pre-1-6
+++ b/ChangeLog.pre-1-6
@@ -1,3 +1,12 @@
+2003-06-25 Matthias Clasen <maclas@gmx.de>
+
+
+ * pango/pango-layout.c:
+ * pango/pango-tabs.c:
+ * pango/pango-attributes.c:
+ * docs/tmpl/layout.sgml:
+ * docs/tmpl/text-attributes.sgml: Doc markup and typo fixes.
+
2003-06-17 Matthias Clasen <maclas@gmx.de>
* docs/Makefile.am: Add rule to regenerate man pages from
diff --git a/ChangeLog.pre-1-8 b/ChangeLog.pre-1-8
index de5d2724..3b14ecdc 100644
--- a/ChangeLog.pre-1-8
+++ b/ChangeLog.pre-1-8
@@ -1,3 +1,12 @@
+2003-06-25 Matthias Clasen <maclas@gmx.de>
+
+
+ * pango/pango-layout.c:
+ * pango/pango-tabs.c:
+ * pango/pango-attributes.c:
+ * docs/tmpl/layout.sgml:
+ * docs/tmpl/text-attributes.sgml: Doc markup and typo fixes.
+
2003-06-17 Matthias Clasen <maclas@gmx.de>
* docs/Makefile.am: Add rule to regenerate man pages from
diff --git a/docs/tmpl/layout.sgml b/docs/tmpl/layout.sgml
index 9202d7db..b12e8085 100644
--- a/docs/tmpl/layout.sgml
+++ b/docs/tmpl/layout.sgml
@@ -200,12 +200,13 @@ has no user-visible fields.
<!-- ##### ENUM PangoWrapMode ##### -->
<para>
-describes how to wrap the lines of a #PangoLayout to the desired width.
+A PangoWrapMode describes how to wrap the lines of a #PangoLayout to the desired width.
</para>
@PANGO_WRAP_WORD: wrap lines at word boundaries.
@PANGO_WRAP_CHAR: wrap lines at character boundaries.
-@PANGO_WRAP_WORD_CHAR: wrap lines at word boundaries, but fall back to character boundaries if there is not enought space for a full word.
+@PANGO_WRAP_WORD_CHAR: wrap lines at word boundaries, but fall back to character boundaries if there is not
+enough space for a full word.
<!-- ##### MACRO PANGO_TYPE_WRAP_MODE ##### -->
<para>
@@ -324,7 +325,7 @@ The GObject type for #PangoWrapMode.
<!-- ##### ENUM PangoAlignment ##### -->
<para>
-describes how to align the lines of a #PangoLayout within the
+A PangoAlignment describes how to align the lines of a #PangoLayout within the
available space. If the #PangoLayout is set to justify
using pango_layout_set_justify(), then this only has an effect
for partial lines.
diff --git a/docs/tmpl/text-attributes.sgml b/docs/tmpl/text-attributes.sgml
index c908e7fd..ce2c5f64 100644
--- a/docs/tmpl/text-attributes.sgml
+++ b/docs/tmpl/text-attributes.sgml
@@ -22,7 +22,7 @@ of attributes applied to a portion of text.
<para>
distinguishes between different types of attributes. Along with the
predefined values, it is possible to allocate additional values
-for custom attributes using pango_attr_register_type(). The predefined
+for custom attributes using pango_attr_type_register(). The predefined
values are given below. The type of structure used to store the
attribute is listed in parentheses after the description.
</para>
diff --git a/pango/pango-attributes.c b/pango/pango-attributes.c
index b3a07722..275de0ac 100644
--- a/pango/pango-attributes.c
+++ b/pango/pango-attributes.c
@@ -1368,7 +1368,7 @@ pango_attr_iterator_get (PangoAttrIterator *iterator,
* pango_font_description_set_family_static using values from
* an attribute in the #PangoAttrList associated with the iterator,
* so if you plan to keep it around, you must call:
- * pango_font_description_set_family (desc, pango_font_description_get_family (desc)).
+ * <literal>pango_font_description_set_family (desc, pango_font_description_get_family (desc))</literal>.
* @language: if non-%NULL, location to store language tag for item, or %NULL
* if non is found.
* @extra_attrs: if non-%NULL, location in which to store a list of non-font
@@ -1509,11 +1509,11 @@ pango_attr_iterator_get_font (PangoAttrIterator *iterator,
* should be filtered out.
* @data: Data to be passed to @func
*
- * Given a PangoAttrList and callback function, removes any elements
+ * Given a #PangoAttrList and callback function, removes any elements
* of @list for which @func returns %TRUE and inserts them into
* a new list.
*
- * Return value: a newly allocated %PangoAttrList or %NULL if
+ * Return value: a newly allocated #PangoAttrList or %NULL if
* no attributes of the given types were found.
**/
PangoAttrList *
@@ -1580,7 +1580,7 @@ pango_attr_list_filter (PangoAttrList *list,
* iterator.
*
* Return value: a list of all attributes for the current range.
- * To free this value, call pango_attributes_destroy() on
+ * To free this value, call pango_attribute_destroy() on
* each value and g_slist_free() on the list.
**/
GSList *
diff --git a/pango/pango-layout.c b/pango/pango-layout.c
index 403faa67..63e96c49 100644
--- a/pango/pango-layout.c
+++ b/pango/pango-layout.c
@@ -374,9 +374,9 @@ pango_layout_get_width (PangoLayout *layout)
/**
* pango_layout_set_wrap:
* @layout: a #PangoLayout
- * @wrap: wrap mode
+ * @wrap: the wrap mode
*
- * Sets the wrap style; the wrap style only has an effect if a width
+ * Sets the wrap mode; the wrap mode only has an effect if a width
* is set on the layout with pango_layout_set_width(). To turn off wrapping,
* set the width to -1.
**/
@@ -397,7 +397,7 @@ pango_layout_set_wrap (PangoLayout *layout,
* pango_layout_get_wrap:
* @layout: a #PangoLayout
*
- * Get the wrap mode for the layout.
+ * Gets the wrap mode for the layout.
*
* Return value: Active wrap mode.
**/
@@ -412,13 +412,13 @@ pango_layout_get_wrap (PangoLayout *layout)
/**
* pango_layout_set_indent
* @layout: a #PangoLayout.
- * @indent: the amount by which to indent
+ * @indent: the amount by which to indentset
*
* Sets the amount by which the first line should be shorter than the
* rest of the lines. This may be negative, in which case
* the subsequent lines will be shorter than the first line. (However,
* in either case, the entire width of the layout will be given by
- * the value
+ * the value.)
**/
void
pango_layout_set_indent (PangoLayout *layout,
@@ -489,7 +489,7 @@ pango_layout_get_spacing (PangoLayout *layout)
* @layout: a #PangoLayout
* @attrs: a #PangoAttrList
*
- * Sets the text attributes for a layout object
+ * Sets the text attributes for a layout object.
**/
void
pango_layout_set_attributes (PangoLayout *layout,
@@ -514,7 +514,7 @@ pango_layout_set_attributes (PangoLayout *layout,
* pango_layout_get_attributes:
* @layout: a #PangoLayout
*
- * Gets the attribute list for the layout, if any
+ * Gets the attribute list for the layout, if any.
*
* Return value: a #PangoAttrList
**/
@@ -529,10 +529,10 @@ pango_layout_get_attributes (PangoLayout *layout)
/**
* pango_layout_set_font_description:
* @layout: a #PangoLayout
- * @desc: the new pango font description, or %NULL to unset the
+ * @desc: the new #PangoFontDescription, or %NULL to unset the
* current font description.
*
- * Set the default font description for the layout. If no font
+ * Sets the default font description for the layout. If no font
* description is set on the layout, the font description from
* the layout's context is used.
**/
@@ -650,7 +650,7 @@ pango_layout_set_tabs (PangoLayout *layout,
* pango_layout_get_tabs:
* @layout: a #PangoLayout
*
- * Get the current #PangoTabArray used by this layout. If no
+ * Gets the current #PangoTabArray used by this layout. If no
* #PangoTabArray has been set, then the default tabs are in use
* and %NULL is returned. Default tabs are every 8 spaces.
* The return value should be freed with pango_tab_array_free().
@@ -712,10 +712,10 @@ pango_layout_get_single_paragraph_mode (PangoLayout *layout)
* @layout: a #PangoLayout
* @text: a UTF8-string
* @length: the length of @text, in bytes. -1 indicates that
- * the string is null terminated and the length should be
+ * the string is nul-terminated and the length should be
* calculated.
*
- * Set the text of the layout.
+ * Sets the text of the layout.
**/
void
pango_layout_set_text (PangoLayout *layout,
@@ -866,7 +866,7 @@ pango_layout_context_changed (PangoLayout *layout)
* array. (The stored value will be equal to the total number
* of characters in the layout.)
*
- * Retrieve an array of logical attributes for each character in
+ * Retrieves an array of logical attributes for each character in
* the @layout.
**/
void
@@ -893,7 +893,7 @@ pango_layout_get_log_attrs (PangoLayout *layout,
* pango_layout_get_line_count:
* @layout: #PangoLayout
*
- * Retrieve the count of lines for the @layout.
+ * Retrieves the count of lines for the @layout.
*
* Return value: the line count
**/
@@ -910,7 +910,7 @@ pango_layout_get_line_count (PangoLayout *layout)
* pango_layout_get_lines:
* @layout: a #PangoLayout
*
- * Return the lines of the @layout as a list.
+ * Returns the lines of the @layout as a list.
*
* Return value: a #GSList containing the lines in the layout. This
* points to internal data of the #PangoLayout and must be used with
@@ -928,7 +928,7 @@ pango_layout_get_lines (PangoLayout *layout)
* pango_layout_get_line:
* @layout: a #PangoLayout
* @line: the index of a line, which must be between 0 and
- * pango_layout_get_line_count(layout) - 1, inclusive.
+ * <literal>pango_layout_get_line_count(layout) - 1</literal>, inclusive.
*
* Retrieves a particular line from a #PangoLayout.
*
@@ -1365,7 +1365,7 @@ pango_layout_move_cursor_visually (PangoLayout *layout,
* be zero, or the number of characters in the
* grapheme. 0 represents the trailing edge of the grapheme.
*
- * Convert from X and Y position within a layout to the byte
+ * Converts from X and Y position within a layout to the byte
* index to the character at that logical position. If the
* position is not inside the layout, the closest position is chosen
* (the x/y position will be clamped inside the layout).
@@ -1463,12 +1463,12 @@ pango_layout_xy_to_index (PangoLayout *layout,
* @index_: byte index within @layout
* @pos: rectangle in which to store the position of the grapheme
*
- * Convert from an index within a PangoLayout to the onscreen position
+ * Converts from an index within a #PangoLayout to the onscreen position
* corresponding to the grapheme at that index, which is represented
- * as rectangle. Note that pos->x is always the leading edge of the
- * grapheme and pos->x + pos->width the trailing edge of the
- * grapheme. If the directionality of the grapheme is right-to-left,
- * then pos->width will be negative.
+ * as rectangle. Note that <literal>pos->x</literal> is always the leading
+ * edge of the grapheme and <literal>pos->x + pos->width</literal> the trailing
+ * edge of the grapheme. If the directionality of the grapheme is right-to-left,
+ * then <literal>pos->width</literal> will be negative.
**/
void
pango_layout_index_to_pos (PangoLayout *layout,
@@ -1689,7 +1689,7 @@ pango_layout_line_get_char_direction (PangoLayoutLine *layout_line,
* @strong_pos: location to store the strong cursor position (may be %NULL)
* @weak_pos: location to store the weak cursor position (may be %NULL)
*
- * Given an index within a layout, determine the positions that of the
+ * Given an index within a layout, determines the positions that of the
* strong and weak cursors if the insertion point is at that
* index. The position of each cursor is stored as a zero-width
* rectangle. The strong cursor location is the location where
@@ -1997,7 +1997,7 @@ pango_layout_get_extents_internal (PangoLayout *layout,
* @logical_rect: rectangle used to store the logical extents of the layout
or %NULL to indicate that the result is not needed.
*
- * Compute the logical and ink extents of @layout. Logical extents
+ * Computes the logical and ink extents of @layout. Logical extents
* are usually what you want for positioning things. The extents
* are given in layout coordinates; layout coordinates begin at the
* top left corner of the layout.
@@ -2020,10 +2020,10 @@ pango_layout_get_extents (PangoLayout *layout,
* @logical_rect: rectangle used to store the logical extents of the
* layout or %NULL to indicate that the result is not needed.
*
- * Compute the logical and ink extents of @layout in device units.
+ * Computes the logical and ink extents of @layout in device units.
* See pango_layout_get_extents(); this function just calls
* pango_layout_get_extents() and then converts the extents to
- * device units using the #PANGO_SCALE factor.
+ * device units using the %PANGO_SCALE factor.
**/
void
pango_layout_get_pixel_extents (PangoLayout *layout,
@@ -2059,9 +2059,9 @@ pango_layout_get_pixel_extents (PangoLayout *layout,
* @width: location to store the logical width, or %NULL
* @height: location to store the logical height, or %NULL
*
- * Determine the logical width and height of a #PangoLayout
- * in Pango units. (device units divided by PANGO_SCALE). This
- * is simply a convenience function around pango_layout_get_extents.
+ * Determines the logical width and height of a #PangoLayout
+ * in Pango units. (device units divided by %PANGO_SCALE). This
+ * is simply a convenience function around pango_layout_get_extents().
**/
void
pango_layout_get_size (PangoLayout *layout,
@@ -2084,10 +2084,10 @@ pango_layout_get_size (PangoLayout *layout,
* @width: location to store the logical width, or %NULL
* @height: location to store the logical height, or %NULL
*
- * Determine the logical width and height of a #PangoLayout
+ * Determines the logical width and height of a #PangoLayout
* in device units. (pango_layout_get_size() returns the width
* and height in thousandths of a device unit.) This
- * is simply a convenience function around pango_layout_get_extents.
+ * is simply a convenience function around pango_layout_get_extents().
**/
void
pango_layout_get_pixel_size (PangoLayout *layout,
@@ -3043,7 +3043,7 @@ pango_layout_check_lines (PangoLayout *layout)
* pango_layout_line_ref:
* @line: a #PangoLayoutLine
*
- * Increase the reference count of a #PangoLayoutLine by one.
+ * Increases the reference count of a #PangoLayoutLine by one.
**/
void
pango_layout_line_ref (PangoLayoutLine *line)
@@ -3059,7 +3059,7 @@ pango_layout_line_ref (PangoLayoutLine *line)
* pango_layout_line_unref:
* @line: a #PangoLayoutLine
*
- * Decrease the reference count of a #PangoLayoutLine by one.
+ * Decreases the reference count of a #PangoLayoutLine by one.
* if the result is zero, the line and all associated memory
* will be freed.
**/
@@ -3098,7 +3098,7 @@ pango_layout_line_unref (PangoLayoutLine *line)
* be zero, or the number of characters in the
* grapheme. 0 represents the trailing edge of the cluster.
*
- * Convert from x offset to the byte index of the corresponding
+ * Converts from x offset to the byte index of the corresponding
* character within the text of the layout. If @x_pos is outside the line,
* the start or end of the line will be stored at @index_.
*
@@ -3316,14 +3316,14 @@ pango_layout_line_x_to_index (PangoLayoutLine *line,
* edge of the layout. Otherwise, it will end at the
* trailing edge of the last character.
* @ranges: location to store a pointer to an array of ranges.
- * The array will be of length 2*@n_ranges, with each
- * range starting at (*ranges)[2*n] and of width
- * (*ranges)[2*n + 1] - (*ranges)[2*n]. This array must be
- * freed with g_free. The coordinates are relative to the
- * layout and are in #PangoGlyphUnit.
+ * The array will be of length <literal>2*n_ranges</literal>,
+ * with each range starting at <literal>(*ranges)[2*n]</literal>
+ * and of width <literal>(*ranges)[2*n + 1] - (*ranges)[2*n]</literal>.
+ * This array must be freed with g_free(). The coordinates are relative
+ * to the layout and are in #PangoGlyphUnit.
* @n_ranges: The number of ranges stored in @ranges.
*
- * Get a list of visual ranges corresponding to a given logical range.
+ * Gets a list of visual ranges corresponding to a given logical range.
* This list is not necessarily minimal - there may be consecutive
* ranges which are adjacent. The ranges will be sorted from left to
* right. The ranges are with respect to the left edge of the entire
@@ -3621,7 +3621,7 @@ pango_layout_run_get_extents (PangoLayoutRun *run,
* @logical_rect: rectangle used to store the logical extents of the glyph string
* or %NULL to indicate that the result is not needed.
*
- * Compute the logical and ink extents of a layout line. See the documentation
+ * Computes the logical and ink extents of a layout line. See the documentation
* for pango_font_get_glyph_extents() for details about the interpretation
* of the rectangles.
*/
@@ -3727,7 +3727,7 @@ pango_layout_line_new (PangoLayout *layout)
* @logical_rect: rectangle used to store the logical extents of the glyph string
* or %NULL to indicate that the result is not needed.
*
- * Compute the logical and ink extents of a layout line. See the documentation
+ * Computes the logical and ink extents of a layout line. See the documentation
* for pango_font_get_glyph_extents() for details about the interpretation
* of the rectangles. The returned rectangles are in device units, as
* opposed to pango_layout_line_get_extents(), which returns the extents in
diff --git a/pango/pango-tabs.c b/pango/pango-tabs.c
index 7917a58b..7aafb22a 100644
--- a/pango/pango-tabs.c
+++ b/pango/pango-tabs.c
@@ -168,7 +168,7 @@ pango_tab_array_get_type (void)
* pango_tab_array_copy:
* @src: #PangoTabArray to copy
*
- * Copy a #PangoTabArray
+ * Copies a #PangoTabArray
*
* Return value: Newly-allocated #PangoTabArray
**/
@@ -190,7 +190,7 @@ pango_tab_array_copy (PangoTabArray *src)
* pango_tab_array_free:
* @tab_array: a #PangoTabArray
*
- * Free a tab array and associated resources.
+ * Frees a tab array and associated resources.
*
**/
void
@@ -207,7 +207,7 @@ pango_tab_array_free (PangoTabArray *tab_array)
* pango_tab_array_get_size:
* @tab_array: a #PangoTabArray
*
- * Get the number of tab stops in @tab_array.
+ * Gets the number of tab stops in @tab_array.
*
* Return value: the number of tab stops in the array.
**/