summaryrefslogtreecommitdiff
path: root/src/cairo-ps.h
diff options
context:
space:
mode:
authorAndrea Canciani <ranma42@gmail.com>2012-02-16 00:31:47 +0100
committerAndrea Canciani <ranma42@gmail.com>2012-03-29 11:03:18 +0200
commitf717341ab9fec1f4a72fe18f5e712272c831d978 (patch)
treeaaa6335d44b56e63f3c046c28d96092560a69502 /src/cairo-ps.h
parentc0fc24c889b09b734383c9250a3663d83510479e (diff)
downloadcairo-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-ps.h')
-rw-r--r--src/cairo-ps.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/cairo-ps.h b/src/cairo-ps.h
index fd1d21deb..edd1e95d0 100644
--- a/src/cairo-ps.h
+++ b/src/cairo-ps.h
@@ -55,7 +55,7 @@ CAIRO_BEGIN_DECLS
* #cairo_ps_level_t is used to describe the language level of the
* PostScript Language Reference that a generated PostScript file will
* conform to.
- */
+ **/
typedef enum _cairo_ps_level {
CAIRO_PS_LEVEL_2,
CAIRO_PS_LEVEL_3