From ac3d35bd4fcf07f86b4ea5a0d71569cc7a49e1c8 Mon Sep 17 00:00:00 2001 From: "Jasper St. Pierre" Date: Thu, 31 Jan 2013 18:15:35 -0500 Subject: doctool: Use definition lists instead of tables --- giscanner/doctemplates/C/mallard-C-function.tmpl | 16 ++++------ giscanner/doctemplates/C/mallard-C-vfunc.tmpl | 16 ++++------ .../doctemplates/Python/mallard-Python-enum.tmpl | 10 +++---- .../Python/mallard-Python-function.tmpl | 16 ++++------ .../doctemplates/Python/mallard-Python-signal.tmpl | 34 ++++++++-------------- .../doctemplates/Python/mallard-Python-vfunc.tmpl | 16 ++++------ 6 files changed, 40 insertions(+), 68 deletions(-) (limited to 'giscanner/doctemplates') diff --git a/giscanner/doctemplates/C/mallard-C-function.tmpl b/giscanner/doctemplates/C/mallard-C-function.tmpl index e0af6413..84cace06 100644 --- a/giscanner/doctemplates/C/mallard-C-function.tmpl +++ b/giscanner/doctemplates/C/mallard-C-function.tmpl @@ -61,19 +61,15 @@ ${formatter.format_type(arg.type) | x} ${arg.argname}\ <%block name="details"> % if node.parameters or node.retval: - +
% for arg, ix in zip(node.parameters, range(len(node.parameters))): -
- - - +

${arg.argname} :

+
${formatter.format(node, arg.doc)}
% endfor % if node.retval: - - - - +

Returns :

+
${formatter.format(node, node.retval.doc)}
% endif -

${arg.argname} :

${formatter.format(node, arg.doc)}

Returns :

${formatter.format(node, node.retval.doc)}
+ % endif diff --git a/giscanner/doctemplates/C/mallard-C-vfunc.tmpl b/giscanner/doctemplates/C/mallard-C-vfunc.tmpl index 9cea1676..34c25b19 100644 --- a/giscanner/doctemplates/C/mallard-C-vfunc.tmpl +++ b/giscanner/doctemplates/C/mallard-C-vfunc.tmpl @@ -8,19 +8,15 @@ <%block name="details"> % if node.parameters or node.retval: - +
% for arg, ix in zip(node.parameters, range(len(node.parameters))): -
- - - +

${arg.argname} :

+
${formatter.format(node, arg.doc)}
% endfor % if node.retval: - - - - +

Returns :

+
${formatter.format(node, node.retval.doc)}
% endif -

${arg.argname} :

${formatter.format(node, arg.doc)}

Returns :

${formatter.format(node, node.retval.doc)}
+ % endif diff --git a/giscanner/doctemplates/Python/mallard-Python-enum.tmpl b/giscanner/doctemplates/Python/mallard-Python-enum.tmpl index 3c38f884..69d2c339 100644 --- a/giscanner/doctemplates/Python/mallard-Python-enum.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-enum.tmpl @@ -1,13 +1,11 @@ <%inherit file="mallard-base.tmpl"/> <%block name="details"> % if node.members: - +
% for member, ix in zip(node.members, range(len(node.members))): -
- - - +

${node.name}.${member.name.upper()} :

+
${formatter.format(node, member.doc)}
% endfor -

${node.name}.${member.name.upper()} :

${formatter.format(node, member.doc)}
+ % endif diff --git a/giscanner/doctemplates/Python/mallard-Python-function.tmpl b/giscanner/doctemplates/Python/mallard-Python-function.tmpl index 1dbba1ee..65adb1d7 100644 --- a/giscanner/doctemplates/Python/mallard-Python-function.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-function.tmpl @@ -48,19 +48,15 @@ ${', '.join((arg.argname for arg in node.parameters))}\ <%block name="details"> % if node.parameters or node.retval: - +
% for arg, ix in zip(node.parameters, range(len(node.parameters))): -
- - - +

${arg.argname} :

+
${formatter.format(node, arg.doc)}
% endfor % if node.retval and node.retval.type.ctype != 'void': - - - - +

Returns :

+
${formatter.format(node, node.retval.doc)}
% endif -

${arg.argname} :

${formatter.format(node, arg.doc)}

Returns :

${formatter.format(node, node.retval.doc)}
+ % endif diff --git a/giscanner/doctemplates/Python/mallard-Python-signal.tmpl b/giscanner/doctemplates/Python/mallard-Python-signal.tmpl index eccede7c..8c721b94 100644 --- a/giscanner/doctemplates/Python/mallard-Python-signal.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-signal.tmpl @@ -13,33 +13,23 @@ user_param1, ...) <%block name="details"> - - - - - +
+

${formatter.to_underscores(node.parent.name).lower()} :

+

instance of ${namespace.name}.${node.parent.name} that is emitting the signal

% for arg, ix in zip(node.parameters, range(len(node.parameters))): -
- - - +

${arg.argname} :

+
${formatter.format(node, arg.doc)}
% endfor - - - - - - - - +

user_param1 :

+

first user parameter (if any) specified with the connect() method

+

... :

+

additional user parameters (if any)

% if node.retval and \ node.retval.type.ctype != 'void' and \ node.retval.type.ctype is not None: - - - - +

Returns :

+
${node.retval.type.ctype} ${formatter.format(node, node.retval.doc)}
% endif -

${formatter.to_underscores(node.parent.name).lower()} :

instance of ${namespace.name}.${node.parent.name} that is emitting the signal

${arg.argname} :

${formatter.format(node, arg.doc)}

user_param1 :

first user parameter (if any) specified with the connect() method

... :

additional user parameters (if any)

Returns :

${node.retval.type.ctype} ${formatter.format(node, node.retval.doc)}
+ diff --git a/giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl b/giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl index 32230704..cf51f7c7 100644 --- a/giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl +++ b/giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl @@ -15,19 +15,15 @@ ${', '.join((arg.argname for arg in node.parameters))}\ <%block name="details"> % if node.parameters or node.retval: - +
% for arg, ix in zip(node.parameters, range(len(node.parameters))): -
- - - +

${arg.argname} :

+
${formatter.format(node, arg.doc)}
% endfor % if node.retval and node.retval.type.ctype != 'void': - - - - +

Returns :

+
${formatter.format(node, node.retval.doc)}
% endif -

${arg.argname} :

${formatter.format(node, arg.doc)}

Returns :

${formatter.format(node, node.retval.doc)}
+ % endif -- cgit v1.2.1