commentscan.h

Go to the documentation of this file.

/******************************************************************************
 *
 * Copyright (C) 1997-2015 by Dimitri van Heesch.
 *
 * 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 COMMENTSCAN_H
#define COMMENTSCAN_H

#include "types.h"

class Entry;
class ParserInterface;

bool parseCommentBlock(ParserInterface *parser,
                       Entry *curEntry,
                       const QCString &comment,
                   const QCString &fileName,
               int  &lineNr,
               bool isBrief,
               bool isJavaDocStyle,
                       bool isInbody,
               Protection &prot,
                       int &position,
                       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