summaryrefslogtreecommitdiffstats
path: root/src/markdown.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/markdown.h')
-rw-r--r--src/markdown.h18
1 files changed, 17 insertions, 1 deletions
diff --git a/src/markdown.h b/src/markdown.h
index 3ffd155..bc1e9bb 100644
--- a/src/markdown.h
+++ b/src/markdown.h
@@ -25,10 +25,23 @@ class Entry;
QCString processMarkdown(const QCString &fileName,const int lineNr,Entry *e,const QCString &s);
QCString markdownFileNameToId(const QCString &fileName);
+/** Performs markdown processing for a comment block if markdown processing is enabled.
+ * @param[in] comment A string representing the actual comment block.
+ * Note that leading *'s should already be 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 processed comment block
+ */
+QCString processMarkdownForCommentBlock(const QCString &comment,
+ const QCString &fileName,
+ int lineNr);
+
class MarkdownOutlineParser : public OutlineParserInterface
{
public:
- virtual ~MarkdownOutlineParser() {}
+ MarkdownOutlineParser();
+ virtual ~MarkdownOutlineParser();
void startTranslationUnit(const char *) {}
void finishTranslationUnit() {}
void parseInput(const char *fileName,
@@ -38,6 +51,9 @@ class MarkdownOutlineParser : public OutlineParserInterface
QStrList &filesInSameTranslationUnit);
bool needsPreprocessing(const QCString &) const { return FALSE; }
void parsePrototype(const char *text);
+ private:
+ struct Private;
+ std::unique_ptr<Private> p;
};