From e15fcdd74734e922183afd4732ec4ba090f313c9 Mon Sep 17 00:00:00 2001 From: Behdad Esfahbod Date: Mon, 28 Jan 2008 21:48:23 -0500 Subject: [PATCH] [doc] Improve syntax --- doc/public/tmpl/cairo-font.sgml | 7 +++++-- doc/public/tmpl/cairo-matrix.sgml | 2 +- doc/public/tmpl/cairo-pattern.sgml | 12 +++++++++--- doc/public/tmpl/cairo-status.sgml | 5 +++-- doc/public/tmpl/cairo-surface.sgml | 8 +++++++- doc/public/tmpl/cairo-xcb-xrender.sgml | 3 ++- doc/public/tmpl/cairo-xcb.sgml | 3 ++- doc/public/tmpl/cairo-xlib-xrender.sgml | 3 ++- doc/public/tmpl/cairo-xlib.sgml | 3 ++- 9 files changed, 33 insertions(+), 13 deletions(-) diff --git a/doc/public/tmpl/cairo-font.sgml b/doc/public/tmpl/cairo-font.sgml index 079c40de7..8a4e80925 100644 --- a/doc/public/tmpl/cairo-font.sgml +++ b/doc/public/tmpl/cairo-font.sgml @@ -8,8 +8,11 @@ Base class for font faces #cairo_font_face_t represents a particular font at a particular weight, slant, and other characteristic but no size, transformation, or size. - -Font faces are created using font-backend specific constructors, + + +Font faces are created using font-backend-specific +constructors, typically of the form +cairo_backend_font_face_create(), or implicitly using the toy text API by way of cairo_select_font_face(). The resulting face can be accessed using cairo_get_font_face(). diff --git a/doc/public/tmpl/cairo-matrix.sgml b/doc/public/tmpl/cairo-matrix.sgml index 308a3bad2..720cdac23 100644 --- a/doc/public/tmpl/cairo-matrix.sgml +++ b/doc/public/tmpl/cairo-matrix.sgml @@ -5,7 +5,7 @@ cairo_matrix_t Generic matrix operations - typescairo_matrix + #cairo_matrix_t is used throughout cairo to convert between different coordinate spaces. A #cairo_matrix_t holds an affine transformation, such as a scale, rotation, shear, or a combination of these. diff --git a/doc/public/tmpl/cairo-pattern.sgml b/doc/public/tmpl/cairo-pattern.sgml index 0deaa631b..adcff6630 100644 --- a/doc/public/tmpl/cairo-pattern.sgml +++ b/doc/public/tmpl/cairo-pattern.sgml @@ -6,9 +6,15 @@ Sources for drawing -Patterns are the paint with which cairo draws. The primary use of patterns -is as the source for all cairo drawing operations, although they can also be -used as masks, that is, as the brush too. +#cairo_pattern_t is the paint with which cairo draws. +The primary use of patterns is as the source for all cairo drawing operations, +although they can also be used as masks, that is, as the brush too. + + +A cairo pattern is created by using one of the many constructors, +of the form cairo_pattern_create_type() +or implicitly through +cairo_set_source_type() functions. diff --git a/doc/public/tmpl/cairo-status.sgml b/doc/public/tmpl/cairo-status.sgml index 2ee02ca31..9b2bbe121 100644 --- a/doc/public/tmpl/cairo-status.sgml +++ b/doc/public/tmpl/cairo-status.sgml @@ -9,10 +9,11 @@ Decoding cairo's status Cairo uses a single status type to represent all kinds of errors. A status value of %CAIRO_STATUS_SUCCESS represents no error and has an integer value of zero. All other status values represent an error. - + + Cairo's error handling is designed to be easy to use and safe. All major cairo objects retain an error status internally which -can be queried anytime by the users using cairo_*_status() calls. In +can be queried anytime by the users using cairo*_status() calls. In the mean time, it is safe to call all cairo functions normally even if the underlying object is in an error status. This means that no error handling code is required before or after each individual cairo function call. diff --git a/doc/public/tmpl/cairo-surface.sgml b/doc/public/tmpl/cairo-surface.sgml index 1e8b69367..20d8569d9 100644 --- a/doc/public/tmpl/cairo-surface.sgml +++ b/doc/public/tmpl/cairo-surface.sgml @@ -6,9 +6,15 @@ Base class for surfaces -Cairo surfaces are target of all drawing operations. The actual drawings are +#cairo_surface_t is the abstract type representing all different drawing +targets that cairo can render to. The actual drawings are performed using a cairo context. + +A cairo surface is created by using backend-specific +constructors, typically of the form +cairo_backend_surface_create(). + diff --git a/doc/public/tmpl/cairo-xcb-xrender.sgml b/doc/public/tmpl/cairo-xcb-xrender.sgml index 40aa65594..993caff44 100644 --- a/doc/public/tmpl/cairo-xcb-xrender.sgml +++ b/doc/public/tmpl/cairo-xcb-xrender.sgml @@ -8,7 +8,8 @@ X Window System rendering using the XCB library and the X Render extension The XCB surface is used to render cairo graphics to X Window System windows and pixmaps using the XCB library and its X Render extension. - + + Note that the XCB surface automatically takes advantage of the X Render extension if it is available. diff --git a/doc/public/tmpl/cairo-xcb.sgml b/doc/public/tmpl/cairo-xcb.sgml index 579654258..845b9a149 100644 --- a/doc/public/tmpl/cairo-xcb.sgml +++ b/doc/public/tmpl/cairo-xcb.sgml @@ -8,7 +8,8 @@ X Window System rendering using the XCB library The XCB surface is used to render cairo graphics to X Window System windows and pixmaps using the XCB library. - + + Note that the XCB surface automatically takes advantage of the X render extension if it is available. diff --git a/doc/public/tmpl/cairo-xlib-xrender.sgml b/doc/public/tmpl/cairo-xlib-xrender.sgml index 3d9ebc68b..04663ed7e 100644 --- a/doc/public/tmpl/cairo-xlib-xrender.sgml +++ b/doc/public/tmpl/cairo-xlib-xrender.sgml @@ -8,7 +8,8 @@ X Window System rendering using XLib and the X Render extension The XLib surface is used to render cairo graphics to X Window System windows and pixmaps using the XLib and Xrender libraries. - + + Note that the XLib surface automatically takes advantage of X Render extension if it is available. diff --git a/doc/public/tmpl/cairo-xlib.sgml b/doc/public/tmpl/cairo-xlib.sgml index b8330a9fa..e0927d064 100644 --- a/doc/public/tmpl/cairo-xlib.sgml +++ b/doc/public/tmpl/cairo-xlib.sgml @@ -8,7 +8,8 @@ X Window System rendering using XLib The XLib surface is used to render cairo graphics to X Window System windows and pixmaps using the XLib library. - + + Note that the XLib surface automatically takes advantage of X render extension if it is available.