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, 1 insertions, 1 deletions

diff --git a/src/cairo-types-private.h b/src/cairo-types-private.h
index 7fcdd1d69..3c2d21a38 100644
--- a/src/cairo-types-private.h
+++ b/src/cairo-types-private.h
@@ -52,7 +52,7 @@ CAIRO_BEGIN_DECLS
  * @Short_Description: Generic data types
  *
  * This section lists generic data types used in the cairo API.
- */
+ **/
 
 typedef struct _cairo_array cairo_array_t;
 typedef struct _cairo_backend cairo_backend_t;