doxygen
src
commentscan.h
Go to the documentation of this file.
1
/******************************************************************************
2
*
3
* Copyright (C) 1997-2015 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 COMMENTSCAN_H
17
#define COMMENTSCAN_H
18
19
#include <memory>
20
#include "
types.h
"
21
22
class
Entry
;
23
class
OutlineParserInterface
;
24
28
class
CommentScanner
29
{
30
public
:
31
CommentScanner
();
32
~
CommentScanner
();
33
70
bool
parseCommentBlock
(
OutlineParserInterface
*parser,
71
Entry
*curEntry,
72
const
QCString
&comment,
73
const
QCString
&fileName,
74
int
&lineNr,
75
bool
isBrief,
76
bool
isJavadocStyle,
77
bool
isInbody,
78
Protection
&prot,
79
int
&position,
80
bool
&newEntryNeeded,
81
bool
markdownEnabled
82
);
83
void
initGroupInfo(
Entry
*entry);
84
void
enterFile(
const
QCString
&fileName,
int
lineNr);
85
void
leaveFile(
const
QCString
&fileName,
int
lineNr);
86
void
enterCompound(
const
QCString
&fileName,
int
line,
const
QCString
&name);
87
void
leaveCompound(
const
QCString
&fileName,
int
line,
const
QCString
&name);
88
void
open(
Entry
*e,
const
QCString
&fileName,
int
line,
bool
implicit=
false
);
89
void
close(
Entry
*e,
const
QCString
&fileName,
int
line,
bool
foundInline,
bool
implicit=
false
);
90
private
:
91
struct
Private;
92
std::unique_ptr<Private> p;
93
};
94
95
#endif
types.h
This file contains a number of basic enums and types.
Entry
Represents an unstructured piece of information, about an entity found in the sources.
Definition:
entry.h:114
OutlineParserInterface
Abstract interface for outline parsers.
Definition:
parserintf.h:40
Protection
Protection
Protection level of members.
Definition:
types.h:26
CommentScanner::parseCommentBlock
bool parseCommentBlock(OutlineParserInterface *parser, Entry *curEntry, const QCString &comment, const QCString &fileName, int &lineNr, bool isBrief, bool isJavadocStyle, bool isInbody, Protection &prot, int &position, bool &newEntryNeeded, bool markdownEnabled)
Invokes the comment block parser with the request to parse a single comment block.
CommentScanner
Definition:
commentscan.h:28
QCString
This is an alternative implementation of QCString.
Definition:
qcstring.h:93
Generated by
1.8.13