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-user-font.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-user-font.c')
-rw-r--r-- | src/cairo-user-font.c | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/cairo-user-font.c b/src/cairo-user-font.c index 1b507fcee..bdac6e40f 100644 --- a/src/cairo-user-font.c +++ b/src/cairo-user-font.c @@ -49,7 +49,7 @@ * in a font. This is most useful in implementing fonts in non-standard * formats, like SVG fonts and Flash fonts, but can also be used by games and * other application to draw "funky" fonts. - */ + **/ /** * CAIRO_HAS_USER_FONT: @@ -60,7 +60,7 @@ * this feature (1.8 and later). * * @Since: 1.8 - */ + **/ typedef struct _cairo_user_scaled_font_methods { cairo_user_scaled_font_init_func_t init; |