summaryrefslogtreecommitdiff
path: root/src/cairo-misc.c
diff options
context:
space:
mode:
authorAndrea Canciani <ranma42@gmail.com>2012-03-27 11:48:19 +0200
committerAndrea Canciani <ranma42@gmail.com>2012-03-29 11:03:18 +0200
commit1d3d64469f3ddac282860f66b24a35cf2253fa46 (patch)
treeb9547d1352d4afbab644a618c70785f6d754a524 /src/cairo-misc.c
parent79740139e05375c4ce3542b571bc6a1e9d9137a7 (diff)
downloadcairo-1d3d64469f3ddac282860f66b24a35cf2253fa46.tar.gz
doc: Add "since" tag to documentation
The following Python script was used to compute "Since: 1.X" tags, based on the first version where a symbol became officially supported. This script requires a concatenation of the the cairo public headers for the officially supported beckends to be available as "../../includes/1.X.0.h". from sys import argv import re syms = {} def stripcomments(text): def replacer(match): s = match.group(0) if s.startswith('/'): return "" else: return s pattern = re.compile( r'//.*?$|/\*.*?\*/|\'(?:\\.|[^\\\'])*\'|"(?:\\.|[^\\"])*"', re.DOTALL | re.MULTILINE ) return re.sub(pattern, replacer, text) for minor in range(12,-2,-2): version = "1.%d" % minor names = re.split('([A-Za-z0-9_]+)', stripcomments(open("../../includes/%s.0.h" % version).read())) for s in names: syms[s] = version for filename in argv[1:]: is_public = False lines = open(filename, "r").read().split("\n") newlines = [] for i in range(len(lines)): if lines[i] == "/**": last_sym = lines[i+1][2:].strip().replace(":", "") is_public = last_sym.lower().startswith("cairo") elif is_public and lines[i] == " **/": if last_sym in syms: v = syms[last_sym] if re.search("Since", newlines[-1]): newlines = newlines[:-1] if newlines[-1].strip() != "*": newlines.append(" *") newlines.append(" * Since: %s" % v) else: print "%s (%d): Cannot determine the version in which '%s' was introduced" % (filename, i, last_sym) newlines.append(lines[i]) out = open(filename, "w") out.write("\n".join(newlines)) out.close()
Diffstat (limited to 'src/cairo-misc.c')
-rw-r--r--src/cairo-misc.c2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/cairo-misc.c b/src/cairo-misc.c
index 60edaae93..bb37e1a0a 100644
--- a/src/cairo-misc.c
+++ b/src/cairo-misc.c
@@ -73,6 +73,8 @@ COMPILE_TIME_ASSERT (CAIRO_INT_STATUS_LAST_STATUS <= 127);
* Provides a human-readable description of a #cairo_status_t.
*
* Returns: a string representation of the status
+ *
+ * Since: 1.0
**/
const char *
cairo_status_to_string (cairo_status_t status)