summaryrefslogtreecommitdiff
path: root/giscanner/doctemplates/Python/mallard-Python-class.tmpl
blob: 800d241fc98f29ec835f1a68c2aa849c62dc205c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
<?xml version="1.0"?>
<page id="${node.namespace.name}.${node.name}"
      type="guide"
      style="${page_style}"
      xmlns="http://projectmallard.org/1.0/"
      xmlns:api="http://projectmallard.org/experimental/api/"
      xmlns:ui="http://projectmallard.org/experimental/ui/">
  <info>
    <link type="guide" xref="index" group="class"/>
  </info>
  <title>${formatter.format_page_name(node)}</title>
${formatter.format(node, node.doc)}

  <synopsis><code>
from gi.repository import ${namespace.name}

${formatter.to_underscores(node.name).lower()} = ${namespace.name}.${node.name}(\
% for property_, ix in zip(node.properties, range(len(node.properties))):
% if property_.construct or property_.construct_only or property_.writable:
<link xref='${namespace.name}.${node.name}-${property_.name}'>${property_.name.replace('-', '_')}</link>=value\
% if ix != len(node.properties) - 1:
, \
% endif
% endif
% endfor
)\
  </code></synopsis>

% if node.version:
<p>Since ${node.version}</p>
% endif
  <synopsis>
    <title>Hierarchy</title>
    <tree>
% for class_ in formatter.get_class_hierarchy(node):
      <item>
        <code>${class_.namespace.name}.${class_.name}</code>
% endfor
% for class_ in formatter.get_class_hierarchy(node):
      </item>
% endfor
    </tree>
  </synopsis>
  <links type="topic" ui:expanded="yes"
         api:type="function" api:mime="text/x-python"
         groups="method" style="linklist">
    <title>Methods</title>
  </links>
  <links type="topic" ui:expanded="yes"
         api:type="function" api:mime="text/x-python"
         groups="function" style="linklist">
    <title>Functions</title>
  </links>
  <links type="topic" ui:expanded="yes" groups="property" style="linklist">
    <title>Properties</title>
  </links>
  <links type="topic" ui:expanded="yes" groups="signal" style="linklist">
    <title>Signals</title>
  </links>
  <links type="topic" ui:expanded="yes" groups="vfunc" style="linklist">
    <title>Virtual functions</title>
  </links>
  <links type="topic" ui:expanded="yes" groups="#first #default #last" style="linklist">
    <title>Other</title>
  </links>
</page>