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-gstate.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-gstate.c')
-rw-r--r-- | src/cairo-gstate.c | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/cairo-gstate.c b/src/cairo-gstate.c index d232f9b51..a2ec371b6 100644 --- a/src/cairo-gstate.c +++ b/src/cairo-gstate.c @@ -382,7 +382,7 @@ _cairo_gstate_get_original_target (cairo_gstate_t *gstate) * This space left intentionally blank. * * Return value: a pointer to the gstate's #cairo_clip_t structure. - */ + **/ cairo_clip_t * _cairo_gstate_get_clip (cairo_gstate_t *gstate) { |