Commit ca00536f authored by Matthias Clasen's avatar Matthias Clasen
Browse files

More doc comments moved inline.

parent 1489222c
2002-11-01 Matthias Clasen <maclas@gmx.de>
* gdk/x11/gdkim-x11.c:
* gdk/gdkfont.c:
* gdk/x11/gdkfont-x11.c:
* gdk/gdkdraw.c: Some docs moved inline.
Thu Oct 31 17:41:12 2002 Owen Taylor <otaylor@redhat.com>
* gtk/gtktooltips.c (gtk_tooltips_update_screen): Fix
......
2002-11-01 Matthias Clasen <maclas@gmx.de>
* gdk/x11/gdkim-x11.c:
* gdk/gdkfont.c:
* gdk/x11/gdkfont-x11.c:
* gdk/gdkdraw.c: Some docs moved inline.
Thu Oct 31 17:41:12 2002 Owen Taylor <otaylor@redhat.com>
* gtk/gtktooltips.c (gtk_tooltips_update_screen): Fix
......
2002-11-01 Matthias Clasen <maclas@gmx.de>
* gdk/x11/gdkim-x11.c:
* gdk/gdkfont.c:
* gdk/x11/gdkfont-x11.c:
* gdk/gdkdraw.c: Some docs moved inline.
Thu Oct 31 17:41:12 2002 Owen Taylor <otaylor@redhat.com>
* gtk/gtktooltips.c (gtk_tooltips_update_screen): Fix
......
2002-11-01 Matthias Clasen <maclas@gmx.de>
* gdk/x11/gdkim-x11.c:
* gdk/gdkfont.c:
* gdk/x11/gdkfont-x11.c:
* gdk/gdkdraw.c: Some docs moved inline.
Thu Oct 31 17:41:12 2002 Owen Taylor <otaylor@redhat.com>
* gtk/gtktooltips.c (gtk_tooltips_update_screen): Fix
......
2002-11-01 Matthias Clasen <maclas@gmx.de>
* gdk/x11/gdkim-x11.c:
* gdk/gdkfont.c:
* gdk/x11/gdkfont-x11.c:
* gdk/gdkdraw.c: Some docs moved inline.
Thu Oct 31 17:41:12 2002 Owen Taylor <otaylor@redhat.com>
* gtk/gtktooltips.c (gtk_tooltips_update_screen): Fix
......
2002-11-01 Matthias Clasen <maclas@gmx.de>
* gdk/x11/gdkim-x11.c:
* gdk/gdkfont.c:
* gdk/x11/gdkfont-x11.c:
* gdk/gdkdraw.c: Some docs moved inline.
Thu Oct 31 17:41:12 2002 Owen Taylor <otaylor@redhat.com>
* gtk/gtktooltips.c (gtk_tooltips_update_screen): Fix
......
2002-11-01 Matthias Clasen <maclas@gmx.de>
* gdk/tmpl/fonts.sgml:
* gdk/tmpl/drawing.sgml: More docs moved inline.
* gtk/tmpl/gtkfilesel.sgml: The label is "Folders" now, not
"Directories". (#97224, Vitaly Tishkov)
......
......@@ -155,53 +155,45 @@ or a #GdkWindow.
<!-- ##### FUNCTION gdk_draw_point ##### -->
<para>
Draws a point, using the foreground color and other attributes of the #GdkGC.
</para>
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
@gc: a #GdkGC.
@x: the x coordinate of the point.
@y: the y coordinate of the point.
@drawable:
@gc:
@x:
@y:
<!-- ##### FUNCTION gdk_draw_points ##### -->
<para>
Draws a number of points, using the foreground color and other attributes of
the #GdkGC.
</para>
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
@gc: a #GdkGC.
@points: an array of #GdkPoint structures.
@npoints: the number of points to be drawn.
@drawable:
@gc:
@points:
@npoints:
<!-- ##### FUNCTION gdk_draw_line ##### -->
<para>
Draws a line, using the foreground color and other attributes of the #GdkGC.
</para>
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
@gc: a #GdkGC.
@x1: the x coordinate of the start point.
@y1: the y coordinate of the start point.
@x2: the x coordinate of the end point.
@y2: the y coordinate of the end point.
@drawable:
@gc:
@x1:
@y1:
@x2:
@y2:
<!-- ##### FUNCTION gdk_draw_lines ##### -->
<para>
Draws a series of lines connecting the given points.
The way in which joins between lines are draw is determined by the
#GdkCapStyle value in the #GdkGC. This can be set with
gdk_gc_set_line_attributes().
</para>
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
@gc: a #GdkGC.
@points: an array of #GdkPoint structures specifying the endpoints of the
@drawable:
@gc:
@points:
lines.
@npoints: the size of the @points array.
@npoints:
<!-- ##### FUNCTION gdk_draw_pixbuf ##### -->
......@@ -225,14 +217,12 @@ lines.
<!-- ##### FUNCTION gdk_draw_segments ##### -->
<para>
Draws a number of unconnected lines.
</para>
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
@gc: a #GdkGC.
@segs: an array of #GdkSegment structures specifying the start and end points
of the lines to be drawn,
@nsegs: the number of line segments to draw, i.e. the size of the @segs array.
@drawable:
@gc:
@segs:
@nsegs:
<!-- ##### STRUCT GdkSegment ##### -->
......@@ -248,60 +238,45 @@ function.
<!-- ##### FUNCTION gdk_draw_rectangle ##### -->
<para>
Draws a rectangular outline or filled rectangle, using the foreground color
and other attributes of the #GdkGC.
</para>
<note>
<para>
A rectangle drawn filled is 1 pixel smaller in both dimensions than a rectangle
outlined. Calling <literal>gdk_draw_rectangle (window, gc, TRUE, 0, 0, 20, 20)</literal> results
in a filled rectangle 20 pixels wide and 20 pixels high. Calling
<literal>gdk_draw_rectangle (window, gc, FALSE, 0, 0, 20, 20)</literal> results in an outlined
rectangle with corners at (0, 0), (0, 20), (20, 20), and (20, 0), which
makes it 21 pixels wide and 21 pixels high.
</para>
</note>
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
@gc: a #GdkGC.
@filled: %TRUE if the rectangle should be filled.
@x: the x coordinate of the left edge of the rectangle.
@y: the y coordinate of the top edge of the rectangle.
@width: the width of the rectangle.
@height: the height of the rectangle.
@drawable:
@gc:
@filled:
@x:
@y:
@width:
@height:
<!-- ##### FUNCTION gdk_draw_arc ##### -->
<para>
Draws an arc or a filled 'pie slice'. The arc is defined by the bounding
rectangle of the entire ellipse, and the start and end angles of the part of
the ellipse to be drawn.
</para>
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
@gc: a #GdkGC.
@filled: %TRUE if the arc should be filled, producing a 'pie slice'.
@x: the x coordinate of the left edge of the bounding rectangle.
@y: the y coordinate of the top edge of the bounding rectangle.
@width: the width of the bounding rectangle.
@height: the height of the bounding rectangle.
@angle1: the start angle of the arc, relative to the 3 o'clock position,
counter-clockwise, in 1/64ths of a degree.
@angle2: the end angle of the arc, relative to @angle1, in 1/64ths of a degree.
@drawable:
@gc:
@filled:
@x:
@y:
@width:
@height:
@angle1:
@angle2:
<!-- ##### FUNCTION gdk_draw_polygon ##### -->
<para>
Draws an outlined or filled polygon.
</para>
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
@gc: a #GdkGC.
@filled: %TRUE if the polygon should be filled. The polygon is closed
automatically, connecting the last point to the first point if necessary.
@points: an array of #GdkPoint structures specifying the points making up the
polygon.
@npoints: the number of points.
@drawable:
@gc:
@filled:
@points:
@npoints:
<!-- ##### FUNCTION gdk_draw_glyphs ##### -->
......@@ -371,45 +346,40 @@ polygon.
<!-- ##### FUNCTION gdk_draw_string ##### -->
<para>
Draws a string of characters in the given font or fontset.
</para>
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
@font: a #GdkFont.
@gc: a #GdkGC.
@x: the x coordinate of the left edge of the text.
@y: the y coordinate of the baseline of the text.
@string: the string of characters to draw.
@drawable:
@font:
@gc:
@x:
@y:
@string:
<!-- ##### FUNCTION gdk_draw_text ##### -->
<para>
Draws a number of characters in the given font or fontset.
</para>
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
@font: a #GdkFont.
@gc: a #GdkGC.
@x: the x coordinate of the left edge of the text.
@y: the y coordinate of the baseline of the text.
@text: the characters to draw.
@text_length: the number of characters of @text to draw.
@drawable:
@font:
@gc:
@x:
@y:
@text:
@text_length:
<!-- ##### FUNCTION gdk_draw_text_wc ##### -->
<para>
Draws a number of wide characters using the given font of fontset.
If the font is a 1-byte font, the string is converted into 1-byte characters
(discarding the high bytes) before output.
</para>
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
@font: a #GdkFont.
@gc: a #GdkGC.
@x: the x coordinate of the left edge of the text.
@y: the y coordinate of the baseline of the text.
@text: the wide characters to draw.
@text_length: the number of characters to draw.
@drawable:
@font:
@gc:
@x:
@y:
@text:
@text_length:
<!-- ##### MACRO gdk_draw_pixmap ##### -->
......@@ -417,20 +387,6 @@ If the font is a 1-byte font, the string is converted into 1-byte characters
Draws a pixmap, or a part of a pixmap, onto another drawable.
</para>
<!-- # Unused Parameters # -->
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
@gc: a #GdkGC.
@src: the source #GdkPixmap to draw.
@xsrc: the left edge of the source rectangle within @src.
@ysrc: the top of the source rectangle within @src.
@xdest: the x coordinate of the destination within @drawable.
@ydest: the y coordinate of the destination within @drawable.
@width: the width of the area to be copied, or -1 to make the area extend to
the right edge of the source pixmap.
@height: the height of the area to be copied, or -1 to make the area extend
to the bottom edge of the source pixmap.
<!-- ##### FUNCTION gdk_draw_drawable ##### -->
<para>
......@@ -449,21 +405,17 @@ to the bottom edge of the source pixmap.
<!-- ##### FUNCTION gdk_draw_image ##### -->
<para>
Draws a #GdkImage onto a drawable.
The depth of the #GdkImage must match the depth of the #GdkDrawable.
</para>
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
@gc: a #GdkGC.
@image: the #GdkImage to draw.
@xsrc: the left edge of the source rectangle within @image.
@ysrc: the top of the source rectangle within @image.
@xdest: the x coordinate of the destination within @drawable.
@ydest: the y coordinate of the destination within @drawable.
@width: the width of the area to be copied, or -1 to make the area extend to
the right edge of @image.
@height: the height of the area to be copied, or -1 to make the area extend
to the bottom edge of @image.
</para>
@drawable:
@gc:
@image:
@xsrc:
@ysrc:
@xdest:
@ydest:
@width:
@height:
<!-- ##### FUNCTION gdk_drawable_get_image ##### -->
......
......@@ -287,16 +287,10 @@ are currently:
<!-- ##### FUNCTION gdk_font_load ##### -->
<para>
Loads a font.
</para>
<para>
The font may be newly loaded or looked up the font in a cache.
You should make no assumptions about the initial reference count.
</para>
@font_name: a XLFD describing the font to load.
@Returns: a #GdkFont, or %NULL if the font could not be loaded.
@font_name:
@Returns:
<!-- ##### FUNCTION gdk_font_load_for_display ##### -->
......@@ -311,16 +305,10 @@ You should make no assumptions about the initial reference count.
<!-- ##### FUNCTION gdk_fontset_load ##### -->
<para>
Loads a fontset.
</para>
<para>
The fontset may be newly loaded or looked up in a cache.
You should make no assumptions about the initial reference count.
</para>
@fontset_name: a comma-separated list of XLFDs describing
the component fonts of the fontset to load.
@Returns: a #GdkFont, or %NULL if the fontset could not be loaded.
@fontset_name:
@Returns:
<!-- ##### FUNCTION gdk_fontset_load_for_display ##### -->
......@@ -363,225 +351,178 @@ You should make no assumptions about the initial reference count.
<!-- ##### FUNCTION gdk_font_ref ##### -->
<para>
Increases the reference count of a font by one.
</para>
@font: a #GdkFont
@Returns: @font
@font:
@Returns:
<!-- ##### FUNCTION gdk_font_unref ##### -->
<para>
Decreases the reference count of a font by one.
If the result is zero, destroys the font.
</para>
@font: a #GdkFont
@font:
<!-- ##### FUNCTION gdk_font_id ##### -->
<para>
Returns the X Font ID for the given font.
</para>
@font: a #GdkFont.
@Returns: the numeric X Font ID
@font:
@Returns:
<!-- ##### FUNCTION gdk_font_equal ##### -->
<para>
Compares two fonts for equality. Single fonts compare equal
if they have the same X font ID. This operation does
not currently work correctly for fontsets.
</para>
@fonta: a #GdkFont.
@fontb: another #GdkFont.
@Returns: %TRUE if the fonts are equal.
@fonta:
@fontb:
@Returns:
<!-- ##### FUNCTION gdk_string_extents ##### -->
<para>
Returns the metrics of a nul-terminated string.
</para>
@font: a #GdkFont.
@string: the nul-terminated string to measure.
@lbearing: the left bearing of the string.
@rbearing: the right bearing of the string.
@width: the width of the string.
@ascent: the ascent of the string.
@descent: the descent of the string.
@font:
@string:
@lbearing:
@rbearing:
@width:
@ascent:
@descent:
<!-- ##### FUNCTION gdk_text_extents ##### -->
<para>
Returns the metrics of a string.
</para>
@font: a #GdkFont
@text: the text to measure
@text_length: the length of the text in bytes. (If the
font is a 16-bit font, this is twice the length
of the text in characters.)
@lbearing: the left bearing of the string.
@rbearing: the right bearing of the string.
@width: the width of the string.
@ascent: the ascent of the string.
@descent: the descent of the string.
@font:
@text:
@text_length:
@lbearing:
@rbearing:
@width:
@ascent:
@descent:
<!-- ##### FUNCTION gdk_text_extents_wc ##### -->
<para>
Returns the metrics of a string of wide characters.
</para>
@font: a #GdkFont
@text: the text to measure.
@text_length: the length of the text in character.
@lbearing: the left bearing of the string.
@rbearing: the right bearing of the string.
@width: the width of the string.
@ascent: the ascent of the string.
@descent: the descent of the string.
@font:
@text:
@text_length:
@lbearing:
@rbearing:
@width:
@ascent:
@descent:
<!-- ##### FUNCTION gdk_string_width ##### -->
<para>
Determines the width of a nul-terminated string.
(The distance from the origin of the string to the
point where the next string in a sequence of strings
should be drawn)
</para>
@font: a #GdkFont
@string: the nul-terminated string to measure
@Returns: the width of the string in pixels.
@font:
@string:
@Returns:
<!-- ##### FUNCTION gdk_text_width ##### -->
<para>
Determines the width of a given string.
</para>
@font: a #GdkFont
@text: the text to measure.
@text_length: the length of the text in bytes.
@Returns: the width of the string in pixels.
@font:
@text:
@text_length:
@Returns:
<!-- ##### FUNCTION gdk_text_width_wc ##### -->
<para>
Determines the width of a given wide-character string.
</para>
@font: a #GdkFont
@text: the text to measure.
@text_length: the length of the text in characters.
@Returns: the width of the string in pixels.
@font:
@text:
@text_length:
@Returns:
<!-- ##### FUNCTION gdk_char_width ##### -->
<para>
Determines the width of a given character.
</para>
@font: a #GdkFont
@character: the character to measure.
@Returns: the width of the character in pixels.
@font:
@character:
@Returns:
<!-- ##### FUNCTION gdk_char_width_wc ##### -->
<para>
Determines the width of a given wide character. (Encoded
in the wide-character encoding of the current locale).
</para>
@font: a #GdkFont
@character: the character to measure.
@Returns: the width of the character in pixels.
@font:
@character:
@Returns:
<!-- ##### FUNCTION gdk_string_measure ##### -->
<para>
Determines the distance from the origin to the rightmost
portion of a nul-terminated string when drawn. This is not the
correct value for determining the origin of the next
portion when drawing text in multiple pieces.
See gdk_string_width().
</para>
@font: a #GdkFont
@string: the nul-terminated string to measure.
@Returns: the right bearing of the string in pixels.
@font:
@string:
@Returns:
<!-- ##### FUNCTION gdk_text_measure ##### -->
<para>
Determines the distance from the origin to the rightmost
portion of a string when drawn. This is not the
correct value for determining the origin of the next
portion when drawing text in multiple pieces.
See gdk_text_width().
</para>
@font: a #GdkFont
@text: the text to measure.
@text_length: the length of the text in bytes.
@Returns: the right bearing of the string in pixels.
@font:
@text:
@text_length:
@Returns:
<!-- ##### FUNCTION gdk_char_measure ##### -->
<para>
Determines the distance from the origin to the rightmost
portion of a character when drawn. This is not the
correct value for determining the origin of the next
portion when drawing text in multiple pieces.
</para>
@font: a #GdkFont
@character: the character to measure.
@Returns: the right bearing of the character in pixels.
@font:
@character: