summaryrefslogtreecommitdiff
path: root/src/docbookgen.cpp
diff options
context:
space:
mode:
authorDongHun Kwak <dh0128.kwak@samsung.com>2021-10-15 10:54:45 +0900
committerDongHun Kwak <dh0128.kwak@samsung.com>2021-10-15 10:54:45 +0900
commit5e552810bc3dfc820036b4b16ae53561bb7cf3c6 (patch)
tree50ee6379d4fdad236b392051a73a2825dc98fb5e /src/docbookgen.cpp
parentd6f1e74d173f59fc63d7e031cd9685b4eb38fed2 (diff)
downloaddoxygen-5e552810bc3dfc820036b4b16ae53561bb7cf3c6.tar.gz
doxygen-5e552810bc3dfc820036b4b16ae53561bb7cf3c6.tar.bz2
doxygen-5e552810bc3dfc820036b4b16ae53561bb7cf3c6.zip
Imported Upstream version 1.8.15upstream/1.8.15
Diffstat (limited to 'src/docbookgen.cpp')
-rw-r--r--src/docbookgen.cpp2703
1 files changed, 939 insertions, 1764 deletions
diff --git a/src/docbookgen.cpp b/src/docbookgen.cpp
index 345629e..97c602d 100644
--- a/src/docbookgen.cpp
+++ b/src/docbookgen.cpp
@@ -1,6 +1,6 @@
/******************************************************************************
*
-*
+*
*
* Copyright (C) 1997-2015 by Dimitri van Heesch.
*
@@ -21,11 +21,14 @@
#include <qfile.h>
#include <qtextstream.h>
#include <qintdict.h>
+#include <qregexp.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"
@@ -54,57 +57,22 @@
// debug inside output
//#define Docbook_DB(x) QCString __t;__t.sprintf x;m_t << __t
+#if 0
+#define DB_GEN_C DB_GEN_C1(t)
+#define DB_GEN_C1(x) x << "<!-- DB_GEN_C " << __LINE__ << " -->\n";
+#define DB_GEN_C2(y) DB_GEN_C2a(t,y)
+#define DB_GEN_C2a(x,y) x << "<!-- DB_GEN_C " << __LINE__ << " " << y << " -->\n";
+#else
+#define DB_GEN_C
+#define DB_GEN_C1(x)
+#define DB_GEN_C2(y)
+#define DB_GEN_C2a(x,y)
+#endif
//------------------
-class DocbookSectionMapper : public QIntDict<char>
-{
- public:
- DocbookSectionMapper() : QIntDict<char>(47)
- {
- insert(MemberListType_pubTypes,"public-type");
- insert(MemberListType_pubMethods,"public-func");
- insert(MemberListType_pubAttribs,"public-attrib");
- insert(MemberListType_pubSlots,"public-slot");
- insert(MemberListType_signals,"signal");
- insert(MemberListType_dcopMethods,"dcop-func");
- insert(MemberListType_properties,"property");
- insert(MemberListType_events,"event");
- insert(MemberListType_pubStaticMethods,"public-static-func");
- insert(MemberListType_pubStaticAttribs,"public-static-attrib");
- insert(MemberListType_proTypes,"protected-type");
- insert(MemberListType_proMethods,"protected-func");
- insert(MemberListType_proAttribs,"protected-attrib");
- insert(MemberListType_proSlots,"protected-slot");
- insert(MemberListType_proStaticMethods,"protected-static-func");
- insert(MemberListType_proStaticAttribs,"protected-static-attrib");
- insert(MemberListType_pacTypes,"package-type");
- insert(MemberListType_pacMethods,"package-func");
- insert(MemberListType_pacAttribs,"package-attrib");
- insert(MemberListType_pacStaticMethods,"package-static-func");
- insert(MemberListType_pacStaticAttribs,"package-static-attrib");
- insert(MemberListType_priTypes,"private-type");
- insert(MemberListType_priMethods,"private-func");
- insert(MemberListType_priAttribs,"private-attrib");
- insert(MemberListType_priSlots,"private-slot");
- insert(MemberListType_priStaticMethods,"private-static-func");
- insert(MemberListType_priStaticAttribs,"private-static-attrib");
- insert(MemberListType_friends,"friend");
- insert(MemberListType_related,"related");
- insert(MemberListType_decDefineMembers,"define");
- insert(MemberListType_decProtoMembers,"prototype");
- insert(MemberListType_decTypedefMembers,"typedef");
- insert(MemberListType_decEnumMembers,"enum");
- insert(MemberListType_decFuncMembers,"func");
- insert(MemberListType_decVarMembers,"var");
- }
-};
-
-static DocbookSectionMapper g_docbookSectionMapper;
-
-
inline void writeDocbookString(FTextStream &t,const char *s)
{
- t << convertToXML(s);
+ t << convertToDocBook(s);
}
inline void writeDocbookCodeString(FTextStream &t,const char *s, int &col)
@@ -128,27 +96,30 @@ inline void writeDocbookCodeString(FTextStream &t,const char *s, int &col)
case '&': t << "&amp;"; col++; break;
case '\'': t << "&apos;"; col++; break;
case '"': t << "&quot;"; col++; break;
+ case '\007': t << "^G"; col++; break; // bell
+ case '\014': t << "^L"; col++; break; // form feed
default: t << c; col++; break;
}
}
}
-static void writeDocbookHeaderMainpage(FTextStream &t)
+static void addIndexTerm(FTextStream &t, QCString prim, QCString sec = "")
{
- t << "<?xml version='1.0' encoding='UTF-8' standalone='no'?>" << endl;;
- t << "<chapter xmlns=\"http://docbook.org/ns/docbook\" version=\"5.0\" xmlns:xlink=\"http://www.w3.org/1999/xlink\">" << endl;
-}
-
-static void writeDocbookHeader_ID(FTextStream &t, QCString id)
-{
- t << "<?xml version='1.0' encoding='UTF-8' standalone='no'?>" << endl;;
- t << "<section xmlns=\"http://docbook.org/ns/docbook\" version=\"5.0\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" xml:id=\"" << id << "\">" << endl;
+ t << "<indexterm><primary>";
+ t << convertToDocBook(prim);
+ t << "</primary>";
+ if (!sec.isEmpty())
+ {
+ t << "<secondary>";
+ t << convertToDocBook(sec);
+ t << "</secondary>";
+ }
+ t << "</indexterm>" << endl;
}
-
void writeDocbookLink(FTextStream &t,const char * /*extRef*/,const char *compoundId,
const char *anchorId,const char * text,const char * /*tooltip*/)
{
- t << "<link linkend=\"" << compoundId;
+ t << "<link linkend=\"_" << stripPath(compoundId);
if (anchorId) t << "_1" << anchorId;
t << "\"";
t << ">";
@@ -156,1856 +127,1060 @@ void writeDocbookLink(FTextStream &t,const char * /*extRef*/,const char *compoun
t << "</link>";
}
-class TextGeneratorDocbookImpl : public TextGeneratorIntf
+DocbookCodeGenerator::DocbookCodeGenerator(FTextStream &t) : m_lineNumber(-1), m_col(0),
+ m_insideCodeLine(FALSE), m_insideSpecialHL(FALSE)
{
- public:
- TextGeneratorDocbookImpl(FTextStream &t): m_t(t) {}
- void writeString(const char *s,bool /*keepSpaces*/) const
- {
- writeDocbookString(m_t,s);
- }
- void writeBreak(int) const {}
- void writeLink(const char *extRef,const char *file,
- const char *anchor,const char *text
- ) const
- {
- writeDocbookLink(m_t,extRef,file,anchor,text,0);
- }
- private:
- FTextStream &m_t;
-};
+ m_prettyCode=Config_getBool(DOCBOOK_PROGRAMLISTING);
+ setTextStream(t);
+}
-class DocbookCodeGenerator : public CodeOutputInterface
+DocbookCodeGenerator::DocbookCodeGenerator() : m_lineNumber(-1), m_col(0),
+ m_insideCodeLine(FALSE), m_insideSpecialHL(FALSE), m_streamSet(FALSE)
{
- public:
- DocbookCodeGenerator(FTextStream &t) : m_t(t), m_lineNumber(-1), m_col(0),
- m_insideCodeLine(FALSE), m_insideSpecialHL(FALSE) {}
- virtual ~DocbookCodeGenerator() {}
+ m_prettyCode=Config_getBool(DOCBOOK_PROGRAMLISTING);
+}
- void codify(const char *text)
- {
- Docbook_DB(("(codify \"%s\")\n",text));
- writeDocbookCodeString(m_t,text,m_col);
- }
- void writeCodeLink(const char *ref,const char *file,
- const char *anchor,const char *name,
- const char *tooltip)
- {
- Docbook_DB(("(writeCodeLink)\n"));
- writeDocbookLink(m_t,ref,file,anchor,name,tooltip);
- m_col+=strlen(name);
- }
- void writeTooltip(const char *, const DocLinkInfo &, const char *,
- const char *, const SourceLinkInfo &, const SourceLinkInfo &
- )
- {
- Docbook_DB(("(writeToolTip)\n"));
- }
- void startCodeLine(bool)
- {
- Docbook_DB(("(startCodeLine)\n"));
- if (m_lineNumber!=-1)
- {
- if (!m_refId.isEmpty())
- {
- m_t << "<link linkend=\"" << m_refId << "\">";
- }
- m_t << m_lineNumber << " ";
- if (!m_refId.isEmpty())
- {
- m_t << "</link>";
- }
- }
- m_insideCodeLine=TRUE;
- m_col=0;
- }
- void endCodeLine()
- {
- m_t << endl;
- Docbook_DB(("(endCodeLine)\n"));
- m_lineNumber = -1;
- m_refId.resize(0);
- m_external.resize(0);
- m_insideCodeLine=FALSE;
- }
- void startFontClass(const char *colorClass)
- {
- Docbook_DB(("(startFontClass)\n"));
- m_t << "<emphasis class=\"" << colorClass << "\">";
- m_insideSpecialHL=TRUE;
- }
- void endFontClass()
- {
- Docbook_DB(("(endFontClass)\n"));
- m_t << "</emphasis>"; // non DocBook
- m_insideSpecialHL=FALSE;
- }
- void writeCodeAnchor(const char *)
- {
- Docbook_DB(("(writeCodeAnchor)\n"));
- }
- void writeLineNumber(const char *extRef,const char *compId,
- const char *anchorId,int l)
- {
- Docbook_DB(("(writeLineNumber)\n"));
- // we remember the information provided here to use it
- // at the <codeline> start tag.
- m_lineNumber = l;
- if (compId)
- {
- m_refId=compId;
- if (anchorId) m_refId+=(QCString)"_1"+anchorId;
- if (extRef) m_external=extRef;
- }
- }
- void setCurrentDoc(Definition *,const char *,bool)
- {
- }
- void addWord(const char *,bool)
+DocbookCodeGenerator::~DocbookCodeGenerator() {}
+
+void DocbookCodeGenerator::codify(const char *text)
+{
+ Docbook_DB(("(codify \"%s\")\n",text));
+ writeDocbookCodeString(m_t,text,m_col);
+}
+void DocbookCodeGenerator::writeCodeLink(const char *ref,const char *file,
+ const char *anchor,const char *name,
+ const char *tooltip)
+{
+ Docbook_DB(("(writeCodeLink)\n"));
+ writeDocbookLink(m_t,ref,file,anchor,name,tooltip);
+ m_col+=strlen(name);
+}
+void DocbookCodeGenerator::writeCodeLinkLine(const char *ref,const char *file,
+ const char *anchor,const char *name,
+ const char *tooltip)
+{
+ Docbook_DB(("(writeCodeLinkLine)\n"));
+ m_t << "<anchor xml:id=\"_" << stripExtensionGeneral(stripPath(file),".xml");
+ m_t << "_1l";
+ writeDocbookString(m_t,name);
+ m_t << "\"/>";
+ m_col+=strlen(name);
+}
+void DocbookCodeGenerator::writeTooltip(const char *, const DocLinkInfo &, const char *,
+ const char *, const SourceLinkInfo &, const SourceLinkInfo &
+ )
+{
+ Docbook_DB(("(writeToolTip)\n"));
+}
+void DocbookCodeGenerator::startCodeLine(bool)
+{
+ Docbook_DB(("(startCodeLine)\n"));
+ m_insideCodeLine=TRUE;
+ m_col=0;
+}
+void DocbookCodeGenerator::endCodeLine()
+{
+ m_t << endl;
+ Docbook_DB(("(endCodeLine)\n"));
+ m_lineNumber = -1;
+ m_refId.resize(0);
+ m_external.resize(0);
+ m_insideCodeLine=FALSE;
+}
+void DocbookCodeGenerator::startFontClass(const char *colorClass)
+{
+ Docbook_DB(("(startFontClass)\n"));
+ m_t << "<emphasis role=\"" << colorClass << "\">";
+ m_insideSpecialHL=TRUE;
+}
+void DocbookCodeGenerator::endFontClass()
+{
+ Docbook_DB(("(endFontClass)\n"));
+ m_t << "</emphasis>"; // non DocBook
+ m_insideSpecialHL=FALSE;
+}
+void DocbookCodeGenerator::writeCodeAnchor(const char *)
+{
+ Docbook_DB(("(writeCodeAnchor)\n"));
+}
+void DocbookCodeGenerator::writeLineNumber(const char *ref,const char *fileName,
+ const char *anchor,int l)
+{
+ Docbook_DB(("(writeLineNumber)\n"));
+ m_insideCodeLine = TRUE;
+ if (m_prettyCode)
+ {
+ QCString lineNumber;
+ lineNumber.sprintf("%05d",l);
+
+ if (fileName && !m_sourceFileName.isEmpty())
{
+ writeCodeLinkLine(ref,m_sourceFileName,anchor,lineNumber,0);
+ writeCodeLink(ref,fileName,anchor,lineNumber,0);
}
- void finish()
+ else
{
- if (m_insideCodeLine) endCodeLine();
+ codify(lineNumber);
}
-
- private:
- FTextStream &m_t;
- QCString m_refId;
- QCString m_external;
- int m_lineNumber;
- int m_col;
- bool m_insideCodeLine;
- bool m_insideSpecialHL;
-};
-
-
-static void writeTemplateArgumentList(ArgumentList *al,
- FTextStream &t,
- Definition *scope,
- FileDef *fileScope,
- int indent)
-{
- QCString indentStr;
- indentStr.fill(' ',indent);
- if (al)
+ m_t << " ";
+ }
+ else
{
- t << indentStr << "<templateparamlist>" << endl;
- ArgumentListIterator ali(*al);
- Argument *a;
- for (ali.toFirst();(a=ali.current());++ali)
- {
- t << indentStr << " <param>" << endl;
- if (!a->type.isEmpty())
- {
- t << indentStr << " <type>";
- linkifyText(TextGeneratorDocbookImpl(t),scope,fileScope,0,a->type);
- t << "</type>" << endl;
- }
- if (!a->name.isEmpty())
- {
- t << indentStr << " <declname>" << a->name << "</declname>" << endl;
- t << indentStr << " <defname>" << a->name << "</defname>" << endl;
- }
- if (!a->defval.isEmpty())
- {
- t << indentStr << " <defval>";
- linkifyText(TextGeneratorDocbookImpl(t),scope,fileScope,0,a->defval);
- t << "</defval>" << endl;
- }
- t << indentStr << " </param>" << endl;
- }
- t << indentStr << "</templateparamlist>" << endl;
+ m_t << l << " ";
}
-}
-static void writeTemplateList(ClassDef *cd,FTextStream &t)
+}
+void DocbookCodeGenerator::setCurrentDoc(Definition *,const char *,bool)
{
- writeTemplateArgumentList(cd->templateArguments(),t,cd,0,4);
}
-
-static void writeDocbookDocBlock(FTextStream &t,
- const QCString &fileName,
- int lineNr,
- Definition *scope,
- MemberDef * md,
- const QCString &text)
-{
- QCString stext = text.stripWhiteSpace();
- if (stext.isEmpty()) return;
- // convert the documentation string into an abstract syntax tree
- DocNode *root = validatingParseDoc(fileName,lineNr,scope,md,text,FALSE,FALSE);
- // create a code generator
- DocbookCodeGenerator *docbookCodeGen = new DocbookCodeGenerator(t);
- // create a parse tree visitor for Docbook
- DocbookDocVisitor *visitor = new DocbookDocVisitor(t,*docbookCodeGen);
- // visit all nodes
- root->accept(visitor);
- // clean up
- delete visitor;
- delete docbookCodeGen;
- delete root;
+void DocbookCodeGenerator::addWord(const char *,bool)
+{
}
-
-void writeDocbookCodeBlock(FTextStream &t,FileDef *fd)
-{
- ParserInterface *pIntf=Doxygen::parserManager->getParser(fd->getDefFileExtension());
- SrcLangExt langExt = getLanguageFromFileName(fd->getDefFileExtension());
- pIntf->resetCodeParserState();
- DocbookCodeGenerator *docbookGen = new DocbookCodeGenerator(t);
- pIntf->parseCode(*docbookGen, // codeOutIntf
- 0, // scopeName
- fileToString(fd->absFilePath(),Config_getBool(FILTER_SOURCE_FILES)),
- langExt, // lang
- FALSE, // isExampleBlock
- 0, // exampleName
- fd, // fileDef
- -1, // startLine
- -1, // endLine
- FALSE, // inlineFragement
- 0, // memberDef
- TRUE // showLineNumbers
- );
- docbookGen->finish();
- delete docbookGen;
+void DocbookCodeGenerator::finish()
+{
+ if (m_insideCodeLine) endCodeLine();
}
-
-static QCString classOutputFileBase(ClassDef *cd)
+void DocbookCodeGenerator::startCodeFragment()
+{
+ m_t << "<literallayout><computeroutput>" << endl;
+}
+void DocbookCodeGenerator::endCodeFragment()
{
- //static bool inlineGroupedClasses = Config_getBool(INLINE_GROUPED_CLASSES);
- //if (inlineGroupedClasses && cd->partOfGroups()!=0)
- return cd->getOutputFileBase();
- //else
- // return cd->getOutputFileBase();
+ m_t << "</computeroutput></literallayout>" << endl;
}
-static QCString memberOutputFileBase(MemberDef *md)
+DocbookGenerator::DocbookGenerator() : OutputGenerator()
{
- //static bool inlineGroupedClasses = Config_getBool(INLINE_GROUPED_CLASSES);
- //if (inlineGroupedClasses && md->getClassDef() && md->getClassDef()->partOfGroups()!=0)
- // return md->getClassDef()->getDocbookOutputFileBase();
- //else
- // return md->getOutputFileBase();
- return md->getOutputFileBase();
+DB_GEN_C
+ dir=Config_getString(DOCBOOK_OUTPUT);
+ //insideTabbing=FALSE;
+ //firstDescItem=TRUE;
+ //disableLinks=FALSE;
+ //m_indent=0;
+ //templateMemberItem = FALSE;
+ m_prettyCode=Config_getBool(DOCBOOK_PROGRAMLISTING);
+ m_denseText = FALSE;
+ m_inGroup = FALSE;
+ m_inDetail = FALSE;
+ m_levelListItem = 0;
+ m_descTable = FALSE;
+ m_inLevel = -1;
+ m_firstMember = FALSE;
+ for (int i = 0 ; i < sizeof(m_inListItem) / sizeof(*m_inListItem) ; i++) m_inListItem[i] = FALSE;
+ for (int i = 0 ; i < sizeof(m_inSimpleSect) / sizeof(*m_inSimpleSect) ; i++) m_inSimpleSect[i] = FALSE;
}
+DocbookGenerator::~DocbookGenerator()
+{
+DB_GEN_C
+}
-static void generateDocbookForMember(MemberDef *md,FTextStream &t,Definition *def, bool detailed=0)
+void DocbookGenerator::init()
{
+ QCString dir=Config_getString(DOCBOOK_OUTPUT);
+ QDir d(dir);
+ if (!d.exists() && !d.mkdir(dir))
+ {
+ err("Could not create output directory %s\n",dir.data());
+ exit(1);
+ }
- // + declaration/definition arg lists
- // + reimplements
- // + reimplementedBy
- // + exceptions
- // + const/volatile specifiers
- // - examples
- // + source definition
- // + source references
- // + source referenced by
- // - body code
- // + template arguments
- // (templateArguments(), definitionTemplateParameterLists())
- // - call graph
+ createSubDirs(d);
+}
- // enum values are written as part of the enum
- if (md->memberType()==MemberType_EnumValue) return;
- if (md->isHidden()) return;
- //if (md->name().at(0)=='@') return; // anonymous member
+void DocbookGenerator::startFile(const char *name,const char *,const char *)
+{
+DB_GEN_C
+ QCString fileName=name;
+ QCString pageName;
+ QCString fileType="section";
+ if (fileName == "refman")
+ {
+ fileName="index";
+ fileType="book";
+ }
+ else if (fileName == "index")
+ {
+ fileName="mainpage";
+ fileType="chapter";
+ }
+ pageName = fileName;
+ relPath = relativePathToRoot(fileName);
+ if (fileName.right(4)!=".xml") fileName+=".xml";
+ startPlainFile(fileName);
+ m_codeGen.setTextStream(t);
+ m_codeGen.setRelativePath(relPath);
+ m_codeGen.setSourceFileName(stripPath(fileName));
+
+ t << "<?xml version='1.0' encoding='UTF-8' standalone='no'?>" << endl;;
+ t << "<" << fileType << " xmlns=\"http://docbook.org/ns/docbook\" version=\"5.0\" xmlns:xlink=\"http://www.w3.org/1999/xlink\"";
+ if (!pageName.isEmpty()) t << " xml:id=\"_" << stripPath(pageName) << "\"";
+ t << ">" << endl;
+}
- // group members are only visible in their group
- //if (def->definitionType()!=Definition::TypeGroup && md->getGroupDef()) return;
- QCString memType;
- switch (md->memberType())
+void DocbookGenerator::endFile()
+{
+DB_GEN_C
+ if (m_inDetail) t << "</section>" << endl;
+ m_inDetail = FALSE;
+ while (m_inLevel != -1)
{
- case MemberType_Define: memType="define"; break;
- case MemberType_Function: memType="function"; break;
- case MemberType_Variable: memType="variable"; break;
- case MemberType_Typedef: memType="typedef"; break;
- case MemberType_Enumeration: memType="enum"; break;
- case MemberType_EnumValue: ASSERT(0); break;
- case MemberType_Signal: memType="signal"; break;
- case MemberType_Slot: memType="slot"; break;
- case MemberType_Friend: memType="friend"; break;
- case MemberType_DCOP: memType="dcop"; break;
- case MemberType_Property: memType="property"; break;
- case MemberType_Event: memType="event"; break;
- case MemberType_Interface: memType="interface"; break;
- case MemberType_Service: memType="service"; break;
+ t << "</section>" << endl;
+ m_inLevel--;
}
- QCString scopeName;
- if (md->getClassDef())
+ if (m_inGroup) t << "</section>" << endl;
+ m_inGroup = FALSE;
+
+ QCString fileType="section";
+ QCString fileName= m_codeGen.sourceFileName();
+ if (fileName == "index.xml")
{
- scopeName=md->getClassDef()->name();
+ fileType="book";
}
- else if (md->getNamespaceDef())
+ else if (fileName == "mainpage.xml")
{
- scopeName=md->getNamespaceDef()->name();
+ fileType="chapter";
}
- if (detailed==0)
+ t << "</" << fileType << ">" << endl;
+ endPlainFile();
+ m_codeGen.setSourceFileName("");
+}
+
+void DocbookGenerator::startIndexSection(IndexSections is)
+{
+DB_GEN_C2("IndexSections " << is)
+ switch (is)
{
- t << " <para>" << endl;
- t << " <itemizedlist>" << endl;
- t << " <listitem>" << endl;
- //enum
- bool closePara=TRUE;
- if (md->memberType()==MemberType_Enumeration)
- {
- MemberList *enumFields = md->enumFieldList();
- t << " <para><literallayout>" << memType << " <link linkend=\"";
- if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)
+ case isTitlePageStart:
{
- t << md->getGroupDef()->getOutputFileBase();
+ QCString dbk_projectName = Config_getString(PROJECT_NAME);
+ t << " <info>" << endl;
+ t << " <title>" << convertToDocBook(dbk_projectName) << "</title>" << endl;
+ t << " </info>" << endl;
}
- else
- {
- t << memberOutputFileBase(md);
- }
- t << "_1" << md->anchor() << "\">" << convertToXML(md->name()) << "</link>";
- if (enumFields!=0)
+ break;
+ case isTitlePageAuthor:
+ break;
+ case isMainPage:
+ t << "<chapter>" << endl;
+ t << " <title>";
+ break;
+ case isModuleIndex:
+ //Module Index}\n"
+ break;
+ case isDirIndex:
+ //Directory Index}\n"
+ break;
+ case isNamespaceIndex:
+ //Namespace Index}\n"
+ break;
+ case isClassHierarchyIndex:
+ //Hierarchical Index}\n"
+ break;
+ case isCompoundIndex:
+ //t << "{"; //Class Index}\n"
+ break;
+ case isFileIndex:
+ //Annotated File Index}\n"
+ break;
+ case isPageIndex:
+ //Annotated Page Index}\n"
+ break;
+ case isModuleDocumentation:
+ t << "<chapter>\n";
+ t << " <title>";
+ break;
+ case isDirDocumentation:
+ t << "<chapter>\n";
+ t << " <title>";
+ break;
+ case isNamespaceDocumentation:
+ t << "<chapter>\n";
+ t << " <title>";
+ break;
+ case isClassDocumentation:
+ t << "<chapter>\n";
+ t << " <title>";
+ break;
+ case isFileDocumentation:
+ t << "<chapter>\n";
+ t << " <title>";
+ break;
+ case isExampleDocumentation:
+ t << "<chapter>\n";
+ t << " <title>";
+ break;
+ case isPageDocumentation:
+ break;
+ case isPageDocumentation2:
+ break;
+ case isEndIndex:
+ break;
+ }
+}
+
+void DocbookGenerator::endIndexSection(IndexSections is)
+{
+DB_GEN_C2("IndexSections " << is)
+ static bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
+ switch (is)
+ {
+ case isTitlePageStart:
+ break;
+ case isTitlePageAuthor:
+ break;
+ case isMainPage:
+ t << "</title>" << endl;
+ t << " <xi:include href=\"mainpage.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
+ t << "</chapter>" << endl;
+ break;
+ case isModuleIndex:
+ //t << "</chapter>" << endl;
+ break;
+ case isDirIndex:
+ //t << "<xi:include href=\"dirs.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";
+ //t << "</chapter>" << endl;
+ break;
+ case isNamespaceIndex:
+ //t << "<xi:include href=\"namespaces.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";
+ //t << "</chapter>" << endl;
+ break;
+ case isClassHierarchyIndex:
+ //t << "<xi:include href=\"hierarchy.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";
+ //t << "</chapter>" << endl;
+ break;
+ case isCompoundIndex:
+ //t << "</chapter>" << endl;
+ break;
+ case isFileIndex:
+ //t << "<xi:include href=\"files.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";
+ //t << "</chapter>" << endl;
+ break;
+ case isPageIndex:
+ //t << "<xi:include href=\"pages.xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>";
+ //t << "</chapter>" << endl;
+ break;
+ case isModuleDocumentation:
{
- MemberListIterator emli(*enumFields);
- MemberDef *emd;
- t << " {" << endl;
- int cnt=0;
- for (emli.toFirst();(emd=emli.current());++emli)
+ t << "</title>" << endl;
+ GroupSDict::Iterator gli(*Doxygen::groupSDict);
+ GroupDef *gd;
+ bool found=FALSE;
+ for (gli.toFirst();(gd=gli.current()) && !found;++gli)
{
- if (cnt!=0)
- {
- t << "," << endl;
- }
- t << "<link linkend=\"" << memberOutputFileBase(emd) << "_1" << emd->anchor() << "\">";
- writeDocbookString(t,emd->name());
- t << "</link>";
- if (!emd->initializer().isEmpty())
+ if (!gd->isReference())
{
- writeDocbookString(t,emd->initializer());
+ t << " <xi:include href=\"" << gd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
+ found=TRUE;
}
- cnt++;
- }
- t << endl << "}";
- }
- t << "</literallayout>" << endl;
- if (md->briefDescription())
- {
- t << "<para><emphasis>";
- writeDocbookString(t,md->briefDescription());
- t << "</emphasis></para>" << endl;
- }
- }
- else if (md->memberType()==MemberType_Define)
- {
- t << " <para>" << "#" << memType << " <link linkend=\"";
- if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)
- {
- t << md->getGroupDef()->getOutputFileBase();
- }
- else
- {
- t << memberOutputFileBase(md);
- }
- t << "_1" << md->anchor() << "\">" << convertToXML(md->name()) << "</link>";
- if (!md->initializer().isEmpty() && md->initializer().length()<2000)
- {
- t << " ";
- linkifyText(TextGeneratorDocbookImpl(t),def,md->getBodyDef(),md,md->initializer());
- }
- if (md->briefDescription())
- {
- t << "<para><emphasis>";
- writeDocbookString(t,md->briefDescription());
- t << "</emphasis></para>" << endl;
- }
- }
- else if (md->memberType()==MemberType_Variable)
- {
- if (md->getClassDef())
- {
- t << " <para>" << convertToXML(md->declaration());
- if (md->briefDescription())
- {
- t << "<para><emphasis>";
- writeDocbookString(t,md->briefDescription());
- t << "</emphasis></para>";
- }
- }
- else
- {
- t << " <para>";
- linkifyText(TextGeneratorDocbookImpl(t),def,md->getBodyDef(),md,md->typeString());
- t << " <link linkend=\"";
- if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)
- {
- t << md->getGroupDef()->getOutputFileBase();
}
- else
+ for (;(gd=gli.current());++gli)
{
- t << memberOutputFileBase(md);
- }
- t << "_1" << md->anchor() << "\">" << convertToXML(md->name()) << "</link>";
- if (md->briefDescription())
- {
- t << "<para><emphasis>";
- writeDocbookString(t,md->briefDescription());
- t << "</emphasis></para>" << endl;
+ if (!gd->isReference())
+ {
+ t << " <xi:include href=\"" << gd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
+ }
}
}
- }
- else if (md->memberType()==MemberType_Typedef)
- {
- t << " <para>" << memType;
- t << " ";
- linkifyText(TextGeneratorDocbookImpl(t),def,md->getBodyDef(),md,md->typeString());
- t << " ";
- t << " <link linkend=\"";
- if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)
- {
- t << md->getGroupDef()->getOutputFileBase();
- }
- else
+ t << "</chapter>\n";
+ break;
+ case isDirDocumentation:
{
- t << memberOutputFileBase(md);
- }
- t << "_1" << md->anchor() << "\">" << convertToXML(md->name()) << "</link>";
- if (md->briefDescription())
- {
- t << "<para><emphasis>";
- writeDocbookString(t,md->briefDescription());
- t << "</emphasis></para>" << endl;
- }
- }
- else if (md->memberType()==MemberType_Function)
- {
- t << " <para>";
- linkifyText(TextGeneratorDocbookImpl(t),def,md->getBodyDef(),md,md->typeString());
- t << " <link linkend=\"";
- if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)
- {
- t << md->getGroupDef()->getOutputFileBase();
- }
- else
- {
- t << memberOutputFileBase(md);
- }
- t << "_1" << md->anchor() << "\">" << convertToXML(md->name()) << "</link>";
- t << " (" << endl;
- ArgumentList *declAl = md->declArgumentList();
- if (declAl && declAl->count()>0)
- {
- ArgumentListIterator declAli(*declAl);
- Argument *a;
- int cnt=0;
- for (declAli.toFirst();(a=declAli.current());++declAli)
+ t << "</title>" << endl;
+ SDict<DirDef>::Iterator dli(*Doxygen::directories);
+ DirDef *dd;
+ bool found=FALSE;
+ for (dli.toFirst();(dd=dli.current()) && !found;++dli)
{
- if (cnt!=0)
- {
- t << ", ";
- }
- if (!a->type.isEmpty())
+ if (dd->isLinkableInProject())
{
- linkifyText(TextGeneratorDocbookImpl(t),def,md->getBodyDef(),md,a->type);
+ t << "< xi:include href=\"" << dd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
+ found=TRUE;
}
- t << " ";
- if (!a->name.isEmpty())
+ }
+ for (;(dd=dli.current());++dli)
+ {
+ if (dd->isLinkableInProject())
{
- writeDocbookString(t,a->name);
+ t << " <xi:include href=\"" << dd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
}
- cnt++;
}
}
- t << ")";
- if (md->briefDescription())
- {
- t << "<para><emphasis>";
- writeDocbookString(t,md->briefDescription());
- t << "</emphasis></para>" << endl;
- }
- }
- else
- {
- closePara = FALSE;
- }
- if (closePara) t << "</para>" << endl;
- t << " </listitem>" << endl;
- t << " </itemizedlist>" << endl;
- t << " </para>" << endl;
- }
- else
- {
- if (md->memberType()==MemberType_Enumeration)
- {
- MemberList *enumFields = md->enumFieldList();
- t << " <section xml:id=\"";
- if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)
- {
- t << md->getGroupDef()->getOutputFileBase();
- }
- else
+ t << "</chapter>\n";
+ break;
+ case isNamespaceDocumentation:
{
- t << memberOutputFileBase(md);
- }
- t << "_1" << md->anchor() << "\">" << endl;
- t << " <title>" << memType << " " << convertToXML(md->name()) << " " << "</title>" << endl;
- t << " ";
- writeDocbookDocBlock(t,md->docFile(),md->docLine(),md->getOuterScope(),md,md->documentation());
- t << endl;
- if (enumFields!=0)
- {
- MemberListIterator emli(*enumFields);
- MemberDef *emd;
- t << " <formalpara>" << endl;
- t << " <title>" << theTranslator->trEnumerationValues() << ":</title>" << endl;
- t << " <variablelist>" << endl;
- for (emli.toFirst();(emd=emli.current());++emli)
+ t << "</title>" << endl;
+ NamespaceSDict::Iterator nli(*Doxygen::namespaceSDict);
+ NamespaceDef *nd;
+ bool found=FALSE;
+ for (nli.toFirst();(nd=nli.current()) && !found;++nli)
{
- t << " <varlistentry xml:id=\"";
- t << memberOutputFileBase(emd) << "_1" << emd->anchor() << "\">" << endl;
- t << " <term>";
- writeDocbookString(t,emd->name());
- t << "</term>" << endl;
- t << " <listitem>" << endl;
- if(Config_getBool(REPEAT_BRIEF))
+ if (nd->isLinkableInProject())
{
- t << " <para>";
- writeDocbookString(t,emd->briefDescription());
- t << "</para>" << endl;
+ t << "<xi:include href=\"" << nd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
+ found=TRUE;
}
- t << " </listitem>" << endl;
- t << " </varlistentry>" << endl;
}
- t << " </variablelist>" << endl;
- t << " </formalpara>" << endl;
- t << " <para>";
- t << "Definition at line " << md->getDefLine() << " of file " << stripPath(md->getDefFileName()) << endl;
- t << " <computeroutput><literallayout>" << endl;
- t << "{" << endl;
- for (emli.toFirst();(emd=emli.current());++emli)
+ while ((nd=nli.current()))
{
- writeDocbookString(t,emd->name());
- if (!emd->initializer().isEmpty())
+ if (nd->isLinkableInProject())
{
- writeDocbookString(t,emd->initializer());
+ t << "<xi:include href=\"" << nd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
}
- t << ", " << endl;
+ ++nli;
}
- t << "}" << convertToXML(md->name()) << ";" << endl;
- t << " </literallayout></computeroutput>" << endl;
- t << " </para>" << endl;
- t << " </section>" << endl;
- }
- }
- else if (md->memberType()==MemberType_Typedef)
- {
- t << " <section xml:id=\"";
- if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)
- {
- t << md->getGroupDef()->getOutputFileBase();
- }
- else
- {
- t << memberOutputFileBase(md);
- }
- t << "_1" << md->anchor() << "\">" << endl;
- t << " <title>" << convertToXML(md->definition()) << "</title>";
- if(Config_getBool(REPEAT_BRIEF))
- {
- t << " <emphasis>";
- writeDocbookString(t,md->briefDescription());
- t << "</emphasis>" << endl;
- }
- t << " ";
- writeDocbookDocBlock(t,md->docFile(),md->docLine(),md->getOuterScope(),md,md->documentation());
- t << endl;
- t << " </section>" << endl;
- }
- else if (md->memberType()==MemberType_Function)
- {
- t << " <section xml:id=\"";
- if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)
- {
- t << md->getGroupDef()->getOutputFileBase();
- }
- else
- {
- t << memberOutputFileBase(md);
- }
- t << "_1" << md->anchor() << "\">" << endl;
- t << " <title>" << convertToXML(md->definition()) << " " << convertToXML(md->argsString()) << "</title>";
- if(Config_getBool(REPEAT_BRIEF))
- {
- t << " <emphasis>";
- writeDocbookString(t,md->briefDescription());
- t << "</emphasis>" << endl;
}
- t << " ";
- writeDocbookDocBlock(t,md->docFile(),md->docLine(),md->getOuterScope(),md,md->documentation());
- t << endl;
- t << " </section>" << endl;
- }
- else if (md->memberType()==MemberType_Define)
- {
- if (md->documentation())
+ t << "</chapter>\n";
+ break;
+ case isClassDocumentation:
{
- t << " <section xml:id=\"";
- if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)
+ t << "</title>" << endl;
+ ClassSDict::Iterator cli(*Doxygen::classSDict);
+ ClassDef *cd=0;
+ bool found=FALSE;
+ for (cli.toFirst();(cd=cli.current()) && !found;++cli)
{
- t << md->getGroupDef()->getOutputFileBase();
+ if (cd->isLinkableInProject() &&
+ cd->templateMaster()==0 &&
+ !cd->isEmbeddedInOuterScope()
+ )
+ {
+ t << " <xi:include href=\"" << cd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
+ found=TRUE;
+ }
}
- else
+ for (;(cd=cli.current());++cli)
{
- t << memberOutputFileBase(md);
+ if (cd->isLinkableInProject() &&
+ cd->templateMaster()==0 &&
+ !cd->isEmbeddedInOuterScope()
+ )
+ {
+ t << " <xi:include href=\"" << cd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
+ }
}
- t << "_1" << md->anchor() << "\">" << endl;
- t << " <title>" << convertToXML(md->definition()) << "</title>";
- t << " ";
- writeDocbookDocBlock(t,md->docFile(),md->docLine(),md->getOuterScope(),md,md->documentation());
- t << endl;
- t << " <para>Definition at line " << md->getDefLine() << " of file " << stripPath(md->getDefFileName()) << "</para>" << endl;
- t << " <para>The Documentation for this define was generated from the following file: </para>" << endl;
- t << " <para><itemizedlist><listitem><para>" << stripPath(md->getDefFileName()) << "</para></listitem></itemizedlist></para>" << endl;
- t << " </section>" << endl;
}
- }
- else if (md->memberType()==MemberType_Variable)
- {
- if (md->getClassDef())
+ t << "</chapter>\n";
+ break;
+ case isFileDocumentation:
{
- if (md->documentation())
+ t << "</title>" << endl;
+ bool isFirst=TRUE;
+ FileNameListIterator fnli(*Doxygen::inputNameList);
+ FileName *fn;
+ for (fnli.toFirst();(fn=fnli.current());++fnli)
{
- t << " <simplesect>" << endl;
- t << " <title>" << convertToXML(md->definition()) << "</title>";
- t << " ";
- writeDocbookDocBlock(t,md->docFile(),md->docLine(),md->getOuterScope(),md,md->documentation());
- t << endl;
- t << " <para>Definition at line " << md->getDefLine() << " of file " << stripPath(md->getDefFileName()) << "</para>" << endl;
- t << " <para>The Documentation for this struct was generated from the following file: </para>" << endl;
- t << " <para><itemizedlist><listitem><para>" << stripPath(md->getDefFileName()) << "</para></listitem></itemizedlist></para>" << endl;
- t << " </simplesect>" << endl;
+ FileNameIterator fni(*fn);
+ FileDef *fd;
+ for (;(fd=fni.current());++fni)
+ {
+ if (fd->isLinkableInProject())
+ {
+ if (isFirst)
+ {
+ t << " <xi:include href=\"" << fd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
+ if (sourceBrowser && m_prettyCode && fd->generateSourceFile())
+ {
+ t << " <xi:include href=\"" << fd->getSourceFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
+ }
+ isFirst=FALSE;
+ }
+ else
+ {
+ t << " <xi:include href=\"" << fd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
+ if (sourceBrowser && m_prettyCode && fd->generateSourceFile())
+ {
+ t << " <xi:include href=\"" << fd->getSourceFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
+ }
+ }
+ }
+ }
}
}
- else
+ t << "</chapter>\n";
+ break;
+ case isExampleDocumentation:
{
- t << " <section xml:id=\"";
- if (md->getGroupDef() && def->definitionType()==Definition::TypeGroup)
- {
- t << md->getGroupDef()->getOutputFileBase();
- }
- else
+ t << "</title>" << endl;
+ PageSDict::Iterator pdi(*Doxygen::exampleSDict);
+ PageDef *pd=pdi.toFirst();
+ if (pd)
{
- t << memberOutputFileBase(md);
+ t << " <xi:include href=\"" << pd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
}
- t << "_1" << md->anchor() << "\">" << endl;
- t << " <title>" << convertToXML(md->definition()) << "</title>";
- if(Config_getBool(REPEAT_BRIEF))
+ for (++pdi;(pd=pdi.current());++pdi)
{
- t << " <emphasis>";
- writeDocbookString(t,md->briefDescription());
- t << "</emphasis>" << endl;
+ t << " <xi:include href=\"" << pd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
}
- t << " ";
- writeDocbookDocBlock(t,md->docFile(),md->docLine(),md->getOuterScope(),md,md->documentation());
- t << endl;
- t << " </section>" << endl;
}
- }
+ t << "</chapter>\n";
+ break;
+ case isPageDocumentation:
+ break;
+ case isPageDocumentation2:
+ break;
+ case isEndIndex:
+ t << "<index/>" << endl;
+ break;
}
}
-
-static void generateDocbookSection(Definition *d,FTextStream &t,MemberList *ml,const char *,
- bool detailed=0, const char *header=0,const char *documentation=0)
-{
- if (ml==0) return;
- MemberListIterator mli(*ml);
- MemberDef *md;
- int count=0;
- int doc_count=0;
- QCString title, desctitle;
-
- for (mli.toFirst();(md=mli.current());++mli)
- {
- // namespace members are also inserted in the file scope, but
- // to prevent this duplication in the Docbook output, we filter those here.
- if (d->definitionType()!=Definition::TypeFile || md->getNamespaceDef()==0)
- {
- count++;
- }
- }
-
- if (count==0) return; // empty list
-
- switch (ml->listType())
- {
- case MemberListType_decDefineMembers: title=theTranslator->trDefines(); desctitle=theTranslator->trDefineDocumentation(); break;
- case MemberListType_decTypedefMembers: title=theTranslator->trTypedefs(); desctitle=theTranslator->trTypedefDocumentation(); break;
- case MemberListType_decEnumMembers: title=theTranslator->trEnumerations(); desctitle=theTranslator->trEnumerationTypeDocumentation(); break;
- case MemberListType_decFuncMembers: title=theTranslator->trFunctions(); desctitle=theTranslator->trFunctionDocumentation(); break;
- case MemberListType_decVarMembers: title=theTranslator->trVariables(); desctitle=theTranslator->trVariableDocumentation(); break;
- case MemberListType_pubAttribs: title=theTranslator->trPublicAttribs(); desctitle=theTranslator->trMemberDataDocumentation(); break;
- case MemberListType_priAttribs: title=theTranslator->trPrivateAttribs(); desctitle=theTranslator->trMemberDataDocumentation(); break;
- case MemberListType_proAttribs: title=theTranslator->trProtectedAttribs(); desctitle=theTranslator->trMemberDataDocumentation(); break;
- default: title=""; desctitle=""; break;
- }
-
- if (detailed)
- {
- for (mli.toFirst();(md=mli.current());++mli)
- {
- if (md->documentation().isEmpty() && !Config_getBool(REPEAT_BRIEF))
- {
- continue;
- }
- doc_count = 1;
- break;
- }
-
- if(doc_count == 0)
- {
- return;
- }
-
- if (desctitle)
- {
- t << " <section>" << endl;
- t << " <title>" << desctitle << "</title>" << endl;
- }
- } else
- {
- t << " <section>" << endl;
- if (header)
- {
- t << " <title>" << convertToXML(header) << "</title>" << endl;
- }
- else
- {
- t << " <title>" << title << "</title>" << endl;
- }
- }
-
- if (documentation)
- {
- t << " <description>";
- writeDocbookDocBlock(t,d->docFile(),d->docLine(),d,0,documentation);
- t << "</description>" << endl;
- }
- for (mli.toFirst();(md=mli.current());++mli)
- {
- // namespace members are also inserted in the file scope, but
- // to prevent this duplication in the Docbook output, we filter those here.
- if (d->definitionType()!=Definition::TypeFile || md->getNamespaceDef()==0)
- {
- if (detailed && md->documentation().isEmpty() && !Config_getBool(REPEAT_BRIEF))
- {
- continue;
- }
-
- generateDocbookForMember(md,t,d,detailed);
- }
- }
- if (detailed)
- {
- if (desctitle)
- {
- t << " </section>" << endl;
- }
- }
- else
- {
- t << " </section>" << endl;
- }
-}
-
-static void writeInnerClasses(const ClassSDict *cl,FTextStream &t)
+void DocbookGenerator::writePageLink(const char *name, bool /*first*/)
{
- if (cl)
+DB_GEN_C
+ PageSDict::Iterator pdi(*Doxygen::pageSDict);
+ PageDef *pd = pdi.toFirst();
+ for (pd = pdi.toFirst();(pd=pdi.current());++pdi)
{
- ClassSDict::Iterator cli(*cl);
- ClassDef *cd;
- QCString title = theTranslator->trClasses();
-
- if (cli.toFirst())
+ if (!pd->getGroupDef() && !pd->isReference() && pd->name() == stripPath(name))
{
- t << " <section>" << endl;
- t << " <title> " << title << " </title>" << endl;
- }
- for (cli.toFirst();(cd=cli.current());++cli)
- {
- if (!cd->isHidden() && cd->name().find('@')==-1)
+ t << "<chapter>\n";
+ if (!pd->title().isEmpty())
{
- t << " <para>" << endl;
- t << " <itemizedlist>" << endl;
- t << " <listitem>" << endl;
- t << " <para>" << "struct <link linkend=\"" << classOutputFileBase(cd) << "\">" << convertToXML(cd->name()) << "</link>";
- t << "</para>" << endl;
- if (cd->briefDescription())
- {
- t << "<para><emphasis>";
- writeDocbookString(t,cd->briefDescription());
- t << "</emphasis></para>" << endl;
- }
- t << " </listitem>" << endl;
- t << " </itemizedlist>" << endl;
- t << " </para>" << endl;
+ t << " <title>" << convertToDocBook(pd->title()) << "</title>" << endl;
}
- }
- if (cli.toFirst())
- {
- t << " </section>" << endl;
- }
- }
-}
-
-static void writeInnerNamespaces(const NamespaceSDict *nl,FTextStream &t)
-{
- if (nl)
- {
- NamespaceSDict::Iterator nli(*nl);
- NamespaceDef *nd;
- QCString title = theTranslator->trNamespaces();
-
- if (nli.toFirst())
- {
- t << " <simplesect>" << endl;
- t << " <title> " << title << " </title>" << endl;
- }
- for (nli.toFirst();(nd=nli.current());++nli)
- {
- if (!nd->isHidden() && nd->name().find('@')==-1) // skip anonymouse scopes
+ else
{
- t << " <para>" << endl;
- t << " <itemizedlist>" << endl;
- t << " <listitem>" << endl;
- t << " <para>" << "struct <link linkend=\"" << nd->getOutputFileBase() << "\">" << convertToXML(nd->name()) << "</link>";
- t << "</para>" << endl;
- t << " </listitem>" << endl;
- t << " </itemizedlist>" << endl;
- t << " </para>" << endl;
+ t << " <title>" << convertToDocBook(pd->name()) << "</title>" << endl;
}
- }
- if (nli.toFirst())
- {
- t << " </simplesect>" << endl;
+ t << " <xi:include href=\"" << pd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
+ t << "</chapter>\n";
}
}
}
-
-static void writeInnerFiles(const FileList *fl,FTextStream &t)
+void DocbookGenerator::writeDoc(DocNode *n,Definition *ctx,MemberDef *)
{
- if (fl)
- {
- QListIterator<FileDef> fli(*fl);
- FileDef *fd;
- QCString title = theTranslator->trFile(TRUE,TRUE);
-
- if (fli.toFirst())
- {
- t << " <simplesect>" << endl;
- t << " <title> " << title << " </title>" << endl;
- }
- for (fli.toFirst();(fd=fli.current());++fli)
- {
- t << " <para>" << endl;
- t << " <itemizedlist>" << endl;
- t << " <listitem>" << endl;
- t << " <para>" << "file <link linkend=\"" << fd->getOutputFileBase() << "\">" << convertToXML(fd->name()) << "</link>";
- t << "</para>" << endl;
- t << " </listitem>" << endl;
- t << " </itemizedlist>" << endl;
- t << " </para>" << endl;
- }
- if (fli.toFirst())
- {
- t << " </simplesect>" << endl;
- }
- }
+DB_GEN_C
+ DocbookDocVisitor *visitor =
+ new DocbookDocVisitor(t,*this);
+ n->accept(visitor);
+ delete visitor;
}
-static void writeInnerPages(const PageSDict *pl,FTextStream &t)
+void DocbookGenerator::startParagraph(const char *)
{
- if (pl)
- {
- PageSDict::Iterator pli(*pl);
- PageDef *pd;
-
- for (pli.toFirst();(pd=pli.current());++pli)
- {
- t << "<xi:include href=\"" << pd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
- }
- }
+DB_GEN_C
+ t << "<para>" << endl;
}
-static void writeInnerGroups(const GroupList *gl,FTextStream &t)
+void DocbookGenerator::endParagraph()
{
- if (gl)
- {
- GroupListIterator gli(*gl);
- GroupDef *sgd;
-
- //Docbook header tags for inner groups
- if (gli.toFirst())
- {
- t << " <simplesect>" << endl;
- t << " <title>" << theTranslator->trModules() << "</title>" << endl;
- t << " </simplesect>" << endl;
- t << " <para>" << endl;
- t << " <itemizedlist>" << endl;
- }
-
- for (gli.toFirst();(sgd=gli.current());++gli)
- {
- t << " <listitem><para><link linkend=\"" << sgd->getOutputFileBase() << "\">" << convertToXML(sgd->groupTitle()) << "</link></para></listitem>" << endl;
- }
-
- //Docbook footer tags for inner groups
- if (gli.toFirst())
- {
- t << " </itemizedlist>" << endl;
- t << " </para>" << endl;
- }
-
- }
+DB_GEN_C
+ t << "</para>" << endl;
}
-
-static void writeInnerDirs(const DirList *dl,FTextStream &t)
+void DocbookGenerator::writeString(const char *text)
{
- if (dl)
- {
- QListIterator<DirDef> subdirs(*dl);
- DirDef *subdir;
- QCString title = theTranslator->trDirectories();
- if (subdirs.toFirst())
- {
- t << " <simplesect>" << endl;
- t << " <title> " << title << " </title>" << endl;
- }
- for (subdirs.toFirst();(subdir=subdirs.current());++subdirs)
- {
- t << " <para>" << endl;
- t << " <itemizedlist>" << endl;
- t << " <listitem>" << endl;
- t << " <para>" << "dir <link linkend=\"" << subdir->getOutputFileBase() << "\">" << convertToXML(subdir->displayName()) << "</link>";
- t << "</para>" << endl;
- t << " </listitem>" << endl;
- t << " </itemizedlist>" << endl;
- t << " </para>" << endl;
- }
- if (subdirs.toFirst())
- {
- t << " </simplesect>" << endl;
- }
- }
+DB_GEN_C
+ t << text;
}
-
-static void writeInnerGroupFiles(const GroupList *gl,FTextStream &t)
+void DocbookGenerator::startMemberHeader(const char *name,int)
{
- if (gl)
- {
- GroupListIterator gli(*gl);
- GroupDef *sgd;
-
- for (gli.toFirst();(sgd=gli.current());++gli)
- {
- t << "<xi:include href=\"" << sgd->getOutputFileBase() << ".xml\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
- }
- }
+DB_GEN_C
+ t << "<simplesect>" << endl;
+ m_inSimpleSect[m_levelListItem] = TRUE;
+ t << " <title>";
}
-static void generateDocbookForClass(ClassDef *cd,FTextStream &ti)
-{
- // + brief description
- // + detailed description
- // + template argument list(s)
- // - include file
- // + member groups
- // + inheritance diagram
- // + list of direct super classes
- // + list of direct sub classes
- // + list of inner classes
- // + collaboration diagram
- // + list of all members
- // + user defined member sections
- // + standard member sections
- // + detailed member documentation
- // - examples using the class
-
- if (cd->isReference()) return; // skip external references.
- if (cd->isHidden()) return; // skip hidden classes.
- if (cd->name().find('@')!=-1) return; // skip anonymous compounds.
- if (cd->templateMaster()!=0) return; // skip generated template instances.
-
- msg("Generating Docbook output for class %s\n",cd->name().data());
-
- QCString fileDocbook=cd->getOutputFileBase()+".xml";
- //Add the file Documentation info to index file
- ti << " <xi:include href=\"" << fileDocbook << "\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
-
- QCString outputDirectory = Config_getString(DOCBOOK_OUTPUT);
- QCString fileName=outputDirectory+"/"+ classOutputFileBase(cd)+".xml";
- QCString relPath = relativePathToRoot(fileName);
- QFile f(fileName);
- if (!f.open(IO_WriteOnly))
- {
- err("Cannot open file %s for writing!\n",fileName.data());
- return;
- }
- FTextStream t(&f);
- //t.setEncoding(FTextStream::UnicodeUTF8);
-
- writeDocbookHeader_ID(t, classOutputFileBase(cd));
+void DocbookGenerator::endMemberHeader()
+{
+DB_GEN_C
+ t << " </title>" << endl;
+}
+void DocbookGenerator::docify(const char *str)
+{
+DB_GEN_C
+ t << convertToDocBook(str);
+}
+void DocbookGenerator::writeObjectLink(const char *ref, const char *f,
+ const char *anchor, const char *text)
+{
+DB_GEN_C
+ if (anchor)
+ if (f) t << "<link linkend=\"_" << stripPath(f) << "_1" << anchor << "\">";
+ else t << "<link linkend=\"_" << anchor << "\">";
+ else
+ t << "<link linkend=\"_" << stripPath(f) << "\">";
+ docify(text);
+ t << "</link>";
+}
+void DocbookGenerator::startMemberList()
+{
+DB_GEN_C
+ t << " <itemizedlist>" << endl;
+ m_levelListItem++;
+}
+void DocbookGenerator::endMemberList()
+{
+DB_GEN_C
+ if (m_inListItem[m_levelListItem]) t << "</listitem>" << endl;
+ m_inListItem[m_levelListItem] = FALSE;
+ t << " </itemizedlist>" << endl;
+ m_levelListItem = (m_levelListItem> 0 ? m_levelListItem - 1 : 0);
+ if (m_inSimpleSect[m_levelListItem]) t << "</simplesect>" << endl;
+ m_inSimpleSect[m_levelListItem] = FALSE;
+}
+void DocbookGenerator::startMemberItem(const char *,int,const char *)
+{
+DB_GEN_C
+ if (m_inListItem[m_levelListItem]) t << "</listitem>" << endl;
+ t << " <listitem><para>";
+ m_inListItem[m_levelListItem] = TRUE;
+}
+void DocbookGenerator::endMemberItem()
+{
+DB_GEN_C
+ t << "</para>" << endl;
+}
+void DocbookGenerator::startBold(void)
+{
+DB_GEN_C
+ t << "<emphasis role=\"strong\">";
+}
+void DocbookGenerator::endBold(void)
+{
+DB_GEN_C
+ t << "</emphasis>";
+}
+void DocbookGenerator::startGroupHeader(int extraIndentLevel)
+{
+DB_GEN_C2("m_inLevel " << m_inLevel)
+DB_GEN_C2("extraIndentLevel " << extraIndentLevel)
+ m_firstMember = TRUE;
+ if (m_inSimpleSect[m_levelListItem]) t << "</simplesect>" << endl;
+ m_inSimpleSect[m_levelListItem] = FALSE;
+ if (m_inLevel != -1) m_inGroup = TRUE;
+ if (m_inLevel == extraIndentLevel) t << "</section>" << endl;
+ m_inLevel = extraIndentLevel;
+ t << "<section>" << endl;
t << "<title>";
- writeDocbookString(t,cd->name());
- t << " " << cd->compoundTypeString() << " Reference";
- t << "</title>" << endl;
-
- IncludeInfo *ii=cd->includeInfo();
- if (ii)
- {
- QCString nm = ii->includeName;
- if (nm.isEmpty() && ii->fileDef) nm = ii->fileDef->docName();
- if (!nm.isEmpty())
- {
- t << "<para>" << endl;
- t << " <programlisting>#include ";
- if (ii->fileDef && !ii->fileDef->isReference()) // TODO: support external references
- {
- t << "<link linkend=\"" << ii->fileDef->getOutputFileBase() << "\">";
- }
- if (ii->local)
- {
- t << "&quot;";
- }
- else
- {
- t << "&lt;";
- }
- t << convertToXML(nm);
- if (ii->local)
- {
- t << "&quot;";
- }
- else
- {
- t << "&gt;";
- }
- if (ii->fileDef && !ii->fileDef->isReference())
- {
- t << "</link>";
- }
- t << "</programlisting>" << endl;
- t << "</para>" << endl;
- }
- }
-
- if (Config_getBool(HAVE_DOT) && (Config_getBool(CLASS_DIAGRAMS) || Config_getBool(CLASS_GRAPH)))
- {
- t << "<para>Inheritance diagram for " << convertToXML(cd->name()) << "</para>" << endl;
- DotClassGraph inheritanceGraph(cd,DotNode::Inheritance);
- inheritanceGraph.writeGraph(t,GOF_BITMAP,EOF_DocBook,Config_getString(DOCBOOK_OUTPUT),fileName,relPath,TRUE,FALSE);
- }
-
- if (Config_getBool(HAVE_DOT) && Config_getBool(COLLABORATION_GRAPH))
- {
- t << "<para>Collaboration diagram for " << convertToXML(cd->name()) << "</para>" << endl;
- DotClassGraph collaborationGraph(cd,DotNode::Collaboration);
- collaborationGraph.writeGraph(t,GOF_BITMAP,EOF_DocBook,Config_getString(DOCBOOK_OUTPUT),fileName,relPath,TRUE,FALSE);
- }
+}
+void DocbookGenerator::writeRuler(void)
+{
+DB_GEN_C2("m_inLevel " << m_inLevel)
+DB_GEN_C2("m_inGroup " << m_inGroup)
+ if (m_inGroup) t << "</section>" << endl;
+ m_inGroup = FALSE;
+}
- writeInnerClasses(cd->getClassSDict(),t);
+void DocbookGenerator::endGroupHeader(int)
+{
+DB_GEN_C
+ t << "</title>" << endl;
+}
- writeTemplateList(cd,t);
- if (cd->getMemberGroupSDict())
+void DocbookGenerator::startParameterList(bool openBracket)
+{
+DB_GEN_C
+ if (openBracket) t << "(";
+}
+void DocbookGenerator::endParameterList()
+{
+DB_GEN_C
+}
+void DocbookGenerator::writeNonBreakableSpace(int n)
+{
+DB_GEN_C
+ for (int i=0;i<n;i++) t << " ";
+}
+void DocbookGenerator::lineBreak(const char *)
+{
+DB_GEN_C
+ t << endl;
+}
+void DocbookGenerator::startTypewriter()
+{
+DB_GEN_C
+ if (!m_denseText) t << "<computeroutput>";
+}
+void DocbookGenerator::endTypewriter()
+{
+DB_GEN_C
+ if (!m_denseText) t << "</computeroutput>" << endl;
+}
+void DocbookGenerator::startTextBlock(bool dense)
+{
+DB_GEN_C
+ if (dense)
{
- MemberGroupSDict::Iterator mgli(*cd->getMemberGroupSDict());
- MemberGroup *mg;
- for (;(mg=mgli.current());++mgli)
- {
- generateDocbookSection(cd,t,mg->members(),"user-defined",0,mg->header(),
- mg->documentation());
- }
+ m_denseText = TRUE;
+ t << "<programlisting>";
}
-
-
- QListIterator<MemberList> mli(cd->getMemberLists());
- MemberList *ml;
- for (mli.toFirst();(ml=mli.current());++mli)
- {
- if ((ml->listType()&MemberListType_detailedLists)==0)
- {
- generateDocbookSection(cd,t,ml,g_docbookSectionMapper.find(ml->listType()));
- }
- }
-
- if(Config_getBool(REPEAT_BRIEF))
+}
+void DocbookGenerator::endTextBlock(bool dense)
+{
+DB_GEN_C
+ if (m_denseText)
{
- if (cd->briefDescription())
- {
- t << " <simplesect>" << endl;
- // A title as 'Brief Description' may not be necessary.
- //t << " <title>" << theTranslator->trBriefDescription() << "</title>" << endl;
- writeDocbookDocBlock(t,cd->briefFile(),cd->briefLine(),cd,0,cd->briefDescription());
- t << " </simplesect>" << endl;
- }
+ m_denseText = FALSE;
+ t << "</programlisting>";
}
-
- if (cd->documentation())
+}
+void DocbookGenerator::startMemberDoc(const char *clname, const char *memname, const char *anchor, const char *title,
+ int memCount, int memTotal, bool showInline)
+{
+DB_GEN_C2("m_inLevel " << m_inLevel)
+ t << " <section>" << endl;
+ t << " <title>" << convertToDocBook(title);
+ if (memTotal>1)
{
- t << " <simplesect>" << endl;
- t << " <title>" << theTranslator->trDetailedDescription() << "</title>" << endl;
- writeDocbookDocBlock(t,cd->docFile(),cd->docLine(),cd,0,cd->documentation());
- t << " <para>Definition at line " << cd->getDefLine() << " of file " << stripPath(cd->getDefFileName()) << "</para>" << endl;
- t << " <para>The Documentation for this struct was generated from the following file: </para>" << endl;
- t << " <para><itemizedlist><listitem><para>" << stripPath(cd->getDefFileName()) << "</para></listitem></itemizedlist></para>" << endl;
- t << " </simplesect>" << endl;
+ t << "<computeroutput>[" << memCount << "/" << memTotal << "]</computeroutput>";
}
- for (mli.toFirst();(ml=mli.current());++mli)
+ t << "</title>" << endl;
+ if (memname && memname[0]!='@')
{
- if ((ml->listType()&MemberListType_detailedLists)==0)
- {
- generateDocbookSection(cd,t,ml,g_docbookSectionMapper.find(ml->listType()),1);
- }
+ addIndexTerm(t,memname,clname);
+ addIndexTerm(t,clname,memname);
}
-
- /*// TODO: Handling of Inheritance and Colloboration graph for Docbook to be implemented
- DotClassGraph inheritanceGraph(cd,DotNode::Inheritance);
- if (!inheritanceGraph.isTrivial())
- {
- t << " <inheritancegraph>" << endl;
- inheritanceGraph.writeDocbook(t);
- t << " </inheritancegraph>" << endl;
- }
- DotClassGraph collaborationGraph(cd,DotNode::Collaboration);
- if (!collaborationGraph.isTrivial())
- {
- t << " <collaborationgraph>" << endl;
- collaborationGraph.writeDocbook(t);
- t << " </collaborationgraph>" << endl;
- }
- t << " <location file=\""
- << cd->getDefFileName() << "\" line=\""
- << cd->getDefLine() << "\"";
- if (cd->getStartBodyLine()!=-1)
- {
- FileDef *bodyDef = cd->getBodyDef();
- if (bodyDef)
- {
- t << " bodyfile=\"" << bodyDef->absFilePath() << "\"";
- }
- t << " bodystart=\"" << cd->getStartBodyLine() << "\" bodyend=\""
- << cd->getEndBodyLine() << "\"";
- }
- t << "/>" << endl;
- writeListOfAllMembers(cd,t);
- */
-
- t << "</section>" << endl;
-
}
-
-static void generateDocbookForNamespace(NamespaceDef *nd,FTextStream &ti)
-{
- // + contained class definitions
- // + contained namespace definitions
- // + member groups
- // + normal members
- // + brief desc
- // + detailed desc
- // + location
- // - files containing (parts of) the namespace definition
-
- if (nd->isReference() || nd->isHidden()) return; // skip external references
-
- QCString fileDocbook=nd->getOutputFileBase()+".xml";
- //Add the file Documentation info to index file
- ti << " <xi:include href=\"" << fileDocbook << "\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
-
- QCString outputDirectory = Config_getString(DOCBOOK_OUTPUT);
- QCString fileName=outputDirectory+"/"+nd->getOutputFileBase()+".xml";
- QFile f(fileName);
- if (!f.open(IO_WriteOnly))
- {
- err("Cannot open file %s for writing!\n",fileName.data());
- return;
- }
- FTextStream t(&f);
- //t.setEncoding(FTextStream::UnicodeUTF8);
-
- writeDocbookHeader_ID(t, nd->getOutputFileBase());
+void DocbookGenerator::endMemberDoc(bool)
+{
+DB_GEN_C
+ t << "</computeroutput></para>";
+}
+void DocbookGenerator::startTitleHead(const char *)
+{
+DB_GEN_C
t << "<title>";
- writeDocbookString(t,nd->name());
+}
+void DocbookGenerator::endTitleHead(const char *fileName,const char *name)
+{
+DB_GEN_C
t << "</title>" << endl;
-
- writeInnerClasses(nd->getClassSDict(),t);
- writeInnerNamespaces(nd->getNamespaceSDict(),t);
-
- if (nd->getMemberGroupSDict())
- {
- MemberGroupSDict::Iterator mgli(*nd->getMemberGroupSDict());
- MemberGroup *mg;
- for (;(mg=mgli.current());++mgli)
- {
- generateDocbookSection(nd,t,mg->members(),"user-defined",0,mg->header(),
- mg->documentation());
- }
- }
-
- QListIterator<MemberList> mli(nd->getMemberLists());
- MemberList *ml;
- for (mli.toFirst();(ml=mli.current());++mli)
+ if (name) addIndexTerm(t, name);
+}
+void DocbookGenerator::startDoxyAnchor(const char *fName,const char *manName,
+ const char *anchor,const char *name,
+ const char *args)
+{
+DB_GEN_C
+ if (!m_inListItem[m_levelListItem] && !m_descTable)
{
- if ((ml->listType()&MemberListType_declarationLists)!=0)
- {
- generateDocbookSection(nd,t,ml,g_docbookSectionMapper.find(ml->listType()));
- }
+ if (!m_firstMember) t << " </section>";
+ m_firstMember = FALSE;
}
-
- if(Config_getBool(REPEAT_BRIEF))
+ if (anchor)
{
- if (nd->briefDescription())
- {
- t << " <simplesect>" << endl;
- //t << " <title>" << theTranslator->trBriefDescription() << "</title>" << endl;
- writeDocbookDocBlock(t,nd->briefFile(),nd->briefLine(),nd,0,nd->briefDescription());
- t << " </simplesect>" << endl;
- }
+ t << "<anchor xml:id=\"_" << stripPath(fName) << "_1" << anchor << "\"/>";
}
-
- if (nd->documentation())
- {
- t << " <simplesect>" << endl;
- t << " <title>" << theTranslator->trDetailedDescription() << "</title>" << endl;
- writeDocbookDocBlock(t,nd->docFile(),nd->docLine(),nd,0,nd->documentation());
- t << " <para>Definition at line " << nd->getDefLine() << " of file " << stripPath(nd->getDefFileName()) << "</para>" << endl;
- t << " <para>The Documentation for this struct was generated from the following file: </para>" << endl;
- t << " <para><itemizedlist><listitem><para>" << stripPath(nd->getDefFileName()) << "</para></listitem></itemizedlist></para>" << endl;
- t << " </simplesect>" << endl;
- }
- t << "</section>" << endl;
}
-
-static void generateDocbookForFile(FileDef *fd,FTextStream &ti)
-{
- // + includes files
- // + includedby files
- // + include graph
- // + included by graph
- // + contained class definitions
- // + contained namespace definitions
- // + member groups
- // + normal members
- // + brief desc
- // + detailed desc
- // + source code
- // + location
- // - number of lines
-
- if (fd->isReference()) return; // skip external references
-
- QCString fileDocbook=fd->getOutputFileBase()+".xml";
- //Add the file Documentation info to index file
- ti << " <xi:include href=\"" << fileDocbook << "\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
-
- QCString outputDirectory = Config_getString(DOCBOOK_OUTPUT);
- QCString fileName=outputDirectory+"/"+fd->getOutputFileBase()+".xml";
- QCString relPath = relativePathToRoot(fileName);
-
- QFile f(fileName);
- if (!f.open(IO_WriteOnly))
- {
- err("Cannot open file %s for writing!\n",fileName.data());
- return;
- }
- FTextStream t(&f);
- //t.setEncoding(FTextStream::UnicodeUTF8);
- writeDocbookHeader_ID(t, fd->getOutputFileBase());
-
- t << " <title>";
- writeDocbookString(t,fd->name());
- t << " File Reference";
+void DocbookGenerator::endDoxyAnchor(const char *fileName,const char *anchor)
+{
+DB_GEN_C
+}
+void DocbookGenerator::startMemberDocName(bool)
+{
+DB_GEN_C
+ t << "<para><computeroutput>";
+}
+void DocbookGenerator::endMemberDocName()
+{
+DB_GEN_C
+}
+void DocbookGenerator::startMemberGroupHeader(bool hasHeader)
+{
+DB_GEN_C
+ t << "<simplesect><title>";
+}
+void DocbookGenerator::endMemberGroupHeader()
+{
+DB_GEN_C
t << "</title>" << endl;
-
- IncludeInfo *inc;
-
- if (fd->includeFileList())
- {
- QListIterator<IncludeInfo> ili1(*fd->includeFileList());
- for (ili1.toFirst();(inc=ili1.current());++ili1)
- {
- t << " <programlisting>#include ";
- if (inc->local)
- {
- t << "&quot;";
- }
- else
- {
- t << "&lt;";
- }
- t << convertToXML(inc->includeName);
- if (inc->local)
- {
- t << "&quot;";
- }
- else
- {
- t << "&gt;";
- }
- t << "</programlisting>" << endl;
- }
- }
- if (Config_getBool(HAVE_DOT))
- {
- if (Config_getBool(INCLUDE_GRAPH))
- {
- t << "<para>Include dependency diagram for " << convertToXML(fd->name()) << "</para>" << endl;
- DotInclDepGraph idepGraph(fd, FALSE);
- idepGraph.writeGraph(t,GOF_BITMAP,EOF_DocBook,Config_getString(DOCBOOK_OUTPUT),fileName,relPath,FALSE);
- }
- if (Config_getBool(INCLUDED_BY_GRAPH))
- {
- t << "<para>Included by dependency diagram for " << convertToXML(fd->name()) << "</para>" << endl;
- DotInclDepGraph ibdepGraph(fd, TRUE);
- ibdepGraph.writeGraph(t,GOF_BITMAP,EOF_DocBook,Config_getString(DOCBOOK_OUTPUT),fileName,relPath,FALSE);
- }
- }
-
- if (fd->getClassSDict())
- {
- writeInnerClasses(fd->getClassSDict(),t);
- }
- if (fd->getNamespaceSDict())
- {
- writeInnerNamespaces(fd->getNamespaceSDict(),t);
- }
-
- if (fd->getMemberGroupSDict())
- {
- MemberGroupSDict::Iterator mgli(*fd->getMemberGroupSDict());
- MemberGroup *mg;
- for (;(mg=mgli.current());++mgli)
- {
- generateDocbookSection(fd,t,mg->members(),"user-defined",0,mg->header(),
- mg->documentation());
- }
- }
-
- QListIterator<MemberList> mli(fd->getMemberLists());
- MemberList *ml;
- for (mli.toFirst();(ml=mli.current());++mli)
- {
- if ((ml->listType()&MemberListType_declarationLists)!=0)
- {
- generateDocbookSection(fd,t,ml,g_docbookSectionMapper.find(ml->listType()));
- }
- }
-
- t << " <simplesect>" << endl;
- t << " <title>" << theTranslator->trDetailedDescription() << "</title>" << endl;
- writeDocbookDocBlock(t,fd->briefFile(),fd->briefLine(),fd,0,fd->briefDescription());
- writeDocbookDocBlock(t,fd->docFile(),fd->docLine(),fd,0,fd->documentation());
- if (Config_getBool(FULL_PATH_NAMES))
- {
- t << " <para>Definition in file " << fd->getDefFileName() << "</para>" << endl;
- }
- else
- {
- t << " <para>Definition in file " << stripPath(fd->getDefFileName()) << "</para>" << endl;
- }
- t << " </simplesect>" << endl;
-
- if (Config_getBool(DOCBOOK_PROGRAMLISTING))
- {
- t << " <literallayout><computeroutput>" << endl;
- writeDocbookCodeBlock(t,fd);
- t << " </computeroutput></literallayout>" << endl;
- }
-
- t << "</section>" << endl;
+}
+void DocbookGenerator::startMemberGroup()
+{
+DB_GEN_C
+}
+void DocbookGenerator::endMemberGroup(bool)
+{
+DB_GEN_C
+ t << "</simplesect>" << endl;
+}
+void DocbookGenerator::startClassDiagram()
+{
+DB_GEN_C
+ t << "<para>";
}
-static void generateDocbookForGroup(GroupDef *gd,FTextStream &ti)
-{
- // + members
- // + member groups
- // + files
- // + classes
- // + namespaces
- // - packages
- // + pages
- // + child groups
- // - examples
- // + brief description
- // + detailed description
-
- if (gd->isReference()) return; // skip external references
-
- if (!gd->isASubGroup())
- {
- QCString fileDocbook=gd->getOutputFileBase()+".xml";
- //Add the file Documentation info to index file
- ti << " <xi:include href=\"" << fileDocbook << "\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
- }
-
- QCString outputDirectory = Config_getString(DOCBOOK_OUTPUT);
- QCString fileName=outputDirectory+"/"+gd->getOutputFileBase()+".xml";
- QCString relPath = relativePathToRoot(fileName);
-
- QFile f(fileName);
- if (!f.open(IO_WriteOnly))
- {
- err("Cannot open file %s for writing!\n",fileName.data());
- return;
- }
-
- FTextStream t(&f);
- //t.setEncoding(FTextStream::UnicodeUTF8);
- writeDocbookHeader_ID(t, gd->getOutputFileBase());
-
- t << " <title>" << convertToXML(gd->groupTitle()) << "</title>" << endl;
+void DocbookGenerator::endClassDiagram(const ClassDiagram &d, const char *fileName,const char *)
+{
+DB_GEN_C
+ t << " <informalfigure>" << endl;
+ t << " <mediaobject>" << endl;
+ t << " <imageobject>" << endl;
+ t << " <imagedata width=\"50%\" align=\"center\" valign=\"middle\" scalefit=\"0\" fileref=\""
+ << relPath << fileName << ".png\">" << "</imagedata>" << endl;
+ t << " </imageobject>" << endl;
+ d.writeImage(t,dir,relPath,fileName,FALSE);
+ t << " </mediaobject>" << endl;
+ t << " </informalfigure>" << endl;
+ t << "</para>" << endl;
+}
+void DocbookGenerator::startLabels()
+{
+DB_GEN_C
+}
- if (Config_getBool(GROUP_GRAPHS) && Config_getBool(HAVE_DOT))
- {
- t << "<para>Collaboration diagram for " << convertToXML(gd->groupTitle()) << "</para>" << endl;
- DotGroupCollaboration collaborationGraph(gd);
- collaborationGraph.writeGraph(t,GOF_BITMAP,EOF_DocBook,Config_getString(DOCBOOK_OUTPUT),fileName,relPath,FALSE);
- }
+void DocbookGenerator::writeLabel(const char *l,bool isLast)
+{
+DB_GEN_C
+ t << "<computeroutput>[" << l << "]</computeroutput>";
+ if (!isLast) t << ", ";
+}
- if (gd->briefDescription())
- {
- //t << " <section>" << endl;
- //t << " <title>" << theTranslator->trBriefDescription() << "</title>" << endl;
- writeDocbookDocBlock(t,gd->briefFile(),gd->briefLine(),gd,0,gd->briefDescription());
- //t << " </section>" << endl;
- }
+void DocbookGenerator::endLabels()
+{
+DB_GEN_C
+}
+void DocbookGenerator::startExamples()
+{
+DB_GEN_C
+ t << "<simplesect><title>";
+ docify(theTranslator->trExamples());
+ t << "</title>";
+}
- if (gd->documentation())
+void DocbookGenerator::endExamples()
+{
+DB_GEN_C
+ t << "</simplesect>" << endl;
+}
+void DocbookGenerator::startSubsubsection(void)
+{
+DB_GEN_C
+ t << "<simplesect><title>";
+}
+void DocbookGenerator::endSubsubsection(void)
+{
+DB_GEN_C
+ t << "</title></simplesect>" << endl;
+}
+void DocbookGenerator::writeChar(char c)
+{
+DB_GEN_C
+ char cs[2];
+ cs[0]=c;
+ cs[1]=0;
+ docify(cs);
+}
+void DocbookGenerator::startMemberDocPrefixItem()
+{
+DB_GEN_C
+ t << "<computeroutput>";
+}
+void DocbookGenerator::endMemberDocPrefixItem()
+{
+DB_GEN_C
+ t << "</computeroutput>";
+}
+void DocbookGenerator::exceptionEntry(const char* prefix,bool closeBracket)
+{
+DB_GEN_C
+ if (prefix)
+ t << " " << prefix << "(";
+ else if (closeBracket)
+ t << ")";
+ t << " ";
+}
+void DocbookGenerator::startParameterName(bool)
+{
+DB_GEN_C
+ t << " ";
+}
+void DocbookGenerator::endParameterName(bool last,bool /*emptyList*/,bool closeBracket)
+{
+DB_GEN_C
+ if (last)
{
- t << " <section>" << endl;
- t << " <title>" << theTranslator->trDetailedDescription() << "</title>" << endl;
- writeDocbookDocBlock(t,gd->docFile(),gd->docLine(),gd,0,gd->documentation());
- t << " </section>" << endl;
+ if (closeBracket) t << ")";
}
+}
+void DocbookGenerator::startCodeFragment()
+{
+DB_GEN_C
+ t << "<programlisting>";
+}
+void DocbookGenerator::endCodeFragment()
+{
+DB_GEN_C
+ t << "</programlisting>";
+}
+void DocbookGenerator::startMemberTemplateParams()
+{
+DB_GEN_C
+}
- writeInnerFiles(gd->getFiles(),t);
- writeInnerClasses(gd->getClasses(),t);
- writeInnerNamespaces(gd->getNamespaces(),t);
- writeInnerPages(gd->getPages(),t);
- writeInnerGroups(gd->getSubGroups(),t);
-
- if (gd->getMemberGroupSDict())
- {
- MemberGroupSDict::Iterator mgli(*gd->getMemberGroupSDict());
- MemberGroup *mg;
- for (;(mg=mgli.current());++mgli)
- {
- generateDocbookSection(gd,t,mg->members(),"user-defined",0,mg->header(),
- mg->documentation());
- }
- }
+void DocbookGenerator::endMemberTemplateParams(const char *,const char *)
+{
+DB_GEN_C
+ t << "</para>";
+ t << "<para>";
+}
+void DocbookGenerator::startSection(const char *lab,const char *,SectionInfo::SectionType type)
+{
+DB_GEN_C
+ t << " <section xml:id=\"_" << stripPath(lab) << "\">";
+ t << "<title>";
+}
+void DocbookGenerator::endSection(const char *lab,SectionInfo::SectionType)
+{
+DB_GEN_C
+ t << "</title>";
+ t << " </section>";
+}
+void DocbookGenerator::addIndexItem(const char *prim,const char *sec)
+{
+DB_GEN_C
+ addIndexTerm(t, prim, sec);
+}
- QListIterator<MemberList> mli(gd->getMemberLists());
- MemberList *ml;
- for (mli.toFirst();(ml=mli.current());++mli)
- {
- if ((ml->listType()&MemberListType_declarationLists)!=0)
- {
- generateDocbookSection(gd,t,ml,g_docbookSectionMapper.find(ml->listType()));
- }
- }
- for (mli.toFirst();(ml=mli.current());++mli)
+void DocbookGenerator::startDescTable(const char *title)
+{
+DB_GEN_C
+ int ncols = 2;
+ t << "<informaltable frame=\"all\">" << endl;
+ if (title)t << "<title>" << convertToDocBook(title) << "</title>" << endl;
+ t << " <tgroup cols=\"" << ncols << "\" align=\"left\" colsep=\"1\" rowsep=\"1\">" << endl;
+ for (int i = 0; i < ncols; i++)
{
- if ((ml->listType()&MemberListType_declarationLists)!=0)
- {
- generateDocbookSection(gd,t,ml,g_docbookSectionMapper.find(ml->listType()),1);
- }
+ t << " <colspec colname='c" << i+1 << "'/>\n";
}
+ t << "<tbody>\n";
+ m_descTable = TRUE;
+}
- writeInnerGroupFiles(gd->getSubGroups(),t);
-
- t << "</section>" << endl;
-
+void DocbookGenerator::endDescTable()
+{
+DB_GEN_C
+ t << " </tbody>" << endl;
+ t << " </tgroup>" << endl;
+ t << "</informaltable>" << endl;
+ m_descTable = FALSE;
}
-static void generateDocbookForDir(DirDef *dd,FTextStream &ti)
+void DocbookGenerator::startDescTableRow()
{
- if (dd->isReference()) return; // skip external references
+DB_GEN_C
+ t << "<row>";
+ t << "<entry>";
+}
- QCString fileDocbook=dd->getOutputFileBase()+".xml";
- //Add the file Documentation info to index file
- ti << " <xi:include href=\"" << fileDocbook << "\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
+void DocbookGenerator::endDescTableRow()
+{
+DB_GEN_C
+ t << "</row>";
+}
- QCString outputDirectory = Config_getString(DOCBOOK_OUTPUT);
- QCString fileName=outputDirectory+"/"+dd->getOutputFileBase()+".xml";
- QFile f(fileName);
- QCString relPath = relativePathToRoot(fileName);
+void DocbookGenerator::startDescTableTitle()
+{
+DB_GEN_C
+}
- if (!f.open(IO_WriteOnly))
- {
- err("Cannot open file %s for writing!\n",fileName.data());
- return;
- }
+void DocbookGenerator::endDescTableTitle()
+{
+DB_GEN_C
+}
- FTextStream t(&f);
- //t.setEncoding(FTextStream::UnicodeUTF8);
- writeDocbookHeader_ID(t, dd->getOutputFileBase());
+void DocbookGenerator::startDescTableData()
+{
+DB_GEN_C
+ t << "</entry><entry>";
+}
- t << " <title>";
- t << theTranslator->trDirReference(dd->displayName());
+void DocbookGenerator::endDescTableData()
+{
+DB_GEN_C
+ t << "</entry>";
+}
+void DocbookGenerator::startGroupCollaboration()
+{
+DB_GEN_C
+}
+void DocbookGenerator::endGroupCollaboration(const DotGroupCollaboration &g)
+{
+DB_GEN_C
+ g.writeGraph(t,GOF_BITMAP,EOF_DocBook,Config_getString(DOCBOOK_OUTPUT),fileName,relPath,FALSE);
+}
+void DocbookGenerator::startDotGraph()
+{
+DB_GEN_C
+}
+void DocbookGenerator::endDotGraph(const DotClassGraph &g)
+{
+DB_GEN_C
+ g.writeGraph(t,GOF_BITMAP,EOF_DocBook,Config_getString(DOCBOOK_OUTPUT),fileName,relPath,TRUE,FALSE);
+}
+void DocbookGenerator::startInclDepGraph()
+{
+DB_GEN_C
+}
+void DocbookGenerator::endInclDepGraph(const DotInclDepGraph &g)
+{
+DB_GEN_C
+ QCString fn = g.writeGraph(t,GOF_BITMAP,EOF_DocBook,Config_getString(DOCBOOK_OUTPUT), fileName,relPath,FALSE);
+}
+void DocbookGenerator::startCallGraph()
+{
+DB_GEN_C
+}
+void DocbookGenerator::endCallGraph(const DotCallGraph &g)
+{
+DB_GEN_C
+ QCString fn = g.writeGraph(t,GOF_BITMAP,EOF_DocBook,Config_getString(DOCBOOK_OUTPUT), fileName,relPath,FALSE);
+}
+void DocbookGenerator::startDirDepGraph()
+{
+DB_GEN_C
+}
+void DocbookGenerator::endDirDepGraph(const DotDirDeps &g)
+{
+DB_GEN_C
+ QCString fn = g.writeGraph(t,GOF_BITMAP,EOF_DocBook,Config_getString(DOCBOOK_OUTPUT), fileName,relPath,FALSE);
+}
+void DocbookGenerator::startMemberDocList()
+{
+DB_GEN_C
+}
+void DocbookGenerator::endMemberDocList()
+{
+DB_GEN_C
+ m_inGroup = TRUE;
+}
+void DocbookGenerator::startConstraintList(const char *header)
+{
+DB_GEN_C
+ t << "<simplesect><title>";
+ docify(header);
t << "</title>" << endl;
- if (Config_getBool(DIRECTORY_GRAPH) && Config_getBool(HAVE_DOT))
- {
- t << "<para>Directory dependency diagram for " << convertToXML(dd->displayName()) << "</para>" << endl;
- DotDirDeps dirdepGraph(dd);
- dirdepGraph.writeGraph(t,GOF_BITMAP,EOF_DocBook,Config_getString(DOCBOOK_OUTPUT),fileName,relPath,FALSE);
- }
-
- writeInnerDirs(&dd->subDirs(),t);
- writeInnerFiles(dd->getFiles(),t);
-
- t << " <simplesect>" << endl;
- t << " <title>" << theTranslator->trDetailedDescription() << "</title>" << endl;
- writeDocbookDocBlock(t,dd->briefFile(),dd->briefLine(),dd,0,dd->briefDescription());
- writeDocbookDocBlock(t,dd->docFile(),dd->docLine(),dd,0,dd->documentation());
- t << " <para>Directory location is " << dd->name() << "</para>" << endl;
- t << " </simplesect>" << endl;
-
- t << "</section>" << endl;
}
-
-static void generateDocbookForPage(PageDef *pd,FTextStream &ti,bool isExample)
+void DocbookGenerator::startConstraintParam()
{
- // + name
- // + title
- // + documentation
-
- if (pd->isReference()) return;
-
- QCString pageName = pd->getOutputFileBase();
- if (pd->getGroupDef())
- {
- pageName+=(QCString)"_"+pd->name();
- }
- if (pageName=="index")
- {
- pageName="mainpage"; // to prevent overwriting the generated index page.
- }
-
- QCString outputDirectory = Config_getString(DOCBOOK_OUTPUT);
- QCString fileName=outputDirectory+"/"+pageName+".xml";
- QFile f(fileName);
- if (!f.open(IO_WriteOnly))
- {
- err("Cannot open file %s for writing!\n",fileName.data());
- return;
- }
-
- FTextStream t(&f);
- //t.setEncoding(FTextStream::UnicodeUTF8);
-
- if(isExample)
- {
- QCString fileDocbook=pageName+".xml";
- ti << " <xi:include href=\"" << fileDocbook << "\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
- }
-
- if (!pd->hasParentPage() && !isExample)
- {
- QCString fileDocbook=pageName+".xml";
- //Add the file Documentation info to index file
- ti << " <xi:include href=\"" << fileDocbook << "\" xmlns:xi=\"http://www.w3.org/2001/XInclude\"/>" << endl;
- writeDocbookHeaderMainpage(t);
- }
- else
- {
- QCString pid;
- if(isExample)
- {
- pid = pageName;
- }
- else
- {
- pid = pageName+"_1"+pageName;
- }
- writeDocbookHeader_ID(t, pid);
- }
-
- SectionInfo *si = Doxygen::sectionDict->find(pd->name());
- if (si)
- {
- t << " <title>" << convertToXML(si->title) << "</title>" << endl;
- }
- else
- {
- t << " <title>" << convertToXML(pd->name()) << "</title>" << endl;
- }
-
- if (isExample)
- {
- writeDocbookDocBlock(t,pd->docFile(),pd->docLine(),pd,0,
- pd->documentation()+"\n\\include "+pd->name());
- }
- else
- {
- writeDocbookDocBlock(t,pd->docFile(),pd->docLine(),pd,0,
- pd->documentation());
- }
- writeInnerPages(pd->getSubPages(),t);
-
- if (!pd->hasParentPage() && !isExample)
- {
- t << endl << "</chapter>" << endl;
- }
- else
- {
- t << endl << "</section>" << endl;
- }
+DB_GEN_C
+ t << "<para><emphasis role=\"strong\">";
}
-
-void generateDocbook()
+void DocbookGenerator::endConstraintParam()
{
-
- // + classes
- // + namespaces
- // + files
- // + groups
- // + related pages
- // - examples
-
- QCString outputDirectory = Config_getString(DOCBOOK_OUTPUT);
- if (outputDirectory.isEmpty())
- {
- outputDirectory=QDir::currentDirPath().utf8();
- }
- else
- {
- QDir dir(outputDirectory);
- if (!dir.exists())
- {
- dir.setPath(QDir::currentDirPath());
- if (!dir.mkdir(outputDirectory))
- {
- err("tag DOCBOOK_OUTPUT: Output directory `%s' does not "
- "exist and cannot be created\n",outputDirectory.data());
- exit(1);
- }
- else
- {
- msg("Notice: Output directory `%s' does not exist. "
- "I have created it for you.\n", outputDirectory.data());
- }
- dir.cd(outputDirectory);
- }
- outputDirectory=dir.absPath().utf8();
- }
-
- QDir dir(outputDirectory);
- if (!dir.exists())
- {
- dir.setPath(QDir::currentDirPath());
- if (!dir.mkdir(outputDirectory))
- {
- err("Cannot create directory %s\n",outputDirectory.data());
- return;
- }
- }
- QDir docbookDir(outputDirectory);
- createSubDirs(docbookDir);
-
- QCString fileName=outputDirectory+"/index.xml";
- QCString dbk_projectName = Config_getString(PROJECT_NAME);
- QFile f(fileName);
-
- f.setName(fileName);
- if (!f.open(IO_WriteOnly))
- {
- err("Cannot open file %s for writing!\n",fileName.data());
- return;
- }
- FTextStream t(&f);
- //t.setEncoding(FTextStream::UnicodeUTF8);
-
- // write index header for Docbook which calls the structure file
- t << "<?xml version='1.0' encoding='UTF-8' standalone='no'?>" << endl;;
- t << "<book xmlns=\"http://docbook.org/ns/docbook\" version=\"5.0\" xmlns:xlink=\"http://www.w3.org/1999/xlink\">" << endl;
- t << " <info>" << endl;
- t << " <title>" << dbk_projectName << "</title>" << endl;
- t << " </info>" << endl;
-
- // NAMESPACE DOCUMENTATION
- NamespaceSDict::Iterator nli(*Doxygen::namespaceSDict);
- NamespaceDef *nd;
-
- //Namespace Documentation index header
- if (nli.toFirst())
- {
- t << " <chapter>" << endl;
- t << " <title>Namespace Documentation</title>" << endl;
- }
-
- for (nli.toFirst();(nd=nli.current());++nli)
- {
- msg("Generating Docbook output for namespace %s\n",nd->name().data());
- generateDocbookForNamespace(nd,t);
- }
-
- //Namespace Documentation index footer
- if (nli.toFirst())
- {
- t << " </chapter>" << endl;
- }
-
- /** MAINPAGE DOCUMENTATION **/
-
- if (Doxygen::mainPage)
- {
- msg("Generating Docbook output for the main page\n");
- generateDocbookForPage(Doxygen::mainPage,t,FALSE);
- }
-
- // PAGE DOCUMENTATION
- {
- PageSDict::Iterator pdi(*Doxygen::pageSDict);
- PageDef *pd=0;
-
- for (pdi.toFirst();(pd=pdi.current());++pdi)
- {
- msg("Generating Docbook output for page %s\n",pd->name().data());
- generateDocbookForPage(pd,t,FALSE);
- }
- }
-
- /** MODULE GROUP DOCUMENTATION **/
-
- GroupSDict::Iterator gli(*Doxygen::groupSDict);
- GroupDef *gd;
-
- //Module group Documentation index header
- if (gli.toFirst())
- {
- t << " <chapter>" << endl;
- t << " <title>" << theTranslator->trModuleDocumentation() << "</title>" << endl;
- }
-
- for (;(gd=gli.current());++gli)
- {
- msg("Generating Docbook output for group %s\n",gd->name().data());
- generateDocbookForGroup(gd,t);
- }
-
- //Module group Documentation index footer
- if (gli.toFirst())
- {
- t << " </chapter>" << endl;
- }
-
- //CLASS DOCUMENTATION
-
- {
- ClassSDict::Iterator cli(*Doxygen::classSDict);
- ClassDef *cd;
-
- //Class Documentation index header
- if (cli.toFirst())
- {
- t << " <chapter>" << endl;
- t << " <title>" << theTranslator->trClassDocumentation() << "</title>" << endl;
- }
-
- for (cli.toFirst();(cd=cli.current());++cli)
- {
- generateDocbookForClass(cd,t);
- }
-
- //Class Documentation index footer
- if (cli.toFirst())
- {
- t << " </chapter>" << endl;
- }
- }
-
- // FILE DOCUMENTATION
-
- static bool showFiles = Config_getBool(SHOW_FILES);
- if (showFiles)
- {
- FileNameListIterator fnli(*Doxygen::inputNameList);
- FileName *fn;
-
- //File Documentation index header
- if (fnli.toFirst())
- {
- t << " <chapter>" << endl;
- t << " <title>" << theTranslator->trFileDocumentation() << "</title>" << endl;
- }
-
- for (;(fn=fnli.current());++fnli)
- {
- FileNameIterator fni(*fn);
- FileDef *fd;
- for (;(fd=fni.current());++fni)
- {
- msg("Generating Docbook output for file %s\n",fd->name().data());
- generateDocbookForFile(fd,t);
- }
- }
-
- //File Documentation index footer
- if (fnli.toFirst())
- {
- t << " </chapter>" << endl;
- }
- }
-
- // DIRECTORY DOCUMENTATION
- if (Config_getBool(DIRECTORY_GRAPH) && Config_getBool(HAVE_DOT))
- {
- DirDef *dir;
- DirSDict::Iterator sdi(*Doxygen::directories);
-
- //Directory Documentation index header
- if (sdi.toFirst())
- {
- t << " <chapter>" << endl;
- t << " <title>" << theTranslator->trDirDocumentation() << "</title>" << endl;
- }
-
- for (sdi.toFirst();(dir=sdi.current());++sdi)
- {
- msg("Generate Docbook output for dir %s\n",dir->name().data());
- generateDocbookForDir(dir,t);
- }
-
- //Module group Documentation index footer
- if (sdi.toFirst())
- {
- t << " </chapter>" << endl;
- }
- }
-
- // EXAMPLE PAGE DOCUMENTATION
-
- {
- PageSDict::Iterator pdi(*Doxygen::exampleSDict);
- PageDef *pd=0;
-
- //Example Page Documentation index header
- if (pdi.toFirst())
- {
- t << " <chapter>" << endl;
- t << " <title>" << theTranslator->trExampleDocumentation() << "</title>" << endl;
- }
-
- for (pdi.toFirst();(pd=pdi.current());++pdi)
- {
- msg("Generating Docbook output for example %s\n",pd->name().data());
- generateDocbookForPage(pd,t,TRUE);
- }
-
- //Example Page Documentation index footer
- if (pdi.toFirst())
- {
- t << " </chapter>" << endl;
- }
- }
-
- t << "</book>" << endl;
-
+DB_GEN_C
+}
+void DocbookGenerator::startConstraintType()
+{
+DB_GEN_C
+ t << ":";
+}
+void DocbookGenerator::endConstraintType()
+{
+DB_GEN_C
+ t << "</emphasis></para>" << endl;
+}
+void DocbookGenerator::startConstraintDocs()
+{
+DB_GEN_C
+}
+void DocbookGenerator::endConstraintDocs()
+{
+DB_GEN_C
+}
+void DocbookGenerator::endConstraintList()
+{
+DB_GEN_C
+ t << "</simplesect>" << endl;
}
-
-