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

diff --git a/src/cairo-version.c b/src/cairo-version.c
index bc7fe109e..11f919d2e 100644
--- a/src/cairo-version.c
+++ b/src/cairo-version.c
@@ -137,39 +137,39 @@
  * </programlisting></informalexample>
  * </para>
  * </refsect2>
- */
+ **/
 
 /**
  * CAIRO_VERSION:
  *
  * The version of cairo available at compile-time, encoded using
  * CAIRO_VERSION_ENCODE().
- */
+ **/
 
 /**
  * CAIRO_VERSION_MAJOR:
  *
  * The major component of the version of cairo available at compile-time.
- */
+ **/
 
 /**
  * CAIRO_VERSION_MINOR:
  *
  * The minor component of the version of cairo available at compile-time.
- */
+ **/
 
 /**
  * CAIRO_VERSION_MICRO:
  *
  * The micro component of the version of cairo available at compile-time.
- */
+ **/
 
 /**
  * CAIRO_VERSION_STRING:
  *
  * A human-readable string literal containing the version of cairo available
  * at compile-time, in the form of "X.Y.Z".
- */
+ **/
 
 /**
  * CAIRO_VERSION_ENCODE:
@@ -183,7 +183,7 @@
  * that later versions compare greater than earlier versions.
  *
  * @Returns: the encoded version.
- */
+ **/
 
 /**
  * CAIRO_VERSION_STRINGIZE:
@@ -198,7 +198,7 @@
  * @Returns: a string literal containing the version.
  *
  * @Since: 1.8
- */
+ **/
 
 /**
  * cairo_version: