summaryrefslogtreecommitdiff
path: root/giscanner/doctemplates/class.tmpl
blob: 86333866548c2a6b1f7fda8b6e99f991e049d532 (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
<%! page_type="guide" %>\
<%inherit file="/base.tmpl"/>
<%block name="details">
% if isinstance(node, ast.Class):
  <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>
% elif isinstance(node, ast.Interface):
  <synopsis>
    <title>Prerequisites</title>
    <p>${node.name} requires ${formatter.format_prerequisites(node)}</p>
  </synopsis>
  <synopsis>
    <title>Known Implementations</title>
    <p>${formatter.format_known_implementations(node)}</p>
  </synopsis>
% endif
</%block>
<%block name="links">\
  <links type="topic" ui:expanded="true"
         api:type="function" api:mime="${formatter.mime_type}"
         groups="constructor" style="linklist">
    <title>Constructors</title>
  </links>
  <links type="topic" ui:expanded="true"
         api:type="function" api:mime="${formatter.mime_type}"
         groups="method" style="linklist">
    <title>Methods</title>
  </links>
  <links type="topic" ui:expanded="true"
         api:type="function" api:mime="${formatter.mime_type}"
         groups="function" style="linklist">
    <title>Static Functions</title>
  </links>
% if isinstance(node, (ast.Class, ast.Interface)):
  <links type="topic" ui:expanded="true" groups="property" style="linklist">
    <title>Properties</title>
  </links>
  <links type="topic" ui:expanded="true" groups="signal" style="linklist">
    <title>Signals</title>
  </links>
  <links type="topic" ui:expanded="true" groups="vfunc" style="linklist">
    <title>Virtual functions</title>
  </links>
% endif
  <links type="topic" ui:expanded="true" groups="field" style="linklist">
    <title>Fields</title>
  </links>
  <links type="topic" ui:expanded="true" groups="#first #default #last" style="linklist">
    <title>Other</title>
  </links>\
</%block>