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-png.c b/src/cairo-png.c
index 59bbe686d..b36c8df44 100644
--- a/src/cairo-png.c
+++ b/src/cairo-png.c
@@ -62,7 +62,7 @@
  * cairo_image_surface_get_data() or a backend-specific access
  * function, and process it with another library, e.g. gdk-pixbuf or
  * libpng.
- */
+ **/
 
 /**
  * CAIRO_HAS_PNG_FUNCTIONS:
@@ -70,7 +70,7 @@
  * Defined if the PNG functions are available.
  * This macro can be used to conditionally compile code using the cairo
  * PNG functions.
- */
+ **/
 
 struct png_read_closure_t {
     cairo_read_func_t		 read_func;