|
Packit Service |
50c9f2 |
/******************************************************************************
|
|
Packit Service |
50c9f2 |
*
|
|
Packit Service |
50c9f2 |
* Copyright (C) 1997-2015 by Dimitri van Heesch.
|
|
Packit Service |
50c9f2 |
*
|
|
Packit Service |
50c9f2 |
* Permission to use, copy, modify, and distribute this software and its
|
|
Packit Service |
50c9f2 |
* documentation under the terms of the GNU General Public License is hereby
|
|
Packit Service |
50c9f2 |
* granted. No representations are made about the suitability of this software
|
|
Packit Service |
50c9f2 |
* for any purpose. It is provided "as is" without express or implied warranty.
|
|
Packit Service |
50c9f2 |
* See the GNU General Public License for more details.
|
|
Packit Service |
50c9f2 |
*
|
|
Packit Service |
50c9f2 |
* Documents produced by Doxygen are derivative works derived from the
|
|
Packit Service |
50c9f2 |
* input used in their production; they are not affected by this license.
|
|
Packit Service |
50c9f2 |
*
|
|
Packit Service |
50c9f2 |
*/
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
#ifndef COMMENTSCAN_H
|
|
Packit Service |
50c9f2 |
#define COMMENTSCAN_H
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
#include "types.h"
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
class Entry;
|
|
Packit Service |
50c9f2 |
class ParserInterface;
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
/** @file
|
|
Packit Service |
50c9f2 |
* @brief Interface for the comment block parser */
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
/** Invokes the comment block parser with the request to parse a
|
|
Packit Service |
50c9f2 |
* single comment block.
|
|
Packit Service |
50c9f2 |
* @param[in] parser The language parse that invoked this function.
|
|
Packit Service |
50c9f2 |
* The comment block parse may invoke
|
|
Packit Service |
50c9f2 |
* ParserInterface::parsePrototype() in order to parse
|
|
Packit Service |
50c9f2 |
* the argument of a @@fn command.
|
|
Packit Service |
50c9f2 |
* @param[in] curEntry The Entry to which the comment block belongs.
|
|
Packit Service |
50c9f2 |
* Any information (like documentation) that is found in
|
|
Packit Service |
50c9f2 |
* the comment block will be stored in this entry.
|
|
Packit Service |
50c9f2 |
* @param[in] comment A string representing the actual comment block.
|
|
Packit Service |
50c9f2 |
* Note that leading *'s are already stripped from the comment block.
|
|
Packit Service |
50c9f2 |
* @param[in] fileName The name of the file in which the comment is found.
|
|
Packit Service |
50c9f2 |
* Mainly used for producing warnings.
|
|
Packit Service |
50c9f2 |
* @param[in,out] lineNr The line number at which the comment block was found.
|
|
Packit Service |
50c9f2 |
* When the function returns it will be set to the last line parsed.
|
|
Packit Service |
50c9f2 |
* @param[in] isBrief TRUE iff this comment block represents a brief description.
|
|
Packit Service |
50c9f2 |
* @param[in] isJavaDocStyle TRUE iff this comment block is in "JavaDoc" style.
|
|
Packit Service |
50c9f2 |
* This means that it starts as a brief description until the end of
|
|
Packit Service |
50c9f2 |
* the sentences is found and then proceeds as a detailed description.
|
|
Packit Service |
50c9f2 |
* @param[in] isInbody TRUE iff this comment block is located in the body of
|
|
Packit Service |
50c9f2 |
* a function.
|
|
Packit Service |
50c9f2 |
* @param[in,out] prot The protection level in which this comment block was
|
|
Packit Service |
50c9f2 |
* found. Commands in the comment block may override this.
|
|
Packit Service |
50c9f2 |
* @param[in,out] position The character position within \a comment where the
|
|
Packit Service |
50c9f2 |
* comment block starts. Typically used in case the comment block
|
|
Packit Service |
50c9f2 |
* contains multiple structural commands.
|
|
Packit Service |
50c9f2 |
* @param[out] newEntryNeeded Boolean that is TRUE if the comment block parser
|
|
Packit Service |
50c9f2 |
* finds that a the comment block finishes the entry and a new one
|
|
Packit Service |
50c9f2 |
* needs to be started.
|
|
Packit Service |
50c9f2 |
* @returns TRUE if the comment requires further processing. The
|
|
Packit Service |
50c9f2 |
* parameter \a newEntryNeeded will typically be true in this case and
|
|
Packit Service |
50c9f2 |
* \a position will indicate the offset inside the \a comment string
|
|
Packit Service |
50c9f2 |
* where to proceed parsing. FALSE indicates no further processing is
|
|
Packit Service |
50c9f2 |
* needed.
|
|
Packit Service |
50c9f2 |
*/
|
|
Packit Service |
50c9f2 |
bool parseCommentBlock(ParserInterface *parser,
|
|
Packit Service |
50c9f2 |
Entry *curEntry,
|
|
Packit Service |
50c9f2 |
const QCString &comment,
|
|
Packit Service |
50c9f2 |
const QCString &fileName,
|
|
Packit Service |
50c9f2 |
int &lineNr,
|
|
Packit Service |
50c9f2 |
bool isBrief,
|
|
Packit Service |
50c9f2 |
bool isJavaDocStyle,
|
|
Packit Service |
50c9f2 |
bool isInbody,
|
|
Packit Service |
50c9f2 |
Protection &prot,
|
|
Packit Service |
50c9f2 |
int &position,
|
|
Packit Service |
50c9f2 |
bool &newEntryNeeded
|
|
Packit Service |
50c9f2 |
);
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
void groupEnterFile(const char *file,int line);
|
|
Packit Service |
50c9f2 |
void groupLeaveFile(const char *file,int line);
|
|
Packit Service |
50c9f2 |
void groupLeaveCompound(const char *file,int line,const char *name);
|
|
Packit Service |
50c9f2 |
void groupEnterCompound(const char *file,int line,const char *name);
|
|
Packit Service |
50c9f2 |
void openGroup(Entry *e,const char *file,int line);
|
|
Packit Service |
50c9f2 |
void closeGroup(Entry *,const char *file,int line,bool foundInline=FALSE);
|
|
Packit Service |
50c9f2 |
void initGroupInfo(Entry *e);
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
|
|
Packit Service |
50c9f2 |
#endif
|