doc fixes

svn path=/trunk/; revision=21987
This commit is contained in:
Matthias Clasen
2008-12-29 06:08:19 +00:00
parent 3f6e3478b7
commit 0c46603ad4
2 changed files with 20 additions and 16 deletions

View File

@ -1,3 +1,7 @@
2008-12-28 Matthias Clasen <mclasen@redhat.com>
* gtk/gtktextlayout.c: Un-doc-commentize non-public api
2008-12-28 Matthias Clasen <mclasen@redhat.com> 2008-12-28 Matthias Clasen <mclasen@redhat.com>
* gtk/gtkprogress.h: Fix a typo * gtk/gtkprogress.h: Fix a typo

View File

@ -404,7 +404,7 @@ gtk_text_layout_set_contexts (GtkTextLayout *layout,
* @overwrite: overwrite mode * @overwrite: overwrite mode
* *
* Sets overwrite mode * Sets overwrite mode
**/ */
void void
gtk_text_layout_set_overwrite_mode (GtkTextLayout *layout, gtk_text_layout_set_overwrite_mode (GtkTextLayout *layout,
gboolean overwrite) gboolean overwrite)
@ -429,7 +429,7 @@ gtk_text_layout_set_overwrite_mode (GtkTextLayout *layout,
* point at which new text is inserted depends on whether the new * point at which new text is inserted depends on whether the new
* text is right-to-left or left-to-right, so it may be desired to * text is right-to-left or left-to-right, so it may be desired to
* make the drawn position of the cursor depend on the keyboard state. * make the drawn position of the cursor depend on the keyboard state.
**/ */
void void
gtk_text_layout_set_cursor_direction (GtkTextLayout *layout, gtk_text_layout_set_cursor_direction (GtkTextLayout *layout,
GtkTextDirection direction) GtkTextDirection direction)
@ -448,7 +448,7 @@ gtk_text_layout_set_cursor_direction (GtkTextLayout *layout,
* Sets the keyboard direction; this is used as for the bidirectional * Sets the keyboard direction; this is used as for the bidirectional
* base direction for the line with the cursor if the line contains * base direction for the line with the cursor if the line contains
* only neutral characters. * only neutral characters.
**/ */
void void
gtk_text_layout_set_keyboard_direction (GtkTextLayout *layout, gtk_text_layout_set_keyboard_direction (GtkTextLayout *layout,
GtkTextDirection keyboard_dir) GtkTextDirection keyboard_dir)
@ -468,7 +468,7 @@ gtk_text_layout_set_keyboard_direction (GtkTextLayout *layout,
* gtk_text_layout_set_buffer(). * gtk_text_layout_set_buffer().
* *
* Return value: the text buffer used by the layout. * Return value: the text buffer used by the layout.
**/ */
GtkTextBuffer * GtkTextBuffer *
gtk_text_layout_get_buffer (GtkTextLayout *layout) gtk_text_layout_get_buffer (GtkTextLayout *layout)
{ {
@ -502,7 +502,7 @@ gtk_text_layout_set_screen_width (GtkTextLayout *layout, gint width)
* Sets whether the insertion cursor should be shown. Generally, * Sets whether the insertion cursor should be shown. Generally,
* widgets using #GtkTextLayout will hide the cursor when the * widgets using #GtkTextLayout will hide the cursor when the
* widget does not have the input focus. * widget does not have the input focus.
**/ */
void void
gtk_text_layout_set_cursor_visible (GtkTextLayout *layout, gtk_text_layout_set_cursor_visible (GtkTextLayout *layout,
gboolean cursor_visible) gboolean cursor_visible)
@ -535,8 +535,8 @@ gtk_text_layout_set_cursor_visible (GtkTextLayout *layout,
* Returns whether the insertion cursor will be shown. * Returns whether the insertion cursor will be shown.
* *
* Return value: if %FALSE, the insertion cursor will not be * Return value: if %FALSE, the insertion cursor will not be
shown, even if the text is editable. * shown, even if the text is editable.
**/ */
gboolean gboolean
gtk_text_layout_get_cursor_visible (GtkTextLayout *layout) gtk_text_layout_get_cursor_visible (GtkTextLayout *layout)
{ {
@ -553,7 +553,7 @@ gtk_text_layout_get_cursor_visible (GtkTextLayout *layout)
* Set the preedit string and attributes. The preedit string is a * Set the preedit string and attributes. The preedit string is a
* string showing text that is currently being edited and not * string showing text that is currently being edited and not
* yet committed into the buffer. * yet committed into the buffer.
**/ */
void void
gtk_text_layout_set_preedit_string (GtkTextLayout *layout, gtk_text_layout_set_preedit_string (GtkTextLayout *layout,
const gchar *preedit_string, const gchar *preedit_string,
@ -958,7 +958,7 @@ gtk_text_layout_real_free_line_data (GtkTextLayout *layout,
* Check if there are any invalid regions in a #GtkTextLayout's buffer * Check if there are any invalid regions in a #GtkTextLayout's buffer
* *
* Return value: %TRUE if any invalid regions were found * Return value: %TRUE if any invalid regions were found
**/ */
gboolean gboolean
gtk_text_layout_is_valid (GtkTextLayout *layout) gtk_text_layout_is_valid (GtkTextLayout *layout)
{ {
@ -990,7 +990,7 @@ update_layout_size (GtkTextLayout *layout)
* *
* Ensure that a region of a #GtkTextLayout is valid. The ::changed * Ensure that a region of a #GtkTextLayout is valid. The ::changed
* signal will be emitted if any lines are validated. * signal will be emitted if any lines are validated.
**/ */
void void
gtk_text_layout_validate_yrange (GtkTextLayout *layout, gtk_text_layout_validate_yrange (GtkTextLayout *layout,
GtkTextIter *anchor, GtkTextIter *anchor,
@ -1429,7 +1429,7 @@ gtk_text_attr_appearance_compare (const PangoAttribute *attr1,
appearance1->draw_bg == appearance2->draw_bg); appearance1->draw_bg == appearance2->draw_bg);
} }
/** /*
* gtk_text_attr_appearance_new: * gtk_text_attr_appearance_new:
* @desc: * @desc:
* *
@ -1438,7 +1438,7 @@ gtk_text_attr_appearance_compare (const PangoAttribute *attr1,
* and size simultaneously.) * and size simultaneously.)
* *
* Return value: * Return value:
**/ */
static PangoAttribute * static PangoAttribute *
gtk_text_attr_appearance_new (const GtkTextAppearance *appearance) gtk_text_attr_appearance_new (const GtkTextAppearance *appearance)
{ {
@ -1650,7 +1650,7 @@ add_child_attrs (GtkTextLayout *layout,
pango_attr_list_insert (attrs, attr); pango_attr_list_insert (attrs, attr);
} }
/** /*
* get_block_cursor: * get_block_cursor:
* @layout: a #GtkTextLayout * @layout: a #GtkTextLayout
* @display: a #GtkTextLineDisplay * @display: a #GtkTextLineDisplay
@ -1664,7 +1664,7 @@ add_child_attrs (GtkTextLayout *layout,
* Checks whether layout should display block cursor at given position. * Checks whether layout should display block cursor at given position.
* For this layout must be in overwrite mode and text at @insert_iter * For this layout must be in overwrite mode and text at @insert_iter
* must be editable. * must be editable.
**/ */
static gboolean static gboolean
get_block_cursor (GtkTextLayout *layout, get_block_cursor (GtkTextLayout *layout,
GtkTextLineDisplay *display, GtkTextLineDisplay *display,
@ -2593,11 +2593,11 @@ get_line_at_y (GtkTextLayout *layout,
* @target_iter: the iterator in which the result is stored * @target_iter: the iterator in which the result is stored
* @y: the y positition * @y: the y positition
* @line_top: location to store the y coordinate of the * @line_top: location to store the y coordinate of the
* top of the line. (Can by %NULL.) * top of the line. (Can by %NULL)
* *
* Get the iter at the beginning of the line which is displayed * Get the iter at the beginning of the line which is displayed
* at the given y. * at the given y.
**/ */
void void
gtk_text_layout_get_line_at_y (GtkTextLayout *layout, gtk_text_layout_get_line_at_y (GtkTextLayout *layout,
GtkTextIter *target_iter, GtkTextIter *target_iter,