Htags Struct Reference

#include <htags.h>

List of all members.

Static Public Member Functions

static bool loadFilemap (const QCString &htmldir)
static QCString path2URL (const QCString &path)
static bool execute (const QCString &htmldir)

Static Public Attributes

static bool useHtags

Detailed Description

Definition at line 20 of file htags.h.

Member Function Documentation

bool Htags::loadFilemap ( const QCString &  htmlDir  )  [static]

load filemap and make index.

Parameters:
htmlDir of HTML directory generated by htags(1).
Return values:
TRUE success
FALSE error

Definition at line 104 of file htags.cpp.

References err(), and QCString.

Referenced by generateOutput().

QCString Htags::path2URL ( const QCString &  path  )  [static]

convert path name into the url in the hypertext generated by htags.

Parameters:
path path name
Returns:
URL NULL: not found.

Definition at line 157 of file htags.cpp.

References convertToQCString(), and QCString.

Referenced by FileDef::getSourceFileBase(), and FileDef::includeName().

bool Htags::execute ( const QCString &  htmldir  )  [static]

constructs command line of htags(1) and executes it.

Return values:
TRUE success
FALSE an error has occured.

Definition at line 38 of file htags.cpp.

References Config_getBool, Config_getList, Config_getString, convertToQCString(), err(), portable_system(), and QCString.

Referenced by generateOutput().

Member Data Documentation

bool Htags::useHtags [static]

Definition at line 22 of file htags.h.

Referenced by generateOutput(), FileDef::getSourceFileBase(), FileDef::includeName(), and Definition::writeSourceDef().

The documentation for this struct was generated from the following files:


Generated on Mon Mar 31 10:59:00 2008 by  doxygen 1.5.1