doxygen.cpp File Reference

#include "qtbc.h"
#include <qfileinfo.h>
#include <qfile.h>
#include <qdir.h>
#include <qdict.h>
#include <qregexp.h>
#include <qstrlist.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/stat.h>
#include <qtextcodec.h>
#include <unistd.h>
#include <errno.h>
#include "version.h"
#include "doxygen.h"
#include "scanner.h"
#include "entry.h"
#include "index.h"
#include "logos.h"
#include "instdox.h"
#include "message.h"
#include "config.h"
#include "util.h"
#include "pre.h"
#include "tagreader.h"
#include "dot.h"
#include "docparser.h"
#include "dirdef.h"
#include "outputlist.h"
#include "declinfo.h"
#include "htmlgen.h"
#include "latexgen.h"
#include "mangen.h"
#include "language.h"
#include "debug.h"
#include "htmlhelp.h"
#include "ftvhelp.h"
#include "defargs.h"
#include "rtfgen.h"
#include "xmlgen.h"
#include "defgen.h"
#include "perlmodgen.h"
#include "reflist.h"
#include "pagedef.h"
#include "bufstr.h"
#include "commentcnv.h"
#include "cmdmapper.h"
#include "searchindex.h"
#include "parserintf.h"
#include "htags.h"
#include "pyscanner.h"
#include "fortranscanner.h"
#include "code.h"
#include "objcache.h"
#include "store.h"
#include "marshal.h"
#include "portable.h"
#include "vhdlscanner.h"
#include <signal.h>

Go to the source code of this file.

Classes

struct  STLInfo

Defines

#define RECURSE_ENTRYTREE(func, var)
#define HAS_SIGNALS

Enumerations

enum  FindBaseClassRelation_Mode { TemplateInstances, DocumentedOnly, Undocumented }

Functions

void clearAll ()
void statistics ()
ArgumentListgetTemplateArgumentsFromName (const QCString &name, const QList< ArgumentList > *tArgLists)
void printNavTree (EntryNav *rootNav, int indent)
void copyAndFilterFile (const char *fileName, BufStr &dest)
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)
int readFileOrDirectory (const char *s, FileNameList *fnList, FileNameDict *fnDict, StringDict *exclDict, QStrList *patList, QStrList *exclPatList, StringList *resultList, StringDict *resultDict, bool recursive, bool errorIfNotExist, QDict< void > *killDict)
void readFormulaRepository ()
void readAliases ()
void commentScanTest ()
void initDoxygen ()
void cleanUpDoxygen ()
void readConfiguration (int argc, char **argv)
void checkConfiguration ()
void parseInput ()
void generateOutput ()

Variables

FileStorageg_storage = 0
QCString spaces


Define Documentation

#define HAS_SIGNALS

Definition at line 88 of file doxygen.cpp.

#define RECURSE_ENTRYTREE ( func,
var   ) 

Value:

do { if (var->children()) { \
    EntryNavListIterator eli(*var->children()); \
    for (;eli.current();++eli) func(eli.current()); \
  } } while(0)

Definition at line 79 of file doxygen.cpp.


Enumeration Type Documentation

enum FindBaseClassRelation_Mode

Enumerator:
TemplateInstances 
DocumentedOnly 
Undocumented 

Definition at line 3630 of file doxygen.cpp.


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 cleanUpDoxygen (  ) 

Definition at line 8944 of file doxygen.cpp.

References Doxygen::classSDict, cleanUpPreprocessor(), codeFreeScanner(), DefinitionIntf::definitionType(), Doxygen::directories, Doxygen::dotFileNameDict, Doxygen::exampleNameDict, Doxygen::exampleSDict, Mappers::freeMappers(), Doxygen::functionNameSDict, Doxygen::globalScope, Doxygen::groupSDict, Doxygen::hiddenClasses, Doxygen::imageNameDict, Doxygen::includeNameDict, Doxygen::inputNameDict, Doxygen::inputNameList, Doxygen::mainPage, Doxygen::memberNameSDict, Doxygen::namespaceSDict, Doxygen::pageSDict, Doxygen::parserManager, Doxygen::symbolMap, theTranslator, DefinitionIntf::TypeSymbolList, and Doxygen::xrefLists.

Referenced by generateOutput(), parseInput(), and readConfiguration().

void clearAll (  ) 

Definition at line 160 of file doxygen.cpp.

References Doxygen::classSDict, SDict< T >::clear(), Doxygen::dotFileNameDict, Doxygen::exampleNameDict, Doxygen::exampleSDict, Doxygen::formulaDict, Doxygen::formulaList, Doxygen::formulaNameDict, Doxygen::imageNameDict, Doxygen::includeNameDict, Doxygen::inputNameDict, Doxygen::inputNameList, Doxygen::mainPage, Doxygen::namespaceSDict, Doxygen::pageSDict, Doxygen::sectionDict, and Doxygen::tagDestinationDict.

void commentScanTest (  ) 

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, HtmlGenerator::init(), LatexGenerator::init(), ManGenerator::init(), RTFGenerator::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().

ArgumentList* getTemplateArgumentsFromName ( const QCString &  name,
const QList< ArgumentList > *  tArgLists 
)

Definition at line 991 of file doxygen.cpp.

References SDict< T >::find(), getClass(), and Doxygen::namespaceSDict.

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 printNavTree ( EntryNav rootNav,
int  indent 
)

Definition at line 7909 of file doxygen.cpp.

References EntryNav::children(), msg(), EntryNav::name(), QCString, and EntryNav::section().

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(), HtmlGenerator::writeHeaderFile(), LatexGenerator::writeHeaderFile(), RTFGenerator::writeStyleSheetFile(), HtmlGenerator::writeStyleSheetFile(), and LatexGenerator::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,
QDict< void > *  killDict 
)

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().

void statistics (  ) 

Definition at line 184 of file doxygen.cpp.

References Doxygen::aliasDict, Doxygen::dotFileNameDict, Doxygen::exampleNameDict, Doxygen::expandAsDefinedDict, Doxygen::formulaDict, Doxygen::formulaNameDict, Doxygen::imageNameDict, Doxygen::includeNameDict, Doxygen::inputNameDict, Doxygen::memGrpInfoDict, Doxygen::namespaceAliasDict, and Doxygen::tagDestinationDict.


Variable Documentation

FileStorage* g_storage = 0

Definition at line 151 of file doxygen.cpp.

Referenced by VhdlDocGen::computeVhdlComponentRelations().

QCString spaces

Definition at line 153 of file doxygen.cpp.

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



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