Doxygen
Toggle main menu visibility
Loading...
Searching...
No Matches
docvisitor.h
Go to the documentation of this file.
1
/******************************************************************************
2
*
3
* Copyright (C) 1997-2021 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 DOCVISITOR_H
17
#define DOCVISITOR_H
18
19
#include <memory>
20
21
#include "
construct.h
"
22
23
class
CodeParserInterface
;
24
class
DString
;
25
26
/*! @brief Helper base class for functionality shared by all visitors
27
*/
28
class
DocVisitor
29
{
30
public
:
31
DocVisitor
();
32
virtual
~DocVisitor
();
33
NON_COPYABLE
(
DocVisitor
)
34
CodeParserInterface
&
getCodeParser
(
const
DString
&langExt);
35
void
pushHidden
(
bool
hide);
36
bool
popHidden
();
37
private
:
38
struct
Private
;
39
std::unique_ptr<Private>
m_p
;
40
};
41
42
43
44
#endif
CodeParserInterface
Abstract interface for code parsers.
Definition
parserintf.h:141
DString
A String class for use with Doxygen wrapping std::string and adding some additional functionality off...
Definition
dstring.h:88
DocVisitor::pushHidden
void pushHidden(bool hide)
Definition
docvisitor.cpp:56
DocVisitor::m_p
std::unique_ptr< Private > m_p
Definition
docvisitor.h:39
DocVisitor::DocVisitor
DocVisitor()
Definition
docvisitor.cpp:32
DocVisitor::getCodeParser
CodeParserInterface & getCodeParser(const DString &langExt)
Definition
docvisitor.cpp:40
DocVisitor::popHidden
bool popHidden()
Definition
docvisitor.cpp:61
construct.h
NON_COPYABLE
#define NON_COPYABLE(cls)
Macro to help implementing the rule of 5 for a non-copyable & movable class.
Definition
construct.h:37
DocVisitor::Private
Definition
docvisitor.cpp:26
src
docvisitor.h
Generated by
1.19.0