This will be used for @param detection.
<link type="guide" xref="index" group="class"/>
</info>
<title>${node.ctype}</title>
-${formatter.format(node.doc)}
+${formatter.format(node, node.doc)}
% if node.version:
<p>Since ${node.version}</p>
% endif
<info>
</info>
<title>${namespace.name}.${node.name}</title>
-${formatter.format(node.doc)}
+${formatter.format(node, node.doc)}
</page>
<link type="guide" xref="index"/>
</info>
<title>${node.namespace.name}.${node.name}</title>
-${formatter.format(node.doc)}
+${formatter.format(node, node.doc)}
</page>
%endif
% endfor
</code></synopsis>
-${formatter.format(node.doc)}
+${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(arg.doc)}</td>
+<td>${formatter.format(node, arg.doc)}</td>
</tr>
% endfor
% if node.retval:
<tr>
<td><p>Returns :</p></td>
-<td>${formatter.format(node.retval.doc)}</td>
+<td>${formatter.format(node, node.retval.doc)}</td>
</tr>
% endif
</table>
<title type="link" role="topic">${node.name}</title>
</info>
<title>${node.parent.ctype}:${node.name}</title>
-${formatter.format(node.doc)}
+${formatter.format(node, node.doc)}
</page>
<link type="guide" xref="index"/>
</info>
<title>${node.namespace.name}${node.name}</title>
-${formatter.format(node.doc)}
+${formatter.format(node, node.doc)}
</page>
<title type="link" role="topic">${node.name}</title>
</info>
<title>${node.parent.ctype}::${node.name}</title>
-${formatter.format(node.doc)}
+${formatter.format(node, node.doc)}
</page>
<title>${node.name}</title>
<synopsis><code mime="text/x-csrc">
</code></synopsis>
-${formatter.format(node.doc)}
+${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(arg.doc)}</td>
+<td>${formatter.format(node, arg.doc)}</td>
</tr>
% endfor
% if node.retval:
<tr>
<td><p>Returns :</p></td>
-<td>${formatter.format(node.retval.doc)}</td>
+<td>${formatter.format(node, node.retval.doc)}</td>
</tr>
% endif
</table>
<link type="guide" xref="index" group="class"/>
</info>
<title>${namespace.name}.${node.name}</title>
-${formatter.format(node.doc)}
+${formatter.format(node, node.doc)}
<synopsis><code>
from gi.repository import ${namespace.name}
<info>
</info>
<title>${namespace.name}.${node.name}</title>
-${formatter.format(node.doc)}
+${formatter.format(node, node.doc)}
</page>
<link type="guide" xref="index"/>
</info>
<title>${node.namespace.name}.${node.name}</title>
- ${formatter.format(node.doc)}
+ ${formatter.format(node, node.doc)}
% if node.members:
<table>
% for member, ix in zip(node.members, range(len(node.members))):
<tr>
<td><p>${node.name}.${member.name.upper()} :</p></td>
-<td>${formatter.format(member.doc)}</td>
+<td>${formatter.format(node, member.doc)}</td>
</tr>
% endfor
</table>
% endfor
)
</code></synopsis>
-${formatter.format(node.doc)}
+${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(arg.doc)}</td>
+<td>${formatter.format(node, arg.doc)}</td>
</tr>
% endfor
% if node.retval and node.retval.type.ctype != 'void':
<tr>
<td><p>Returns :</p></td>
-<td>${formatter.format(node.retval.doc)}</td>
+<td>${formatter.format(node, node.retval.doc)}</td>
</tr>
% endif
</table>
<synopsis><code mime="text/x-python">
"${node.name}" ${formatter.format_type(node.type)} : ${formatter.format_property_flags(node)}
</code></synopsis>
-${formatter.format(node.doc)}
+${formatter.format(node, node.doc)}
</page>
% endfor
user_param1, ...)
</code></synopsis>
-${formatter.format(node.doc)}
+${formatter.format(node, node.doc)}
<table>
<tr>
% for arg, ix in zip(node.parameters, range(len(node.parameters))):
<tr>
<td><p>${arg.argname} :</p></td>
-<td>${formatter.format(arg.doc)}</td>
+<td>${formatter.format(node, arg.doc)}</td>
</tr>
% endfor
<tr>
node.retval.type.ctype is not None:
<tr>
<td><p>Returns :</p></td>
-<td>${node.retval.type.ctype} ${formatter.format(node.retval.doc)}</td>
+<td>${node.retval.type.ctype} ${formatter.format(node, node.retval.doc)}</td>
</tr>
% endif
</table>
% endfor
):
</code></synopsis>
-${formatter.format(node.doc)}
+${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(arg.doc)}</td>
+<td>${formatter.format(node, arg.doc)}</td>
</tr>
% endfor
% if node.retval and node.retval.type.ctype != 'void':
<tr>
<td><p>Returns :</p></td>
-<td>${formatter.format(node.retval.doc)}</td>
+<td>${formatter.format(node, node.retval.doc)}</td>
</tr>
% endif
</table>
def escape(self, text):
return saxutils.escape(text)
- def format(self, doc):
+ def format(self, node, doc):
if doc is None:
return ''
result = ''
for para in doc.split('\n\n'):
result += '<p>'
- result += self.format_inline(para)
+ result += self.format_inline(node, para)
result += '</p>'
return result
return item
raise KeyError("Could not find %s" % (name, ))
- def _process_other(self, match, props):
+ def _process_other(self, node, match, props):
return self.escape(match)
- def _process_property(self, match, props):
+ def _process_property(self, node, match, props):
type_node = self._resolve_type(props['type_name'])
if type_node is None:
return match
try:
- node = self._find_thing(type_node.properties, props['property_name'])
+ prop = self._find_thing(type_node.properties, props['property_name'])
except (AttributeError, KeyError), e:
return match
- return self.format_xref(node)
+ return self.format_xref(prop)
- def _process_signal(self, match, props):
+ def _process_signal(self, node, match, props):
type_node = self._resolve_type(props['type_name'])
if type_node is None:
return match
try:
- node = self._find_thing(type_node.signals, props['signal_name'])
+ signal = self._find_thing(type_node.signals, props['signal_name'])
except (AttributeError, KeyError), e:
return match
- return self.format_xref(node)
+ return self.format_xref(signal)
- def _process_type_name(self, match, props):
- node = self._resolve_type(props['type_name'])
- if node is None:
+ def _process_type_name(self, node, match, props):
+ type_ = self._resolve_type(props['type_name'])
+ if type_ is None:
return match
- return self.format_xref(node)
+ return self.format_xref(type_)
- def _process_function_call(self, match, props):
- node = self._resolve_symbol(props['symbol_name'])
- if node is None:
+ def _process_function_call(self, node, match, props):
+ func = self._resolve_symbol(props['symbol_name'])
+ if func is None:
return match
- return self.format_xref(node)
+ return self.format_xref(func)
- def _process_fundamental(self, match, props):
+ def _process_fundamental(self, node, match, props):
return self.fundamentals.get(props['fundamental'], match)
- def _process_token(self, tok):
+ def _process_token(self, node, tok):
kind, match, props = tok
dispatch = {
'fundamental': self._process_fundamental,
}
- return dispatch[kind](match, props)
+ return dispatch[kind](node, match, props)
- def format_inline(self, para):
+ def format_inline(self, node, para):
tokens = self._scanner.scan(para)
- words = [self._process_token(tok) for tok in tokens]
+ words = [self._process_token(node, tok) for tok in tokens]
return ''.join(words)
def format_function_name(self, func):