Doxygen
Toggle main menu visibility
Loading...
Searching...
No Matches
devnullgen.h
Go to the documentation of this file.
1
/******************************************************************************
2
*
3
* Copyright (C) 1997-2026 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 DEVNULLGEN_H
17
#define DEVNULLGEN_H
18
19
#include "
outputgen.h
"
20
21
/** Class implementing OutputCodeIntf by throwing away everything. */
22
class
DevNullCodeGenerator
final :
public
OutputCodeIntf
23
{
24
public
:
25
OutputType
type
()
const override
{
return
OutputType::Null
; }
26
std::unique_ptr<OutputCodeIntf>
clone
()
override
{
return
std::make_unique<DevNullCodeGenerator>(*
this
); }
27
void
codify
(
const
DString
&)
override
{}
28
void
stripCodeComments
(
bool
)
override
{}
29
void
startSpecialComment
()
override
{}
30
void
endSpecialComment
()
override
{}
31
void
setStripIndentAmount
(
size_t
)
override
{}
32
void
writeCodeLink
(
CodeSymbolType
,
33
const
DString
&,
const
DString
&,
34
const
DString
&,
const
DString
&,
35
const
DString
&)
override
{}
36
void
writeTooltip
(
const
DString
&,
const
DocLinkInfo
&,
const
DString
&,
37
const
DString
&,
const
SourceLinkInfo
&,
const
SourceLinkInfo
&
38
)
override
{}
39
void
writeLineNumber
(
const
DString
&,
const
DString
&,
40
const
DString
&,
int
,
bool
)
override
{}
41
void
startCodeLine
(
int
)
override
{}
42
void
endCodeLine
()
override
{}
43
void
startFontClass
(
const
DString
&)
override
{}
44
void
endFontClass
()
override
{}
45
void
writeCodeAnchor
(
const
DString
&)
override
{}
46
void
startCodeFragment
(
const
DString
&)
override
{}
47
void
endCodeFragment
(
const
DString
&)
override
{}
48
void
startFold
(
int
,
const
DString
&,
const
DString
&)
override
{}
49
void
endFold
()
override
{}
50
};
51
52
#endif
// DEVNULLGEN_H
DString
A String class for use with Doxygen wrapping std::string and adding some additional functionality off...
Definition
dstring.h:84
DevNullCodeGenerator
Class implementing OutputCodeIntf by throwing away everything.
Definition
devnullgen.h:23
DevNullCodeGenerator::writeLineNumber
void writeLineNumber(const DString &, const DString &, const DString &, int, bool) override
Definition
devnullgen.h:39
DevNullCodeGenerator::endCodeFragment
void endCodeFragment(const DString &) override
Definition
devnullgen.h:47
DevNullCodeGenerator::startFontClass
void startFontClass(const DString &) override
Definition
devnullgen.h:43
DevNullCodeGenerator::writeTooltip
void writeTooltip(const DString &, const DocLinkInfo &, const DString &, const DString &, const SourceLinkInfo &, const SourceLinkInfo &) override
Definition
devnullgen.h:36
DevNullCodeGenerator::type
OutputType type() const override
Definition
devnullgen.h:25
DevNullCodeGenerator::endSpecialComment
void endSpecialComment() override
Definition
devnullgen.h:30
DevNullCodeGenerator::stripCodeComments
void stripCodeComments(bool) override
Definition
devnullgen.h:28
DevNullCodeGenerator::endFontClass
void endFontClass() override
Definition
devnullgen.h:44
DevNullCodeGenerator::endFold
void endFold() override
Definition
devnullgen.h:49
DevNullCodeGenerator::writeCodeLink
void writeCodeLink(CodeSymbolType, const DString &, const DString &, const DString &, const DString &, const DString &) override
Definition
devnullgen.h:32
DevNullCodeGenerator::clone
std::unique_ptr< OutputCodeIntf > clone() override
Definition
devnullgen.h:26
DevNullCodeGenerator::startCodeFragment
void startCodeFragment(const DString &) override
Definition
devnullgen.h:46
DevNullCodeGenerator::codify
void codify(const DString &) override
Definition
devnullgen.h:27
DevNullCodeGenerator::startSpecialComment
void startSpecialComment() override
Definition
devnullgen.h:29
DevNullCodeGenerator::setStripIndentAmount
void setStripIndentAmount(size_t) override
Definition
devnullgen.h:31
DevNullCodeGenerator::endCodeLine
void endCodeLine() override
Definition
devnullgen.h:42
DevNullCodeGenerator::startFold
void startFold(int, const DString &, const DString &) override
Definition
devnullgen.h:48
DevNullCodeGenerator::startCodeLine
void startCodeLine(int) override
Definition
devnullgen.h:41
DevNullCodeGenerator::writeCodeAnchor
void writeCodeAnchor(const DString &) override
Definition
devnullgen.h:45
OutputCodeIntf::OutputCodeIntf
OutputCodeIntf()=default
outputgen.h
OutputType
OutputType
Definition
outputgen.h:56
OutputType::Null
@ Null
Definition
outputgen.h:56
DocLinkInfo
Definition
outputgen.h:40
SourceLinkInfo
Definition
outputgen.h:48
CodeSymbolType
CodeSymbolType
Definition
types.h:481
src
devnullgen.h
Generated by
1.19.0