doxygen.h File Reference

#include "qtbc.h"
#include <qtextstream.h>
#include <qdatetime.h>
#include <qcache.h>
#include "groupdef.h"
#include "filedef.h"
#include "classdef.h"
#include "memberdef.h"
#include "classlist.h"
#include "membername.h"
#include "filename.h"
#include "namespacedef.h"
#include "formula.h"
#include "section.h"
#include "membergroup.h"
#include "reflist.h"
#include "dirdef.h"
#include "index.h"
#include "docsets.h"

Go to the source code of this file.

Classes

class  StringDict
struct  LookupInfo
class  Doxygen
 This class serves as a namespace for global variables used by doxygen. More...

Defines

#define NEWMATCH

Typedefs

typedef QList< QCString > StringList
typedef QDict< FileDefFileDict
typedef QDict< GroupDefGroupDict

Functions

void initDoxygen ()
void readConfiguration (int argc, char **argv)
void checkConfiguration ()
void parseInput ()
void generateOutput ()
void readAliases ()
void readFormulaRepository ()
int readFileOrDirectory (const char *s, FileNameList *fnList, FileNameDict *fnDict, StringDict *exclDict, QStrList *patList, QStrList *exclPatList, StringList *resultList, StringDict *resultDict, bool recursive, bool errorIfNotExist=TRUE, QDict< void > *killDict=0)
int readDir (QFileInfo *fi, FileNameList *fnList, FileNameDict *fnDict, StringDict *exclDict, QStrList *patList, QStrList *exclPatList, StringList *resultList, StringDict *resultDict, bool errorIfNotExist, bool recursive, QDict< void > *killDict)
void copyAndFilterFile (const char *fileName, BufStr &dest)

Variables

QCString spaces


Define Documentation

#define NEWMATCH

Definition at line 168 of file doxygen.h.


Typedef Documentation

typedef QDict<FileDef> FileDict

Definition at line 54 of file doxygen.h.

typedef QDict<GroupDef> GroupDict

Definition at line 55 of file doxygen.h.

typedef QList<QCString> StringList

Definition at line 51 of file doxygen.h.


Function Documentation

void checkConfiguration (  ) 

Definition at line 9281 of file doxygen.cpp.

References addSearchDir(), Config::check(), Config_getBool, Config_getEnum, Config_getList, Config_getString, Config::convertStrToVal(), err(), Doxygen::htmlFileExtension, initWarningFormat(), Config::instance(), Doxygen::parseSourcesNeeded, QCString, setTranslator(), Config::substituteEnvironmentVars(), and Doxygen::xrefLists.

Referenced by main().

void copyAndFilterFile ( const char *  fileName,
BufStr dest 
)

Definition at line 8352 of file doxygen.cpp.

References BufStr::addArray(), BufStr::data(), err(), Debug::ExtCmd, filterCRLF(), getFileFilter(), portable_pclose(), portable_popen(), Debug::print(), QCString, BufStr::shrink(), and BufStr::skip().

void generateOutput (  ) 

Definition at line 9932 of file doxygen.cpp.

References OutputList::add(), IndexList::addIndex(), cleanUpDoxygen(), Store::close(), Config_getBool, Config_getString, dateToString(), Config::deleteInstance(), OutputList::disableAllBut(), OutputList::enableAll(), err(), Htags::execute(), IndexList::finalize(), finializeDocParser(), Doxygen::formulaList, FormulaList::generateBitmaps(), generateDEF(), generateDirDocs(), generatePerlMod(), HtmlGenerator::generateSectionImages(), generateXML(), Doxygen::indexList, RTFGenerator::init(), ManGenerator::init(), LatexGenerator::init(), HtmlGenerator::init(), initDocParser(), IndexList::initialize(), Debug::isFlagSet(), OutputGenerator::Latex, Htags::loadFilemap(), msg(), Doxygen::objDBFileName, OutputList::parseText(), portable_system(), RTFGenerator::preProcessFileInplace(), QCString, removeDoxFont(), Doxygen::runningTime, Doxygen::searchIndex, Doxygen::symbolCache, Doxygen::symbolMap, Doxygen::symbolStorage, Doxygen::sysElapsedTime, Doxygen::tagFile, theTranslator, Debug::Time, Translator::trGeneratedAt(), Htags::useHtags, SearchIndex::write(), writeDirIndex(), writeDoxFont(), writeExampleIndex(), writeFileIndex(), writeFileMemberIndex(), writeGraphicalClassHierarchy(), writeGraphInfo(), writeGroupIndex(), writeIndex(), writeNamespaceMemberIndex(), writePageIndex(), HtmlGenerator::writeSearchPage(), and OutputList::writeStyleInfo().

Referenced by main().

void initDoxygen (  ) 

Definition at line 8916 of file doxygen.cpp.

References initClassMemberIndices(), initFileMemberIndices(), initNamespaceMemberIndices(), initPreprocessor(), Doxygen::parserManager, ParserManager::registerParser(), and Doxygen::runningTime.

Referenced by main().

void parseInput (  ) 

Definition at line 9353 of file doxygen.cpp.

References buildDirectories(), Doxygen::classSDict, cleanUpDoxygen(), computeDirDependencies(), Config_getBool, Config_getInt, Config_getList, Config_getString, countDataStructures(), Doxygen::directories, Doxygen::dirRelations, Doxygen::dotFileNameDict, Doxygen::entryDBFileName, err(), Doxygen::exampleNameDict, Doxygen::exampleSDict, Doxygen::expandAsDefinedDict, Doxygen::functionNameSDict, FileNameList::generateDiskNames(), Doxygen::globalScope, Doxygen::groupSDict, Doxygen::hiddenClasses, Doxygen::imageNameDict, Doxygen::includeNameDict, Doxygen::inputNameDict, Doxygen::inputNameList, Doxygen::lookupCache, Doxygen::memberNameSDict, Doxygen::memGrpInfoDict, msg(), Doxygen::namespaceSDict, Doxygen::objDBFileName, Doxygen::pageSDict, portable_pid(), preFreeScanner(), pyscanFreeScanner(), QCString, readAliases(), readFileOrDirectory(), readFormulaRepository(), scanFreeScanner(), Doxygen::sectionDict, SDict< T >::setAutoDelete(), EntryNav::setEntry(), SDict< T >::sort(), spaces, Doxygen::symbolCache, Doxygen::symbolMap, Doxygen::symbolStorage, and Doxygen::tagDestinationDict.

Referenced by main().

void readAliases (  ) 

Definition at line 8780 of file doxygen.cpp.

References Doxygen::aliasDict, Config_getList, and QCString.

Referenced by parseInput().

void readConfiguration ( int  argc,
char **  argv 
)

Definition at line 8998 of file doxygen.cpp.

References Config::check(), cleanUpDoxygen(), Config_getEnum, Config::convertStrToVal(), err(), Config::init(), Config::instance(), msg(), Doxygen::outputToWizard, parse(), QCString, Debug::setFlag(), setPerlModDoxyfile(), setTranslator(), Config::substituteEnvironmentVars(), versionString, RTFGenerator::writeExtensionsFile(), HtmlGenerator::writeFooterFile(), LatexGenerator::writeHeaderFile(), HtmlGenerator::writeHeaderFile(), LatexGenerator::writeStyleSheetFile(), HtmlGenerator::writeStyleSheetFile(), and RTFGenerator::writeStyleSheetFile().

Referenced by main().

int readDir ( QFileInfo *  fi,
FileNameList fnList,
FileNameDict fnDict,
StringDict exclDict,
QStrList *  patList,
QStrList *  exclPatList,
StringList resultList,
StringDict resultDict,
bool  errorIfNotExist,
bool  recursive,
QDict< void > *  killDict 
)

Definition at line 8524 of file doxygen.cpp.

References Config_getBool, convertToQCString(), err(), msg(), QCString, and readDir().

Referenced by readDir(), and readFileOrDirectory().

int readFileOrDirectory ( const char *  s,
FileNameList fnList,
FileNameDict fnDict,
StringDict exclDict,
QStrList *  patList,
QStrList *  exclPatList,
StringList resultList,
StringDict resultDict,
bool  recursive,
bool  errorIfNotExist = TRUE,
QDict< void > *  killDict = 0 
)

Definition at line 8616 of file doxygen.cpp.

References Config_getBool, convertToQCString(), err(), QCString, and readDir().

Referenced by parseInput().

void readFormulaRepository (  ) 

Definition at line 8701 of file doxygen.cpp.

References Config_getString, err(), Doxygen::formulaDict, Doxygen::formulaList, Doxygen::formulaNameDict, msg(), and QCString.

Referenced by parseInput().


Variable Documentation

QCString spaces

Definition at line 153 of file doxygen.cpp.

Referenced by HtmlGenerator::codify(), LatexGenerator::codify(), ManGenerator::codify(), RTFGenerator::codify(), and parseInput().



Generated on Mon Mar 31 10:58:52 2008 by  doxygen 1.5.1