diff options
| author | Giovanni Campagna <gcampagna@src.gnome.org> | 2014-02-19 16:19:53 +0100 |
|---|---|---|
| committer | Giovanni Campagna <gcampagna@src.gnome.org> | 2014-02-20 02:07:48 +0100 |
| commit | 75d25b7f47542aa003c92ce576b6e82bae66aec9 (patch) | |
| tree | fe44b2083492e76f8bda7d903db169530dcba2b4 /giscanner/doctemplates/Gjs/field.tmpl | |
| parent | bd4608b6c761209bca8362bd5524e4dbe781e532 (diff) | |
| download | gobject-introspection-75d25b7f47542aa003c92ce576b6e82bae66aec9.tar.gz | |
doctool: improve Gjs documentation
- Add documentation for structures, fields, constants and
callbacks
- Improve the synopsis for interfaces to have prerequisites
and known implementations
- Respect gjs constraints for field writability
- Format in and out parameters for callables according to GJS
conventions
- Format property names according to the GJS API
- Show boxed constructors according to how they can be used
in the gjs API
https://bugzilla.gnome.org/show_bug.cgi?id=724735
Diffstat (limited to 'giscanner/doctemplates/Gjs/field.tmpl')
| -rw-r--r-- | giscanner/doctemplates/Gjs/field.tmpl | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/giscanner/doctemplates/Gjs/field.tmpl b/giscanner/doctemplates/Gjs/field.tmpl new file mode 100644 index 00000000..dda82469 --- /dev/null +++ b/giscanner/doctemplates/Gjs/field.tmpl @@ -0,0 +1,9 @@ +<%inherit file="/base.tmpl"/> +<%block name="info"> + ${formatter.format_xref(node.parent, type="guide", group=page_kind)} + <title type="link" role="topic">${node.name}</title> +</%block> +<%block name="synopsis"> + <synopsis><code mime="text/x-gjs"> +${node.parent.name}.${formatter.to_underscores(node)}: ${formatter.format_type(node.type, True)} (${formatter.format_property_flags(node)}) + </code></synopsis></%block> |