blob: 500b10cd214b5733450305ef994bf3b480b11160 (
plain)
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
|
/*****************************************************************************
*
*
*
* 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 COMMENTCNV_H
#define COMMENTCNV_H
/** @file
* @brief First pass comment processing.
*/
class BufStr;
class QCString;
/** Converts the comments in a file.
* @param inBuf input buffer holding the file content.
* @param outBuf output buffer to which the results after conversion are written to.
* @param fileName the name of the file from which the comments originate.
*
* The following is converted:
* - C++ style multiline doxygen comments are converted to C style doxygen comments.
* - conditional sections are processed.
* - aliases are expanded.
*/
void convertCppComments(const BufStr &inBuf,BufStr &outBuf,
const QCString &fileName);
#endif
|
