Orb/Doxygen/src/parserintf.h
changeset 4 468f4c8d3d5b
parent 0 42188c7ea2d9
equal deleted inserted replaced
3:d8fccb2cd802 4:468f4c8d3d5b
     1 /******************************************************************************
     1 /******************************************************************************
     2  *
     2  *
     3  * 
     3  * 
     4  *
     4  *
     5  * Copyright (C) 1997-2008 by Dimitri van Heesch.
     5  * Copyright (C) 1997-2010 by Dimitri van Heesch.
     6  *
     6  *
     7  * Permission to use, copy, modify, and distribute this software and its
     7  * Permission to use, copy, modify, and distribute this software and its
     8  * documentation under the terms of the GNU General Public License is hereby 
     8  * documentation under the terms of the GNU General Public License is hereby 
     9  * granted. No representations are made about the suitability of this software 
     9  * granted. No representations are made about the suitability of this software 
    10  * for any purpose. It is provided "as is" without express or implied warranty.
    10  * for any purpose. It is provided "as is" without express or implied warranty.
    66      *  @param[in] inlineFragment Code fragment that is to be shown inline 
    66      *  @param[in] inlineFragment Code fragment that is to be shown inline 
    67      *             as part of the documentation.
    67      *             as part of the documentation.
    68      *  @param[in] memberDef Member definition to which the code
    68      *  @param[in] memberDef Member definition to which the code
    69      *             is associated (non null in case of an inline fragment 
    69      *             is associated (non null in case of an inline fragment 
    70      *             for a member).
    70      *             for a member).
       
    71      *  @param[in] showLineNumbers if set to TRUE and also fileDef is not 0,
       
    72      *             line numbers will be added to the source fragement
    71      */
    73      */
    72     virtual void parseCode(CodeOutputInterface &codeOutIntf,
    74     virtual void parseCode(CodeOutputInterface &codeOutIntf,
    73                            const char *scopeName,
    75                            const char *scopeName,
    74                            const QCString &input,
    76                            const QCString &input,
    75                            bool isExampleBlock,
    77                            bool isExampleBlock,
    76                            const char *exampleName=0,
    78                            const char *exampleName=0,
    77                            FileDef *fileDef=0,
    79                            FileDef *fileDef=0,
    78                            int startLine=-1,
    80                            int startLine=-1,
    79                            int endLine=-1,
    81                            int endLine=-1,
    80                            bool inlineFragment=FALSE,
    82                            bool inlineFragment=FALSE,
    81                            MemberDef *memberDef=0
    83                            MemberDef *memberDef=0,
       
    84                            bool showLineNumbers=TRUE
    82                           ) = 0;
    85                           ) = 0;
    83 
    86 
    84     /** Resets the state of the code parser.
    87     /** Resets the state of the code parser.
    85      *  Since multiple code fragments can together form a single example, an
    88      *  Since multiple code fragments can together form a single example, an
    86      *  explicit function is used to reset the code parser state.
    89      *  explicit function is used to reset the code parser state.