[cairo] [PATCH] minor document fixes

[Behdad Esfahbod]

On Mon, 2007-05-28 at 08:00 -0400, Kouhei Sutou wrote:
> Hi,
> 
> I found some typos in documentation. I'll attach a patch to
> fix them and improve markup.

Thanks Kouhei.  Reviewed and committed most.  Read below for comments.

> Thanks,
> --
> kou
> plain text document attachment (cairo-doc-fix.diff)
> diff --git a/src/cairo-matrix.c b/src/cairo-matrix.c
> index 40828f0..872bfc1 100644
> --- a/src/cairo-matrix.c
> +++ b/src/cairo-matrix.c
> @@ -218,7 +218,7 @@ slim_hidden_def(cairo_matrix_scale);
>   * @radians: angle of rotation, in radians. The direction of rotation
>   * is defined such that positive angles rotate in the direction from
>   * the positive X axis toward the positive Y axis. With the default
> - * axis orientation of cairo, positive angles rotate in a clockwise
> + * axis orientation of cairo, positive angles rotate in a counterclockwise
>   * direction.
>   *
>   * Initialized @matrix to a transformation that rotates by @radians.
> @@ -246,7 +246,7 @@ slim_hidden_def(cairo_matrix_init_rotate);
>   * @radians: angle of rotation, in radians. The direction of rotation
>   * is defined such that positive angles rotate in the direction from
>   * the positive X axis toward the positive Y axis. With the default
> - * axis orientation of cairo, positive angles rotate in a clockwise
> + * axis orientation of cairo, positive angles rotate in a counterclockwise
>   * direction.
>   *
>   * Applies rotation by @radians to the transformation in

No, the current docs in these cases is correct.  Cairo uses a
y-grows-down coordinate system by default, which means positive angles
rotate clockwise.


> diff --git a/src/cairo.c b/src/cairo.c
> index 2abc073..abebfd3 100644
> --- a/src/cairo.c
> +++ b/src/cairo.c
> @@ -3117,7 +3117,7 @@ cairo_get_antialias (cairo_t *cr)
>   *
>   * cairo_new_path(), cairo_move_to(), cairo_line_to(),
>   * cairo_curve_to(), cairo_arc(), cairo_rel_move_to(),
> - * cairo_rel_line_to(), cairo_rel_curve_to(), cairo_arc(),
> + * cairo_rel_line_to(), cairo_rel_curve_to(), cairo_rel_arc(),
>   * cairo_text_path(), cairo_stroke_to_path()
>   **/
>  void

There is no such function as cairo_rel_arc(), but I updated that list to
include all path-modifying functions as well as some others..


Thanks,
-- 
behdad
http://behdad.org/

"Those who would give up Essential Liberty to purchase a little
 Temporary Safety, deserve neither Liberty nor Safety."
        -- Benjamin Franklin, 1759