summaryrefslogtreecommitdiff
path: root/src/commentscan.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/commentscan.h')
-rw-r--r--src/commentscan.h21
1 files changed, 13 insertions, 8 deletions
diff --git a/src/commentscan.h b/src/commentscan.h
index d324969..7d2189f 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.
@@ -72,13 +85,5 @@ bool parseCommentBlock(ParserInterface *parser,
bool &newEntryNeeded
);
-void groupEnterFile(const char *file,int line);
-void groupLeaveFile(const char *file,int line);
-void groupLeaveCompound(const char *file,int line,const char *name);
-void groupEnterCompound(const char *file,int line,const char *name);
-void openGroup(Entry *e,const char *file,int line);
-void closeGroup(Entry *,const char *file,int line,bool foundInline=FALSE);
-void initGroupInfo(Entry *e);
-
#endif