diff options
| author | Andrea Canciani <ranma42@gmail.com> | 2012-02-16 00:31:47 +0100 |
|---|---|---|
| committer | Andrea Canciani <ranma42@gmail.com> | 2012-03-29 11:03:18 +0200 |
| commit | f717341ab9fec1f4a72fe18f5e712272c831d978 (patch) | |
| tree | aaa6335d44b56e63f3c046c28d96092560a69502 /src/cairo.c | |
| parent | c0fc24c889b09b734383c9250a3663d83510479e (diff) | |
| download | cairo-f717341ab9fec1f4a72fe18f5e712272c831d978.tar.gz | |
doc: Make documentation comments symmetric
Documentation comments should always start with "/**" and end with
"**/". This is not required by gtk-doc, but it makes the
documentations formatting more consistent and simplifies the checking
of documentation comments.
The following Python script tries to enforce this.
from sys import argv
from sre import search
for filename in argv[1:]:
in_doc = False
lines = open(filename, "r").read().split("\n")
for i in range(len(lines)):
ls = lines[i].strip()
if ls == "/**":
in_doc = True
elif in_doc and ls == "*/":
lines[i] = " **/"
if ls.endswith("*/"):
in_doc = False
out = open(filename, "w")
out.write("\n".join(lines))
out.close()
This fixes most 'documentation comment not closed with **/' warnings
by check-doc-syntax.awk.
Diffstat (limited to 'src/cairo.c')
| -rw-r--r-- | src/cairo.c | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/cairo.c b/src/cairo.c index 002d199fd..08ecff32d 100644 --- a/src/cairo.c +++ b/src/cairo.c @@ -65,7 +65,7 @@ * #cairo_t<!-- -->'s can be pushed to a stack via cairo_save(). * They may then safely be changed, without losing the current state. * Use cairo_restore() to restore to the saved state. - */ + **/ /** * SECTION:cairo-text @@ -92,7 +92,7 @@ * the pangocairo that is part of the Pango text layout and rendering library. * Pango is available from <ulink * url="http://www.pango.org/">http://www.pango.org/</ulink>. - */ + **/ /** * SECTION:cairo-transforms @@ -105,7 +105,7 @@ * drawing instruments from the <firstterm>user space</firstterm> into the * surface's canonical coordinate system, also known as the <firstterm>device * space</firstterm>. - */ + **/ #define DEFINE_NIL_CONTEXT(status) \ { \ @@ -468,7 +468,7 @@ slim_hidden_def(cairo_restore); * </programlisting></informalexample> * * Since: 1.2 - */ + **/ void cairo_push_group (cairo_t *cr) { @@ -493,7 +493,7 @@ cairo_push_group (cairo_t *cr) * detailed description of group rendering. * * Since: 1.2 - */ + **/ void cairo_push_group_with_content (cairo_t *cr, cairo_content_t content) { @@ -1052,7 +1052,7 @@ cairo_set_dash (cairo_t *cr, * Return value: the length of the dash array, or 0 if no dash array set. * * Since: 1.4 - */ + **/ int cairo_get_dash_count (cairo_t *cr) { @@ -1951,7 +1951,7 @@ cairo_paint_with_alpha (cairo_t *cr, * using the alpha channel of @pattern as a mask. (Opaque * areas of @pattern are painted with the source, transparent * areas are not painted.) - */ + **/ void cairo_mask (cairo_t *cr, cairo_pattern_t *pattern) @@ -1988,7 +1988,7 @@ slim_hidden_def (cairo_mask); * using the alpha channel of @surface as a mask. (Opaque * areas of @surface are painted with the source, transparent * areas are not painted.) - */ + **/ void cairo_mask_surface (cairo_t *cr, cairo_surface_t *surface, |