diff options
| author | Tomeu Vizoso <tomeu.vizoso@collabora.com> | 2012-02-20 12:21:41 +0100 |
|---|---|---|
| committer | Tomeu Vizoso <tomeu.vizoso@collabora.com> | 2012-02-20 12:21:41 +0100 |
| commit | fb98a4f19da972709ac56b89a1184624e23bc224 (patch) | |
| tree | c4b547682b24a74a4c873616cfbd3f760ca9572f | |
| parent | 1ff74fb0a469f3f1f00692e20834cce3bd7b212a (diff) | |
| download | gobject-introspection-fb98a4f19da972709ac56b89a1184624e23bc224.tar.gz | |
g-ir-doc-tool: Show how to construct instances in the Class page
| -rw-r--r-- | giscanner/mallard-Python-class.tmpl | 18 | ||||
| -rw-r--r-- | giscanner/mallardwriter.py | 4 | ||||
| -rw-r--r-- | tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.page | 8 |
3 files changed, 20 insertions, 10 deletions
diff --git a/giscanner/mallard-Python-class.tmpl b/giscanner/mallard-Python-class.tmpl index 1dd8644d..d45b0ab6 100644 --- a/giscanner/mallard-Python-class.tmpl +++ b/giscanner/mallard-Python-class.tmpl @@ -21,11 +21,19 @@ ${formatter.format(node.doc)} </item> </tree> </synopsis> - <links type="topic" ui:expanded="yes" - api:type="function" api:mime="text/x-python" - groups="constructor" style="linklist"> - <title>Constructors</title> - </links> + <p>Constructor</p> + <synopsis><code mime="text/x-python"> +${formatter.to_underscores(node.name).lower()} = ${node.name}(\ +% for property_, ix in zip(node.properties, range(len(node.properties))): +% if property_.construct or property_.construct_only or property_.writable: +${property_.name.replace('-', '_')}=value\ +% if ix != len(node.properties) - 1: +, \ +% endif +% endif +% endfor +)\ + </code></synopsis> <links type="topic" ui:expanded="yes" api:type="function" api:mime="text/x-python" groups="method" style="linklist"> diff --git a/giscanner/mallardwriter.py b/giscanner/mallardwriter.py index fcfd2368..351a8c1f 100644 --- a/giscanner/mallardwriter.py +++ b/giscanner/mallardwriter.py @@ -30,6 +30,7 @@ from mako.template import Template from mako.runtime import supports_caller from . import ast +from .utils import to_underscores class MallardFormatter(object): def __init__(self, namespace): @@ -90,6 +91,9 @@ class MallardFormatter(object): return " / ".join(flags) + def to_underscores(self, string): + return to_underscores(string) + class MallardFormatterC(MallardFormatter): def format_type(self, type_): diff --git a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.page b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.page index b194a079..eb466270 100644 --- a/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.page +++ b/tests/doctool/GIRepository-2.0-Python-expected/GIRepository.Repository.page @@ -18,11 +18,9 @@ </item> </tree> </synopsis> - <links type="topic" ui:expanded="yes" - api:type="function" api:mime="text/x-python" - groups="constructor" style="linklist"> - <title>Constructors</title> - </links> + <p>Constructor</p> + <synopsis><code mime="text/x-python"> +repository = Repository() </code></synopsis> <links type="topic" ui:expanded="yes" api:type="function" api:mime="text/x-python" groups="method" style="linklist"> |