summaryrefslogtreecommitdiff
path: root/giscanner/doctemplates
diff options
context:
space:
mode:
authorJasper St. Pierre <jstpierre@mecheye.net>2013-01-31 18:15:35 -0500
committerJasper St. Pierre <jstpierre@mecheye.net>2013-02-01 19:47:41 -0500
commitac3d35bd4fcf07f86b4ea5a0d71569cc7a49e1c8 (patch)
tree8db5aa5814c59edaae91b17d26ab63c981173456 /giscanner/doctemplates
parent7e0ab2b629691c5904e00f4890a2da052a0a9c37 (diff)
downloadgobject-introspection-ac3d35bd4fcf07f86b4ea5a0d71569cc7a49e1c8.tar.gz
doctool: Use definition lists instead of tables
Diffstat (limited to 'giscanner/doctemplates')
-rw-r--r--giscanner/doctemplates/C/mallard-C-function.tmpl16
-rw-r--r--giscanner/doctemplates/C/mallard-C-vfunc.tmpl16
-rw-r--r--giscanner/doctemplates/Python/mallard-Python-enum.tmpl10
-rw-r--r--giscanner/doctemplates/Python/mallard-Python-function.tmpl16
-rw-r--r--giscanner/doctemplates/Python/mallard-Python-signal.tmpl34
-rw-r--r--giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl16
6 files changed, 40 insertions, 68 deletions
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>
<%block name="details">
% if node.parameters or node.retval:
-<table>
+<dl>
% for arg, ix in zip(node.parameters, range(len(node.parameters))):
-<tr>
-<td><p>${arg.argname} :</p></td>
-<td>${formatter.format(node, arg.doc)}</td>
-</tr>
+<dt><p>${arg.argname} :</p></dt>
+<dd>${formatter.format(node, arg.doc)}</dd>
% endfor
% if node.retval:
-<tr>
-<td><p>Returns :</p></td>
-<td>${formatter.format(node, node.retval.doc)}</td>
-</tr>
+<dt><p>Returns :</p></dt>
+<dd>${formatter.format(node, node.retval.doc)}</dd>
% endif
-</table>
+</dl>
% endif
</%block>
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>
<%block name="details">
% if node.parameters or node.retval:
-<table>
+<dl>
% for arg, ix in zip(node.parameters, range(len(node.parameters))):
-<tr>
-<td><p>${arg.argname} :</p></td>
-<td>${formatter.format(node, arg.doc)}</td>
-</tr>
+<dt><p>${arg.argname} :</p></dt>
+<dd>${formatter.format(node, arg.doc)}</dd>
% endfor
% if node.retval:
-<tr>
-<td><p>Returns :</p></td>
-<td>${formatter.format(node, node.retval.doc)}</td>
-</tr>
+<dt><p>Returns :</p></dt>
+<dd>${formatter.format(node, node.retval.doc)}</dd>
% endif
-</table>
+</dl>
% endif
</%block>
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:
-<table>
+<dl>
% for member, ix in zip(node.members, range(len(node.members))):
-<tr>
-<td><p>${node.name}.${member.name.upper()} :</p></td>
-<td>${formatter.format(node, member.doc)}</td>
-</tr>
+<dt><p>${node.name}.${member.name.upper()} :</p></dt>
+<dd>${formatter.format(node, member.doc)}</dd>
% endfor
-</table>
+</dl>
% endif
</%block>
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>
<%block name="details">
% if node.parameters or node.retval:
-<table>
+<dl>
% for arg, ix in zip(node.parameters, range(len(node.parameters))):
-<tr>
-<td><p>${arg.argname} :</p></td>
-<td>${formatter.format(node, arg.doc)}</td>
-</tr>
+<dt><p>${arg.argname} :</p></dt>
+<dd>${formatter.format(node, arg.doc)}</dd>
% endfor
% if node.retval and node.retval.type.ctype != 'void':
-<tr>
-<td><p>Returns :</p></td>
-<td>${formatter.format(node, node.retval.doc)}</td>
-</tr>
+<dt><p>Returns :</p></dt>
+<dd>${formatter.format(node, node.retval.doc)}</dd>
% endif
-</table>
+</dl>
% endif
</%block>
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, ...)
</code></synopsis>
</%block>
<%block name="details">
-<table>
-<tr>
-<td><p>${formatter.to_underscores(node.parent.name).lower()} :</p></td>
-<td><p>instance of ${namespace.name}.${node.parent.name} that is emitting the signal</p></td>
-</tr>
+<dl>
+<dt><p>${formatter.to_underscores(node.parent.name).lower()} :</p></dt>
+<dd><p>instance of ${namespace.name}.${node.parent.name} that is emitting the signal</p></dd>
% for arg, ix in zip(node.parameters, range(len(node.parameters))):
-<tr>
-<td><p>${arg.argname} :</p></td>
-<td>${formatter.format(node, arg.doc)}</td>
-</tr>
+<dt><p>${arg.argname} :</p></dt>
+<dd>${formatter.format(node, arg.doc)}</dd>
% endfor
-<tr>
-<td><p>user_param1 :</p></td>
-<td><p>first user parameter (if any) specified with the connect() method</p></td>
-</tr>
-<tr>
-<td><p>... :</p></td>
-<td><p>additional user parameters (if any)</p></td>
-</tr>
+<dt><p>user_param1 :</p></dt>
+<dd><p>first user parameter (if any) specified with the connect() method</p></dd>
+<dt><p>... :</p></dt>
+<dd><p>additional user parameters (if any)</p></dd>
% if node.retval and \
node.retval.type.ctype != 'void' and \
node.retval.type.ctype is not None:
-<tr>
-<td><p>Returns :</p></td>
-<td>${node.retval.type.ctype} ${formatter.format(node, node.retval.doc)}</td>
-</tr>
+<dt><p>Returns :</p></dt>
+<dd>${node.retval.type.ctype} ${formatter.format(node, node.retval.doc)}</dd>
% endif
-</table>
+</dl>
</%block>
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>
<%block name="details">
% if node.parameters or node.retval:
-<table>
+<dl>
% for arg, ix in zip(node.parameters, range(len(node.parameters))):
-<tr>
-<td><p>${arg.argname} :</p></td>
-<td>${formatter.format(node, arg.doc)}</td>
-</tr>
+<dt><p>${arg.argname} :</p></dt>
+<dd>${formatter.format(node, arg.doc)}</dd>
% endfor
% if node.retval and node.retval.type.ctype != 'void':
-<tr>
-<td><p>Returns :</p></td>
-<td>${formatter.format(node, node.retval.doc)}</td>
-</tr>
+<dt><p>Returns :</p></dt>
+<dd>${formatter.format(node, node.retval.doc)}</dd>
% endif
-</table>
+</dl>
% endif
</%block>