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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
/******************************************************************************
*
*
*
* Copyright (C) 1997-2015 by Dimitri van Heesch.
*
* Permission to use, copy, modify, and distribute this software and its
* documentation under the terms of the GNU General Public License is hereby
* granted. No representations are made about the suitability of this software
* for any purpose. It is provided "as is" without express or implied warranty.
* See the GNU General Public License for more details.
*
* Documents produced by Doxygen are derivative works derived from the
* input used in their production; they are not affected by this license.
*
*/
#ifndef MANGEN_H
#define MANGEN_H
#include "outputgen.h"
/** Generator for Man page output. */
class ManGenerator : public OutputGenerator
{
public:
ManGenerator();
ManGenerator(const ManGenerator &g);
ManGenerator &operator=(const ManGenerator &g);
virtual ~ManGenerator();
virtual std::unique_ptr<OutputGenerator> clone() const;
OutputType type() const { return Man; }
void writeDoc(const IDocNodeAST *ast,const Definition *,const MemberDef *,int);
static void init();
void cleanup();
void startFile(const QCString &name,const QCString &manName,const QCString &title,int);
void writeSearchInfo() {}
void writeFooter(const QCString &) {}
void endFile();
void clearBuffer();
void startIndexSection(IndexSections) {}
void endIndexSection(IndexSections) {}
void writePageLink(const QCString &,bool) {}
void startProjectNumber() {}
void endProjectNumber() {}
void writeStyleInfo(int) {}
void startTitleHead(const QCString &) {}
void endTitleHead(const QCString &,const QCString &);
void startTitle();
void endTitle();
void newParagraph();
void startParagraph(const QCString &classDef);
void endParagraph();
void writeString(const QCString &text);
void startIndexListItem() {}
void endIndexListItem() {}
void startIndexList() {}
void endIndexList() { newParagraph(); }
void startIndexKey() {}
void endIndexKey() {}
void startIndexValue(bool) {}
void endIndexValue(const QCString &,bool) {}
void startItemList() {}
void endItemList() { newParagraph(); }
void startIndexItem(const QCString &ref,const QCString &file);
void endIndexItem(const QCString &ref,const QCString &file);
void docify(const QCString &text);
void codify(const QCString &text);
void writeObjectLink(const QCString &ref,const QCString &file,
const QCString &anchor,const QCString &name);
void writeCodeLink(CodeSymbolType type,
const QCString &ref,const QCString &file,
const QCString &anchor,const QCString &name,
const QCString &tooltip);
void writeTooltip(const QCString &, const DocLinkInfo &, const QCString &,
const QCString &, const SourceLinkInfo &, const SourceLinkInfo &
) {}
void startTextLink(const QCString &,const QCString &) {}
void endTextLink() {}
void startHtmlLink(const QCString &url);
void endHtmlLink();
void startTypewriter() { m_t << "\\fC"; m_firstCol=FALSE; }
void endTypewriter() { m_t << "\\fP"; m_firstCol=FALSE; }
void startGroupHeader(int);
void endGroupHeader(int);
void startMemberSections() {}
void endMemberSections() {}
void startHeaderSection() {}
void endHeaderSection();
void startMemberHeader(const QCString &,int);
void endMemberHeader();
void insertMemberAlign(bool) {}
void insertMemberAlignLeft(int,bool){}
void startMemberSubtitle() {}
void endMemberSubtitle() {}
void startItemListItem();
void endItemListItem();
void startMemberDocList() {}
void endMemberDocList() {}
void startMemberList();
void endMemberList();
void startInlineHeader();
void endInlineHeader();
void startAnonTypeScope(int);
void endAnonTypeScope(int);
void startMemberItem(const QCString &,int,const QCString &);
void endMemberItem();
void startMemberTemplateParams() {}
void endMemberTemplateParams(const QCString &,const QCString &) {}
void startCompoundTemplateParams() { startSubsubsection(); }
void endCompoundTemplateParams() { endSubsubsection(); }
void startMemberGroupHeader(bool);
void endMemberGroupHeader();
void startMemberGroupDocs();
void endMemberGroupDocs();
void startMemberGroup();
void endMemberGroup(bool);
void writeRuler() {}
void writeAnchor(const QCString &,const QCString &) {}
void startCodeFragment(const QCString &);
void endCodeFragment(const QCString &);
void writeLineNumber(const QCString &,const QCString &,const QCString &,int l, bool) { m_t << l << " "; m_col=0; }
void startCodeLine(bool) {}
void endCodeLine() { codify("\n"); m_col=0; }
void startEmphasis() { m_t << "\\fI"; m_firstCol=FALSE; }
void endEmphasis() { m_t << "\\fP"; m_firstCol=FALSE; }
void startBold() { m_t << "\\fB"; m_firstCol=FALSE; }
void endBold() { m_t << "\\fP"; m_firstCol=FALSE; }
void startDescription() {}
void endDescription() {}
void startDescItem();
void endDescItem();
void lineBreak(const QCString &) { m_t << "\n.br\n"; }
void writeChar(char c);
void startMemberDoc(const QCString &,const QCString &,const QCString &,const QCString &,int,int,bool);
void endMemberDoc(bool);
void startDoxyAnchor(const QCString &,const QCString &,const QCString &,const QCString &,const QCString &);
void endDoxyAnchor(const QCString &,const QCString &) {}
void writeLatexSpacing() {}
void writeStartAnnoItem(const QCString &type,const QCString &file,
const QCString &path,const QCString &name);
void writeEndAnnoItem(const QCString &) { m_t << "\n"; m_firstCol=TRUE; }
void startSubsection();
void endSubsection();
void startSubsubsection();
void endSubsubsection();
void startCenter() {}
void endCenter() {}
void startSmall() {}
void endSmall() {}
void startMemberDescription(const QCString &,const QCString &,bool) { m_t << "\n.RI \""; m_firstCol=FALSE; }
void endMemberDescription() { m_t << "\""; m_firstCol=FALSE; }
void startMemberDeclaration() {}
void endMemberDeclaration(const QCString &,const QCString &) {}
void writeInheritedSectionTitle(const QCString &,const QCString &,const QCString &,
const QCString &,const QCString &,const QCString &) {}
void startDescList(SectionTypes);
void endDescList() {}
void startExamples();
void endExamples();
void startParamList(ParamListTypes,const QCString &title);
void endParamList();
void startDescForItem();
void endDescForItem();
void startSection(const QCString &,const QCString &,SectionType);
void endSection(const QCString &,SectionType);
void addIndexItem(const QCString &,const QCString &) {}
void startIndent() {}
void endIndent() {}
void writeSynopsis();
void startClassDiagram() {}
void endClassDiagram(const ClassDiagram &,const QCString &,const QCString &) {}
void startPageRef() {}
void endPageRef(const QCString &,const QCString &) {}
void startQuickIndices() {}
void endQuickIndices() {}
void writeSplitBar(const QCString &) {}
void writeNavigationPath(const QCString &) {}
void writeLogo() {}
void writeQuickLinks(bool,HighlightedItem,const QCString &) {}
void writeSummaryLink(const QCString &,const QCString &,const QCString &,bool) {}
void startContents() {}
void endContents() {}
void writeNonBreakableSpace(int n) { int i; for (i=0;i<n;i++) m_t << " "; }
void startDescTable(const QCString &t);
void endDescTable();
void startDescTableRow() {}
void endDescTableRow() {}
void startDescTableTitle() { startItemListItem(); startBold(); startEmphasis(); endItemListItem(); }
void endDescTableTitle() { endEmphasis(); endBold(); }
void startDescTableData() { m_t << "\n"; m_firstCol=TRUE; }
void endDescTableData() {}
void startDotGraph() {}
void endDotGraph(DotClassGraph &) {}
void startInclDepGraph() {}
void endInclDepGraph(DotInclDepGraph &) {}
void startGroupCollaboration() {}
void endGroupCollaboration(DotGroupCollaboration &) {}
void startCallGraph() {}
void endCallGraph(DotCallGraph &) {}
void startDirDepGraph() {}
void endDirDepGraph(DotDirDeps &) {}
void writeGraphicalHierarchy(DotGfxHierarchyTable &) {}
void startTextBlock(bool) {}
void endTextBlock(bool) {}
void lastIndexPage() {}
void startMemberDocPrefixItem() {}
void endMemberDocPrefixItem() {}
void startMemberDocName(bool) {}
void endMemberDocName() {}
void startParameterType(bool,const QCString &) {}
void endParameterType() {}
void startParameterName(bool) {}
void endParameterName(bool,bool,bool) {}
void startParameterList(bool) {}
void endParameterList() {}
void exceptionEntry(const QCString &,bool) {}
void startFontClass(const QCString &) {}
void endFontClass() {}
void startConstraintList(const QCString &);
void startConstraintParam();
void endConstraintParam();
void startConstraintType();
void endConstraintType();
void startConstraintDocs();
void endConstraintDocs();
void endConstraintList();
void startMemberDocSimple(bool);
void endMemberDocSimple(bool);
void startInlineMemberType();
void endInlineMemberType();
void startInlineMemberName();
void endInlineMemberName();
void startInlineMemberDoc();
void endInlineMemberDoc();
void startLabels();
void writeLabel(const QCString &l,bool isLast);
void endLabels();
void writeCodeAnchor(const QCString &) {}
private:
bool m_firstCol = true;
bool m_paragraph = true;
int m_col = 0;
bool m_upperCase = false;
bool m_insideTabbing = false;
bool m_inHeader = false;
};
#endif
|
