Doxygen
docbookgen.cpp 文件参考
#include <stdlib.h>
#include "docbookgen.h"
#include "doxygen.h"
#include "message.h"
#include "config.h"
#include "classlist.h"
#include "classdef.h"
#include "diagram.h"
#include "util.h"
#include "defargs.h"
#include "outputgen.h"
#include "dot.h"
#include "dotcallgraph.h"
#include "dotclassgraph.h"
#include "dotdirdeps.h"
#include "dotgroupcollaboration.h"
#include "dotincldepgraph.h"
#include "pagedef.h"
#include "filename.h"
#include "version.h"
#include "docbookvisitor.h"
#include "docparser.h"
#include "language.h"
#include "parserintf.h"
#include "arguments.h"
#include "memberlist.h"
#include "groupdef.h"
#include "memberdef.h"
#include "namespacedef.h"
#include "membername.h"
#include "membergroup.h"
#include "dirdef.h"
#include "section.h"
#include "dir.h"
+ docbookgen.cpp 的引用(Include)关系图:

浏览源代码.

宏定义

#define Docbook_DB(x)   do {} while(0)
 
#define DB_GEN_C
 
#define DB_GEN_C1(x)
 
#define DB_GEN_C2(y)
 
#define DB_GEN_C2a(x, y)
 

函数

void writeDocbookString (TextStream &t, const QCString &s)
 
void writeDocbookCodeString (TextStream &t, const QCString &str, int &col)
 
static void addIndexTerm (TextStream &t, QCString prim, QCString sec="")
 
void writeDocbookLink (TextStream &t, const QCString &, const QCString &compoundId, const QCString &anchorId, const QCString &text, const QCString &)
 

宏定义说明

◆ DB_GEN_C

#define DB_GEN_C

在文件 docbookgen.cpp67 行定义.

◆ DB_GEN_C1

#define DB_GEN_C1 (   x)

在文件 docbookgen.cpp68 行定义.

◆ DB_GEN_C2

#define DB_GEN_C2 (   y)

在文件 docbookgen.cpp69 行定义.

◆ DB_GEN_C2a

#define DB_GEN_C2a (   x,
 
)

在文件 docbookgen.cpp70 行定义.

◆ Docbook_DB

#define Docbook_DB (   x)    do {} while(0)

在文件 docbookgen.cpp55 行定义.

函数说明

◆ addIndexTerm()

static void addIndexTerm ( TextStream t,
QCString  prim,
QCString  sec = "" 
)
static

在文件 docbookgen.cpp122 行定义.

123 {
124  t << "<indexterm><primary>";
125  t << convertToDocBook(prim);
126  t << "</primary>";
127  if (!sec.isEmpty())
128  {
129  t << "<secondary>";
130  t << convertToDocBook(sec);
131  t << "</secondary>";
132  }
133  t << "</indexterm>\n";
134 }

引用了 convertToDocBook().

被这些函数引用 DocbookGenerator::addIndexItem(), DocbookGenerator::endTitleHead() , 以及 DocbookGenerator::startMemberDoc().

◆ writeDocbookCodeString()

void writeDocbookCodeString ( TextStream t,
const QCString str,
int &  col 
)
inline

在文件 docbookgen.cpp80 行定义.

81 {
82  if (str.isEmpty()) return;
83  const char *s = str.data();
84  char c;
85  while ((c=*s++))
86  {
87  switch(c)
88  {
89  case '\t':
90  {
91  int tabSize = Config_getInt(TAB_SIZE);
92  int spacesToNextTabStop = tabSize - (col%tabSize);
93  col+=spacesToNextTabStop;
94  while (spacesToNextTabStop--) t << "&#32;";
95  break;
96  }
97  case ' ': t << "&#32;"; col++; break;
98  case '<': t << "&lt;"; col++; break;
99  case '>': t << "&gt;"; col++; break;
100  case '&': t << "&amp;"; col++; break;
101  case '\'': t << "&apos;"; col++; break;
102  case '"': t << "&quot;"; col++; break;
103  default:
104  {
105  uchar uc = static_cast<uchar>(c);
106  static const char *hex="0123456789ABCDEF";
107  if (uc<32)
108  {
109  t << "&#x24" << hex[uc>>4] << hex[uc&0xF] << ";";
110  }
111  else
112  {
113  t << c;
114  }
115  col++;
116  }
117  break;
118  }
119  }
120 }

引用了 Config_getInt, QCString::data(), hex , 以及 QCString::isEmpty().

被这些函数引用 DocbookCodeGenerator::codify().

◆ writeDocbookLink()

void writeDocbookLink ( TextStream t,
const QCString ,
const QCString compoundId,
const QCString anchorId,
const QCString text,
const QCString  
)

在文件 docbookgen.cpp135 行定义.

137 {
138  t << "<link linkend=\"_" << stripPath(compoundId);
139  if (!anchorId.isEmpty()) t << "_1" << anchorId;
140  t << "\"";
141  t << ">";
142  writeDocbookString(t,text);
143  t << "</link>";
144 }

引用了 QCString::isEmpty(), stripPath() , 以及 writeDocbookString().

被这些函数引用 DocbookCodeGenerator::writeCodeLink().

◆ writeDocbookString()

void writeDocbookString ( TextStream t,
const QCString s 
)
inline

在文件 docbookgen.cpp75 行定义.

76 {
77  t << convertToDocBook(s);
78 }

引用了 convertToDocBook().

被这些函数引用 DocbookCodeGenerator::writeCodeLinkLine() , 以及 writeDocbookLink().

QCString::isEmpty
bool isEmpty() const
Returns TRUE iff the string is empty
Definition: qcstring.h:144
writeDocbookString
void writeDocbookString(TextStream &t, const QCString &s)
Definition: docbookgen.cpp:75
Config_getInt
#define Config_getInt(name)
Definition: config.h:34
uchar
unsigned char uchar
Definition: qcstring.h:38
stripPath
QCString stripPath(const QCString &s)
Definition: util.cpp:5318
hex
static const char * hex
Definition: htmldocvisitor.cpp:65
convertToDocBook
QCString convertToDocBook(const QCString &s)
Definition: util.cpp:3999
QCString::data
const char * data() const
Returns a pointer to the contents of the string in the form of a 0-terminated C string
Definition: qcstring.h:153