mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-18 14:26:43 +00:00
79 lines
2.4 KiB
Python
79 lines
2.4 KiB
Python
|
#!/usr/bin/env python
|
||
|
|
# -*- Mode: Python; py-indent-offset: 4 -*-
|
||
|
|
#
|
||
|
|
# This litte script outputs the C doc comments to an XML format.
|
||
|
|
# So far it's only used by gtkmm (The C++ bindings). Murray Cumming.
|
||
|
|
# Usage example:
|
||
|
|
# # ./docextract_to_xml.py -s /gnome/head/cvs/gtk+/gtk/ -s /gnome/head/cvs/gtk+/docs/reference/gtk/tmpl/ > gtk_docs.xml
|
||
|
|
|
||
|
|
import sys, os, string, re, getopt
|
||
|
|
|
||
|
|
import docextract
|
||
|
|
import string
|
||
|
|
|
||
|
|
def escape_text(unescaped_text):
|
||
|
|
escaped_text = unescaped_text
|
||
|
|
escaped_text = string.replace(escaped_text, '<', '<')
|
||
|
|
escaped_text = string.replace(escaped_text, '>', '>')
|
||
|
|
escaped_text = string.replace(escaped_text, '&', '&')
|
||
|
|
escaped_text = string.replace(escaped_text, '\'', ''')
|
||
|
|
escaped_text = string.replace(escaped_text, '\"', '"')
|
||
|
|
|
||
|
|
#Apparently this is an undefined symbol:
|
||
|
|
escaped_text = string.replace(escaped_text, '—', ' mdash ')
|
||
|
|
|
||
|
|
return escaped_text
|
||
|
|
|
||
|
|
if __name__ == '__main__':
|
||
|
|
try:
|
||
|
|
opts, args = getopt.getopt(sys.argv[1:], "d:s:o:",
|
||
|
|
["source-dir="])
|
||
|
|
except getopt.error, e:
|
||
|
|
sys.stderr.write('docgen.py: %s\n' % e)
|
||
|
|
sys.stderr.write(
|
||
|
|
'usage: docgen.py [-s /src/dir]\n')
|
||
|
|
sys.exit(1)
|
||
|
|
source_dirs = []
|
||
|
|
for opt, arg in opts:
|
||
|
|
if opt in ('-s', '--source-dir'):
|
||
|
|
source_dirs.append(arg)
|
||
|
|
if len(args) != 0:
|
||
|
|
sys.stderr.write(
|
||
|
|
'usage: docgen.py [-s /src/dir]\n')
|
||
|
|
sys.exit(1)
|
||
|
|
|
||
|
|
docs = docextract.extract(source_dirs);
|
||
|
|
docextract.extract_tmpl(source_dirs, docs); #Try the tmpl sgml files too.
|
||
|
|
|
||
|
|
# print d.docs
|
||
|
|
|
||
|
|
if docs:
|
||
|
|
|
||
|
|
print "<root>"
|
||
|
|
|
||
|
|
for name, value in docs.items():
|
||
|
|
print "<function name=\"" + escape_text(name) + "\">"
|
||
|
|
|
||
|
|
print "<description>"
|
||
|
|
#The value is a docextract.FunctionDoc
|
||
|
|
print escape_text(value.description)
|
||
|
|
print "</description>"
|
||
|
|
|
||
|
|
# Loop through the parameters:
|
||
|
|
print "<parameters>"
|
||
|
|
for name, description in value.params:
|
||
|
|
print "<parameter name=\"" + escape_text(name) + "\">"
|
||
|
|
print "<parameter_description>" + escape_text(description) + "</parameter_description>"
|
||
|
|
print "</parameter>"
|
||
|
|
|
||
|
|
print "</parameters>"
|
||
|
|
|
||
|
|
# Show the return-type:
|
||
|
|
print "<return>" + escape_text(value.ret) + "</return>"
|
||
|
|
|
||
|
|
print "</function>\n"
|
||
|
|
|
||
|
|
print "</root>"
|
||
|
|
|
||
|
|
|