summaryrefslogtreecommitdiffstats
path: root/src/commentscan.h
diff options
context:
space:
mode:
authorDimitri van Heesch <doxygen@gmail.com>2019-01-07 20:51:07 (GMT)
committerDimitri van Heesch <doxygen@gmail.com>2019-01-07 20:51:07 (GMT)
commitc61d8701470352385bcf5720ee516ba95c4393c8 (patch)
tree498d67f3c418e7b9da5b07e1f5b6f67faa2b914f /src/commentscan.h
parentc581ea17bac7dd4ebba1ca53a55ef592f96e0117 (diff)
downloadDoxygen-c61d8701470352385bcf5720ee516ba95c4393c8.zip
Doxygen-c61d8701470352385bcf5720ee516ba95c4393c8.tar.gz
Doxygen-c61d8701470352385bcf5720ee516ba95c4393c8.tar.bz2
issue #6734 parsing performance worsened
Diffstat (limited to 'src/commentscan.h')
-rw-r--r--src/commentscan.h13
1 files changed, 13 insertions, 0 deletions
diff --git a/src/commentscan.h b/src/commentscan.h
index d324969..75cd99f 100644
--- a/src/commentscan.h
+++ b/src/commentscan.h
@@ -24,6 +24,19 @@ class ParserInterface;
/** @file
* @brief Interface for the comment block parser */
+/** Invokes the comment block parser with the request to preprocess a
+ * single comment block.
+ * @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.
+ * @returns The prepocessed comment block
+ */
+QCString preprocessCommentBlock(const QCString &comment,
+ const QCString &fileName,
+ int lineNr);
+
/** Invokes the comment block parser with the request to parse a
* single comment block.
* @param[in] parser The language parse that invoked this function.