summaryrefslogtreecommitdiffstats
path: root/templates/latex/latexclass.tpl
blob: 9fdcb24b854e30f178f0f03af0e8627b9c0d2cc7 (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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<# input: compound #>
<% msg %>Generating LaTeX output for class <{ compound.name }><% endmsg %>
\hypertarget{<{ compound.fileName|raw }>}{}\section{<{ compound.title }>}
\label{<{ compound.fileName|raw }>}\index{<{ compound.name|texLabel }>@{<{ compound.name|texIndex }>}}
<# brief description #>
<% if compound.brief %>
  <{ compound.brief }>

<% endif %>
<# compound includes #>
<% if compound.includeInfo %>
    <% with ii=compound.includeInfo %>
      <% include 'latexinclude.tpl' %>
    <% endwith %>


<% endif %>
<# inheritance graph #>
  <% if compound.hasInheritanceDiagram %>
    <{ tr.inheritanceDiagramFor:compound.name }>
    <{ compound.inheritanceDiagram }>
  <% else %>
    <# textual inheritance list #>
    <% if compound.inherits|length>0 %>
      <% markers c in compound.inherits with tr.inheritsList:compound.inherits|length %>
        <% with obj=c.class text=c.name %>
          <% include 'latexobjlink.tpl' %>
        <% endwith %>
      <% endmarkers %>


    <% endif %>
    <% if compound.inheritedBy|length>0 %>
      <% markers c in compound.inheritedBy with tr.inheritedByList:compound.inheritedBy|length %>
        <% with obj=c.class text=c.name %>
          <% include 'latexobjlink.tpl' %>
        <% endwith %>
      <% endmarkers %>


    <% endif %>
  <% endif %>
<# collaboration graph #>
  <% if compound.hasCollaborationDiagram %>
      <{ tr.collaborationDiagramFor:compound.name }>
      <{ compound.collaborationDiagram }>


  <% endif %>
<# member declarations #>
<% if compound.hasDetails %>
  <% if compound.anchor %>
    \label{<{ compound.anchor|raw }>}
    <% if config.PDF_HYPERLINKS and config.USE_PDFLATEX %>
    \hypertarget{<% if compound.fileName %><{ compound.fileName|raw }>_<% endif %><{ compound.anchor|raw }>}{}
    <% endif %>
  <% endif %>
  <% if config.COMPACT_LATEX %>\subsubsection<% else %>\subsection<% endif %>{<{ tr.detailedDesc }>}
  <# template specifier #>
  <% if compound.language=='cpp' and compound.templateDecls %>
    <% spaceless %>
    \subsubsection*{
      <% for targList in compound.templateDecls %>
        template$<$
        <% for targ in targList %>
          <{ targ.type }><% if targ.name %><{ space }><{ targ.name }><% endif %><% if targ.defVal %><{ space }>= <{ targ.defVal }><% endif %><% if not forloop.last %>, <% endif %>
        <% endfor %>
        $>$\\*
      <% endfor %>
    <{ compound.compoundType }><{ space }><{ compound.name }>
    }
    <% endspaceless %>


  <% endif %>
  <% if compound.brief and config.REPEAT_BRIEF %>
  <{ compound.brief }>


  <% endif %>
  <{ compound.details }>


  <# type constraints #>
  <% with obj=compound %>
    <% include 'latextypeconstraints.tpl' %>
  <% endwith %>


<% endif %>
<% msg %>
  <# examples #>
    <% if compound.examples %>
      <dl><dt><b><{ tr.examples }></b><dd>
      <% markers obj in compound.examples with tr.exampleList:compound.examples|length %>
        <% with page=compound text=obj.text %>
          <% include 'htmlobjlink.tpl' %>
        <% endwith %>
      <% endmarkers %>
      </dd></dl>
    <% endif %>
  <# source definition #>
    <% if compound.sourceDef %>
      <% markers obj in compound.sourceDef with tr.definedAtLineInSourceFile %>
        <% with page=compound text=obj.text %>
          <% include 'htmlobjlink.tpl' %>
        <% endwith %>
      <% endmarkers %>
    <% endif %>
<% endmsg %>
<# detailed description #>
<# member definitions #>
<# used files #>
<# separate member pages #>