summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLubomir Rintel <lkundrak@v3.sk>2017-03-10 20:08:11 +0100
committerLubomir Rintel <lkundrak@v3.sk>2017-03-17 10:15:11 +0100
commita1c5f43501958a2546c4da8fbab9224215d44973 (patch)
tree8767644742cada861fe7b8e0c9e2e7def671732d
parent7bd69aa08d99583c9824ab4145fcba1ff089b497 (diff)
downloadNetworkManager-a1c5f43501958a2546c4da8fbab9224215d44973.tar.gz
libnm/generate-setting-docs.py: include description attribute
-rwxr-xr-xlibnm/generate-setting-docs.py9
1 files changed, 6 insertions, 3 deletions
diff --git a/libnm/generate-setting-docs.py b/libnm/generate-setting-docs.py
index 0a4adae3a4..86fe08cde1 100755
--- a/libnm/generate-setting-docs.py
+++ b/libnm/generate-setting-docs.py
@@ -112,7 +112,7 @@ def get_prop_type(setting, pspec, propxml):
return prop_type
-def get_docs(setting, pspec, propxml):
+def get_docs(propxml):
doc_xml = propxml.find('gi:doc', ns_map)
if doc_xml is None:
return None
@@ -215,7 +215,10 @@ for settingxml in settings:
new_func = NM.__getattr__(settingxml.attrib['name'])
setting = new_func()
- outfile.write(" <setting name=\"%s\">\n" % setting.props.name)
+ class_desc = get_docs(settingxml)
+ if class_desc is None:
+ raise Exception("%s needs a gtk-doc block with one-line description" % setting.props.name)
+ outfile.write(" <setting name=\"%s\" description=\"%s\">\n" % (setting.props.name, class_desc))
setting_properties = { prop.name: prop for prop in GObject.list_properties(setting) }
if args.overrides is None:
@@ -239,7 +242,7 @@ for settingxml in settings:
propxml = ipxml.find('./gi:property[@name="%s"]' % pspec.name, ns_map)
value_type = get_prop_type(setting, pspec, propxml)
- value_desc = get_docs(setting, pspec, propxml)
+ value_desc = get_docs(propxml)
default_value = get_default_value(setting, pspec, propxml)
if prop in setting_overrides: