markdown.h 2.1 KB
Newer Older
1 2
/******************************************************************************
 *
Dimitri van Heesch's avatar
Dimitri van Heesch committed
3
 * Copyright (C) 1997-2013 by Dimitri van Heesch.
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation under the terms of the GNU General Public License is hereby 
 * granted. No representations are made about the suitability of this software 
 * for any purpose. It is provided "as is" without express or implied warranty.
 * See the GNU General Public License for more details.
 *
 * Documents produced by Doxygen are derivative works derived from the
 * input used in their production; they are not affected by this license.
 *
 */

#ifndef MARKDOWN_H
#define MARKDOWN_H

#include <qcstring.h>
#include "parserintf.h"

22 23
class Entry;

24
/** processes string \a s and converts markdown into doxygen/html commands. */
25
QCString processMarkdown(const QCString &fileName,Entry *e,const QCString &s);
26
QCString markdownFileNameToId(const QCString &fileName);
27 28 29 30 31

class MarkdownFileParser : public ParserInterface
{
  public:
    virtual ~MarkdownFileParser() {}
32 33
    void startTranslationUnit(const char *) {}
    void finishTranslationUnit() {}
34 35
    void parseInput(const char *fileName, 
                    const char *fileBuf, 
36 37 38
                    Entry *root,
                    bool sameTranslationUnit,
                    QStrList &filesInSameTranslationUnit);
39 40 41 42
    bool needsPreprocessing(const QCString &) { return FALSE; }
    void parseCode(CodeOutputInterface &codeOutIntf,
                   const char *scopeName,
                   const QCString &input,
43
                   SrcLangExt lang,
44 45 46 47 48 49 50
                   bool isExampleBlock,
                   const char *exampleName=0,
                   FileDef *fileDef=0,
                   int startLine=-1,
                   int endLine=-1,
                   bool inlineFragment=FALSE,
                   MemberDef *memberDef=0,
Dimitri van Heesch's avatar
Dimitri van Heesch committed
51
                   bool showLineNumbers=TRUE,
52 53
                   Definition *searchCtx=0,
                   bool collectXRefs=TRUE
54 55 56 57 58 59 60 61 62
                  );
    void resetCodeParserState();
    void parsePrototype(const char *text);
};




#endif