[cairo-commit] 4 commits - src/cairo-array.c src/cairo-base85-stream.c src/cairo-bentley-ottmann.c src/cairo-beos-surface.cpp src/cairo.c src/cairo-cache.c src/cairo-deflate-stream.c src/cairo-ft-font.c src/cairo.h src/cairo-hash.c src/cairoint.h src/cairo-meta-surface.c src/cairo-os2-surface.c src/cairo-output-stream-private.h src/cairo-paginated-private.h src/cairo-path-fixed.c src/cairo-pattern.c src/cairo-png.c src/cairo-scaled-font.c src/cairo-scaled-font-subsets-private.h src/cairo-surface.c src/cairo-unicode.c src/cairo-xcb-surface.c src/cairo-xlib-surface.c src/check-doc-syntax.sh
Behdad Esfahbod
behdad at kemper.freedesktop.org
Sun Jun 1 17:42:04 PDT 2008
src/cairo-array.c | 6 ++--
src/cairo-base85-stream.c | 3 +-
src/cairo-bentley-ottmann.c | 2 -
src/cairo-beos-surface.cpp | 2 -
src/cairo-cache.c | 2 -
src/cairo-deflate-stream.c | 3 +-
src/cairo-ft-font.c | 1
src/cairo-hash.c | 8 +++---
src/cairo-meta-surface.c | 4 +--
src/cairo-os2-surface.c | 4 +--
src/cairo-output-stream-private.h | 4 +--
src/cairo-paginated-private.h | 4 +--
src/cairo-path-fixed.c | 2 +
src/cairo-pattern.c | 2 -
src/cairo-png.c | 10 +++----
src/cairo-scaled-font-subsets-private.h | 26 ++++++++++----------
src/cairo-scaled-font.c | 8 +++---
src/cairo-surface.c | 6 ++--
src/cairo-unicode.c | 3 +-
src/cairo-xcb-surface.c | 4 +--
src/cairo-xlib-surface.c | 4 +--
src/cairo.c | 41 +++++++++++++++-----------------
src/cairo.h | 16 ++++++------
src/cairoint.h | 24 +++++++++---------
src/check-doc-syntax.sh | 8 +++---
25 files changed, 101 insertions(+), 96 deletions(-)
New commits:
commit 3f5051fab161da167fdedcdad0280da1f57a1828
Author: Behdad Esfahbod <behdad at behdad.org>
Date: Sun Jun 1 19:14:13 2008 -0400
Fix now-detected doc formatting issues
diff --git a/src/cairo-base85-stream.c b/src/cairo-base85-stream.c
index 2b8a8be..8897403 100644
--- a/src/cairo-base85-stream.c
+++ b/src/cairo-base85-stream.c
@@ -1,4 +1,5 @@
-/* cairo_output_stream.c: Output stream abstraction
+/* -*- Mode: c; c-basic-offset: 4; indent-tabs-mode: t; tab-width: 8; -*- */
+/* cairo - a vector graphics library with display and print output
*
* Copyright © 2005 Red Hat, Inc
*
diff --git a/src/cairo-beos-surface.cpp b/src/cairo-beos-surface.cpp
index 69dfd83..ec4aff0 100644
--- a/src/cairo-beos-surface.cpp
+++ b/src/cairo-beos-surface.cpp
@@ -946,7 +946,7 @@ _cairo_beos_surface_create_internal (BView* view,
* Creates a Cairo surface that draws onto a BeOS BView.
* The caller must ensure that the view does not get deleted before the surface.
* If the view is attached to a bitmap rather than an on-screen window, use
- * cairo_beos_surface_create_for_bitmap instead of this function.
+ * cairo_beos_surface_create_for_bitmap() instead of this function.
**/
cairo_surface_t *
cairo_beos_surface_create (BView* view)
diff --git a/src/cairo-deflate-stream.c b/src/cairo-deflate-stream.c
index 9feb46d..bf2784a 100644
--- a/src/cairo-deflate-stream.c
+++ b/src/cairo-deflate-stream.c
@@ -1,4 +1,5 @@
-/* cairo_deflate_stream.c: Output stream abstraction
+/* -*- Mode: c; c-basic-offset: 4; indent-tabs-mode: t; tab-width: 8; -*- */
+/* cairo - a vector graphics library with display and print output
*
* Copyright © 2006 Adrian Johnson
*
diff --git a/src/cairo-ft-font.c b/src/cairo-ft-font.c
index 3e3f2a2..5824f49 100644
--- a/src/cairo-ft-font.c
+++ b/src/cairo-ft-font.c
@@ -1,3 +1,4 @@
+/* -*- Mode: c; c-basic-offset: 4; indent-tabs-mode: t; tab-width: 8; -*- */
/* cairo - a vector graphics library with display and print output
*
* Copyright © 2000 Keith Packard
diff --git a/src/cairo-meta-surface.c b/src/cairo-meta-surface.c
index 18a5b4b..733ded4 100644
--- a/src/cairo-meta-surface.c
+++ b/src/cairo-meta-surface.c
@@ -486,7 +486,7 @@ _cairo_meta_surface_show_glyphs (void *abstract_surface,
* surface-modifying function on the result of this function.
*
* The caller owns the return value and should call
- * cairo_surface_destroy when finished with it. This function will not
+ * cairo_surface_destroy() when finished with it. This function will not
* return %NULL, but will return a nil surface instead.
*
* Return value: The snapshot surface.
diff --git a/src/cairo-os2-surface.c b/src/cairo-os2-surface.c
index f485cfe..b0c2731 100644
--- a/src/cairo-os2-surface.c
+++ b/src/cairo-os2-surface.c
@@ -56,8 +56,8 @@
/*
* Here comes the extra API for the OS/2 platform. Currently it consists
- * of two extra functions, the cairo_os2_init () and the
- * cairo_os2_fini (). Both of them are called automatically if
+ * of two extra functions, the cairo_os2_init() and the
+ * cairo_os2_fini(). Both of them are called automatically if
* Cairo is compiled to be a DLL file, but you have to call them before
* using the Cairo API if you link to Cairo statically!
*
diff --git a/src/cairo-output-stream-private.h b/src/cairo-output-stream-private.h
index 1a25788..9bfc534 100644
--- a/src/cairo-output-stream-private.h
+++ b/src/cairo-output-stream-private.h
@@ -157,11 +157,11 @@ _cairo_memory_stream_copy (cairo_output_stream_t *base,
cairo_private int
_cairo_memory_stream_length (cairo_output_stream_t *stream);
-/* cairo_base85_stream.c */
+/* cairo-base85-stream.c */
cairo_private cairo_output_stream_t *
_cairo_base85_stream_create (cairo_output_stream_t *output);
-/* cairo_deflate_stream.c */
+/* cairo-deflate-stream.c */
cairo_private cairo_output_stream_t *
_cairo_deflate_stream_create (cairo_output_stream_t *output);
diff --git a/src/cairo-paginated-private.h b/src/cairo-paginated-private.h
index bb31487..f2f80db 100644
--- a/src/cairo-paginated-private.h
+++ b/src/cairo-paginated-private.h
@@ -80,7 +80,7 @@ struct _cairo_paginated_surface_backend {
* _cairo_paginated_surface_create which takes its own, much simpler,
* #cairo_paginated_surface_backend_t. You are free to return the result
* of _cairo_paginated_surface_create() from your public
- * cairo_<foo>_surface_create. The paginated backend will be careful
+ * cairo_<foo>_surface_create(). The paginated backend will be careful
* to not let the user see that they really got a "wrapped"
* surface. See test-paginated-surface.c for a fairly minimal example
* of a paginated-using surface. That should be a reasonable example
@@ -88,7 +88,7 @@ struct _cairo_paginated_surface_backend {
*
* What the paginated surface does is first save all drawing
* operations for a page into a meta-surface. Then when the user calls
- * cairo_show_page, the paginated surface performs the following
+ * cairo_show_page(), the paginated surface performs the following
* sequence of operations (using the backend functions passed to
* cairo_paginated_surface_create()):
*
diff --git a/src/cairo-path-fixed.c b/src/cairo-path-fixed.c
index 58b3636..9086119 100644
--- a/src/cairo-path-fixed.c
+++ b/src/cairo-path-fixed.c
@@ -872,11 +872,13 @@ _cairo_path_fixed_is_box (cairo_path_fixed_t *path,
/*
* Check whether the given path contains a single rectangle
* that is logically equivalent to:
+ * <informalexample><programlisting>
* cairo_move_to (cr, x, y);
* cairo_rel_line_to (cr, width, 0);
* cairo_rel_line_to (cr, 0, height);
* cairo_rel_line_to (cr, -width, 0);
* cairo_close_path (cr);
+ * </programlisting></informalexample>
*/
cairo_bool_t
_cairo_path_fixed_is_rectangle (cairo_path_fixed_t *path,
diff --git a/src/cairo-surface.c b/src/cairo-surface.c
index 27fe68d..a20009b 100644
--- a/src/cairo-surface.c
+++ b/src/cairo-surface.c
@@ -1156,7 +1156,7 @@ _cairo_surface_clone_similar (cairo_surface_t *surface,
* surface-modifying function on the result of this function.
*
* The caller owns the return value and should call
- * cairo_surface_destroy when finished with it. This function will not
+ * cairo_surface_destroy() when finished with it. This function will not
* return %NULL, but will return a nil surface instead.
*
* Return value: The snapshot surface. Note that the return surface
diff --git a/src/cairo-unicode.c b/src/cairo-unicode.c
index 4ae5556..caa4727 100644
--- a/src/cairo-unicode.c
+++ b/src/cairo-unicode.c
@@ -1,4 +1,5 @@
-/* cairo_unicode.c: Unicode conversion routines
+/* -*- Mode: c; c-basic-offset: 4; indent-tabs-mode: t; tab-width: 8; -*- */
+/* cairo - a vector graphics library with display and print output
*
* The code in this file is derived from GLib's gutf8.c and
* ultimately from libunicode. It is relicensed under the
diff --git a/src/cairo-xcb-surface.c b/src/cairo-xcb-surface.c
index fbcb7f7..9bd9d72 100644
--- a/src/cairo-xcb-surface.c
+++ b/src/cairo-xcb-surface.c
@@ -1856,7 +1856,7 @@ _cairo_xcb_screen_from_visual (xcb_connection_t *c, xcb_visualtype_t *visual)
* by the provided visual.
*
* Note: If @drawable is a window, then the function
- * cairo_xcb_surface_set_size must be called whenever the size of the
+ * cairo_xcb_surface_set_size() must be called whenever the size of the
* window changes.
*
* Return value: the newly created surface
@@ -1918,7 +1918,7 @@ cairo_xcb_surface_create_for_bitmap (xcb_connection_t *c,
* by the provided picture format.
*
* Note: If @drawable is a Window, then the function
- * cairo_xcb_surface_set_size must be called whenever the size of the
+ * cairo_xcb_surface_set_size() must be called whenever the size of the
* window changes.
*
* Return value: the newly created surface.
diff --git a/src/cairo-xlib-surface.c b/src/cairo-xlib-surface.c
index b106952..7397573 100644
--- a/src/cairo-xlib-surface.c
+++ b/src/cairo-xlib-surface.c
@@ -2353,7 +2353,7 @@ _cairo_xlib_screen_from_visual (Display *dpy, Visual *visual)
* by the provided visual.
*
* Note: If @drawable is a Window, then the function
- * cairo_xlib_surface_set_size must be called whenever the size of the
+ * cairo_xlib_surface_set_size() must be called whenever the size of the
* window changes.
*
* When @drawable is a Window containing child windows then drawing to
@@ -2419,7 +2419,7 @@ cairo_xlib_surface_create_for_bitmap (Display *dpy,
* by the provided picture format.
*
* Note: If @drawable is a Window, then the function
- * cairo_xlib_surface_set_size must be called whenever the size of the
+ * cairo_xlib_surface_set_size() must be called whenever the size of the
* window changes.
*
* Return value: the newly created surface
diff --git a/src/cairo.c b/src/cairo.c
index 48bc58b..e001e70 100644
--- a/src/cairo.c
+++ b/src/cairo.c
@@ -166,7 +166,7 @@ slim_hidden_def (cairo_version_string);
* default values and with @target as a target surface. The target
* surface should be constructed with a backend-specific function such
* as cairo_image_surface_create() (or any other
- * cairo_<emphasis>backend</emphasis>_surface_create variant).
+ * cairo_<emphasis>backend</emphasis>_surface_create() variant).
*
* This function references @target, so you can immediately
* call cairo_surface_destroy() on it if you don't need to
@@ -666,7 +666,7 @@ slim_hidden_def (cairo_set_operator);
* clamped.
*
* The default source pattern is opaque black, (that is, it is
- * equivalent to cairo_set_source_rgb (cr, 0.0, 0.0, 0.0)).
+ * equivalent to cairo_set_source_rgb(cr, 0.0, 0.0, 0.0)).
**/
void
cairo_set_source_rgb (cairo_t *cr, double red, double green, double blue)
@@ -701,7 +701,7 @@ cairo_set_source_rgb (cairo_t *cr, double red, double green, double blue)
* will be clamped.
*
* The default source pattern is opaque black, (that is, it is
- * equivalent to cairo_set_source_rgba (cr, 0.0, 0.0, 0.0, 1.0)).
+ * equivalent to cairo_set_source_rgba(cr, 0.0, 0.0, 0.0, 1.0)).
**/
void
cairo_set_source_rgba (cairo_t *cr,
@@ -785,7 +785,7 @@ slim_hidden_def (cairo_set_source_surface);
* will not affect the source pattern. See cairo_pattern_set_matrix().
*
* The default source pattern is a solid pattern that is opaque black,
- * (that is, it is equivalent to cairo_set_source_rgb (cr, 0.0, 0.0,
+ * (that is, it is equivalent to cairo_set_source_rgb(cr, 0.0, 0.0,
* 0.0)).
**/
void
@@ -1449,7 +1449,7 @@ cairo_new_sub_path (cairo_t *cr)
* will be (@x, @y).
*
* If there is no current point before the call to cairo_line_to()
- * this function will behave as cairo_move_to (@cr, @x, @y).
+ * this function will behave as cairo_move_to(@cr, @x, @y).
**/
void
cairo_line_to (cairo_t *cr, double x, double y)
@@ -1487,7 +1487,7 @@ slim_hidden_def (cairo_line_to);
*
* If there is no current point before the call to cairo_curve_to()
* this function will behave as if preceded by a call to
- * cairo_move_to (@cr, @x1, @y1).
+ * cairo_move_to(@cr, @x1, @y1).
**/
void
cairo_curve_to (cairo_t *cr,
@@ -1669,7 +1669,7 @@ cairo_arc_to (cairo_t *cr,
* by (@x, @y).
*
* Given a current point of (x, y), cairo_rel_move_to(@cr, @dx, @dy)
- * is logically equivalent to cairo_move_to (@cr, x + @dx, y + @dy).
+ * is logically equivalent to cairo_move_to(@cr, x + @dx, y + @dy).
*
* It is an error to call this function with no current point. Doing
* so will cause @cr to shutdown with a status of
@@ -1706,7 +1706,7 @@ cairo_rel_move_to (cairo_t *cr, double dx, double dy)
* current point will be offset by (@dx, @dy).
*
* Given a current point of (x, y), cairo_rel_line_to(@cr, @dx, @dy)
- * is logically equivalent to cairo_line_to (@cr, x + @dx, y + @dy).
+ * is logically equivalent to cairo_line_to(@cr, x + @dx, y + @dy).
*
* It is an error to call this function with no current point. Doing
* so will cause @cr to shutdown with a status of
@@ -1749,10 +1749,9 @@ slim_hidden_def(cairo_rel_line_to);
* (@dx2, @dy2) as the control points. After this call the current
* point will be offset by (@dx3, @dy3).
*
- * Given a current point of (x, y), cairo_rel_curve_to (@cr, @dx1,
+ * Given a current point of (x, y), cairo_rel_curve_to(@cr, @dx1,
* @dy1, @dx2, @dy2, @dx3, @dy3) is logically equivalent to
- * cairo_curve_to (@cr, x + @dx1, y + @dy1, x + @dx2, y + @dy2, x +
- * @dx3, y + @dy3).
+ * cairo_curve_to(@cr, x+ at dx1, y+ at dy1, x+ at dx2, y+ at dy2, x+ at dx3, y+ at dy3).
*
* It is an error to call this function with no current point. Doing
* so will cause @cr to shutdown with a status of
@@ -2080,7 +2079,7 @@ cairo_mask_surface (cairo_t *cr,
*
* A drawing operator that strokes the current path according to the
* current line width, line join, line cap, and dash settings. After
- * cairo_stroke, the current path will be cleared from the cairo
+ * cairo_stroke(), the current path will be cleared from the cairo
* context. See cairo_set_line_width(), cairo_set_line_join(),
* cairo_set_line_cap(), cairo_set_dash(), and
* cairo_stroke_preserve().
@@ -2702,7 +2701,7 @@ cairo_set_font_face (cairo_t *cr,
*
* Return value: the current font face. This object is owned by
* cairo. To keep a reference to it, you must call
- * cairo_font_face_reference.
+ * cairo_font_face_reference().
*
* This function never returns %NULL. If memory cannot be allocated, a
* special "nil" #cairo_font_face_t object will be returned on which
@@ -3015,7 +3014,7 @@ cairo_text_extents (cairo_t *cr,
* glyphs, (as they would be drawn by cairo_show_glyphs()).
* Additionally, the x_advance and y_advance values indicate the
* amount by which the current point would be advanced by
- * cairo_show_glyphs.
+ * cairo_show_glyphs().
*
* Note that whitespace glyphs do not contribute to the size of the
* rectangle (extents.width and extents.height).
diff --git a/src/cairo.h b/src/cairo.h
index 63cf303..762f952 100644
--- a/src/cairo.h
+++ b/src/cairo.h
@@ -1172,7 +1172,7 @@ cairo_font_face_status (cairo_font_face_t *font_face);
*
* The type of a font face is determined by the function used to
* create it, which will generally be of the form
- * cairo_<emphasis>type</emphasis>_font_face_create. The font face type can be queried
+ * cairo_<emphasis>type</emphasis>_font_face_create(). The font face type can be queried
* with cairo_font_face_get_type()
*
* The various #cairo_font_face_t functions can be used with a font face
@@ -1186,7 +1186,7 @@ cairo_font_face_status (cairo_font_face_t *font_face);
* fonts of any type, but some font backends also provide
* type-specific functions that must only be called with a scaled font
* of the appropriate type. These functions have names that begin with
- * cairo_<emphasis>type</emphasis>_scaled_font such as cairo_ft_scaled_font_lock_face().
+ * cairo_<emphasis>type</emphasis>_scaled_font() such as cairo_ft_scaled_font_lock_face().
*
* The behavior of calling a type-specific function with a scaled font
* of the wrong type is undefined.
@@ -1585,7 +1585,7 @@ cairo_surface_status (cairo_surface_t *surface);
* any type, but some backends also provide type-specific functions
* that must only be called with a surface of the appropriate
* type. These functions have names that begin with
- * cairo_<emphasis>type</emphasis>_surface such as cairo_image_surface_get_width().
+ * cairo_<emphasis>type</emphasis>_surface<!-- --> such as cairo_image_surface_get_width().
*
* The behavior of calling a type-specific function with a surface of
* the wrong type is undefined.
@@ -1820,7 +1820,7 @@ cairo_pattern_set_user_data (cairo_pattern_t *pattern,
* The type of a pattern is determined by the function used to create
* it. The cairo_pattern_create_rgb() and cairo_pattern_create_rgba()
* functions create SOLID patterns. The remaining
- * cairo_pattern_create functions map to pattern types in obvious
+ * cairo_pattern_create<!-- --> functions map to pattern types in obvious
* ways.
*
* The pattern type can be queried with cairo_pattern_get_type()
diff --git a/src/cairoint.h b/src/cairoint.h
index 24e818b..b52b040 100755
--- a/src/cairoint.h
+++ b/src/cairoint.h
@@ -237,7 +237,7 @@ _cairo_box_intersects_line_segment (cairo_box_t *box, cairo_line_t *line);
cairo_private cairo_bool_t
_cairo_box_contains_point (cairo_box_t *box, cairo_point_t *point);
-/* cairo_array.c structures and functions */
+/* cairo-array.c structures and functions */
cairo_private void
_cairo_array_init (cairo_array_t *array, int element_size);
@@ -943,7 +943,7 @@ _cairo_restrict_value (double *value, double min, double max);
cairo_private int
_cairo_lround (double d);
-/* cairo_gstate.c */
+/* cairo-gstate.c */
cairo_private cairo_status_t
_cairo_gstate_init (cairo_gstate_t *gstate,
cairo_surface_t *target);
@@ -1224,7 +1224,7 @@ _cairo_operator_bounded_by_mask (cairo_operator_t op);
cairo_private cairo_bool_t
_cairo_operator_bounded_by_source (cairo_operator_t op);
-/* cairo_color.c */
+/* cairo-color.c */
cairo_private const cairo_color_t *
_cairo_stock_color (cairo_stock_t stock);
@@ -1864,7 +1864,7 @@ _cairo_surface_set_device_scale (cairo_surface_t *surface,
cairo_private cairo_bool_t
_cairo_surface_has_device_transform (cairo_surface_t *surface);
-/* cairo_image_surface.c */
+/* cairo-image-surface.c */
/* XXX: In cairo 1.2.0 we added a new %CAIRO_FORMAT_RGB16_565 but
* neglected to adjust this macro. The net effect is that it's
@@ -1986,7 +1986,7 @@ _cairo_surface_is_image (const cairo_surface_t *surface);
cairo_private cairo_bool_t
_cairo_surface_is_meta (const cairo_surface_t *surface);
-/* cairo_pen.c */
+/* cairo-pen.c */
cairo_private cairo_status_t
_cairo_pen_init (cairo_pen_t *pen,
double radius,
@@ -2028,7 +2028,7 @@ _cairo_pen_stroke_spline (cairo_pen_t *pen,
double tolerance,
cairo_traps_t *traps);
-/* cairo_polygon.c */
+/* cairo-polygon.c */
cairo_private void
_cairo_polygon_init (cairo_polygon_t *polygon);
@@ -2050,7 +2050,7 @@ _cairo_polygon_line_to (cairo_polygon_t *polygon, cairo_point_t *point);
cairo_private void
_cairo_polygon_close (cairo_polygon_t *polygon);
-/* cairo_spline.c */
+/* cairo-spline.c */
cairo_private cairo_int_status_t
_cairo_spline_init (cairo_spline_t *spline,
const cairo_point_t *a,
@@ -2064,7 +2064,7 @@ _cairo_spline_decompose (cairo_spline_t *spline, double tolerance);
cairo_private void
_cairo_spline_fini (cairo_spline_t *spline);
-/* cairo_matrix.c */
+/* cairo-matrix.c */
cairo_private void
_cairo_matrix_get_affine (const cairo_matrix_t *matrix,
double *xx, double *yx,
@@ -2109,7 +2109,7 @@ cairo_private void
_cairo_matrix_to_pixman_matrix (const cairo_matrix_t *matrix,
pixman_transform_t *pixman_transform);
-/* cairo_traps.c */
+/* cairo-traps.c */
cairo_private void
_cairo_traps_init (cairo_traps_t *traps);
@@ -2173,14 +2173,14 @@ _cairo_trapezoid_array_translate_and_scale (cairo_trapezoid_t *offset_traps,
double tx, double ty,
double sx, double sy);
-/* cairo_slope.c */
+/* cairo-slope.c */
cairo_private void
_cairo_slope_init (cairo_slope_t *slope, cairo_point_t *a, cairo_point_t *b);
cairo_private int
_cairo_slope_compare (cairo_slope_t *a, cairo_slope_t *b);
-/* cairo_pattern.c */
+/* cairo-pattern.c */
cairo_private cairo_status_t
_cairo_pattern_create_copy (cairo_pattern_t **pattern,
@@ -2273,7 +2273,7 @@ _cairo_gstate_get_antialias (cairo_gstate_t *gstate);
#include "cairo-region-private.h"
-/* cairo_unicode.c */
+/* cairo-unicode.c */
cairo_private cairo_status_t
_cairo_utf8_to_ucs4 (const char *str,
commit 0c208f28268028fbb4fe2cc175131b279626975c
Author: Behdad Esfahbod <behdad at behdad.org>
Date: Sun Jun 1 19:13:49 2008 -0400
[src/check-doc-syntax.sh] Detect malformatted functions at line start
diff --git a/src/check-doc-syntax.sh b/src/check-doc-syntax.sh
index e91d25c..0c59654 100755
--- a/src/check-doc-syntax.sh
+++ b/src/check-doc-syntax.sh
@@ -47,13 +47,13 @@ if grep . /dev/null $FILES | sed -e '/<programlisting>/,/<\/programlisting>/d' |
echo " '$type_regexp'"
fi
-func_regexp='\([^#]\|^\)\<\(cairo_[][<>/0-9a-z_]*\> \?[^][ <>(]\)'
+func_regexp='\([^#]\|^\)\<\(cairo_[][<>/0-9a-z_]*\>[^][<>(]\)'
if test "x$SGML_DOCS" = x; then
- func_regexp='^[^:]*:[/ ][*] .*'$func_regexp
+ func_regexp='^[^:]*:[/ ][*]\(\|[ \t].*\)'$func_regexp
fi
# We need to filter out gtk-doc markup errors for program listings.
-if grep . /dev/null $FILES | sed -e '/<programlisting>/,/<\/programlisting>/d' | grep "$func_regexp" | grep -v '#####'; then
+if grep . /dev/null $FILES | sed -e '/<programlisting>/,/<\/programlisting>/d' | grep "$func_regexp" | grep -v '^[^:]*: [*] [a-z_0-9]*:$' | grep -v '#####'; then
status=1
echo Error: some function names in the docs are not followed by parentheses.
echo Fix this by searching for the following regexp in the above files:
commit 3f02e0d74b9b04f6e8ad32d12768aafa0076bd97
Author: Behdad Esfahbod <behdad at behdad.org>
Date: Sun Jun 1 18:46:45 2008 -0400
Fix newly detected doc syntax issues
diff --git a/src/cairo-array.c b/src/cairo-array.c
index 053e73e..1b2c903 100644
--- a/src/cairo-array.c
+++ b/src/cairo-array.c
@@ -236,7 +236,7 @@ _cairo_array_copy_element (cairo_array_t *array, int index, void *dst)
* _cairo_array_index (array, _cairo_array_num_elements (array) - 1);
*
* Return value: %CAIRO_STATUS_SUCCESS if successful or
- * CAIRO_STATUS_NO_MEMORY if insufficient memory is available for the
+ * %CAIRO_STATUS_NO_MEMORY if insufficient memory is available for the
* operation.
**/
cairo_status_t
@@ -256,7 +256,7 @@ _cairo_array_append (cairo_array_t *array,
* @elements into the array.
*
* Return value: %CAIRO_STATUS_SUCCESS if successful or
- * CAIRO_STATUS_NO_MEMORY if insufficient memory is available for the
+ * %CAIRO_STATUS_NO_MEMORY if insufficient memory is available for the
* operation.
**/
cairo_status_t
@@ -287,7 +287,7 @@ _cairo_array_append_multiple (cairo_array_t *array,
* for in the return value of _cairo_array_num_elements().
*
* Return value: %CAIRO_STATUS_SUCCESS if successful or
- * CAIRO_STATUS_NO_MEMORY if insufficient memory is available for the
+ * %CAIRO_STATUS_NO_MEMORY if insufficient memory is available for the
* operation.
**/
cairo_status_t
diff --git a/src/cairo-bentley-ottmann.c b/src/cairo-bentley-ottmann.c
index 208da7c..bc1f687 100644
--- a/src/cairo-bentley-ottmann.c
+++ b/src/cairo-bentley-ottmann.c
@@ -508,7 +508,7 @@ det64_128 (cairo_int64_t a,
* result is provided as a coordinate pair of 128-bit integers.
*
* Returns %CAIRO_BO_STATUS_INTERSECTION if there is an intersection or
- * CAIRO_BO_STATUS_PARALLEL if the two lines are exactly parallel.
+ * %CAIRO_BO_STATUS_PARALLEL if the two lines are exactly parallel.
*/
static cairo_bo_status_t
intersect_lines (cairo_bo_edge_t *a,
diff --git a/src/cairo-cache.c b/src/cairo-cache.c
index c87e20f..bb5c719 100644
--- a/src/cairo-cache.c
+++ b/src/cairo-cache.c
@@ -296,7 +296,7 @@ _cairo_cache_shrink_to_accommodate (cairo_cache_t *cache,
* entry_destroy() callback will be called on it).
*
* Return value: %CAIRO_STATUS_SUCCESS if successful or
- * CAIRO_STATUS_NO_MEMORY if insufficient memory is available.
+ * %CAIRO_STATUS_NO_MEMORY if insufficient memory is available.
**/
cairo_status_t
_cairo_cache_insert (cairo_cache_t *cache,
diff --git a/src/cairo-hash.c b/src/cairo-hash.c
index 8575499..2317eb1 100644
--- a/src/cairo-hash.c
+++ b/src/cairo-hash.c
@@ -296,7 +296,7 @@ _cairo_hash_table_lookup_internal (cairo_hash_table_t *hash_table,
* size.
*
* Return value: %CAIRO_STATUS_SUCCESS if successful or
- * CAIRO_STATUS_NO_MEMORY if out of memory.
+ * %CAIRO_STATUS_NO_MEMORY if out of memory.
**/
static cairo_status_t
_cairo_hash_table_resize (cairo_hash_table_t *hash_table)
@@ -401,7 +401,7 @@ _cairo_hash_table_lookup (cairo_hash_table_t *hash_table,
*
* Return value: a random live entry or %NULL if there are no entries
* that match the given predicate. In particular, if predicate is
- * NULL, a %NULL return value indicates that the table is empty.
+ * %NULL, a %NULL return value indicates that the table is empty.
**/
void *
_cairo_hash_table_random_entry (cairo_hash_table_t *hash_table,
@@ -459,7 +459,7 @@ _cairo_hash_table_random_entry (cairo_hash_table_t *hash_table,
* necessary, use _cairo_hash_table_remove first.
*
* Return value: %CAIRO_STATUS_SUCCESS if successful or
- * CAIRO_STATUS_NO_MEMORY if insufficient memory is available.
+ * %CAIRO_STATUS_NO_MEMORY if insufficient memory is available.
**/
cairo_status_t
_cairo_hash_table_insert (cairo_hash_table_t *hash_table,
@@ -504,7 +504,7 @@ _cairo_hash_table_insert (cairo_hash_table_t *hash_table,
* _cairo_hash_table_create).
*
* Return value: %CAIRO_STATUS_SUCCESS if successful or
- * CAIRO_STATUS_NO_MEMORY if out of memory.
+ * %CAIRO_STATUS_NO_MEMORY if out of memory.
**/
void
_cairo_hash_table_remove (cairo_hash_table_t *hash_table,
diff --git a/src/cairo-meta-surface.c b/src/cairo-meta-surface.c
index a7674cd..18a5b4b 100644
--- a/src/cairo-meta-surface.c
+++ b/src/cairo-meta-surface.c
@@ -962,7 +962,7 @@ _cairo_meta_surface_replay (cairo_surface_t *surface,
/* Replay meta to surface. When the return status of each operation is
* one of %CAIRO_STATUS_SUCCESS, %CAIRO_INT_STATUS_UNSUPPORTED, or
- * CAIRO_INT_STATUS_FLATTEN_TRANSPARENCY the status of each operation
+ * %CAIRO_INT_STATUS_FLATTEN_TRANSPARENCY the status of each operation
* will be stored in the meta surface. Any other status will abort the
* replay and return the status.
*/
diff --git a/src/cairo-pattern.c b/src/cairo-pattern.c
index 2685d49..1e4c8c2 100644
--- a/src/cairo-pattern.c
+++ b/src/cairo-pattern.c
@@ -64,7 +64,7 @@ const cairo_solid_pattern_t cairo_pattern_none = {
* _cairo_pattern_set_error:
* @pattern: a pattern
* @status: a status value indicating an error, (eg. not
- * CAIRO_STATUS_SUCCESS)
+ * %CAIRO_STATUS_SUCCESS)
*
* Atomically sets pattern->status to @status and calls _cairo_error;
*
diff --git a/src/cairo-png.c b/src/cairo-png.c
index 9476ab6..59e0419 100644
--- a/src/cairo-png.c
+++ b/src/cairo-png.c
@@ -274,7 +274,7 @@ stdio_write_func (png_structp png, png_bytep data, png_size_t size)
* Return value: %CAIRO_STATUS_SUCCESS if the PNG file was written
* successfully. Otherwise, %CAIRO_STATUS_NO_MEMORY if memory could not
* be allocated for the operation or
- * CAIRO_STATUS_SURFACE_TYPE_MISMATCH if the surface does not have
+ * %CAIRO_STATUS_SURFACE_TYPE_MISMATCH if the surface does not have
* pixel contents, or %CAIRO_STATUS_WRITE_ERROR if an I/O error occurs
* while attempting to write the file.
**/
@@ -341,7 +341,7 @@ stream_write_func (png_structp png, png_bytep data, png_size_t size)
* Return value: %CAIRO_STATUS_SUCCESS if the PNG file was written
* successfully. Otherwise, %CAIRO_STATUS_NO_MEMORY is returned if
* memory could not be allocated for the operation,
- * CAIRO_STATUS_SURFACE_TYPE_MISMATCH if the surface does not have
+ * %CAIRO_STATUS_SURFACE_TYPE_MISMATCH if the surface does not have
* pixel contents.
**/
cairo_status_t
@@ -615,9 +615,9 @@ stdio_read_func (png_structp png, png_bytep data, png_size_t size)
* surface can be checked for with cairo_surface_status(surface) which
* may return one of the following values:
*
- * CAIRO_STATUS_NO_MEMORY
- * CAIRO_STATUS_FILE_NOT_FOUND
- * CAIRO_STATUS_READ_ERROR
+ * %CAIRO_STATUS_NO_MEMORY
+ * %CAIRO_STATUS_FILE_NOT_FOUND
+ * %CAIRO_STATUS_READ_ERROR
**/
cairo_surface_t *
cairo_image_surface_create_from_png (const char *filename)
diff --git a/src/cairo-scaled-font-subsets-private.h b/src/cairo-scaled-font-subsets-private.h
index 733fe1e..235343e 100644
--- a/src/cairo-scaled-font-subsets-private.h
+++ b/src/cairo-scaled-font-subsets-private.h
@@ -180,7 +180,7 @@ _cairo_scaled_font_subsets_destroy (cairo_scaled_font_subsets_t *font_subsets);
*
* Return value: %CAIRO_STATUS_SUCCESS if successful, or a non-zero
* value indicating an error. Possible errors include
- * CAIRO_STATUS_NO_MEMORY.
+ * %CAIRO_STATUS_NO_MEMORY.
**/
cairo_private cairo_status_t
_cairo_scaled_font_subsets_map_glyph (cairo_scaled_font_subsets_t *font_subsets,
@@ -220,7 +220,7 @@ typedef cairo_status_t
*
* Return value: %CAIRO_STATUS_SUCCESS if successful, or a non-zero
* value indicating an error. Possible errors include
- * CAIRO_STATUS_NO_MEMORY.
+ * %CAIRO_STATUS_NO_MEMORY.
**/
cairo_private cairo_status_t
_cairo_scaled_font_subsets_foreach_scaled (cairo_scaled_font_subsets_t *font_subsets,
@@ -255,7 +255,7 @@ _cairo_scaled_font_subsets_foreach_scaled (cairo_scaled_font_subsets_t *fon
*
* Return value: %CAIRO_STATUS_SUCCESS if successful, or a non-zero
* value indicating an error. Possible errors include
- * CAIRO_STATUS_NO_MEMORY.
+ * %CAIRO_STATUS_NO_MEMORY.
**/
cairo_private cairo_status_t
_cairo_scaled_font_subsets_foreach_unscaled (cairo_scaled_font_subsets_t *font_subsets,
@@ -270,7 +270,7 @@ _cairo_scaled_font_subsets_foreach_unscaled (cairo_scaled_font_subsets_t
* in @font_subsets. The array as store in font_subsets->glyph_names.
*
* Return value: %CAIRO_STATUS_SUCCESS if successful,
- * CAIRO_INT_STATUS_UNSUPPORTED if the font backend does not support
+ * %CAIRO_INT_STATUS_UNSUPPORTED if the font backend does not support
* mapping the glyph indices to unicode characters. Possible errors
* include %CAIRO_STATUS_NO_MEMORY.
**/
@@ -298,7 +298,7 @@ typedef struct _cairo_cff_subset {
* data.
*
* Return value: %CAIRO_STATUS_SUCCESS if successful,
- * CAIRO_INT_STATUS_UNSUPPORTED if the font can't be subset as a
+ * %CAIRO_INT_STATUS_UNSUPPORTED if the font can't be subset as a
* cff file, or an non-zero value indicating an error. Possible
* errors include %CAIRO_STATUS_NO_MEMORY.
**/
@@ -329,7 +329,7 @@ _cairo_cff_subset_fini (cairo_cff_subset_t *cff_subset);
* with information about the subset and the cff data.
*
* Return value: %CAIRO_STATUS_SUCCESS if successful,
- * CAIRO_INT_STATUS_UNSUPPORTED if the font can't be subset as a
+ * %CAIRO_INT_STATUS_UNSUPPORTED if the font can't be subset as a
* cff file, or an non-zero value indicating an error. Possible
* errors include %CAIRO_STATUS_NO_MEMORY.
**/
@@ -372,7 +372,7 @@ typedef struct _cairo_truetype_subset {
* data.
*
* Return value: %CAIRO_STATUS_SUCCESS if successful,
- * CAIRO_INT_STATUS_UNSUPPORTED if the font can't be subset as a
+ * %CAIRO_INT_STATUS_UNSUPPORTED if the font can't be subset as a
* truetype file, or an non-zero value indicating an error. Possible
* errors include %CAIRO_STATUS_NO_MEMORY.
**/
@@ -416,7 +416,7 @@ typedef struct _cairo_type1_subset {
* with information about the subset and the type1 data.
*
* Return value: %CAIRO_STATUS_SUCCESS if successful,
- * CAIRO_INT_STATUS_UNSUPPORTED if the font can't be subset as a type1
+ * %CAIRO_INT_STATUS_UNSUPPORTED if the font can't be subset as a type1
* file, or an non-zero value indicating an error. Possible errors
* include %CAIRO_STATUS_NO_MEMORY.
**/
@@ -458,7 +458,7 @@ _cairo_type1_scaled_font_is_type1 (cairo_scaled_font_t *scaled_font);
* part of the font is binary encoded.
*
* Return value: %CAIRO_STATUS_SUCCESS if successful,
- * CAIRO_INT_STATUS_UNSUPPORTED if the font can't be subset as a type1
+ * %CAIRO_INT_STATUS_UNSUPPORTED if the font can't be subset as a type1
* file, or an non-zero value indicating an error. Possible errors
* include %CAIRO_STATUS_NO_MEMORY.
**/
@@ -479,7 +479,7 @@ _cairo_type1_fallback_init_binary (cairo_type1_subset_t *type_subset,
* part of the font is hex encoded.
*
* Return value: %CAIRO_STATUS_SUCCESS if successful,
- * CAIRO_INT_STATUS_UNSUPPORTED if the font can't be subset as a type1
+ * %CAIRO_INT_STATUS_UNSUPPORTED if the font can't be subset as a type1
* file, or an non-zero value indicating an error. Possible errors
* include %CAIRO_STATUS_NO_MEMORY.
**/
@@ -517,7 +517,7 @@ typedef struct _cairo_type2_charstrings {
* with information about the subset.
*
* Return value: %CAIRO_STATUS_SUCCESS if successful,
- * CAIRO_INT_STATUS_UNSUPPORTED if the font can't be subset as a type2
+ * %CAIRO_INT_STATUS_UNSUPPORTED if the font can't be subset as a type2
* charstrings, or an non-zero value indicating an error. Possible errors
* include %CAIRO_STATUS_NO_MEMORY.
**/
@@ -546,9 +546,9 @@ _cairo_type2_charstrings_fini (cairo_type2_charstrings_t *charstrings);
* fontsubset->to_unicode.
*
* Return value: %CAIRO_STATUS_SUCCESS if successful,
- * CAIRO_INT_STATUS_UNSUPPORTED if the unicode encoding of
+ * %CAIRO_INT_STATUS_UNSUPPORTED if the unicode encoding of
* the glyphs is not available. Possible errors include
- * CAIRO_STATUS_NO_MEMORY.
+ * %CAIRO_STATUS_NO_MEMORY.
**/
cairo_private cairo_int_status_t
_cairo_truetype_create_glyph_to_unicode_map (cairo_scaled_font_subset_t *font_subset);
diff --git a/src/cairo-scaled-font.c b/src/cairo-scaled-font.c
index 33ee9af..bfdf17b 100644
--- a/src/cairo-scaled-font.c
+++ b/src/cairo-scaled-font.c
@@ -209,7 +209,7 @@ static const cairo_scaled_font_t _cairo_scaled_font_nil = {
* _cairo_scaled_font_set_error:
* @scaled_font: a scaled_font
* @status: a status value indicating an error, (eg. not
- * CAIRO_STATUS_SUCCESS)
+ * %CAIRO_STATUS_SUCCESS)
*
* Atomically sets scaled_font->status to @status and calls _cairo_error;
*
@@ -1789,7 +1789,7 @@ _cairo_scaled_font_glyph_path (cairo_scaled_font_t *scaled_font,
}
/**
- * cairo_scaled_glyph_set_metrics:
+ * _cairo_scaled_glyph_set_metrics:
* @scaled_glyph: a #cairo_scaled_glyph_t
* @scaled_font: a #cairo_scaled_font_t
* @fs_metrics: a #cairo_text_extents_t in font space
@@ -1797,7 +1797,7 @@ _cairo_scaled_font_glyph_path (cairo_scaled_font_t *scaled_font,
* _cairo_scaled_glyph_set_metrics() stores user space metrics
* for the specified glyph given font space metrics. It is
* called by the font backend when initializing a glyph with
- * CAIRO_SCALED_GLYPH_INFO_METRICS.
+ * %CAIRO_SCALED_GLYPH_INFO_METRICS.
**/
void
_cairo_scaled_glyph_set_metrics (cairo_scaled_glyph_t *scaled_glyph,
@@ -1921,7 +1921,7 @@ _cairo_scaled_glyph_set_meta_surface (cairo_scaled_glyph_t *scaled_glyph,
*
* If the desired info is not available, (for example, when trying to
* get INFO_PATH with a bitmapped font), this function will return
- * CAIRO_INT_STATUS_UNSUPPORTED.
+ * %CAIRO_INT_STATUS_UNSUPPORTED.
*
* Note: This function must be called with scaled_font->mutex held.
**/
diff --git a/src/cairo-surface.c b/src/cairo-surface.c
index 86aeff9..27fe68d 100644
--- a/src/cairo-surface.c
+++ b/src/cairo-surface.c
@@ -97,7 +97,7 @@ _cairo_surface_copy_pattern_for_destination (const cairo_pattern_t *pattern,
* _cairo_surface_set_error:
* @surface: a surface
* @status: a status value indicating an error, (eg. not
- * CAIRO_STATUS_SUCCESS)
+ * %CAIRO_STATUS_SUCCESS)
*
* Atomically sets surface->status to @status and calls _cairo_error;
*
@@ -1788,7 +1788,7 @@ _cairo_surface_get_current_clip_serial (cairo_surface_t *surface)
* this function allocates one from the specified surface. As zero is
* reserved for the special no-clipping case, this function will not
* return that except for an in-error surface, (ie. surface->status !=
- * CAIRO_STATUS_SUCCESS).
+ * %CAIRO_STATUS_SUCCESS).
*/
unsigned int
_cairo_surface_allocate_clip_serial (cairo_surface_t *surface)
diff --git a/src/cairo.c b/src/cairo.c
index e03ad26..48bc58b 100644
--- a/src/cairo.c
+++ b/src/cairo.c
@@ -66,7 +66,7 @@ static const cairo_t _cairo_nil = {
/**
* _cairo_error:
* @status: a status value indicating an error, (eg. not
- * CAIRO_STATUS_SUCCESS)
+ * %CAIRO_STATUS_SUCCESS)
*
* Checks that status is an error status, but does nothing else.
*
@@ -93,7 +93,7 @@ _cairo_error (cairo_status_t status)
* _cairo_set_error:
* @cr: a cairo context
* @status: a status value indicating an error, (eg. not
- * CAIRO_STATUS_SUCCESS)
+ * %CAIRO_STATUS_SUCCESS)
*
* Atomically sets cr->status to @status and calls _cairo_error;
*
@@ -426,7 +426,7 @@ slim_hidden_def(cairo_restore);
* group, (the pop_group functions call cairo_restore()).
*
* By default the intermediate group will have a content type of
- * CAIRO_CONTENT_COLOR_ALPHA. Other content types can be chosen for
+ * %CAIRO_CONTENT_COLOR_ALPHA. Other content types can be chosen for
* the group by using cairo_push_group_with_content() instead.
*
* As an example, here is how one might fill and stroke a path with
@@ -1673,7 +1673,7 @@ cairo_arc_to (cairo_t *cr,
*
* It is an error to call this function with no current point. Doing
* so will cause @cr to shutdown with a status of
- * CAIRO_STATUS_NO_CURRENT_POINT.
+ * %CAIRO_STATUS_NO_CURRENT_POINT.
**/
void
cairo_rel_move_to (cairo_t *cr, double dx, double dy)
@@ -1710,7 +1710,7 @@ cairo_rel_move_to (cairo_t *cr, double dx, double dy)
*
* It is an error to call this function with no current point. Doing
* so will cause @cr to shutdown with a status of
- * CAIRO_STATUS_NO_CURRENT_POINT.
+ * %CAIRO_STATUS_NO_CURRENT_POINT.
**/
void
cairo_rel_line_to (cairo_t *cr, double dx, double dy)
@@ -1756,7 +1756,7 @@ slim_hidden_def(cairo_rel_line_to);
*
* It is an error to call this function with no current point. Doing
* so will cause @cr to shutdown with a status of
- * CAIRO_STATUS_NO_CURRENT_POINT.
+ * %CAIRO_STATUS_NO_CURRENT_POINT.
**/
void
cairo_rel_curve_to (cairo_t *cr,
@@ -2098,7 +2098,7 @@ cairo_mask_surface (cairo_t *cr,
* 2. A sub-path created by cairo_move_to() followed by either a
* cairo_close_path() or one or more calls to cairo_line_to() to the
* same coordinate as the cairo_move_to(). If the cap style is
- * CAIRO_LINE_CAP_ROUND then these sub-paths will be drawn as circular
+ * %CAIRO_LINE_CAP_ROUND then these sub-paths will be drawn as circular
* dots. Note that in the case of %CAIRO_LINE_CAP_SQUARE a degenerate
* sub-path will not be drawn at all, (since the correct orientation
* is indeterminate).
diff --git a/src/cairo.h b/src/cairo.h
index 3e21e27..63cf303 100644
--- a/src/cairo.h
+++ b/src/cairo.h
@@ -278,8 +278,8 @@ typedef enum _cairo_content {
* closure which was specified by the user at the time the write
* function was registered, the data to write and the length of the
* data in bytes. The write function should return
- * CAIRO_STATUS_SUCCESS if all the data was successfully written,
- * CAIRO_STATUS_WRITE_ERROR otherwise.
+ * %CAIRO_STATUS_SUCCESS if all the data was successfully written,
+ * %CAIRO_STATUS_WRITE_ERROR otherwise.
*
* Returns: the status code of the write operation
**/
@@ -298,8 +298,8 @@ typedef cairo_status_t (*cairo_write_func_t) (void *closure,
* closure which was specified by the user at the time the read
* function was registered, the buffer to read the data into and the
* length of the data in bytes. The read function should return
- * CAIRO_STATUS_SUCCESS if all the data was successfully read,
- * CAIRO_STATUS_READ_ERROR otherwise.
+ * %CAIRO_STATUS_SUCCESS if all the data was successfully read,
+ * %CAIRO_STATUS_READ_ERROR otherwise.
*
* Returns: the status code of the read operation
**/
commit b37c7557303e750c672648fe00922262d2a56a5a
Author: Behdad Esfahbod <behdad at behdad.org>
Date: Sun Jun 1 18:46:23 2008 -0400
[src/check-doc-syntax.sh] Detect malformatted enums starting the line
diff --git a/src/check-doc-syntax.sh b/src/check-doc-syntax.sh
index 1e5e76a..e91d25c 100755
--- a/src/check-doc-syntax.sh
+++ b/src/check-doc-syntax.sh
@@ -23,7 +23,7 @@ fi
enum_regexp='\([^%@]\|^\)\<\(FALSE\|TRUE\|NULL\|CAIRO_[0-9A-Z_]*\)\($\|[^(A-Za-z0-9_]\)'
if test "x$SGML_DOCS" = x; then
- enum_regexp='^[^:]*:[/ ][*] .*'$enum_regexp
+ enum_regexp='^[^:]*:[/ ][*]\(\|[ \t].*\)'$enum_regexp
fi
if grep . /dev/null $FILES | sed -e '/<programlisting>/,/<\/programlisting>/d' | grep "$enum_regexp" | grep -v '#####'; then
status=1
More information about the cairo-commit
mailing list