diff options
Diffstat (limited to 'src/commentscan.h')
| -rw-r--r-- | src/commentscan.h | 55 |
1 files changed, 45 insertions, 10 deletions
diff --git a/src/commentscan.h b/src/commentscan.h index 363dda2..74efa63 100644 --- a/src/commentscan.h +++ b/src/commentscan.h @@ -21,16 +21,51 @@ class ParserInterface; -int parseCommentBlock(/* in */ ParserInterface *parser, - /* in */ Entry *curEntry, - /* in */ const QCString &comment, - /* in */ const QCString &fileName, - /* in */ int lineNr, - /* in */ bool isBrief, - /* in */ bool isJavaDocStyle, - /* in,out */ Protection &prot, - /* in,out */ int &position, - /* out */ bool &newEntryNeeded +/** @file + * @brief Interface for the comment block parser */ + +/** Invokes the comment block parser with the request to parse a + * single comment block. + * @param[in] parser The language parse that invoked this function. + * The comment block parse may invoke + * ParserInterface::parsePrototype() in order to parse + * the argument of a @@fn command. + * @param[in] curEntry The Entry to which the comment block belongs. + * Any information (like documentation) that is found in + * the comment block will be stored in this entry. + * @param[in] comment A string representing the actual comment block. + * Note that leading *'s are already stripped from the comment block. + * @param[in] fileName The name of the file in which the comment is found. + * Mainly used for producing warnings. + * @param[in] lineNr The line number at which the comment block was found. + * @param[in] isBrief TRUE iff this comment block represents a brief description. + * @param[in] isJavaDocStyle TRUE iff this comment block is in "JavaDoc" style. + * This means that it starts as a brief description until the end of + * the sentences is found and then proceeds as a detailed description. + * @param[in,out] prot The protection level in which this comment block was + * found. Commands in the comment block may override this. + * @param[in,out] position The character position within \a comment where the + * comment block starts. Typically used in case the comment block + * contains multiple structural commands. + * @param[out] newEntryNeeded Boolean that is TRUE if the comment block parser + * finds that a the comment block finishes the entry and a new one + * needs to be started. + * @returns TRUE if the comment requires further processing. The + * parameter \a newEntryNeeded will typically be true in this case and + * \a position will indicate the offset inside the \a comment string + * where to proceed parsing. FALSE indicates no further processing is + * needed. + */ +bool parseCommentBlock(ParserInterface *parser, + Entry *curEntry, + const QCString &comment, + const QCString &fileName, + int lineNr, + bool isBrief, + bool isJavaDocStyle, + Protection &prot, + int &position, + bool &newEntryNeeded ); void groupEnterFile(const char *file,int line); |