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-device.c b/src/cairo-device.c
index fd1ec71de..098f85601 100644
--- a/src/cairo-device.c
+++ b/src/cairo-device.c
@@ -92,7 +92,7 @@
  * interactions with existing surface API of the device functions for
  * surfaces of that type.
  * </para></note>
- */
+ **/
 
 static const cairo_device_t _nil_device = {
     CAIRO_REFERENCE_COUNT_INVALID,