summaryrefslogtreecommitdiff
path: root/giscanner/doctemplates
diff options
context:
space:
mode:
authorJasper St. Pierre <jstpierre@mecheye.net>2013-02-14 22:47:10 -0500
committerJasper St. Pierre <jstpierre@mecheye.net>2013-02-14 23:18:00 -0500
commit3b64a2e808ae25b437c30bec237ada89dc4bcfb3 (patch)
tree359dfe6569e3c0058af70f7e8431cf1ae6aa6633 /giscanner/doctemplates
parentafe9d25896491db94bdbfac109f003d9ec9ff852 (diff)
downloadgobject-introspection-3b64a2e808ae25b437c30bec237ada89dc4bcfb3.tar.gz
doctool: Fix use of <dl> tag in templates
This isn't legal Mallard
Diffstat (limited to 'giscanner/doctemplates')
-rw-r--r--giscanner/doctemplates/C/function.tmpl16
-rw-r--r--giscanner/doctemplates/Gjs/enum.tmpl10
-rw-r--r--giscanner/doctemplates/Gjs/function.tmpl16
-rw-r--r--giscanner/doctemplates/Gjs/signal.tmpl34
-rw-r--r--giscanner/doctemplates/Gjs/vfunc.tmpl16
-rw-r--r--giscanner/doctemplates/Python/enum.tmpl10
-rw-r--r--giscanner/doctemplates/Python/function.tmpl16
-rw-r--r--giscanner/doctemplates/Python/signal.tmpl33
-rw-r--r--giscanner/doctemplates/Python/vfunc.tmpl16
9 files changed, 104 insertions, 63 deletions
diff --git a/giscanner/doctemplates/C/function.tmpl b/giscanner/doctemplates/C/function.tmpl
index c551bc2e..c2d393b9 100644
--- a/giscanner/doctemplates/C/function.tmpl
+++ b/giscanner/doctemplates/C/function.tmpl
@@ -47,15 +47,19 @@ ${formatter.format_type(arg.type) | x} ${arg.argname}\
</%block>
<%block name="details">
% if formatter.get_parameters(node) or node.retval:
-<dl>
+<terms>
% for arg in formatter.get_parameters(node):
-<dt><p>${arg.argname} :</p></dt>
-<dd>${formatter.format(node, arg.doc)}</dd>
+<item>
+<title><code>${arg.argname}</code></title>
+${formatter.format(node, arg.doc)}
+</item>
% endfor
% if node.retval:
-<dt><p>Returns :</p></dt>
-<dd>${formatter.format(node, node.retval.doc)}</dd>
+<item>
+<title><code>Returns</code></title>
+${formatter.format(node, node.retval.doc)}
+</item>
% endif
-</dl>
+</terms>
% endif
</%block>
diff --git a/giscanner/doctemplates/Gjs/enum.tmpl b/giscanner/doctemplates/Gjs/enum.tmpl
index 2624c425..35cdd439 100644
--- a/giscanner/doctemplates/Gjs/enum.tmpl
+++ b/giscanner/doctemplates/Gjs/enum.tmpl
@@ -1,11 +1,13 @@
<%inherit file="/base.tmpl"/>
<%block name="details">
% if node.members:
-<dl>
+<terms>
% for member in node.members:
-<dt><p>${node.name}.${member.name.upper()} :</p></dt>
-<dd>${formatter.format(node, member.doc)}</dd>
+<item>
+<title><code>${node.name}.${member.name.upper()}</code></title>
+${formatter.format(node, member.doc)}
+</item>
% endfor
-</dl>
+</terms>
% endif
</%block>
diff --git a/giscanner/doctemplates/Gjs/function.tmpl b/giscanner/doctemplates/Gjs/function.tmpl
index db2c8ae3..46c46271 100644
--- a/giscanner/doctemplates/Gjs/function.tmpl
+++ b/giscanner/doctemplates/Gjs/function.tmpl
@@ -34,15 +34,19 @@ ${', '.join('%s:%s' % (arg.argname, formatter.format_type(arg.type)) for arg in
</%block>
<%block name="details">
% if formatter.get_parameters(node) or node.retval:
-<dl>
+<terms>
% for arg in formatter.get_parameters(node):
-<dt><p>${arg.argname} :</p></dt>
-<dd>${formatter.format(node, arg.doc)}</dd>
+<item>
+<title><code>${arg.argname}</code></title>
+${formatter.format(node, arg.doc)}
+</item>
% endfor
% if node.retval and node.retval.type.ctype != 'void':
-<dt><p>Returns :</p></dt>
-<dd>${formatter.format(node, node.retval.doc)}</dd>
+<item>
+<title><code>Returns</code></title>
+${formatter.format(node, node.retval.doc)}
+</item>
% endif
-</dl>
+</terms>
% endif
</%block>
diff --git a/giscanner/doctemplates/Gjs/signal.tmpl b/giscanner/doctemplates/Gjs/signal.tmpl
index 83264804..994392ce 100644
--- a/giscanner/doctemplates/Gjs/signal.tmpl
+++ b/giscanner/doctemplates/Gjs/signal.tmpl
@@ -13,23 +13,33 @@ user_param1, ...):${formatter.format_type(node.retval.type)};
</code></synopsis>
</%block>
<%block name="details">
-<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>
+<terms>
+<item>
+<title><code>${formatter.to_underscores(node.parent.name).lower()}</code></title>
+<p>instance of ${namespace.name}.${node.parent.name} that is emitting the signal</p>
+</item>
% for arg in formatter.get_parameters(node):
-<dt><p>${arg.argname} :</p></dt>
-<dd>${formatter.format(node, arg.doc)}</dd>
+<item>
+<title><code>${arg.argname}</code></title>
+${formatter.format(node, arg.doc)}
+</item>
% endfor
-<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>
+<item>
+<title><code>user_param1</code></title>
+<p>first user parameter (if any) specified with the connect() method</p>
+</item>
+<item>
+<title><code>...</code></title>
+<p>additional user parameters (if any)</p>
+</item>
% if node.retval and \
node.retval.type.ctype != 'void' and \
node.retval.type.ctype is not None:
-<dt><p>Returns :</p></dt>
-<dd>${node.retval.type.ctype} ${formatter.format(node, node.retval.doc)}</dd>
+<item>
+<title><code>Returns</code></title>
+<p>${node.retval.type.ctype} ${formatter.format(node, node.retval.doc)}</p>
+</item>
% endif
-</dl>
+</terms>
</%block>
diff --git a/giscanner/doctemplates/Gjs/vfunc.tmpl b/giscanner/doctemplates/Gjs/vfunc.tmpl
index 1d132c78..1cbe511c 100644
--- a/giscanner/doctemplates/Gjs/vfunc.tmpl
+++ b/giscanner/doctemplates/Gjs/vfunc.tmpl
@@ -9,15 +9,19 @@ ${', '.join('%s:%s' % (arg.argname, formatter.format_type(arg.type)) for arg in
</%block>
<%block name="details">
% if formatter.get_parameters(node) or node.retval:
-<dl>
+<terms>
% for arg in formatter.get_parameters(node):
-<dt><p>${arg.argname} :</p></dt>
-<dd>${formatter.format(node, arg.doc)}</dd>
+<item>
+<title><code>${arg.argname}</code></title>
+${formatter.format(node, arg.doc)}
+</item>
% endfor
% if node.retval and node.retval.type.ctype != 'void':
-<dt><p>Returns :</p></dt>
-<dd>${formatter.format(node, node.retval.doc)}</dd>
+<item>
+<title><code>Returns</code></title>
+${formatter.format(node, node.retval.doc)}
+</item>
% endif
-</dl>
+</terms>
% endif
</%block>
diff --git a/giscanner/doctemplates/Python/enum.tmpl b/giscanner/doctemplates/Python/enum.tmpl
index 2624c425..35cdd439 100644
--- a/giscanner/doctemplates/Python/enum.tmpl
+++ b/giscanner/doctemplates/Python/enum.tmpl
@@ -1,11 +1,13 @@
<%inherit file="/base.tmpl"/>
<%block name="details">
% if node.members:
-<dl>
+<terms>
% for member in node.members:
-<dt><p>${node.name}.${member.name.upper()} :</p></dt>
-<dd>${formatter.format(node, member.doc)}</dd>
+<item>
+<title><code>${node.name}.${member.name.upper()}</code></title>
+${formatter.format(node, member.doc)}
+</item>
% endfor
-</dl>
+</terms>
% endif
</%block>
diff --git a/giscanner/doctemplates/Python/function.tmpl b/giscanner/doctemplates/Python/function.tmpl
index 356619c3..d1b57f4e 100644
--- a/giscanner/doctemplates/Python/function.tmpl
+++ b/giscanner/doctemplates/Python/function.tmpl
@@ -39,15 +39,19 @@ ${', '.join((formatter.format_parameter_name(node, arg) for arg in formatter.get
</%block>
<%block name="details">
% if formatter.get_parameters(node) or node.retval:
-<dl>
+<terms>
% for ix, arg in enumerate(formatter.get_parameters(node)):
-<dt><p>${formatter.format_parameter_name(node, arg)} :</p></dt>
-<dd>${formatter.format(node, arg.doc)}</dd>
+<item>
+<title><code>${formatter.format_parameter_name(node, arg)}</code></title>
+${formatter.format(node, arg.doc)}
+</item>
% endfor
% if node.retval and node.retval.type.ctype != 'void':
-<dt><p>Returns :</p></dt>
-<dd>${formatter.format(node, node.retval.doc)}</dd>
+<item>
+<title><code>Returns</code></title>
+{formatter.format(node, node.retval.doc)}
+</item>
% endif
-</dl>
+</terms>
% endif
</%block>
diff --git a/giscanner/doctemplates/Python/signal.tmpl b/giscanner/doctemplates/Python/signal.tmpl
index 0df13f64..fa850418 100644
--- a/giscanner/doctemplates/Python/signal.tmpl
+++ b/giscanner/doctemplates/Python/signal.tmpl
@@ -13,23 +13,30 @@ user_param1, ...)
</code></synopsis>
</%block>
<%block name="details">
-<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>
+<terms>
+<item>
+<title><code>${formatter.to_underscores(node.parent.name).lower()}</code></title>
+<p>instance of ${namespace.name}.${node.parent.name} that is emitting the signal</p>
+</item>
% for arg in formatter.get_parameters(node):
-<dt><p>${arg.argname} :</p></dt>
-<dd>${formatter.format(node, arg.doc)}</dd>
+<item>
+<title><code>${arg.argname}</code></title>
+${formatter.format(node, arg.doc)}
+</item>
% endfor
-<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>
+<title><code>user_param1</code></title>
+<p>first user parameter (if any) specified with the connect() method</p>
+<item>
+<title><code>...</code></title>
+<p>additional user parameters (if any)</p>
+</item>
% if node.retval and \
node.retval.type.ctype != 'void' and \
node.retval.type.ctype is not None:
-<dt><p>Returns :</p></dt>
-<dd>${node.retval.type.ctype} ${formatter.format(node, node.retval.doc)}</dd>
+<item>
+<title><code>Returns</code></title>
+<p>${node.retval.type.ctype} ${formatter.format(node, node.retval.doc)}</p>
+</item>
% endif
-</dl>
+</terms>
</%block>
-
diff --git a/giscanner/doctemplates/Python/vfunc.tmpl b/giscanner/doctemplates/Python/vfunc.tmpl
index c4716a5e..98a30932 100644
--- a/giscanner/doctemplates/Python/vfunc.tmpl
+++ b/giscanner/doctemplates/Python/vfunc.tmpl
@@ -15,15 +15,19 @@ ${', '.join((arg.argname for arg in formatter.get_parameters(node)))}\
</%block>
<%block name="details">
% if formatter.get_parameters(node) or node.retval:
-<dl>
+<terms>
% for arg in formatter.get_parameters(node):
-<dt><p>${arg.argname} :</p></dt>
-<dd>${formatter.format(node, arg.doc)}</dd>
+<item>
+<title><code>${arg.argname}</code></title>
+${formatter.format(node, arg.doc)}
+</item>
% endfor
% if node.retval and node.retval.type.ctype != 'void':
-<dt><p>Returns :</p></dt>
-<dd>${formatter.format(node, node.retval.doc)}</dd>
+<item>
+<title><code>Returns</code></title>
+${formatter.format(node, node.retval.doc)}
+</item>
% endif
-</dl>
+</terms>
% endif
</%block>