Classes | Enumerations | Functions | Variables
index.h File Reference
#include <qlist.h>
#include <qcstring.h>

Go to the source code of this file.

Classes

class  IndexIntf
 Abstract interface for index generators. More...
 
class  IndexList
 A list of index interfaces. More...
 

Enumerations

enum  IndexSections {
  isTitlePageStart, isTitlePageAuthor, isMainPage, isModuleIndex,
  isDirIndex, isNamespaceIndex, isClassHierarchyIndex, isCompoundIndex,
  isFileIndex, isPageIndex, isModuleDocumentation, isDirDocumentation,
  isNamespaceDocumentation, isClassDocumentation, isFileDocumentation, isExampleDocumentation,
  isPageDocumentation, isPageDocumentation2, isEndIndex
}
 
enum  HighlightedItem {
  HLI_None =0, HLI_Main, HLI_Modules, HLI_Namespaces,
  HLI_Hierarchy, HLI_Classes, HLI_Annotated, HLI_Files,
  HLI_NamespaceMembers, HLI_Functions, HLI_Globals, HLI_Pages,
  HLI_Examples, HLI_Search, HLI_UserGroup, HLI_ClassVisible,
  HLI_NamespaceVisible, HLI_FileVisible
}
 
enum  ClassMemberHighlight {
  CMHL_All = 0, CMHL_Functions, CMHL_Variables, CMHL_Typedefs,
  CMHL_Enums, CMHL_EnumValues, CMHL_Properties, CMHL_Events,
  CMHL_Related, CMHL_Total = CMHL_Related+1
}
 
enum  FileMemberHighlight {
  FMHL_All = 0, FMHL_Functions, FMHL_Variables, FMHL_Typedefs,
  FMHL_Enums, FMHL_EnumValues, FMHL_Defines, FMHL_Total = FMHL_Defines+1
}
 
enum  NamespaceMemberHighlight {
  NMHL_All = 0, NMHL_Functions, NMHL_Variables, NMHL_Typedefs,
  NMHL_Enums, NMHL_EnumValues, NMHL_Total = NMHL_EnumValues+1
}
 
enum  ClassHighlight {
  CHL_All = 0, CHL_Classes, CHL_Structs, CHL_Unions,
  CHL_Interfaces, CHL_Protocols, CHL_Categories, CHL_Exceptions,
  CHL_Total = CHL_Exceptions+1
}
 

Functions

void writeGraphInfo (OutputList &ol)
 
void writeIndexHierarchy (OutputList &ol)
 
void countDataStructures ()
 
void startTitle (OutputList &ol, const char *fileName, Definition *def=0)
 
void endTitle (OutputList &ol, const char *fileName, const char *name)
 
void startFile (OutputList &ol, const char *name, const char *manName, const char *title, HighlightedItem hli=HLI_None, bool additionalIndices=FALSE, const char *altSidebarName=0)
 
void endFile (OutputList &ol, bool skipNavIndex=FALSE, bool skipEndContents=FALSE, const QCString &navPath=QCString())
 
void endFileWithNavPath (Definition *d, OutputList &ol)
 
void initClassMemberIndices ()
 
void initFileMemberIndices ()
 
void initNamespaceMemberIndices ()
 
void addClassMemberNameToIndex (MemberDef *md)
 
void addFileMemberNameToIndex (MemberDef *md)
 
void addNamespaceMemberNameToIndex (MemberDef *md)
 
QCString fixSpaces (const QCString &s)
 

Variables

int annotatedClasses
 
int hierarchyClasses
 
int documentedFiles
 
int documentedGroups
 
int documentedNamespaces
 
int indexedPages
 
int documentedClassMembers [CMHL_Total]
 
int documentedFileMembers [FMHL_Total]
 
int documentedNamespaceMembers [NMHL_Total]
 
int documentedDirs
 
int documentedHtmlFiles
 
int documentedPages
 

Enumeration Type Documentation

Enumerator
CHL_All 
CHL_Classes 
CHL_Structs 
CHL_Unions 
CHL_Interfaces 
CHL_Protocols 
CHL_Categories 
CHL_Exceptions 
CHL_Total 

Definition at line 241 of file index.h.

242 {
243  CHL_All = 0,
244  CHL_Classes,
245  CHL_Structs,
246  CHL_Unions,
251  CHL_Total = CHL_Exceptions+1
252 };
Definition: index.h:243
Enumerator
CMHL_All 
CMHL_Functions 
CMHL_Variables 
CMHL_Typedefs 
CMHL_Enums 
CMHL_EnumValues 
CMHL_Properties 
CMHL_Events 
CMHL_Related 
CMHL_Total 

Definition at line 204 of file index.h.

205 {
206  CMHL_All = 0,
210  CMHL_Enums,
213  CMHL_Events,
214  CMHL_Related,
215  CMHL_Total = CMHL_Related+1
216 };
Enumerator
FMHL_All 
FMHL_Functions 
FMHL_Variables 
FMHL_Typedefs 
FMHL_Enums 
FMHL_EnumValues 
FMHL_Defines 
FMHL_Total 

Definition at line 218 of file index.h.

219 {
220  FMHL_All = 0,
224  FMHL_Enums,
226  FMHL_Defines,
227  FMHL_Total = FMHL_Defines+1
228 };
Enumerator
HLI_None 
HLI_Main 
HLI_Modules 
HLI_Namespaces 
HLI_Hierarchy 
HLI_Classes 
HLI_Annotated 
HLI_Files 
HLI_NamespaceMembers 
HLI_Functions 
HLI_Globals 
HLI_Pages 
HLI_Examples 
HLI_Search 
HLI_UserGroup 
HLI_ClassVisible 
HLI_NamespaceVisible 
HLI_FileVisible 

Definition at line 180 of file index.h.

Enumerator
isTitlePageStart 
isTitlePageAuthor 
isMainPage 
isModuleIndex 
isDirIndex 
isNamespaceIndex 
isClassHierarchyIndex 
isCompoundIndex 
isFileIndex 
isPageIndex 
isModuleDocumentation 
isDirDocumentation 
isNamespaceDocumentation 
isClassDocumentation 
isFileDocumentation 
isExampleDocumentation 
isPageDocumentation 
isPageDocumentation2 
isEndIndex 

Definition at line 157 of file index.h.

Enumerator
NMHL_All 
NMHL_Functions 
NMHL_Variables 
NMHL_Typedefs 
NMHL_Enums 
NMHL_EnumValues 
NMHL_Total 

Definition at line 230 of file index.h.

231 {
232  NMHL_All = 0,
236  NMHL_Enums,
238  NMHL_Total = NMHL_EnumValues+1
239 };

Function Documentation

void addClassMemberNameToIndex ( MemberDef md)

Definition at line 2264 of file index.cpp.

2265 {
2266  static bool hideFriendCompounds = Config_getBool("HIDE_FRIEND_COMPOUNDS");
2267  ClassDef *cd=0;
2268 
2269 
2270 
2271  if (md->isLinkableInProject() &&
2272  (cd=md->getClassDef()) &&
2273  cd->isLinkableInProject() &&
2274  cd->templateMaster()==0)
2275  {
2276  QCString n = md->name();
2277  int index = getPrefixIndex(n);
2278  uint letter = getUtf8CodeToLower(n,index);
2279  if (!n.isEmpty())
2280  {
2281  bool isFriendToHide = hideFriendCompounds &&
2282  (QCString(md->typeString())=="friend class" ||
2283  QCString(md->typeString())=="friend struct" ||
2284  QCString(md->typeString())=="friend union");
2285  if (!(md->isFriend() && isFriendToHide) &&
2286  (!md->isEnumValue() || (md->getEnumScope() && !md->getEnumScope()->isStrong()))
2287  )
2288  {
2289  g_memberIndexLetterUsed[CMHL_All].append(letter,md);
2291  }
2292  if (md->isFunction() || md->isSlot() || md->isSignal())
2293  {
2294  g_memberIndexLetterUsed[CMHL_Functions].append(letter,md);
2296  }
2297  else if (md->isVariable())
2298  {
2299  g_memberIndexLetterUsed[CMHL_Variables].append(letter,md);
2301  }
2302  else if (md->isTypedef())
2303  {
2304  g_memberIndexLetterUsed[CMHL_Typedefs].append(letter,md);
2306  }
2307  else if (md->isEnumerate())
2308  {
2309  g_memberIndexLetterUsed[CMHL_Enums].append(letter,md);
2311  }
2312  else if (md->isEnumValue() && md->getEnumScope() && !md->getEnumScope()->isStrong())
2313  {
2314  g_memberIndexLetterUsed[CMHL_EnumValues].append(letter,md);
2316  }
2317  else if (md->isProperty())
2318  {
2319  g_memberIndexLetterUsed[CMHL_Properties].append(letter,md);
2321  }
2322  else if (md->isEvent())
2323  {
2324  g_memberIndexLetterUsed[CMHL_Events].append(letter,md);
2326  }
2327  else if (md->isRelated() || md->isForeign() ||
2328  (md->isFriend() && !isFriendToHide))
2329  {
2330  g_memberIndexLetterUsed[CMHL_Related].append(letter,md);
2332  }
2333  }
2334  }
2335 }
bool isProperty() const
Definition: memberdef.cpp:4185
bool isLinkableInProject() const
Definition: classdef.cpp:2707
bool isEmpty() const
Definition: qcstring.h:189
bool isFriend() const
Definition: memberdef.cpp:4175
static LetterToIndexMap< MemberIndexList > g_memberIndexLetterUsed[CMHL_Total]
Definition: index.cpp:139
bool isEvent() const
Definition: memberdef.cpp:4190
int documentedClassMembers[CMHL_Total]
Definition: index.cpp:62
bool isLinkableInProject() const
Definition: memberdef.cpp:1150
uint getUtf8CodeToLower(const QCString &s, int idx)
Returns one unicode character as an unsigned integer from utf-8 string, making the character lower ca...
Definition: util.cpp:8276
bool isSignal() const
Definition: memberdef.cpp:4130
bool isSlot() const
Definition: memberdef.cpp:4135
bool isVariable() const
Definition: memberdef.cpp:4140
ClassDef * templateMaster() const
Definition: classdef.cpp:4439
const char * typeString() const
Definition: memberdef.cpp:4035
MemberDef * getEnumScope() const
Definition: memberdef.cpp:4487
const QCString & name() const
Definition: definition.h:114
bool isEnumValue() const
Definition: memberdef.cpp:4150
std::void_t< T > n
bool isForeign() const
Definition: memberdef.cpp:4200
bool isStrong() const
Definition: memberdef.cpp:4345
#define Config_getBool(val)
Definition: config.cpp:664
ClassDef * getClassDef() const
Definition: memberdef.cpp:4070
int getPrefixIndex(const QCString &name)
Definition: util.cpp:5144
bool isFunction() const
Definition: memberdef.cpp:4160
bool isRelated() const
Definition: memberdef.cpp:4195
bool isTypedef() const
Definition: memberdef.cpp:4155
unsigned uint
Definition: qglobal.h:351
bool isEnumerate() const
Definition: memberdef.cpp:4145
void addFileMemberNameToIndex ( MemberDef md)

Definition at line 2406 of file index.cpp.

2407 {
2408  FileDef *fd=md->getFileDef();
2409  if (fd && fd->isLinkableInProject() && md->isLinkableInProject())
2410  {
2411  QCString n = md->name();
2412  int index = getPrefixIndex(n);
2413  uint letter = getUtf8CodeToLower(n,index);
2414  if (!n.isEmpty())
2415  {
2416  if (!md->isEnumValue() || (md->getEnumScope() && !md->getEnumScope()->isStrong()))
2417  {
2418  g_fileIndexLetterUsed[FMHL_All].append(letter,md);
2420  }
2421 
2422  if (md->isFunction())
2423  {
2424  g_fileIndexLetterUsed[FMHL_Functions].append(letter,md);
2426  }
2427  else if (md->isVariable())
2428  {
2429  g_fileIndexLetterUsed[FMHL_Variables].append(letter,md);
2431  }
2432  else if (md->isTypedef())
2433  {
2434  g_fileIndexLetterUsed[FMHL_Typedefs].append(letter,md);
2436  }
2437  else if (md->isEnumerate())
2438  {
2439  g_fileIndexLetterUsed[FMHL_Enums].append(letter,md);
2441  }
2442  else if (md->isEnumValue() && md->getEnumScope() && !md->getEnumScope()->isStrong())
2443  {
2444  g_fileIndexLetterUsed[FMHL_EnumValues].append(letter,md);
2446  }
2447  else if (md->isDefine())
2448  {
2449  g_fileIndexLetterUsed[FMHL_Defines].append(letter,md);
2451  }
2452  }
2453  }
2454 }
bool isEmpty() const
Definition: qcstring.h:189
int documentedFileMembers[FMHL_Total]
Definition: index.cpp:63
bool isLinkableInProject() const
Definition: memberdef.cpp:1150
bool isDefine() const
Definition: memberdef.cpp:4170
uint getUtf8CodeToLower(const QCString &s, int idx)
Returns one unicode character as an unsigned integer from utf-8 string, making the character lower ca...
Definition: util.cpp:8276
bool isVariable() const
Definition: memberdef.cpp:4140
FileDef * getFileDef() const
Definition: memberdef.cpp:4075
MemberDef * getEnumScope() const
Definition: memberdef.cpp:4487
const QCString & name() const
Definition: definition.h:114
bool isEnumValue() const
Definition: memberdef.cpp:4150
bool isLinkableInProject() const
Definition: filedef.cpp:1877
std::void_t< T > n
static LetterToIndexMap< MemberIndexList > g_fileIndexLetterUsed[FMHL_Total]
Definition: index.cpp:140
bool isStrong() const
Definition: memberdef.cpp:4345
int getPrefixIndex(const QCString &name)
Definition: util.cpp:5144
bool isFunction() const
Definition: memberdef.cpp:4160
bool isTypedef() const
Definition: memberdef.cpp:4155
unsigned uint
Definition: qglobal.h:351
bool isEnumerate() const
Definition: memberdef.cpp:4145
void addNamespaceMemberNameToIndex ( MemberDef md)

Definition at line 2349 of file index.cpp.

2350 {
2351  NamespaceDef *nd=md->getNamespaceDef();
2352  if (nd && nd->isLinkableInProject() && md->isLinkableInProject())
2353  {
2354  QCString n = md->name();
2355  int index = getPrefixIndex(n);
2356  uint letter = getUtf8CodeToLower(n,index);
2357  if (!n.isEmpty())
2358  {
2359  if (!md->isEnumValue() || (md->getEnumScope() && !md->getEnumScope()->isStrong()))
2360  {
2361  g_namespaceIndexLetterUsed[NMHL_All].append(letter,md);
2363  }
2364 
2365  if (md->isFunction())
2366  {
2367  g_namespaceIndexLetterUsed[NMHL_Functions].append(letter,md);
2369  }
2370  else if (md->isVariable())
2371  {
2372  g_namespaceIndexLetterUsed[NMHL_Variables].append(letter,md);
2374  }
2375  else if (md->isTypedef())
2376  {
2377  g_namespaceIndexLetterUsed[NMHL_Typedefs].append(letter,md);
2379  }
2380  else if (md->isEnumerate())
2381  {
2382  g_namespaceIndexLetterUsed[NMHL_Enums].append(letter,md);
2384  }
2385  else if (md->isEnumValue() && md->getEnumScope() && !md->getEnumScope()->isStrong())
2386  {
2387  g_namespaceIndexLetterUsed[NMHL_EnumValues].append(letter,md);
2389  }
2390  }
2391  }
2392 }
bool isEmpty() const
Definition: qcstring.h:189
bool isLinkableInProject() const
Definition: memberdef.cpp:1150
uint getUtf8CodeToLower(const QCString &s, int idx)
Returns one unicode character as an unsigned integer from utf-8 string, making the character lower ca...
Definition: util.cpp:8276
bool isVariable() const
Definition: memberdef.cpp:4140
static LetterToIndexMap< MemberIndexList > g_namespaceIndexLetterUsed[NMHL_Total]
Definition: index.cpp:141
MemberDef * getEnumScope() const
Definition: memberdef.cpp:4487
const QCString & name() const
Definition: definition.h:114
bool isEnumValue() const
Definition: memberdef.cpp:4150
std::void_t< T > n
bool isStrong() const
Definition: memberdef.cpp:4345
int getPrefixIndex(const QCString &name)
Definition: util.cpp:5144
int documentedNamespaceMembers[NMHL_Total]
Definition: index.cpp:64
NamespaceDef * getNamespaceDef() const
Definition: memberdef.cpp:4080
bool isFunction() const
Definition: memberdef.cpp:4160
bool isLinkableInProject() const
bool isTypedef() const
Definition: memberdef.cpp:4155
unsigned uint
Definition: qglobal.h:351
bool isEnumerate() const
Definition: memberdef.cpp:4145
void countDataStructures ( )

Definition at line 77 of file index.cpp.

78 {
79  annotatedClasses = countAnnotatedClasses(&annotatedClassesPrinted); // "classes" + "annotated"
80  hierarchyClasses = countClassHierarchy(); // "hierarchy"
83  documentedGroups = countGroups(); // "modules"
84  documentedNamespaces = countNamespaces(); // "namespaces"
85  documentedDirs = countDirs(); // "dirs"
86  // "globals"
87  // "namespacemembers"
88  // "functions"
89 }
int documentedDirs
Definition: index.cpp:67
int annotatedClassesPrinted
Definition: index.cpp:56
static int countNamespaces()
Definition: index.cpp:1305
int documentedHtmlFiles
Definition: index.cpp:65
static int countAnnotatedClasses(int *cp)
Definition: index.cpp:1555
static void countRelatedPages(int &docPages, int &indexPages)
Definition: index.cpp:3065
int hierarchyClasses
Definition: index.cpp:57
int documentedPages
Definition: index.cpp:66
int indexedPages
Definition: index.cpp:61
int documentedGroups
Definition: index.cpp:59
int documentedFiles
Definition: index.cpp:58
int documentedNamespaces
Definition: index.cpp:60
static int countDirs()
Definition: index.cpp:3226
static int countClassHierarchy()
Definition: index.cpp:943
static int countGroups()
Definition: index.cpp:3208
static void countFiles(int &htmlFiles, int &files)
Definition: index.cpp:1062
int annotatedClasses
Definition: index.cpp:55
void endFile ( OutputList ol,
bool  skipNavIndex = FALSE,
bool  skipEndContents = FALSE,
const QCString navPath = QCString() 
)

Definition at line 263 of file index.cpp.

265 {
266  static bool generateTreeView = Config_getBool("GENERATE_TREEVIEW");
267  ol.pushGeneratorState();
269  if (!skipNavIndex)
270  {
271  if (!skipEndContents) ol.endContents();
272  if (generateTreeView)
273  {
274  ol.writeString("</div><!-- doc-content -->\n");
275  }
276  }
277  ol.writeFooter(navPath); // write the footer
278  ol.popGeneratorState();
279  ol.endFile();
280 }
void writeString(const char *text)
Definition: outputlist.h:119
void disableAllBut(OutputGenerator::OutputType o)
Definition: outputlist.cpp:49
void endFile()
Definition: outputlist.h:103
void popGeneratorState()
Definition: outputlist.cpp:121
void pushGeneratorState()
Definition: outputlist.cpp:111
#define Config_getBool(val)
Definition: config.cpp:664
void endContents()
Definition: outputlist.h:366
void writeFooter(const char *navPath)
Definition: outputlist.h:101
void endFileWithNavPath ( Definition d,
OutputList ol 
)

Definition at line 282 of file index.cpp.

283 {
284  static bool generateTreeView = Config_getBool("GENERATE_TREEVIEW");
285  QCString navPath;
286  if (generateTreeView)
287  {
288  ol.pushGeneratorState();
290  ol.writeString("</div><!-- doc-content -->\n");
291  ol.popGeneratorState();
292  navPath = d->navigationPathAsString();
293  }
294  endFile(ol,generateTreeView,TRUE,navPath);
295 }
void endFile(OutputList &ol, bool skipNavIndex, bool skipEndContents, const QCString &navPath)
Definition: index.cpp:263
void writeString(const char *text)
Definition: outputlist.h:119
void disableAllBut(OutputGenerator::OutputType o)
Definition: outputlist.cpp:49
void popGeneratorState()
Definition: outputlist.cpp:121
void pushGeneratorState()
Definition: outputlist.cpp:111
QCString navigationPathAsString() const
#define Config_getBool(val)
Definition: config.cpp:664
const bool TRUE
Definition: qglobal.h:371
void endTitle ( OutputList ol,
const char *  fileName,
const char *  name 
)

Definition at line 237 of file index.cpp.

238 {
239  ol.popGeneratorState();
241  ol.endHeaderSection();
242 }
static QCString name
Definition: declinfo.cpp:673
void endHeaderSection()
Definition: outputlist.h:192
void endTitleHead(const char *fileName, const char *name)
Definition: outputlist.h:107
void popGeneratorState()
Definition: outputlist.cpp:121
fileName
Definition: dumpTree.py:9
QCString fixSpaces ( const QCString s)

Definition at line 223 of file index.cpp.

224 {
225  return substitute(s," ","&#160;");
226 }
QCString substitute(const QCString &s, const QCString &src, const QCString &dst)
substitute all occurrences of src in s by dst
Definition: util.cpp:5088
void initClassMemberIndices ( )

Definition at line 2254 of file index.cpp.

2255 {
2256  int j=0;
2257  for (j=0;j<CMHL_Total;j++)
2258  {
2260  g_memberIndexLetterUsed[j].clear();
2261  }
2262 }
static LetterToIndexMap< MemberIndexList > g_memberIndexLetterUsed[CMHL_Total]
Definition: index.cpp:139
int documentedClassMembers[CMHL_Total]
Definition: index.cpp:62
void initFileMemberIndices ( )

Definition at line 2396 of file index.cpp.

2397 {
2398  int j=0;
2399  for (j=0;j<NMHL_Total;j++)
2400  {
2401  documentedFileMembers[j]=0;
2402  g_fileIndexLetterUsed[j].clear();
2403  }
2404 }
int documentedFileMembers[FMHL_Total]
Definition: index.cpp:63
static LetterToIndexMap< MemberIndexList > g_fileIndexLetterUsed[FMHL_Total]
Definition: index.cpp:140
void initNamespaceMemberIndices ( )

Definition at line 2339 of file index.cpp.

2340 {
2341  int j=0;
2342  for (j=0;j<NMHL_Total;j++)
2343  {
2345  g_namespaceIndexLetterUsed[j].clear();
2346  }
2347 }
static LetterToIndexMap< MemberIndexList > g_namespaceIndexLetterUsed[NMHL_Total]
Definition: index.cpp:141
int documentedNamespaceMembers[NMHL_Total]
Definition: index.cpp:64
void startFile ( OutputList ol,
const char *  name,
const char *  manName,
const char *  title,
HighlightedItem  hli = HLI_None,
bool  additionalIndices = FALSE,
const char *  altSidebarName = 0 
)

Definition at line 244 of file index.cpp.

247 {
248  static bool disableIndex = Config_getBool("DISABLE_INDEX");
249  ol.startFile(name,manName,title);
250  ol.startQuickIndices();
251  if (!disableIndex)
252  {
253  ol.writeQuickLinks(TRUE,hli,name);
254  }
255  if (!additionalIndices)
256  {
257  ol.endQuickIndices();
258  }
259  ol.writeSplitBar(altSidebarName ? altSidebarName : name);
260  ol.writeSearchInfo();
261 }
static QCString name
Definition: declinfo.cpp:673
void writeSearchInfo()
Definition: outputlist.h:99
void startQuickIndices()
Definition: outputlist.h:350
void writeSplitBar(const char *name)
Definition: outputlist.h:354
#define Config_getBool(val)
Definition: config.cpp:664
void endQuickIndices()
Definition: outputlist.h:352
void writeQuickLinks(bool compact, HighlightedItem hli, const char *file)
Definition: outputlist.h:360
const bool TRUE
Definition: qglobal.h:371
void startFile(const char *name, const char *manName, const char *title)
Definition: outputlist.h:97
void startTitle ( OutputList ol,
const char *  fileName,
Definition def = 0 
)

Definition at line 228 of file index.cpp.

229 {
230  ol.startHeaderSection();
231  if (def) def->writeSummaryLinks(ol);
233  ol.pushGeneratorState();
235 }
void startHeaderSection()
Definition: outputlist.h:190
fileName
Definition: dumpTree.py:9
void pushGeneratorState()
Definition: outputlist.cpp:111
void disable(OutputGenerator::OutputType o)
Definition: outputlist.cpp:79
void startTitleHead(const char *fileName)
Definition: outputlist.h:105
virtual void writeSummaryLinks(OutputList &)
Definition: definition.h:339
void writeGraphInfo ( OutputList ol)

Definition at line 3245 of file index.cpp.

3246 {
3247  if (!Config_getBool("HAVE_DOT") || !Config_getBool("GENERATE_HTML")) return;
3248  ol.pushGeneratorState();
3250  generateGraphLegend(Config_getString("HTML_OUTPUT"));
3251 
3252  bool &stripCommentsStateRef = Config_getBool("STRIP_CODE_COMMENTS");
3253  bool oldStripCommentsState = stripCommentsStateRef;
3254  bool &createSubdirs = Config_getBool("CREATE_SUBDIRS");
3255  bool oldCreateSubdirs = createSubdirs;
3256  // temporarily disable the stripping of comments for our own code example!
3257  stripCommentsStateRef = FALSE;
3258  // temporarily disable create subdirs for linking to our example
3259  createSubdirs = FALSE;
3260 
3261  startFile(ol,"graph_legend",0,theTranslator->trLegendTitle().data());
3262  startTitle(ol,0);
3264  endTitle(ol,0,0);
3265  ol.startContents();
3266  QCString legendDocs = theTranslator->trLegendDocs();
3267  int s = legendDocs.find("<center>");
3268  int e = legendDocs.find("</center>");
3269  QCString imgExt = getDotImageExtension();
3270  if (imgExt=="svg" && s!=-1 && e!=-1)
3271  {
3272  legendDocs = legendDocs.left(s+8) + "[!-- SVG 0 --]\n" + legendDocs.mid(e);
3273  //printf("legendDocs=%s\n",legendDocs.data());
3274  }
3275  FileDef fd("","graph_legend");
3276  ol.generateDoc("graph_legend",1,&fd,0,legendDocs,FALSE,FALSE);
3277 
3278  // restore config settings
3279  stripCommentsStateRef = oldStripCommentsState;
3280  createSubdirs = oldCreateSubdirs;
3281 
3282  endFile(ol);
3283  ol.popGeneratorState();
3284 }
void endFile(OutputList &ol, bool skipNavIndex, bool skipEndContents, const QCString &navPath)
Definition: index.cpp:263
void startFile(OutputList &ol, const char *name, const char *manName, const char *title, HighlightedItem hli, bool additionalIndices, const char *altSidebarName)
Definition: index.cpp:244
bool generateDoc(const char *fileName, int startLine, Definition *ctx, MemberDef *md, const QCString &docStr, bool indexWords, bool isExample, const char *exampleName=0, bool singleLine=FALSE, bool linkFromIndex=FALSE)
Definition: outputlist.cpp:131
void disableAllBut(OutputGenerator::OutputType o)
Definition: outputlist.cpp:49
virtual QCString trLegendTitle()=0
const bool FALSE
Definition: qglobal.h:370
QCString left(uint len) const
Definition: qcstring.cpp:213
int find(char c, int index=0, bool cs=TRUE) const
Definition: qcstring.cpp:41
bool parseText(const QCString &textStr)
Definition: outputlist.cpp:175
void popGeneratorState()
Definition: outputlist.cpp:121
const double e
void pushGeneratorState()
Definition: outputlist.cpp:111
const char * data() const
Definition: qcstring.h:207
#define Config_getString(val)
Definition: config.cpp:660
#define Config_getBool(val)
Definition: config.cpp:664
QCString getDotImageExtension(void)
Definition: util.cpp:8562
QCString mid(uint index, uint len=0xffffffff) const
Definition: qcstring.cpp:246
void startTitle(OutputList &ol, const char *fileName, Definition *def)
Definition: index.cpp:228
Translator * theTranslator
Definition: language.cpp:157
void endTitle(OutputList &ol, const char *fileName, const char *name)
Definition: index.cpp:237
static QCString * s
Definition: config.cpp:1042
virtual QCString trLegendDocs()=0
void startContents()
Definition: outputlist.h:364
void generateGraphLegend(const char *path)
Definition: dot.cpp:4127
void writeIndexHierarchy ( OutputList ol)

Definition at line 4279 of file index.cpp.

4280 {
4282  if (lne)
4283  {
4285  }
4286 }
static LayoutDocManager & instance()
Definition: layout.cpp:1359
const QList< LayoutNavEntry > & children() const
Definition: layout.h:157
Base class for the layout of a navigation item at the top of the HTML pages.
Definition: layout.h:118
LayoutNavEntry * rootNavEntry() const
Definition: layout.cpp:1370
static void writeIndexHierarchyEntries(OutputList &ol, const QList< LayoutNavEntry > &entries)
Definition: index.cpp:4072

Variable Documentation

int annotatedClasses

Definition at line 55 of file index.cpp.

int documentedClassMembers[CMHL_Total]

Definition at line 62 of file index.cpp.

int documentedDirs

Definition at line 67 of file index.cpp.

int documentedFileMembers[FMHL_Total]

Definition at line 63 of file index.cpp.

int documentedFiles

Definition at line 58 of file index.cpp.

int documentedGroups

Definition at line 59 of file index.cpp.

int documentedHtmlFiles

Definition at line 65 of file index.cpp.

int documentedNamespaceMembers[NMHL_Total]

Definition at line 64 of file index.cpp.

int documentedNamespaces

Definition at line 60 of file index.cpp.

int documentedPages

Definition at line 66 of file index.cpp.

int hierarchyClasses

Definition at line 57 of file index.cpp.

int indexedPages

Definition at line 61 of file index.cpp.