src/markdown.h

   1 /******************************************************************************
   2  *
   3  * Copyright (C) 1997-2012 by Dimitri van Heesch.
   4  *
   5  * Permission to use, copy, modify, and distribute this software and its
   6  * documentation under the terms of the GNU General Public License is hereby
   7  * granted. No representations are made about the suitability of this software
   8  * for any purpose. It is provided "as is" without express or implied warranty.
   9  * See the GNU General Public License for more details.
  10  *
  11  * Documents produced by Doxygen are derivative works derived from the
  12  * input used in their production; they are not affected by this license.
  13  *
  14  */
  15
  16 #ifndef MARKDOWN_H
  17 #define MARKDOWN_H
  18
  19 #include <qcstring.h>
  20 #include "parserintf.h"
  21
  22 class Entry;
  23
  24 /** processes string \a s and converts markdown into doxygen/html commands. */
  25 QCString processMarkdown(const QCString &fileName,Entry *e,const QCString &s);
  26
  27 class MarkdownFileParser : public ParserInterface
  28 {
  29   public:
  30     virtual ~MarkdownFileParser() {}
  31     void parseInput(const char *fileName,
  32                     const char *fileBuf,
  33                     Entry *root);
  34     bool needsPreprocessing(const QCString &) { return FALSE; }
  35     void parseCode(CodeOutputInterface &codeOutIntf,
  36                    const char *scopeName,
  37                    const QCString &input,
  38                    bool isExampleBlock,
  39                    const char *exampleName=0,
  40                    FileDef *fileDef=0,
  41                    int startLine=-1,
  42                    int endLine=-1,
  43                    bool inlineFragment=FALSE,
  44                    MemberDef *memberDef=0,
  45                    bool showLineNumbers=TRUE,
  46                    Definition *searchCtx=0
  47                   );
  48     void resetCodeParserState();
  49     void parsePrototype(const char *text);
  50 };
  51
  52
  53
  54
  55 #endif