summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBilly Biggs <vektor@dumbterm.net>2005-08-23 21:36:08 +0000
committerBilly Biggs <vektor@dumbterm.net>2005-08-23 21:36:08 +0000
commit0b616d20dd77aaa4549759a49d72dd1007290ebb (patch)
treee2188f159e88a9ae535b3bd7e1633fe7853f0864
parent86889a55de043b1357af39a2446b948068d54179 (diff)
Add a long description.
Fix a typo. Document the return value of cairo_scaled_font_reference(). Document the width and height parameters of cairo_xlib_surface_set_drawable().
-rw-r--r--ChangeLog9
-rw-r--r--doc/public/tmpl/cairo-image.sgml7
-rw-r--r--doc/public/tmpl/cairo.sgml2
-rw-r--r--src/cairo-font.c2
-rw-r--r--src/cairo-xlib-surface.c2
5 files changed, 19 insertions, 3 deletions
diff --git a/ChangeLog b/ChangeLog
index 0663872c..93702cae 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,14 @@
2005-08-23 Billy Biggs <vektor@dumbterm.net>
+ * doc/public/tmpl/cairo-image.sgml: Add a long description.
+ * doc/public/tmpl/cairo.sgml: Fix a typo.
+ * src/cairo-font.c: Document the return value of
+ cairo_scaled_font_reference().
+ * src/cairo-xlib-surface.c: Document the width and height
+ parameters of cairo_xlib_surface_set_drawable().
+
+2005-08-23 Billy Biggs <vektor@dumbterm.net>
+
* src/cairo.c: Document the rest of the path functions (except the
two text ones, which should coordinate with their corresponding
non-path versions).
diff --git a/doc/public/tmpl/cairo-image.sgml b/doc/public/tmpl/cairo-image.sgml
index 4f5a4e48..5c6ffec1 100644
--- a/doc/public/tmpl/cairo-image.sgml
+++ b/doc/public/tmpl/cairo-image.sgml
@@ -7,9 +7,12 @@
Rendering to memory buffers
<!-- ##### SECTION Long_Description ##### -->
-<para>
-</para>
+ <para>
+ Image surfaces provide the ability to render to memory buffers
+ either allocated by cairo or by the calling code. The supported
+ image formats are those defined in #cairo_format_t.
+ </para>
<!-- ##### SECTION See_Also ##### -->
<para>
diff --git a/doc/public/tmpl/cairo.sgml b/doc/public/tmpl/cairo.sgml
index d161b79a..34d9fc03 100644
--- a/doc/public/tmpl/cairo.sgml
+++ b/doc/public/tmpl/cairo.sgml
@@ -13,7 +13,7 @@
draw with Cairo, you create a #cairo_t, set the target surface,
and drawing options for the #cairo_t, create shapes with
functions like cairo_move_to() and cairo_line_to(), and then
- draw ships with cairo_stroke() or cairo_fill().
+ draw shapes with cairo_stroke() or cairo_fill().
</para>
<para>
#cairo_t<!-- -->'s can be pushed to a stack via cairo_save().
diff --git a/src/cairo-font.c b/src/cairo-font.c
index 947d7c88..b228f285 100644
--- a/src/cairo-font.c
+++ b/src/cairo-font.c
@@ -756,6 +756,8 @@ UNWIND:
* Increases the reference count on @scaled_font by one. This prevents
* @scaled_font from being destroyed until a matching call to
* cairo_scaled_font_destroy() is made.
+ *
+ * Returns: the referenced #cairo_scaled_font_t
**/
cairo_scaled_font_t *
cairo_scaled_font_reference (cairo_scaled_font_t *scaled_font)
diff --git a/src/cairo-xlib-surface.c b/src/cairo-xlib-surface.c
index 3c5a58d7..d52642a7 100644
--- a/src/cairo-xlib-surface.c
+++ b/src/cairo-xlib-surface.c
@@ -1830,6 +1830,8 @@ cairo_xlib_surface_set_size (cairo_surface_t *surface,
* cairo_xlib_surface_set_drawable:
* @surface: a #cairo_surface_t for the XLib backend
* @drawable: the new drawable for the surface
+ * @width: the width of the new drawable
+ * @height: the height of the new drawable
*
* Informs cairo of a new X Drawable underlying the
* surface. The drawable must match the display, screen