Doxygen
Loading...
Searching...
No Matches
htmlgen.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * Copyright (C) 1997-2023 by Dimitri van Heesch.
4 *
5 * Permission to use, copy, modify, and distribute this software and its
6 * documentation under the terms of the GNU General Public License is hereby
7 * granted. No representations are made about the suitability of this software
8 * for any purpose. It is provided "as is" without express or implied warranty.
9 * See the GNU General Public License for more details.
10 *
11 * Documents produced by Doxygen are derivative works derived from the
12 * input used in their production; they are not affected by this license.
13 *
14 */
15
16#ifndef HTMLGEN_H
17#define HTMLGEN_H
18
19#include "outputgen.h"
20
21class OutputCodeList;
22
23/** Generator for HTML code fragments */
25{
26 public:
27 HtmlCodeGenerator(TextStream *t,const QCString &relPath);
28 HtmlCodeGenerator(TextStream *t);
29
30 void setTextStream(TextStream *t) { m_t = t; }
31 void setFileName(const QCString fileName) { m_fileName = fileName; }
32 QCString fileName() { return m_fileName; }
33
34 OutputType type() const override { return OutputType::Html; }
35 std::unique_ptr<OutputCodeIntf> clone() override { return std::make_unique<HtmlCodeGenerator>(*this); }
36 void codify(const QCString &text) override;
37 void stripCodeComments(bool b) override;
38 void startSpecialComment() override;
39 void endSpecialComment() override;
40 void setStripIndentAmount(size_t amount) override;
42 const QCString &ref,const QCString &file,
43 const QCString &anchor,const QCString &name,
44 const QCString &tooltip) override;
45 void writeTooltip(const QCString &id,
46 const DocLinkInfo &docInfo,
47 const QCString &decl,
48 const QCString &desc,
49 const SourceLinkInfo &defInfo,
50 const SourceLinkInfo &declInfo
51 ) override;
52 void writeLineNumber(const QCString &,const QCString &,const QCString &,int, bool) override;
53 void startCodeLine(int) override;
54 void endCodeLine() override;
55 void startFontClass(const QCString &s) override;
56 void endFontClass() override;
57 void writeCodeAnchor(const QCString &anchor) override;
58 void startCodeFragment(const QCString &style) override;
59 void endCodeFragment(const QCString &) override;
60 void startFold(int,const QCString &,const QCString &) override;
61 void endFold() override;
62
63 void setRelativePath(const QCString &path);
64 private:
65 void _writeCodeLink(const QCString &className,
66 const QCString &ref,const QCString &file,
67 const QCString &anchor,const QCString &name,
68 const QCString &tooltip);
69 void _startOpenLine();
70 //void docify(const QCString &str);
71 TextStream *m_t;
72 size_t m_col = 0;
73 QCString m_relPath;
74 QCString m_fileName;
75 bool m_lineOpen = false;
76 bool m_stripCodeComments = false;
77 bool m_hide = false;
78 struct LineInfo
79 {
81 LineInfo(const QCString &r,const QCString &f,const QCString &a,int l,bool wa)
82 : ref(r), fileName(f), anchor(a), line(l), writeAnchor(wa) {}
83 QCString ref;
84 QCString fileName;
85 QCString anchor;
86 int line = -1;
87 bool writeAnchor = false;
88 };
91};
92
93/** Generator for HTML output */
95{
96 public:
103
104 static void init();
105 static void writeStyleSheetFile(TextStream &t);
106 static void writeHeaderFile(TextStream &t, const QCString &cssname);
107 static void writeFooterFile(TextStream &t);
108 static void writeTabData();
109 static void writeSearchInfoStatic(TextStream &t,const QCString &relPath);
110 static void writeSearchData(const QCString &dir);
111 static void writeSearchPage();
112 static void writeExternalSearchPage();
113 static QCString writeLogoAsString(const QCString &path);
114 static QCString writeSplitBarAsString(const QCString &name,const QCString &relpath);
115 static QCString getMathJaxMacros();
116 static QCString getNavTreeCss();
118
119 //---------------------------------------------------------------------
120
121 OutputType type() const override { return OutputType::Html; }
122 std::unique_ptr<OutputGenIntf> clone() override { return std::make_unique<HtmlGenerator>(*this); }
123 void addCodeGen(OutputCodeList &list) override;
124 void cleanup() override;
125 void writeDoc(const IDocNodeAST *node,const Definition *,const MemberDef *,int id) override;
126 void startFile(const QCString &name,const QCString &manName,const QCString &title,int id, int hierarchyLevel) override;
127 void endFile() override;
128
129 void writeFooter(const QCString &navPath) override;
130 void writeSearchInfo() override;
131
134 void writePageLink(const QCString &,bool) override {}
135 void startProjectNumber() override;
136 void endProjectNumber() override;
137 void writeStyleInfo(int part) override;
138 void startTitleHead(const QCString &) override;
139 void endTitleHead(const QCString &,const QCString &) override;
140
141 void startParagraph(const QCString &classDef) override;
142 void endParagraph() override;
143 void writeString(const QCString &text) override;
144 void startIndexListItem() override;
145 void endIndexListItem() override;
146 void startIndexList() override;
147 void endIndexList() override;
148 void startIndexKey() override;
149 void endIndexKey() override;
150 void startIndexValue(bool) override;
151 void endIndexValue(const QCString &,bool) override;
152 void startItemList() override { m_t << "<ul>\n"; }
153 void endItemList() override { m_t << "</ul>\n"; }
154 void startIndexItem(const QCString &ref,const QCString &file) override;
155 void endIndexItem(const QCString &ref,const QCString &file) override;
156 void docify(const QCString &text) override;
157
158 void writeObjectLink(const QCString &ref,const QCString &file,
159 const QCString &anchor,const QCString &name) override;
160
161 void startTextLink(const QCString &file,const QCString &anchor) override;
162 void endTextLink() override;
163 void startTypewriter() override { m_t << "<code>"; }
164 void endTypewriter() override { m_t << "</code>"; }
165 void startGroupHeader(int) override;
166 void endGroupHeader(int) override;
167 void startItemListItem() override { m_t << "<li>"; }
168 void endItemListItem() override { m_t << "</li>\n"; }
169
170 void startMemberSections() override;
171 void endMemberSections() override;
172 void startHeaderSection() override;
173 void endHeaderSection() override;
174 void startMemberHeader(const QCString &, int) override;
175 void endMemberHeader() override;
176 void startMemberSubtitle() override;
177 void endMemberSubtitle() override;
178 void startMemberDocList() override;
179 void endMemberDocList() override;
180 void startMemberList() override;
181 void endMemberList() override;
182 void startInlineHeader() override;
183 void endInlineHeader() override;
184 void startAnonTypeScope(int) override {}
185 void endAnonTypeScope(int) override {}
186 void startMemberItem(const QCString &anchor,MemberItemType,const QCString &inheritId) override;
187 void endMemberItem(MemberItemType) override;
188 void startMemberTemplateParams() override;
189 void endMemberTemplateParams(const QCString &anchor,const QCString &inheritId) override;
190 void startCompoundTemplateParams() override;
191 void endCompoundTemplateParams() override;
192
193 void startMemberGroupHeader(bool) override;
194 void endMemberGroupHeader() override;
195 void startMemberGroupDocs() override;
196 void endMemberGroupDocs() override;
197 void startMemberGroup() override;
198 void endMemberGroup(bool) override;
199
200 void insertMemberAlign(bool) override;
201 void insertMemberAlignLeft(MemberItemType,bool) override;
202 void startMemberDescription(const QCString &anchor,const QCString &inheritId, bool typ) override;
203 void endMemberDescription() override;
204 void startMemberDeclaration() override {}
205 void endMemberDeclaration(const QCString &anchor,const QCString &inheritId) override;
206 void writeInheritedSectionTitle(const QCString &id, const QCString &ref,
207 const QCString &file, const QCString &anchor,
208 const QCString &title,const QCString &name) override;
209
210 void writeRuler() override { m_t << "<hr/>"; }
211 void writeAnchor(const QCString &,const QCString &name)
212 override { m_t << "<a name=\"" << name <<"\" id=\"" << name << "\"></a>"; }
213 void startEmphasis() override { m_t << "<em>"; }
214 void endEmphasis() override { m_t << "</em>"; }
215 void startBold() override { m_t << "<b>"; }
216 void endBold() override { m_t << "</b>"; }
217 void startDescForItem() override { m_t << "<dd>"; }
218 void endDescForItem() override { m_t << "</dd>\n"; }
219 void lineBreak(const QCString &style) override;
220 void writeChar(char c) override;
221 void startMemberDoc(const QCString &clName, const QCString &memName,
222 const QCString &anchor, const QCString &title,
223 int memCount, int memTotal, bool showInline) override;
224 void endMemberDoc(bool) override;
225 void startDoxyAnchor(const QCString &fName,const QCString &manName,
226 const QCString &anchor,const QCString &name,
227 const QCString &args) override;
228 void endDoxyAnchor(const QCString &fName,const QCString &anchor) override;
229 void addLabel(const QCString &,const QCString &) override;
230 void writeLatexSpacing() override {}
231 void writeStartAnnoItem(const QCString &type,const QCString &file,
232 const QCString &path,const QCString &name) override;
233 void startCenter() override { m_t << "<center>\n"; }
234 void endCenter() override { m_t << "</center>\n"; }
235 void startSmall() override { m_t << "<small>\n"; }
236 void endSmall() override { m_t << "</small>\n"; }
237 void startExamples() override;
238 void endExamples() override;
239 void startSection(const QCString &,const QCString &,SectionType) override;
240 void endSection(const QCString &,SectionType) override;
241 void addIndexItem(const QCString &,const QCString &) override;
242 void startIndent() override;
243 void endIndent() override;
244 void writeSynopsis() override {}
245 void startClassDiagram() override;
246 void endClassDiagram(const ClassDiagram &,const QCString &,const QCString &) override;
247 void startPageRef() override {}
248 void endPageRef(const QCString &,const QCString &) override {}
249 void startQuickIndices() override {}
250 void endQuickIndices() override;
251 void writeSplitBar(const QCString &name) override;
252 void writeNavigationPath(const QCString &s) override;
253 void writeLogo() override;
254 void writeQuickLinks(HighlightedItem hli,const QCString &file) override;
255 void writeSummaryLink(const QCString &file,const QCString &anchor,const QCString &title,bool first) override;
256 void startContents() override;
257 void endContents() override;
258 void startPageDoc(const QCString &pageTitle) override;
259 void endPageDoc() override;
260 void writeNonBreakableSpace(int) override;
261
262 void startDescTable(const QCString &title,const bool hasInits) override;
263 void endDescTable() override;
264 void startDescTableRow() override;
265 void endDescTableRow() override;
266 void startDescTableTitle() override;
267 void endDescTableTitle() override;
268 void startDescTableInit() override;
269 void endDescTableInit() override;
270 void startDescTableData() override;
271 void endDescTableData() override;
272
273 void startDotGraph() override;
274 void endDotGraph(DotClassGraph &g) override;
275 void startInclDepGraph() override;
276 void endInclDepGraph(DotInclDepGraph &g) override;
277 void startGroupCollaboration() override;
278 void endGroupCollaboration(DotGroupCollaboration &g) override;
279 void startCallGraph() override;
280 void endCallGraph(DotCallGraph &g) override;
281 void startDirDepGraph() override;
282 void endDirDepGraph(DotDirDeps &g) override;
283 void writeGraphicalHierarchy(DotGfxHierarchyTable &g) override;
284
285 void startTextBlock(bool) override { m_t << "<div class=\"textblock\">"; }
286 void endTextBlock(bool) override { m_t << "</div>"; }
287 void lastIndexPage() override {}
288
289 void startMemberDocPrefixItem() override;
290 void endMemberDocPrefixItem() override;
291 void startMemberDocName(bool) override;
292 void endMemberDocName() override;
293 void startParameterType(bool first,const QCString &key) override;
294 void endParameterType() override;
295 void startParameterName(bool) override;
296 void endParameterName() override;
297 void startParameterExtra() override;
298 void endParameterExtra(bool last,bool emptyList,bool closeBracket) override;
299 void startParameterDefVal(const char *sep) override;
300 void endParameterDefVal() override;
301 void startParameterList(bool) override;
302 void endParameterList() override;
303 void exceptionEntry(const QCString &,bool) override;
304
305 void startConstraintList(const QCString &) override;
306 void startConstraintParam() override;
307 void endConstraintParam() override;
308 void startConstraintType() override;
309 void endConstraintType() override;
310 void startConstraintDocs() override;
311 void endConstraintDocs() override;
312 void endConstraintList() override;
313
314 void startMemberDocSimple(bool) override;
315 void endMemberDocSimple(bool) override;
316 void startInlineMemberType() override;
317 void endInlineMemberType() override;
318 void startInlineMemberName() override;
319 void endInlineMemberName() override;
320 void startInlineMemberDoc() override;
321 void endInlineMemberDoc() override;
322
323 void startLabels() override;
324 void writeLabel(const QCString &l,bool isLast) override;
325 void endLabels() override;
326
327 void writeLocalToc(const SectionRefs &sr,const LocalToc &lt) override;
328
329 void startPlainFile(const QCString &name) override { OutputGenerator::startPlainFile(name); }
331
332 private:
333 void startTitle() { m_t << "<div class=\"title\">"; }
334 void endTitle() { m_t << "</div>"; }
335 static void writePageFooter(TextStream &t,const QCString &,const QCString &,const QCString &);
336 void docify_(const QCString &text,bool inHtmlComment);
337
338 QCString m_lastTitle;
339 QCString m_lastFile;
340 QCString m_relPath;
342 bool m_emptySection = false;
343 std::unique_ptr<OutputCodeList> m_codeList;
344 HtmlCodeGenerator *m_codeGen = nullptr;
345};
346
347#endif
void codify(const QCString &text) override
Definition htmlgen.cpp:725
bool m_stripCodeComments
Definition htmlgen.h:76
void startSpecialComment() override
Definition htmlgen.cpp:811
void setFileName(const QCString fileName)
Definition htmlgen.h:31
void endCodeLine() override
Definition htmlgen.cpp:994
QCString m_fileName
Definition htmlgen.h:74
void startFontClass(const QCString &s) override
Definition htmlgen.cpp:1009
void writeCodeAnchor(const QCString &anchor) override
Definition htmlgen.cpp:1021
QCString fileName()
Definition htmlgen.h:32
size_t m_stripIndentAmount
Definition htmlgen.h:90
QCString m_relPath
Definition htmlgen.h:73
void writeCodeLink(CodeSymbolType type, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip) override
Definition htmlgen.cpp:859
void startFold(int, const QCString &, const QCString &) override
Definition htmlgen.cpp:1040
void writeLineNumber(const QCString &, const QCString &, const QCString &, int, bool) override
Definition htmlgen.cpp:828
void startCodeLine(int) override
Definition htmlgen.cpp:983
void endFold() override
Definition htmlgen.cpp:1074
void _writeCodeLink(const QCString &className, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name, const QCString &tooltip)
Definition htmlgen.cpp:875
void setRelativePath(const QCString &path)
Definition htmlgen.cpp:720
void setStripIndentAmount(size_t amount) override
Definition htmlgen.cpp:823
void endSpecialComment() override
Definition htmlgen.cpp:817
HtmlCodeGenerator(TextStream *t, const QCString &relPath)
Definition htmlgen.cpp:714
void writeTooltip(const QCString &id, const DocLinkInfo &docInfo, const QCString &decl, const QCString &desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo) override
Definition htmlgen.cpp:903
void endFontClass() override
Definition htmlgen.cpp:1015
void startCodeFragment(const QCString &style) override
Definition htmlgen.cpp:1027
std::unique_ptr< OutputCodeIntf > clone() override
Definition htmlgen.h:35
TextStream * m_t
Definition htmlgen.h:71
void setTextStream(TextStream *t)
Definition htmlgen.h:30
LineInfo m_lastLineInfo
Definition htmlgen.h:89
void endCodeFragment(const QCString &) override
Definition htmlgen.cpp:1032
void stripCodeComments(bool b) override
Definition htmlgen.cpp:806
OutputType type() const override
Definition htmlgen.h:34
void startClassDiagram() override
Definition htmlgen.cpp:2000
void writeLogo() override
Definition htmlgen.cpp:1575
void endFile() override
Definition htmlgen.cpp:1591
void startDescForItem() override
Definition htmlgen.h:217
void endParameterExtra(bool last, bool emptyList, bool closeBracket) override
Definition htmlgen.cpp:2341
static void init()
Definition htmlgen.cpp:1135
void startInlineMemberName() override
Definition htmlgen.cpp:3393
void endDescTableInit() override
Definition htmlgen.cpp:2613
void startTitle()
Definition htmlgen.h:333
void startTextLink(const QCString &file, const QCString &anchor) override
Definition htmlgen.cpp:1800
void startInlineMemberType() override
Definition htmlgen.cpp:3381
void endDescTable() override
Definition htmlgen.cpp:2583
void startEmphasis() override
Definition htmlgen.h:213
void startParameterDefVal(const char *sep) override
Definition htmlgen.cpp:2365
void endMemberGroupHeader() override
Definition htmlgen.cpp:2530
void startIndexKey() override
Definition htmlgen.cpp:2218
void lineBreak(const QCString &style) override
Definition htmlgen.cpp:3317
void startParameterName(bool) override
Definition htmlgen.cpp:2324
void startMemberItem(const QCString &anchor, MemberItemType, const QCString &inheritId) override
Definition htmlgen.cpp:2053
static void writeSearchPage()
Definition htmlgen.cpp:3071
void startInclDepGraph() override
Definition htmlgen.cpp:2448
void insertMemberAlignLeft(MemberItemType, bool) override
Definition htmlgen.cpp:2116
void startMemberSubtitle() override
Definition htmlgen.cpp:2196
void startMemberDeclaration() override
Definition htmlgen.h:204
HtmlGenerator & operator=(const HtmlGenerator &)
Definition htmlgen.cpp:1110
void writeFooter(const QCString &navPath) override
Definition htmlgen.cpp:1586
void startItemListItem() override
Definition htmlgen.h:167
void endAnonTypeScope(int) override
Definition htmlgen.h:185
int m_sectionCount
Definition htmlgen.h:341
void startMemberDocName(bool) override
Definition htmlgen.cpp:2277
void endParameterType() override
Definition htmlgen.cpp:2318
void startLabels() override
Definition htmlgen.cpp:3417
void startCallGraph() override
Definition htmlgen.cpp:2484
void endMemberList() override
Definition htmlgen.cpp:2044
static QCString getNavTreeCss()
Definition htmlgen.cpp:3510
void startParagraph(const QCString &classDef) override
Definition htmlgen.cpp:1693
void endIndexList() override
Definition htmlgen.cpp:2213
void writeSearchInfo() override
Definition htmlgen.cpp:1538
void startCenter() override
Definition htmlgen.h:233
void startContents() override
Definition htmlgen.cpp:3045
void startMemberDoc(const QCString &clName, const QCString &memName, const QCString &anchor, const QCString &title, int memCount, int memTotal, bool showInline) override
Definition htmlgen.cpp:2248
void startDescTableRow() override
Definition htmlgen.cpp:2588
void startBold() override
Definition htmlgen.h:215
void startDoxyAnchor(const QCString &fName, const QCString &manName, const QCString &anchor, const QCString &name, const QCString &args) override
Definition htmlgen.cpp:1678
void startDirDepGraph() override
Definition htmlgen.cpp:2502
void startCompoundTemplateParams() override
Definition htmlgen.cpp:2099
void startConstraintParam() override
Definition htmlgen.cpp:3279
void endGroupHeader(int) override
Definition htmlgen.cpp:1833
QCString m_lastFile
Definition htmlgen.h:339
void writeNavigationPath(const QCString &s) override
Definition htmlgen.cpp:3040
void startTypewriter() override
Definition htmlgen.h:163
void writeObjectLink(const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name) override
Definition htmlgen.cpp:1776
void startMemberDescription(const QCString &anchor, const QCString &inheritId, bool typ) override
Definition htmlgen.cpp:2128
void endEmphasis() override
Definition htmlgen.h:214
void writeRuler() override
Definition htmlgen.h:210
void writeChar(char c) override
Definition htmlgen.cpp:1918
void endConstraintList() override
Definition htmlgen.cpp:3309
void endParameterList() override
Definition htmlgen.cpp:2377
void writeDoc(const IDocNodeAST *node, const Definition *, const MemberDef *, int id) override
Definition htmlgen.cpp:2640
void startDotGraph() override
Definition htmlgen.cpp:2414
void writeLatexSpacing() override
Definition htmlgen.h:230
void endIndent() override
Definition htmlgen.cpp:2560
void endParameterName() override
Definition htmlgen.cpp:2330
void endPageDoc() override
Definition htmlgen.cpp:3060
void startMemberDocList() override
Definition htmlgen.cpp:2238
static QCString writeLogoAsString(const QCString &path)
Definition htmlgen.cpp:1544
void endDescTableRow() override
Definition htmlgen.cpp:2593
void writeSplitBar(const QCString &name) override
Definition htmlgen.cpp:3035
void startParameterType(bool first, const QCString &key) override
Definition htmlgen.cpp:2301
void startQuickIndices() override
Definition htmlgen.h:249
void startDescTableInit() override
Definition htmlgen.cpp:2608
void startMemberList() override
Definition htmlgen.cpp:2039
void endQuickIndices() override
Definition htmlgen.cpp:2981
void startHeaderSection() override
Definition htmlgen.cpp:3329
void startDescTableTitle() override
Definition htmlgen.cpp:2598
void endDirDepGraph(DotDirDeps &g) override
Definition htmlgen.cpp:2507
void endSmall() override
Definition htmlgen.h:236
void startIndexList() override
Definition htmlgen.cpp:2208
void endItemListItem() override
Definition htmlgen.h:168
void endParameterDefVal() override
Definition htmlgen.cpp:2372
void endMemberGroup(bool) override
Definition htmlgen.cpp:2549
void endInlineHeader() override
Definition htmlgen.cpp:3361
void writeSynopsis() override
Definition htmlgen.h:244
static void writeFooterFile(TextStream &t)
Definition htmlgen.cpp:1457
void endMemberDescription() override
Definition htmlgen.cpp:2147
void startGroupCollaboration() override
Definition htmlgen.cpp:2466
void endClassDiagram(const ClassDiagram &, const QCString &, const QCString &) override
Definition htmlgen.cpp:2005
void startConstraintList(const QCString &) override
Definition htmlgen.cpp:3272
void startDescTable(const QCString &title, const bool hasInits) override
Definition htmlgen.cpp:2578
void endConstraintDocs() override
Definition htmlgen.cpp:3304
void writeNonBreakableSpace(int) override
Definition htmlgen.cpp:2570
void writeQuickLinks(HighlightedItem hli, const QCString &file) override
Definition htmlgen.cpp:3065
void startInlineMemberDoc() override
Definition htmlgen.cpp:3405
void exceptionEntry(const QCString &, bool) override
Definition htmlgen.cpp:2384
static void writeTabData()
Additional initialization after indices have been created.
Definition htmlgen.cpp:1291
void endExamples() override
Definition htmlgen.cpp:2635
void endIndexKey() override
Definition htmlgen.cpp:2223
void writeString(const QCString &text) override
Definition htmlgen.cpp:1706
HtmlGenerator(HtmlGenerator &&)=delete
void endMemberDocName() override
Definition htmlgen.cpp:2287
void endContents() override
Definition htmlgen.cpp:3050
void endInlineMemberType() override
Definition htmlgen.cpp:3387
void startMemberGroupDocs() override
Definition htmlgen.cpp:2535
void startMemberDocSimple(bool) override
Definition htmlgen.cpp:3366
void startIndexItem(const QCString &ref, const QCString &file) override
Definition htmlgen.cpp:1721
void endDescForItem() override
Definition htmlgen.h:218
OutputType type() const override
Definition htmlgen.h:121
void endHeaderSection() override
Definition htmlgen.cpp:3346
void startIndent() override
Definition htmlgen.cpp:2553
void writeStyleInfo(int part) override
Definition htmlgen.cpp:1606
void addIndexItem(const QCString &, const QCString &) override
Definition htmlgen.cpp:2566
void docify_(const QCString &text, bool inHtmlComment)
Definition htmlgen.cpp:1885
void endMemberGroupDocs() override
Definition htmlgen.cpp:2540
void cleanup() override
Definition htmlgen.cpp:1283
void endDotGraph(DotClassGraph &g) override
Definition htmlgen.cpp:2419
void startIndexSection(IndexSection) override
Definition htmlgen.h:132
void endMemberHeader() override
Definition htmlgen.cpp:2190
void endTextLink() override
Definition htmlgen.cpp:1812
void writeLabel(const QCString &l, bool isLast) override
Definition htmlgen.cpp:3423
void startMemberSections() override
Definition htmlgen.cpp:2153
static void writeSearchData(const QCString &dir)
Definition htmlgen.cpp:1329
static QCString writeSplitBarAsString(const QCString &name, const QCString &relpath)
Definition htmlgen.cpp:2991
void endMemberSections() override
Definition htmlgen.cpp:2161
void endMemberDocList() override
Definition htmlgen.cpp:2243
void endCompoundTemplateParams() override
Definition htmlgen.cpp:2104
static void writeExternalSearchPage()
Definition htmlgen.cpp:3162
void endDescTableData() override
Definition htmlgen.cpp:2623
void endCenter() override
Definition htmlgen.h:234
void startDescTableData() override
Definition htmlgen.cpp:2618
void writeStartAnnoItem(const QCString &type, const QCString &file, const QCString &path, const QCString &name) override
Definition htmlgen.cpp:1764
static void writePageFooter(TextStream &t, const QCString &, const QCString &, const QCString &)
Definition htmlgen.cpp:1580
void endParagraph() override
Definition htmlgen.cpp:1701
void insertMemberAlign(bool) override
Definition htmlgen.cpp:2109
static void writeStyleSheetFile(TextStream &t)
Definition htmlgen.cpp:1445
void endDoxyAnchor(const QCString &fName, const QCString &anchor) override
Definition htmlgen.cpp:1685
void startMemberTemplateParams() override
Definition htmlgen.cpp:2084
void endLabels() override
Definition htmlgen.cpp:3431
void startPageDoc(const QCString &pageTitle) override
Definition htmlgen.cpp:3055
void endMemberDeclaration(const QCString &anchor, const QCString &inheritId) override
Definition htmlgen.cpp:3495
HtmlCodeGenerator * m_codeGen
Definition htmlgen.h:344
HtmlGenerator & operator=(HtmlGenerator &&)=delete
void startIndexValue(bool) override
Definition htmlgen.cpp:2228
void endGroupCollaboration(DotGroupCollaboration &g) override
Definition htmlgen.cpp:2471
QCString m_relPath
Definition htmlgen.h:340
static void writeSearchInfoStatic(TextStream &t, const QCString &relPath)
Definition htmlgen.cpp:1508
std::unique_ptr< OutputCodeList > m_codeList
Definition htmlgen.h:343
static void writeHeaderFile(TextStream &t, const QCString &cssname)
Definition htmlgen.cpp:1451
void startConstraintType() override
Definition htmlgen.cpp:3289
void endConstraintParam() override
Definition htmlgen.cpp:3284
void startTitleHead(const QCString &) override
Definition htmlgen.cpp:3334
void startFile(const QCString &name, const QCString &manName, const QCString &title, int id, int hierarchyLevel) override
Definition htmlgen.cpp:1465
void endIndexValue(const QCString &, bool) override
Definition htmlgen.cpp:2233
void addCodeGen(OutputCodeList &list) override
Definition htmlgen.cpp:1130
void startConstraintDocs() override
Definition htmlgen.cpp:3299
void lastIndexPage() override
Definition htmlgen.h:287
void endMemberTemplateParams(const QCString &anchor, const QCString &inheritId) override
Definition htmlgen.cpp:2088
void endPlainFile() override
Definition htmlgen.h:330
void startIndexListItem() override
Definition htmlgen.cpp:1711
void endProjectNumber() override
Definition htmlgen.cpp:1601
void startPageRef() override
Definition htmlgen.h:247
void endBold() override
Definition htmlgen.h:216
void writeSummaryLink(const QCString &file, const QCString &anchor, const QCString &title, bool first) override
Definition htmlgen.cpp:3468
void endMemberDocPrefixItem() override
Definition htmlgen.cpp:2271
void endDescTableTitle() override
Definition htmlgen.cpp:2603
void addLabel(const QCString &, const QCString &) override
Definition htmlgen.cpp:1689
void writeAnchor(const QCString &, const QCString &name) override
Definition htmlgen.h:211
void endInclDepGraph(DotInclDepGraph &g) override
Definition htmlgen.cpp:2453
void startParameterExtra() override
Definition htmlgen.cpp:2336
void writeLocalToc(const SectionRefs &sr, const LocalToc &lt) override
Definition htmlgen.cpp:3516
void endPageRef(const QCString &, const QCString &) override
Definition htmlgen.h:248
void startProjectNumber() override
Definition htmlgen.cpp:1596
void endIndexSection(IndexSection) override
Definition htmlgen.h:133
void writeGraphicalHierarchy(DotGfxHierarchyTable &g) override
Definition htmlgen.cpp:2520
void startExamples() override
Definition htmlgen.cpp:2628
std::unique_ptr< OutputGenIntf > clone() override
Definition htmlgen.h:122
void startAnonTypeScope(int) override
Definition htmlgen.h:184
void docify(const QCString &text) override
Definition htmlgen.cpp:1880
void endTextBlock(bool) override
Definition htmlgen.h:286
void startTextBlock(bool) override
Definition htmlgen.h:285
bool m_emptySection
Definition htmlgen.h:342
void endInlineMemberDoc() override
Definition htmlgen.cpp:3411
void endCallGraph(DotCallGraph &g) override
Definition htmlgen.cpp:2489
void endConstraintType() override
Definition htmlgen.cpp:3294
void endMemberSubtitle() override
Definition htmlgen.cpp:2202
void endTitle()
Definition htmlgen.h:334
void startGroupHeader(int) override
Definition htmlgen.cpp:1817
void startMemberDocPrefixItem() override
Definition htmlgen.cpp:2265
void startSection(const QCString &, const QCString &, SectionType) override
Definition htmlgen.cpp:1849
void endMemberItem(MemberItemType) override
Definition htmlgen.cpp:2075
void startMemberGroup() override
Definition htmlgen.cpp:2545
void endMemberDoc(bool) override
Definition htmlgen.cpp:2403
void endIndexItem(const QCString &ref, const QCString &file) override
Definition htmlgen.cpp:1751
void startMemberHeader(const QCString &, int) override
Definition htmlgen.cpp:2170
void endTitleHead(const QCString &, const QCString &) override
Definition htmlgen.cpp:3340
void endSection(const QCString &, SectionType) override
Definition htmlgen.cpp:1865
void startInlineHeader() override
Definition htmlgen.cpp:3351
void endInlineMemberName() override
Definition htmlgen.cpp:3399
void endMemberDocSimple(bool) override
Definition htmlgen.cpp:3375
void writePageLink(const QCString &, bool) override
Definition htmlgen.h:134
void writeInheritedSectionTitle(const QCString &id, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &title, const QCString &name) override
Definition htmlgen.cpp:3437
void clearBuffer()
void endIndexListItem() override
Definition htmlgen.cpp:1716
static QCString getMathJaxMacros()
Definition htmlgen.cpp:3505
void startParameterList(bool) override
Definition htmlgen.cpp:2293
void endTypewriter() override
Definition htmlgen.h:164
void startSmall() override
Definition htmlgen.h:235
QCString m_lastTitle
Definition htmlgen.h:338
void startMemberGroupHeader(bool) override
Definition htmlgen.cpp:2525
void startItemList() override
Definition htmlgen.h:152
void endItemList() override
Definition htmlgen.h:153
void startPlainFile(const QCString &name) override
Definition htmlgen.h:329
OutputCodeIntf()=default
Class representing a list of different code generators.
Definition outputlist.h:164
Abstract interface for output generators.
Definition outputgen.h:127
QCString dir() const
Definition outputgen.cpp:52
void startPlainFile(const QCString &name)
Definition outputgen.cpp:32
void endPlainFile()
Definition outputgen.cpp:44
TextStream m_t
Definition outputgen.h:116
HighlightedItem
Definition index.h:59
IndexSection
Definition index.h:32
OutputType
Definition outputgen.h:59
LineInfo(const QCString &r, const QCString &f, const QCString &a, int l, bool wa)
Definition htmlgen.h:81
CodeSymbolType
Definition types.h:319