summaryrefslogtreecommitdiff
path: root/giscanner/mallard-C-function.tmpl
diff options
context:
space:
mode:
authorJasper St. Pierre <jstpierre@mecheye.net>2013-01-09 03:11:06 -0500
committerJasper St. Pierre <jstpierre@mecheye.net>2013-01-09 03:16:14 -0500
commit8b23c6c8755bca0b0c58b25ee3c4b06c06d72bcd (patch)
tree6b743fe7fdd23dabcd49b90b8ff35aab358da857 /giscanner/mallard-C-function.tmpl
parent634961eac7186ec95680916de0b627ea1c7441e7 (diff)
downloadgobject-introspection-8b23c6c8755bca0b0c58b25ee3c4b06c06d72bcd.tar.gz
doc: Put documentation templates into their own directories
Instead of cluttering up the giscanner directory, put templates into their own files, with each language having its own templates in its own directory for comfort.
Diffstat (limited to 'giscanner/mallard-C-function.tmpl')
-rw-r--r--giscanner/mallard-C-function.tmpl95
1 files changed, 0 insertions, 95 deletions
diff --git a/giscanner/mallard-C-function.tmpl b/giscanner/mallard-C-function.tmpl
deleted file mode 100644
index 051fb0b0..00000000
--- a/giscanner/mallard-C-function.tmpl
+++ /dev/null
@@ -1,95 +0,0 @@
-<?xml version="1.0"?>
-<%
-page_style = 'function'
-if node.is_constructor:
- page_style = 'constructor'
-elif node.is_method:
- page_style = 'method'
-%>
-<page id="${page_id}"
- type="topic"
- style="${page_style}"
- xmlns="http://projectmallard.org/1.0/"
- xmlns:api="http://projectmallard.org/experimental/api/"
- xmlns:ui="http://projectmallard.org/experimental/ui/">
- <info>
-% if node.parent is not None:
- <link type="guide" xref="${namespace.name}.${node.parent.name}" group="${page_style}"/>
-% else:
- <link type="guide" xref="index" group="${page_style}"/>
-% endif
- <api:function>
- <api:returns>
- <api:type>${formatter.format_type(node.retval.type) | x}</api:type>
- </api:returns>
- <api:name>${node.symbol}</api:name>
-% if node.is_method:
- <api:arg>
- <api:type>${node.parent.ctype} *</api:type>
- <api:name>self</api:name>
- </api:arg>
-% endif
-% for arg in node.parameters:
-% if arg.type.ctype == '<varargs>':
- <api:varargs/>
-% else:
- <api:arg>
- <api:type>${formatter.format_type(arg.type) | x}</api:type>
- <api:name>${arg.argname}</api:name>
- </api:arg>
-% endif
-% endfor
- </api:function>
- </info>
- <title>${node.symbol}</title>
-<synopsis><code mime="text/x-csrc">
-${node.retval.type.ctype} ${node.symbol} (\
-% if node.is_method:
-${node.parent.ctype} *self\
-%endif
-% if len(node.parameters) == 0:
-% if not node.is_method:
-void\
-%endif
-);
-% elif node.is_method:
-,
-% endif
-% for arg, ix in zip(node.parameters, range(len(node.parameters))):
-% if ix != 0:
-${' ' * (len(formatter.format_type(node.retval.type)) + len(node.symbol) + 3)}\
-% endif
-% if arg.type.ctype == '<varargs>':
-...\
-% else:
-${formatter.format_type(arg.type) | x} ${arg.argname}\
-% endif
-% if ix == len(node.parameters) - 1:
-);
-% else:
-,
-%endif
-% endfor
-</code></synopsis>
-${formatter.format(node, node.doc)}
-
-% if node.parameters or node.retval:
-<table>
-% 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>
-% endfor
-% if node.retval:
-<tr>
-<td><p>Returns :</p></td>
-<td>${formatter.format(node, node.retval.doc)}</td>
-</tr>
-% endif
-</table>
-% endif
-% if node.version:
-<p>Since ${node.version}</p>
-% endif
-</page>