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.

1 files changed, 2 insertions, 2 deletions

diff --git a/src/cairo-script-surface.c b/src/cairo-script-surface.c
index f235be97..e307c1b8 100644
--- a/src/cairo-script-surface.c
+++ b/src/cairo-script-surface.c
@@ -52,7 +52,7 @@
  * script that matches the cairo drawing model. The scripts can
  * be replayed using tools under the util/cairo-script directoriy,
  * or with cairo-perf-trace.
- */
+ **/
 
 /**
  * CAIRO_HAS_SCRIPT_SURFACE:
@@ -61,7 +61,7 @@
  * The script surface backend is always built in since 1.12.
  *
  * @Since: 1.10
- */
+ **/
 
 
 #include "cairoint.h"