summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorMark Spruiell <mes@zeroc.com>2017-12-27 19:12:07 (GMT)
committerJoe George <joe@zeroc.com>2018-10-22 19:21:42 (GMT)
commit3a97099d5e6afd298486f219694a7fb5eff67fea (patch)
tree979abad6dd502a4d28dac1f29a1bce9e4bb3b336 /src
parentd94c10574f44c10ff0df9ce24c09cb6fcaac37c0 (diff)
downloadDoxygen-3a97099d5e6afd298486f219694a7fb5eff67fea.zip
Doxygen-3a97099d5e6afd298486f219694a7fb5eff67fea.tar.gz
Doxygen-3a97099d5e6afd298486f219694a7fb5eff67fea.tar.bz2
Added *.ice files as a recognized file type.
Added a Slice-optimized output mode.
Diffstat (limited to 'src')
-rw-r--r--src/classdef.cpp325
-rw-r--r--src/classdef.h6
-rw-r--r--src/code.l4
-rw-r--r--src/config.xml1091
-rw-r--r--src/context.cpp125
-rw-r--r--src/defgen.cpp34
-rw-r--r--src/dirdef.cpp6
-rw-r--r--src/docbookgen.cpp47
-rw-r--r--src/docsets.cpp5
-rw-r--r--src/dot.cpp15
-rw-r--r--src/dot.h14
-rw-r--r--src/doxygen.cpp151
-rw-r--r--src/entry.cpp1
-rw-r--r--src/entry.h66
-rw-r--r--src/filedef.cpp138
-rw-r--r--src/filedef.h6
-rw-r--r--src/ftvhelp.cpp69
-rw-r--r--src/groupdef.cpp6
-rw-r--r--src/htmlgen.cpp18
-rw-r--r--src/index.cpp912
-rw-r--r--src/index.h19
-rw-r--r--src/layout.cpp196
-rw-r--r--src/layout.h16
-rw-r--r--src/layout_default.xml32
-rw-r--r--src/marshal.cpp2
-rw-r--r--src/memberdef.cpp83
-rw-r--r--src/memberdef.h5
-rw-r--r--src/membergroup.cpp10
-rw-r--r--src/membergroup.h2
-rw-r--r--src/memberlist.cpp64
-rw-r--r--src/memberlist.h26
-rw-r--r--src/namespacedef.cpp152
-rw-r--r--src/namespacedef.h18
-rw-r--r--src/pre.l2
-rw-r--r--src/scanner.l203
-rw-r--r--src/searchindex.cpp115
-rw-r--r--src/searchindex.h37
-rw-r--r--src/translator.h32
-rw-r--r--src/translator_am.h135
-rw-r--r--src/translator_ar.h135
-rw-r--r--src/translator_br.h135
-rw-r--r--src/translator_ca.h135
-rw-r--r--src/translator_cn.h135
-rw-r--r--src/translator_cz.h135
-rw-r--r--src/translator_de.h136
-rw-r--r--src/translator_dk.h134
-rw-r--r--src/translator_en.h136
-rw-r--r--src/translator_eo.h135
-rw-r--r--src/translator_es.h135
-rw-r--r--src/translator_fa.h135
-rw-r--r--src/translator_fi.h135
-rw-r--r--src/translator_fr.h135
-rw-r--r--src/translator_gr.h135
-rw-r--r--src/translator_hr.h135
-rw-r--r--src/translator_hu.h133
-rw-r--r--src/translator_id.h135
-rw-r--r--src/translator_it.h135
-rw-r--r--src/translator_jp.h135
-rw-r--r--src/translator_kr.h135
-rw-r--r--src/translator_lt.h133
-rw-r--r--src/translator_lv.h135
-rw-r--r--src/translator_mk.h135
-rw-r--r--src/translator_nl.h132
-rw-r--r--src/translator_no.h135
-rw-r--r--src/translator_pl.h135
-rw-r--r--src/translator_pt.h135
-rw-r--r--src/translator_ro.h135
-rw-r--r--src/translator_ru.h135
-rw-r--r--src/translator_sc.h135
-rw-r--r--src/translator_si.h135
-rw-r--r--src/translator_sk.h135
-rw-r--r--src/translator_sr.h135
-rw-r--r--src/translator_sv.h133
-rw-r--r--src/translator_tr.h135
-rw-r--r--src/translator_tw.h135
-rw-r--r--src/translator_ua.h135
-rw-r--r--src/translator_vi.h135
-rw-r--r--src/translator_za.h135
-rw-r--r--src/types.h10
-rw-r--r--src/util.cpp66
-rw-r--r--src/util.h25
-rw-r--r--src/vhdldocgen.cpp3
-rw-r--r--src/xmlgen.cpp32
83 files changed, 8564 insertions, 1017 deletions
diff --git a/src/classdef.cpp b/src/classdef.cpp
index 787cd5e..abe7a52 100644
--- a/src/classdef.cpp
+++ b/src/classdef.cpp
@@ -17,6 +17,7 @@
#include <stdio.h>
#include <qfile.h>
+#include <qfileinfo.h>
#include <qregexp.h>
#include "classdef.h"
#include "classlist.h"
@@ -201,6 +202,8 @@ class ClassDefImpl
bool isAnonymous;
uint64 spec;
+
+ QCString metaData;
};
void ClassDefImpl::init(const char *defFileName, const char *name,
@@ -1372,27 +1375,53 @@ void ClassDef::writeIncludeFiles(OutputList &ol)
{
if (m_impl->incInfo /*&& Config_getBool(SHOW_INCLUDE_FILES)*/)
{
- QCString nm=m_impl->incInfo->includeName.isEmpty() ?
- (m_impl->incInfo->fileDef ?
- m_impl->incInfo->fileDef->docName().data() : ""
- ) :
- m_impl->incInfo->includeName.data();
- if (!nm.isEmpty())
+ SrcLangExt lang = getLanguage();
+ if (lang==SrcLangExt_Slice)
{
+ QCString nm;
+ QStrList paths = Config_getList(STRIP_FROM_PATH);
+ if (!paths.isEmpty() && m_impl->incInfo->fileDef)
+ {
+ QCString abs = m_impl->incInfo->fileDef->absFilePath();
+ const char *s = paths.first();
+ QCString potential;
+ unsigned int length = 0;
+ while (s)
+ {
+ QFileInfo info(s);
+ if (info.exists())
+ {
+ QString prefix = info.absFilePath();
+ if (prefix.at(prefix.length() - 1) != '/')
+ {
+ prefix += '/';
+ }
+
+ if (prefix.length() > length &&
+ qstricmp(abs.left(prefix.length()).data(), prefix.data()) == 0) // case insensitive compare
+ {
+ length = prefix.length();
+ potential = abs.right(abs.length() - prefix.length());
+ }
+ s = paths.next();
+ }
+ }
+
+ if (length > 0)
+ {
+ nm = potential;
+ }
+ }
+
+ if (nm.isEmpty())
+ {
+ nm = m_impl->incInfo->includeName.data();
+ }
+
ol.startParagraph();
+ ol.docify("Defined in ");
ol.startTypewriter();
- ol.docify(includeStatement());
- SrcLangExt lang = getLanguage();
- bool isIDLorJava = lang==SrcLangExt_IDL || lang==SrcLangExt_Java;
- if (m_impl->incInfo->local || isIDLorJava)
- ol.docify("\"");
- else
- ol.docify("<");
- ol.pushGeneratorState();
- ol.disable(OutputGenerator::Html);
- ol.docify(nm);
- ol.disableAllBut(OutputGenerator::Html);
- ol.enable(OutputGenerator::Html);
+ ol.docify("<");
if (m_impl->incInfo->fileDef)
{
ol.writeObjectLink(0,m_impl->incInfo->fileDef->includeName(),0,nm);
@@ -1401,13 +1430,143 @@ void ClassDef::writeIncludeFiles(OutputList &ol)
{
ol.docify(nm);
}
- ol.popGeneratorState();
- if (m_impl->incInfo->local || isIDLorJava)
- ol.docify("\"");
+ ol.docify(">");
+ ol.endTypewriter();
+ ol.endParagraph();
+ }
+ else
+ {
+ QCString nm=m_impl->incInfo->includeName.isEmpty() ?
+ (m_impl->incInfo->fileDef ?
+ m_impl->incInfo->fileDef->docName().data() : ""
+ ) :
+ m_impl->incInfo->includeName.data();
+ if (!nm.isEmpty())
+ {
+ ol.startParagraph();
+ ol.startTypewriter();
+ ol.docify(includeStatement());
+ bool isIDLorJava = lang==SrcLangExt_IDL || lang==SrcLangExt_Java;
+ if (m_impl->incInfo->local || isIDLorJava)
+ ol.docify("\"");
+ else
+ ol.docify("<");
+ ol.pushGeneratorState();
+ ol.disable(OutputGenerator::Html);
+ ol.docify(nm);
+ ol.disableAllBut(OutputGenerator::Html);
+ ol.enable(OutputGenerator::Html);
+ if (m_impl->incInfo->fileDef)
+ {
+ ol.writeObjectLink(0,m_impl->incInfo->fileDef->includeName(),0,nm);
+ }
+ else
+ {
+ ol.docify(nm);
+ }
+ ol.popGeneratorState();
+ if (m_impl->incInfo->local || isIDLorJava)
+ ol.docify("\"");
+ else
+ ol.docify(">");
+ if (isIDLorJava)
+ ol.docify(";");
+ ol.endTypewriter();
+ ol.endParagraph();
+ }
+ }
+
+ // Write a summary of the Slice definition including metadata.
+ if (lang == SrcLangExt_Slice)
+ {
+ ol.startParagraph();
+ ol.startTypewriter();
+ if (!m_impl->metaData.isEmpty())
+ {
+ ol.docify(m_impl->metaData);
+ ol.lineBreak();
+ }
+ if (m_impl->spec & Entry::Local)
+ {
+ ol.docify("local ");
+ }
+ if (m_impl->spec & Entry::Interface)
+ {
+ ol.docify("interface ");
+ }
+ else if (m_impl->spec & Entry::Struct)
+ {
+ ol.docify("struct ");
+ }
+ else if (m_impl->spec & Entry::Exception)
+ {
+ ol.docify("exception ");
+ }
else
- ol.docify(">");
- if (isIDLorJava)
- ol.docify(";");
+ {
+ ol.docify("class ");
+ }
+ ol.docify(stripScope(name()));
+ if (m_impl->inherits)
+ {
+ if (m_impl->spec & (Entry::Interface|Entry::Exception))
+ {
+ ol.docify(" extends ");
+ BaseClassListIterator it(*m_impl->inherits);
+ BaseClassDef *ibcd;
+ for (;(ibcd=it.current());++it)
+ {
+ ClassDef *icd = ibcd->classDef;
+ ol.docify(icd->name());
+ if (!it.atLast())
+ {
+ ol.docify(", ");
+ }
+ }
+ }
+ else
+ {
+ // Must be a class.
+ bool implements = false;
+ BaseClassListIterator it(*m_impl->inherits);
+ BaseClassDef *ibcd;
+ for (;(ibcd=it.current());++it)
+ {
+ ClassDef *icd = ibcd->classDef;
+ if (icd->m_impl->spec & Entry::Interface)
+ {
+ implements = true;
+ }
+ else
+ {
+ ol.docify(" extends ");
+ ol.docify(icd->name());
+ }
+ }
+ if (implements)
+ {
+ ol.docify(" implements ");
+ bool first = true;
+ for (ibcd=it.toFirst();(ibcd=it.current());++it)
+ {
+ ClassDef *icd = ibcd->classDef;
+ if (icd->m_impl->spec & Entry::Interface)
+ {
+ if (!first)
+ {
+ ol.docify(", ");
+ }
+ else
+ {
+ first = false;
+ }
+ ol.docify(icd->name());
+ }
+ }
+ }
+ }
+ }
+ ol.docify(" { ... }");
ol.endTypewriter();
ol.endParagraph();
}
@@ -1914,6 +2073,10 @@ void ClassDef::writeDeclarationLink(OutputList &ol,bool &found,const char *heade
if (lang!=SrcLangExt_VHDL) // for VHDL we swap the name and the type
{
+ if (isSliceLocal())
+ {
+ ol.writeString("local ");
+ }
ol.writeString(ctype);
ol.writeString(" ");
ol.insertMemberAlign();
@@ -2079,8 +2242,14 @@ void ClassDef::writeDocumentationContents(OutputList &ol,const QCString & /*page
case LayoutDocEntry::NamespaceNestedNamespaces:
case LayoutDocEntry::NamespaceNestedConstantGroups:
case LayoutDocEntry::NamespaceClasses:
+ case LayoutDocEntry::NamespaceInterfaces:
+ case LayoutDocEntry::NamespaceStructs:
+ case LayoutDocEntry::NamespaceExceptions:
case LayoutDocEntry::NamespaceInlineClasses:
case LayoutDocEntry::FileClasses:
+ case LayoutDocEntry::FileInterfaces:
+ case LayoutDocEntry::FileStructs:
+ case LayoutDocEntry::FileExceptions:
case LayoutDocEntry::FileNamespaces:
case LayoutDocEntry::FileConstantGroups:
case LayoutDocEntry::FileIncludes:
@@ -2119,6 +2288,12 @@ QCString ClassDef::title() const
m_impl->compType,
m_impl->tempArgs != 0);
}
+ else if (lang==SrcLangExt_Slice)
+ {
+ pageTitle = theTranslator->trCompoundReferenceSlice(displayName(),
+ m_impl->compType,
+ isSliceLocal());
+ }
else if (lang==SrcLangExt_VHDL)
{
pageTitle = theTranslator->trCustomReference(VhdlDocGen::getClassTitle(this));
@@ -2157,9 +2332,35 @@ void ClassDef::writeDocumentation(OutputList &ol)
static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
//static bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
//static bool vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
QCString pageTitle = title();
- startFile(ol,getOutputFileBase(),name(),pageTitle,HLI_ClassVisible,!generateTreeView);
+ HighlightedItem hli;
+ if (sliceOpt)
+ {
+ if (isInterface())
+ {
+ hli = HLI_InterfaceVisible;
+ }
+ else if (isStruct())
+ {
+ hli = HLI_StructVisible;
+ }
+ else if (isException())
+ {
+ hli = HLI_ExceptionVisible;
+ }
+ else
+ {
+ hli = HLI_ClassVisible;
+ }
+ }
+ else
+ {
+ hli = HLI_ClassVisible;
+ }
+
+ startFile(ol,getOutputFileBase(),name(),pageTitle,hli,!generateTreeView);
if (!generateTreeView)
{
if (getOuterScope()!=Doxygen::globalScope)
@@ -2286,15 +2487,40 @@ void ClassDef::writeMemberList(OutputList &ol)
{
static bool cOpt = Config_getBool(OPTIMIZE_OUTPUT_FOR_C);
//static bool vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
if (m_impl->allMemberNameInfoSDict==0 || cOpt) return;
// only for HTML
ol.pushGeneratorState();
ol.disableAllBut(OutputGenerator::Html);
+ HighlightedItem hli;
+ if (sliceOpt)
+ {
+ if (isInterface())
+ {
+ hli = HLI_InterfaceVisible;
+ }
+ else if (isStruct())
+ {
+ hli = HLI_StructVisible;
+ }
+ else if (isException())
+ {
+ hli = HLI_ExceptionVisible;
+ }
+ else
+ {
+ hli = HLI_ClassVisible;
+ }
+ }
+ else
+ {
+ hli = HLI_ClassVisible;
+ }
+
QCString memListFile = getMemberListFileName();
- startFile(ol,memListFile,memListFile,theTranslator->trMemberList(),
- HLI_ClassVisible,!generateTreeView,getOutputFileBase());
+ startFile(ol,memListFile,memListFile,theTranslator->trMemberList(),hli,!generateTreeView,getOutputFileBase());
if (!generateTreeView)
{
if (getOuterScope()!=Doxygen::globalScope)
@@ -3549,19 +3775,21 @@ QCString ClassDef::compoundTypeString() const
}
else
{
+ QCString type;
switch (m_impl->compType)
{
- case Class: return isJavaEnum() ? "enum" : "class";
- case Struct: return "struct";
- case Union: return "union";
- case Interface: return getLanguage()==SrcLangExt_ObjC ? "class" : "interface";
- case Protocol: return "protocol";
- case Category: return "category";
- case Exception: return "exception";
- case Service: return "service";
- case Singleton: return "singleton";
+ case Class: type += isJavaEnum() ? "enum" : "class"; break;
+ case Struct: type += "struct"; break;
+ case Union: type += "union"; break;
+ case Interface: type += getLanguage()==SrcLangExt_ObjC ? "class" : "interface"; break;
+ case Protocol: type += "protocol"; break;
+ case Category: type += "category"; break;
+ case Exception: type += "exception"; break;
+ case Service: type += "service"; break;
+ case Singleton: type += "singleton"; break;
default: return "unknown";
}
+ return type;
}
}
@@ -4746,12 +4974,37 @@ bool ClassDef::subGrouping() const
return m_impl->subGrouping;
}
+bool ClassDef::isInterface() const
+{
+ return m_impl->compType == Interface;
+}
+
+bool ClassDef::isStruct() const
+{
+ return m_impl->compType == Struct;
+}
+
+bool ClassDef::isException() const
+{
+ return m_impl->compType == Exception;
+}
+
+bool ClassDef::isSliceLocal() const
+{
+ return m_impl->spec&Entry::Local;
+}
+
void ClassDef::setName(const char *name)
{
m_impl->isAnonymous = QCString(name).find('@')!=-1;
Definition::setName(name);
}
+void ClassDef::setMetaData(const char *md)
+{
+ m_impl->metaData = md;
+}
+
bool ClassDef::isAnonymous() const
{
return m_impl->isAnonymous;
diff --git a/src/classdef.h b/src/classdef.h
index 12fcd93..caa2750 100644
--- a/src/classdef.h
+++ b/src/classdef.h
@@ -336,6 +336,10 @@ class ClassDef : public Definition
QCString getMemberListFileName() const;
bool subGrouping() const;
+ bool isInterface() const;
+ bool isStruct() const;
+ bool isException() const;
+ bool isSliceLocal() const;
//-----------------------------------------------------------------------------------
// --- setters ----
@@ -376,6 +380,8 @@ class ClassDef : public Definition
void setTagLessReference(ClassDef *cd);
void setName(const char *name);
+ void setMetaData(const char *md);
+
//-----------------------------------------------------------------------------------
// --- actions ----
//-----------------------------------------------------------------------------------
diff --git a/src/code.l b/src/code.l
index a55ab1a..3fd2f6a 100644
--- a/src/code.l
+++ b/src/code.l
@@ -1834,7 +1834,7 @@ KEYWORD_OBJC ("@public"|"@private"|"@protected"|"@class"|"@implementation"|"@int
KEYWORD ("asm"|"__assume"|"auto"|"class"|"const"|"delete"|"enum"|"explicit"|"extern"|"false"|"friend"|"gcnew"|"gcroot"|"set"|"get"|"inline"|"internal"|"mutable"|"namespace"|"new"|"null"|"nullptr"|"override"|"operator"|"pin_ptr"|"private"|"protected"|"public"|"raise"|"register"|"remove"|"self"|"sizeof"|"static"|"struct"|"__super"|"function"|"template"|"generic"|"this"|"true"|"typedef"|"typeid"|"typename"|"union"|"using"|"virtual"|"volatile"|"abstract"|"final"|"import"|"synchronized"|"transient"|"alignas"|"alignof"|{KEYWORD_OBJC})
FLOWKW ("break"|"catch"|"continue"|"default"|"do"|"else"|"finally"|"return"|"switch"|"throw"|"throws"|"@catch"|"@finally")
FLOWCONDITION ("case"|"for"|"foreach"|"for each"|"goto"|"if"|"try"|"while"|"@try")
-TYPEKW ("bool"|"char"|"double"|"float"|"int"|"long"|"object"|"short"|"signed"|"unsigned"|"void"|"wchar_t"|"size_t"|"boolean"|"id"|"SEL"|"string"|"nullptr")
+TYPEKW ("bool"|"byte"|"char"|"double"|"float"|"int"|"long"|"object"|"short"|"signed"|"unsigned"|"void"|"wchar_t"|"size_t"|"boolean"|"id"|"SEL"|"string"|"nullptr"|"LocalObject"|"Object"|"Value")
CASTKW ("const_cast"|"dynamic_cast"|"reinterpret_cast"|"static_cast")
CHARLIT (("'"\\[0-7]{1,3}"'")|("'"\\."'")|("'"[^' \\\n]{1,4}"'"))
ARITHOP "+"|"-"|"/"|"*"|"%"|"--"|"++"
@@ -2241,7 +2241,7 @@ RAWEND ")"[^ \t\(\)\\]{0,16}\"
unput(*yytext);
BEGIN( Body );
}
-<ClassVar>("extends"|"implements") { // Java
+<ClassVar>("extends"|"implements") { // Java, Slice
startFontClass("keyword");
codifyLines(yytext);
endFontClass();
diff --git a/src/config.xml b/src/config.xml
index 08795dc..74c50c2 100644
--- a/src/config.xml
+++ b/src/config.xml
@@ -4,13 +4,13 @@
<![CDATA[
/*
*
- *
+ *
*
* Copyright (C) 1997-2015 by Dimitri van Heesch.
*
* Permission to use, copy, modify, and distribute this software and its
- * documentation under the terms of the GNU General Public License is hereby
- * granted. No representations are made about the suitability of this software
+ * documentation under the terms of the GNU General Public License is hereby
+ * granted. No representations are made about the suitability of this software
* for any purpose. It is provided "as is" without express or implied warranty.
* See the GNU General Public License for more details.
*
@@ -41,28 +41,28 @@ Each statement consists of a \c TAG_NAME written in capitals,
followed by the equal sign (<code>=</code>) and one or more values. If the same tag
is assigned more than once, the last assignment overwrites any earlier
assignment. For tags that take a list as their argument,
-the <code>+=</code> operator can be used instead of <code>=</code> to append
-new values to the list. Values are sequences of non-blanks. If the value should
+the <code>+=</code> operator can be used instead of <code>=</code> to append
+new values to the list. Values are sequences of non-blanks. If the value should
contain one or more blanks it must be surrounded by quotes (<code>&quot;...&quot;</code>).
Multiple lines can be concatenated by inserting a backslash (\c \\)
-as the last character of a line. Environment variables can be expanded
+as the last character of a line. Environment variables can be expanded
using the pattern <code>\$(ENV_VARIABLE_NAME)</code>.
You can also include part of a configuration file from another configuration
file using a <code>\@INCLUDE</code> tag as follows:
\verbatim
@INCLUDE = config_file_name
-\endverbatim
-The include file is searched in the current working directory. You can
+\endverbatim
+The include file is searched in the current working directory. You can
also specify a list of directories that should be searched before looking
-in the current working directory. Do this by putting a <code>\@INCLUDE_PATH</code> tag
+in the current working directory. Do this by putting a <code>\@INCLUDE_PATH</code> tag
with these paths before the <code>\@INCLUDE</code> tag, e.g.:
\verbatim
@INCLUDE_PATH = my_config_dir
\endverbatim
The configuration options can be divided into several categories.
-Below is an alphabetical index of the tags that are recognized
+Below is an alphabetical index of the tags that are recognized
followed by the descriptions of the tags grouped by category.
]]>
</docs>
@@ -91,14 +91,14 @@ Values that contain spaces should be placed between quotes (\" \").
<![CDATA[
\section config_examples Examples
-Suppose you have a simple project consisting of two files: a source file
+Suppose you have a simple project consisting of two files: a source file
\c example.cc and a header file \c example.h.
Then a minimal configuration file is as simple as:
\verbatim
INPUT = example.cc example.h
\endverbatim
-Assuming the example makes use of Qt classes and \c perl is located
+Assuming the example makes use of Qt classes and \c perl is located
in <code>/usr/bin</code>, a more realistic configuration file would be:
\verbatim
PROJECT_NAME = Example
@@ -109,7 +109,7 @@ PERL_PATH = /usr/local/bin/perl
SEARCHENGINE = NO
\endverbatim
-To generate the documentation for the
+To generate the documentation for the
<a href="https://sourceforge.net/projects/qdbttabular/">QdbtTabular</a> package
I have used the following configuration file:
\verbatim
@@ -160,7 +160,7 @@ INPUT = $(QTDIR)/doc \
$(QTDIR)/src/dialogs \
$(QTDIR)/src/tools
FILE_PATTERNS = *.cpp *.h q*.doc
-INCLUDE_PATH = $(QTDIR)/include
+INCLUDE_PATH = $(QTDIR)/include
RECURSIVE = YES
\endverbatim
@@ -212,7 +212,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='string' id='DOXYFILE_ENCODING' format='string' defval='UTF-8'>
<docs>
<![CDATA[
- This tag specifies the encoding used for all characters in the configuration file that
+ This tag specifies the encoding used for all characters in the configuration file that
follow. The default is UTF-8 which is also the encoding used for all text before
the first occurrence of this tag. Doxygen uses \c libiconv (or the iconv built into
\c libc) for the transcoding. See https://www.gnu.org/software/libiconv/ for the list of
@@ -224,8 +224,8 @@ Go to the <a href="commands.html">next</a> section or return to the
<docs>
<![CDATA[
The \c PROJECT_NAME tag is a single word (or a sequence of words
- surrounded by double-quotes, unless you are using Doxywizard) that should identify the project for which the
- documentation is generated. This name is used in the title of most
+ surrounded by double-quotes, unless you are using Doxywizard) that should identify the project for which the
+ documentation is generated. This name is used in the title of most
generated pages and in a few other places.
]]>
</docs>
@@ -242,9 +242,9 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='string' id='PROJECT_BRIEF' format='string' defval=''>
<docs>
<![CDATA[
- Using the \c PROJECT_BRIEF tag one can provide an optional one line description
- for a project that appears at the top of each page and should give viewer
- a quick idea about the purpose of the project. Keep the description short.
+ Using the \c PROJECT_BRIEF tag one can provide an optional one line description
+ for a project that appears at the top of each page and should give viewer
+ a quick idea about the purpose of the project. Keep the description short.
]]>
</docs>
</option>
@@ -252,9 +252,9 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='string' id='PROJECT_LOGO' format='image' defval=''>
<docs>
<![CDATA[
- With the \c PROJECT_LOGO tag one can specify a logo or an icon that is
- included in the documentation. The maximum height of the logo should not
- exceed 55 pixels and the maximum width should not exceed 200 pixels.
+ With the \c PROJECT_LOGO tag one can specify a logo or an icon that is
+ included in the documentation. The maximum height of the logo should not
+ exceed 55 pixels and the maximum width should not exceed 200 pixels.
Doxygen will copy the logo to the output directory.
]]>
</docs>
@@ -262,9 +262,9 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='string' id='OUTPUT_DIRECTORY' format='dir' defval=''>
<docs>
<![CDATA[
- The \c OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
- path into which the generated documentation will be written.
- If a relative path is entered, it will be relative to the location
+ The \c OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+ path into which the generated documentation will be written.
+ If a relative path is entered, it will be relative to the location
where doxygen was started. If left blank the current directory will be used.
]]>
</docs>
@@ -273,11 +273,11 @@ Go to the <a href="commands.html">next</a> section or return to the
<docs>
<![CDATA[
If the \c CREATE_SUBDIRS tag is set to \c YES then doxygen will create
- 4096 sub-directories (in 2 levels) under the output directory of each output
- format and will distribute the generated files over these directories.
+ 4096 sub-directories (in 2 levels) under the output directory of each output
+ format and will distribute the generated files over these directories.
Enabling this option can be useful when feeding doxygen a huge amount of source
files, where putting all generated files in the same directory would otherwise
- causes performance problems for the file system.
+ causes performance problems for the file system.
]]>
</docs>
</option>
@@ -285,8 +285,8 @@ Go to the <a href="commands.html">next</a> section or return to the
<docs>
<![CDATA[
If the \c ALLOW_UNICODE_NAMES tag is set to \c YES,
- doxygen will allow non-ASCII characters to appear in the names of generated files.
- If set to \c NO, non-ASCII characters will be escaped, for example _xE3_x81_x84
+ doxygen will allow non-ASCII characters to appear in the names of generated files.
+ If set to \c NO, non-ASCII characters will be escaped, for example _xE3_x81_x84
will be used for Unicode U+3044.
]]>
</docs>
@@ -369,12 +369,12 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='REPEAT_BRIEF' defval='1'>
<docs>
<![CDATA[
- If the \c REPEAT_BRIEF tag is set to \c YES, doxygen will
- prepend the brief description of a member or function before the detailed
- description
- <br>Note:
+ If the \c REPEAT_BRIEF tag is set to \c YES, doxygen will
+ prepend the brief description of a member or function before the detailed
+ description
+ <br>Note:
If both \ref cfg_hide_undoc_members "HIDE_UNDOC_MEMBERS" and
- \ref cfg_brief_member_desc "BRIEF_MEMBER_DESC" are set to \c NO, the
+ \ref cfg_brief_member_desc "BRIEF_MEMBER_DESC" are set to \c NO, the
brief descriptions will be completely suppressed.
]]>
</docs>
@@ -388,7 +388,7 @@ Go to the <a href="commands.html">next</a> section or return to the
stripped from the text and the result, after processing the whole list, is used
as the annotated text. Otherwise, the brief description is used as-is. If left
blank, the following values are used (`$name` is automatically replaced with the
- name of the entity):
+ name of the entity):
]]>
</docs>
<value name='The $name class'/>
@@ -406,7 +406,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='ALWAYS_DETAILED_SEC' defval='0'>
<docs>
<![CDATA[
- If the \c ALWAYS_DETAILED_SEC and \ref cfg_repeat_brief "REPEAT_BRIEF" tags
+ If the \c ALWAYS_DETAILED_SEC and \ref cfg_repeat_brief "REPEAT_BRIEF" tags
are both set to \c YES then
doxygen will generate a detailed section even if there is only a brief
description.
@@ -437,12 +437,12 @@ Go to the <a href="commands.html">next</a> section or return to the
<![CDATA[
The \c STRIP_FROM_PATH tag
can be used to strip a user-defined part of the path. Stripping is
- only done if one of the specified strings matches the left-hand part of the
+ only done if one of the specified strings matches the left-hand part of the
path. The tag can be used to show relative paths in the file list.
If left blank the directory from which doxygen is run is used as the
path to strip.
- <br>Note that you can specify absolute paths here, but also
- relative paths, which will be relative from the directory where doxygen is
+ <br>Note that you can specify absolute paths here, but also
+ relative paths, which will be relative from the directory where doxygen is
started.
]]>
</docs>
@@ -451,11 +451,11 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='list' id='STRIP_FROM_INC_PATH' format='string'>
<docs>
<![CDATA[
- The \c STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
+ The \c STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
the path mentioned in the documentation of a class, which tells
- the reader which header file to include in order to use a class.
+ the reader which header file to include in order to use a class.
If left blank only the name of the header file containing the class
- definition is used. Otherwise one should specify the list of include paths that
+ definition is used. Otherwise one should specify the list of include paths that
are normally passed to the compiler using the `-I` flag.
]]>
</docs>
@@ -474,7 +474,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<![CDATA[
If the \c JAVADOC_AUTOBRIEF tag is set to \c YES then doxygen
will interpret the first line (until the first dot) of a Javadoc-style
- comment as the brief description. If set to \c NO, the
+ comment as the brief description. If set to \c NO, the
Javadoc-style will behave just like regular Qt-style comments
(thus requiring an explicit \ref cmdbrief "\@brief" command for a brief description.)
]]>
@@ -534,20 +534,20 @@ Go to the <a href="commands.html">next</a> section or return to the
<docs>
<![CDATA[
This tag can be used to specify a number of aliases that act
- as commands in the documentation. An alias has the form:
+ as commands in the documentation. An alias has the form:
\verbatim
name=value
\endverbatim
- For example adding
+ For example adding
\verbatim
- "sideeffect=@par Side Effects:\n"
+ "sideeffect=@par Side Effects:\n"
\endverbatim
will allow you to
- put the command \c \\sideeffect (or \c \@sideeffect) in the documentation, which
+ put the command \c \\sideeffect (or \c \@sideeffect) in the documentation, which
will result in a user-defined paragraph with heading "Side Effects:".
You can put \ref cmdn "\\n"'s in the value part of an alias to insert newlines
(in the resulting output).
- You can put `^^` in the value part of an alias to insert a newline as if
+ You can put `^^` in the value part of an alias to insert a newline as if
a physical newline was in the original file.
]]>
</docs>
@@ -579,9 +579,9 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='list' id='TCL_SUBST' format='string'>
<docs>
<![CDATA[
- This tag can be used to specify a number of word-keyword mappings (TCL only).
- A mapping has the form <code>"name=value"</code>. For example adding
- <code>"class=itcl::class"</code> will allow you to use the command class in the
+ This tag can be used to specify a number of word-keyword mappings (TCL only).
+ A mapping has the form <code>"name=value"</code>. For example adding
+ <code>"class=itcl::class"</code> will allow you to use the command class in the
<code>itcl::class</code> meaning.
]]>
</docs>
@@ -589,10 +589,10 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='OPTIMIZE_OUTPUT_FOR_C' defval='0'>
<docs>
<![CDATA[
- Set the \c OPTIMIZE_OUTPUT_FOR_C tag to \c YES if your project consists
- of C sources only. Doxygen will then generate output that is more tailored
- for C. For instance, some of the names that are used will be different.
- The list of all members will be omitted, etc.
+ Set the \c OPTIMIZE_OUTPUT_FOR_C tag to \c YES if your project consists
+ of C sources only. Doxygen will then generate output that is more tailored
+ for C. For instance, some of the names that are used will be different.
+ The list of all members will be omitted, etc.
]]>
</docs>
</option>
@@ -600,16 +600,16 @@ Go to the <a href="commands.html">next</a> section or return to the
<docs>
<![CDATA[
Set the \c OPTIMIZE_OUTPUT_JAVA tag to \c YES if your project consists of Java or
- Python sources only. Doxygen will then generate output that is more tailored
- for that language. For instance, namespaces will be presented as packages,
- qualified scopes will look different, etc.
+ Python sources only. Doxygen will then generate output that is more tailored
+ for that language. For instance, namespaces will be presented as packages,
+ qualified scopes will look different, etc.
]]>
</docs>
</option>
<option type='bool' id='OPTIMIZE_FOR_FORTRAN' defval='0'>
<docs>
<![CDATA[
- Set the \c OPTIMIZE_FOR_FORTRAN tag to \c YES if your project consists of Fortran
+ Set the \c OPTIMIZE_FOR_FORTRAN tag to \c YES if your project consists of Fortran
sources. Doxygen will then generate output that is tailored for Fortran.
]]>
</docs>
@@ -617,11 +617,21 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='OPTIMIZE_OUTPUT_VHDL' defval='0'>
<docs>
<![CDATA[
- Set the \c OPTIMIZE_OUTPUT_VHDL tag to \c YES if your project consists of VHDL
+ Set the \c OPTIMIZE_OUTPUT_VHDL tag to \c YES if your project consists of VHDL
sources. Doxygen will then generate output that is tailored for VHDL.
]]>
</docs>
</option>
+ <option type='bool' id='OPTIMIZE_OUTPUT_SLICE' defval='0'>
+ <docs>
+<![CDATA[
+ Set the \c OPTIMIZE_OUTPUT_SLICE tag to \c YES if your project consists of Slice
+ sources only. Doxygen will then generate output that is more tailored
+ for that language. For instance, namespaces will be presented as modules,
+ types will be separated into more groups, etc.
+]]>
+ </docs>
+ </option>
<option type='list' id='EXTENSION_MAPPING' format='string'>
<docs>
<![CDATA[
@@ -630,7 +640,7 @@ Go to the <a href="commands.html">next</a> section or return to the
Doxygen has a built-in mapping, but you can override or extend it using this tag.
The format is <code>ext=language</code>, where \c ext is a file extension, and language is one of
the parsers supported by doxygen: IDL, Java, Javascript, Csharp (C#), C, C++, D, PHP,
- md (Markdown), Objective-C, Python, Fortran (fixed format Fortran: FortranFixed,
+ md (Markdown), Objective-C, Python, Slice, Fortran (fixed format Fortran: FortranFixed,
free formatted Fortran: FortranFree, unknown formatted Fortran: Fortran. In
the later case the parser tries to guess whether the code is fixed or free
formatted code, this is the default for Fortran type files), VHDL, tcl.
@@ -640,7 +650,7 @@ Go to the <a href="commands.html">next</a> section or return to the
use: `inc=Fortran f=C`.
<br>Note: For files without extension you can use `no_extension` as a placeholder.
- <br>Note that for custom extensions you also need to set \ref cfg_file_patterns "FILE_PATTERNS" otherwise the
+ <br>Note that for custom extensions you also need to set \ref cfg_file_patterns "FILE_PATTERNS" otherwise the
files are not read by doxygen.
]]>
</docs>
@@ -648,12 +658,12 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='MARKDOWN_SUPPORT' defval='1'>
<docs>
<![CDATA[
- If the \c MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all
- comments according to the Markdown format, which allows for more readable
- documentation. See http://daringfireball.net/projects/markdown/ for details.
- The output of markdown processing is further processed by doxygen, so you
- can mix doxygen, HTML, and XML commands with Markdown formatting.
- Disable only in case of backward compatibilities issues.
+ If the \c MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all
+ comments according to the Markdown format, which allows for more readable
+ documentation. See http://daringfireball.net/projects/markdown/ for details.
+ The output of markdown processing is further processed by doxygen, so you
+ can mix doxygen, HTML, and XML commands with Markdown formatting.
+ Disable only in case of backward compatibilities issues.
]]>
</docs>
</option>
@@ -670,9 +680,9 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='AUTOLINK_SUPPORT' defval='1'>
<docs>
<![CDATA[
- When enabled doxygen tries to link words that correspond to documented classes,
- or namespaces to their corresponding documentation. Such a link can be
- prevented in individual cases by putting a \c % sign in front of the word or
+ When enabled doxygen tries to link words that correspond to documented classes,
+ or namespaces to their corresponding documentation. Such a link can be
+ prevented in individual cases by putting a \c % sign in front of the word or
globally by setting \c AUTOLINK_SUPPORT to \c NO.
]]>
</docs>
@@ -700,10 +710,10 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='SIP_SUPPORT' defval='0'>
<docs>
<![CDATA[
- Set the \c SIP_SUPPORT tag to \c YES if your project consists
- of <a href="https://www.riverbankcomputing.com/software/sip/intro">sip</a> sources only.
- Doxygen will parse them like normal C++ but will assume all classes use public
- instead of private inheritance when no explicit protection keyword is present.
+ Set the \c SIP_SUPPORT tag to \c YES if your project consists
+ of <a href="https://www.riverbankcomputing.com/software/sip/intro">sip</a> sources only.
+ Doxygen will parse them like normal C++ but will assume all classes use public
+ instead of private inheritance when no explicit protection keyword is present.
]]>
</docs>
</option>
@@ -713,8 +723,8 @@ Go to the <a href="commands.html">next</a> section or return to the
For Microsoft's IDL there are \c propget and \c propput attributes to indicate getter
and setter methods for a property. Setting this option to \c YES
will make doxygen to replace the get and set methods by a property in the
- documentation. This will only work if the methods are indeed getting or
- setting a simple type. If this is not the case, or you want to show the
+ documentation. This will only work if the methods are indeed getting or
+ setting a simple type. If this is not the case, or you want to show the
methods anyway, you should set this option to \c NO.
]]>
</docs>
@@ -745,16 +755,16 @@ Go to the <a href="commands.html">next</a> section or return to the
the same type (for instance a group of public functions) to be put as a
subgroup of that type (e.g. under the Public Functions section). Set it to
\c NO to prevent subgrouping. Alternatively, this can be done per class using
- the \ref cmdnosubgrouping "\\nosubgrouping" command.
+ the \ref cmdnosubgrouping "\\nosubgrouping" command.
]]>
</docs>
</option>
<option type='bool' id='INLINE_GROUPED_CLASSES' defval='0'>
<docs>
<![CDATA[
- When the \c INLINE_GROUPED_CLASSES tag is set to \c YES, classes, structs and
- unions are shown inside the group in which they are included
- (e.g. using \ref cmdingroup "\\ingroup") instead of on a separate page (for HTML and Man pages)
+ When the \c INLINE_GROUPED_CLASSES tag is set to \c YES, classes, structs and
+ unions are shown inside the group in which they are included
+ (e.g. using \ref cmdingroup "\\ingroup") instead of on a separate page (for HTML and Man pages)
or section (for \f$\mbox{\LaTeX}\f$ and RTF).
<br>Note that this feature does not work in
combination with \ref cfg_separate_member_pages "SEPARATE_MEMBER_PAGES".
@@ -764,11 +774,11 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='INLINE_SIMPLE_STRUCTS' defval='0'>
<docs>
<![CDATA[
- When the \c INLINE_SIMPLE_STRUCTS tag is set to \c YES, structs, classes, and
- unions with only public data fields or simple typedef fields will be shown
- inline in the documentation of the scope in which they are defined (i.e. file,
- namespace, or group documentation), provided this scope is documented. If set
- to \c NO, structs, classes, and unions are shown on a separate
+ When the \c INLINE_SIMPLE_STRUCTS tag is set to \c YES, structs, classes, and
+ unions with only public data fields or simple typedef fields will be shown
+ inline in the documentation of the scope in which they are defined (i.e. file,
+ namespace, or group documentation), provided this scope is documented. If set
+ to \c NO, structs, classes, and unions are shown on a separate
page (for HTML and Man pages) or section (for \f$\mbox{\LaTeX}\f$ and RTF).
]]>
</docs>
@@ -777,11 +787,11 @@ Go to the <a href="commands.html">next</a> section or return to the
<docs>
<![CDATA[
When \c TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or enum
- is documented as struct, union, or enum with the name of the typedef. So
- <code>typedef struct TypeS {} TypeT</code>, will appear in the documentation as a struct
- with name \c TypeT. When disabled the typedef will appear as a member of a file,
- namespace, or class. And the struct will be named \c TypeS. This can typically
- be useful for C code in case the coding convention dictates that all compound
+ is documented as struct, union, or enum with the name of the typedef. So
+ <code>typedef struct TypeS {} TypeT</code>, will appear in the documentation as a struct
+ with name \c TypeT. When disabled the typedef will appear as a member of a file,
+ namespace, or class. And the struct will be named \c TypeS. This can typically
+ be useful for C code in case the coding convention dictates that all compound
types are typedef'ed and only the typedef is referenced, never the tag name.
]]>
</docs>
@@ -790,14 +800,14 @@ Go to the <a href="commands.html">next</a> section or return to the
<!-- be careful when changing these formulas as they are hard coded in the conversion script -->
<docs>
<![CDATA[
- The size of the symbol lookup cache can be
- set using \c LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
- their name and scope. Since this can be an expensive process and often the
- same symbol appears multiple times in the code, doxygen keeps a cache of
- pre-resolved symbols. If the cache is too small doxygen will become slower.
- If the cache is too large, memory is wasted. The cache size is given by this
- formula: \f$2^{(16+\mbox{LOOKUP\_CACHE\_SIZE})}\f$. The valid range is 0..9, the default is 0,
- corresponding to a cache size of \f$2^{16} = 65536\f$ symbols.
+ The size of the symbol lookup cache can be
+ set using \c LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
+ their name and scope. Since this can be an expensive process and often the
+ same symbol appears multiple times in the code, doxygen keeps a cache of
+ pre-resolved symbols. If the cache is too small doxygen will become slower.
+ If the cache is too large, memory is wasted. The cache size is given by this
+ formula: \f$2^{(16+\mbox{LOOKUP\_CACHE\_SIZE})}\f$. The valid range is 0..9, the default is 0,
+ corresponding to a cache size of \f$2^{16} = 65536\f$ symbols.
At the end of a run doxygen will report the cache usage and suggest the
optimal cache size from a speed point of view.
]]>
@@ -808,14 +818,14 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='EXTRACT_ALL' defval='0'>
<docs>
<![CDATA[
- If the \c EXTRACT_ALL tag is set to \c YES, doxygen will assume all
- entities in documentation are documented, even if no documentation was
- available. Private class members and static file members will be hidden
- unless the \ref cfg_extract_private "EXTRACT_PRIVATE" respectively
+ If the \c EXTRACT_ALL tag is set to \c YES, doxygen will assume all
+ entities in documentation are documented, even if no documentation was
+ available. Private class members and static file members will be hidden
+ unless the \ref cfg_extract_private "EXTRACT_PRIVATE" respectively
\ref cfg_extract_static "EXTRACT_STATIC" tags are set to \c YES.
- \note This will also disable the warnings about undocumented members
- that are normally produced when \ref cfg_warnings "WARNINGS" is
+ \note This will also disable the warnings about undocumented members
+ that are normally produced when \ref cfg_warnings "WARNINGS" is
set to \c YES.
]]>
</docs>
@@ -823,7 +833,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='EXTRACT_PRIVATE' defval='0'>
<docs>
<![CDATA[
- If the \c EXTRACT_PRIVATE tag is set to \c YES, all private members of a
+ If the \c EXTRACT_PRIVATE tag is set to \c YES, all private members of a
class will be included in the documentation.
]]>
</docs>
@@ -831,8 +841,8 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='EXTRACT_PACKAGE' defval='0'>
<docs>
<![CDATA[
- If the \c EXTRACT_PACKAGE tag is set to \c YES, all members with package
- or internal scope will be included in the documentation.
+ If the \c EXTRACT_PACKAGE tag is set to \c YES, all members with package
+ or internal scope will be included in the documentation.
]]>
</docs>
</option>
@@ -847,8 +857,8 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='EXTRACT_LOCAL_CLASSES' defval='1'>
<docs>
<![CDATA[
- If the \c EXTRACT_LOCAL_CLASSES tag is set to \c YES, classes (and structs)
- defined locally in source files will be included in the documentation.
+ If the \c EXTRACT_LOCAL_CLASSES tag is set to \c YES, classes (and structs)
+ defined locally in source files will be included in the documentation.
If set to \c NO, only classes defined in header files are included. Does not
have any effect for Java sources.
]]>
@@ -857,7 +867,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='EXTRACT_LOCAL_METHODS' defval='0'>
<docs>
<![CDATA[
- This flag is only useful for Objective-C code. If set to \c YES, local
+ This flag is only useful for Objective-C code. If set to \c YES, local
methods, which are defined in the implementation section but not in
the interface are included in the documentation.
If set to \c NO, only methods in the interface are included.
@@ -878,7 +888,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<docs>
<![CDATA[
If the \c HIDE_UNDOC_MEMBERS tag is set to \c YES, doxygen will hide all
- undocumented members inside documented classes or files.
+ undocumented members inside documented classes or files.
If set to \c NO these members will be included in the
various overviews, but no documentation section is generated.
This option has no effect if \ref cfg_extract_all "EXTRACT_ALL" is enabled.
@@ -889,7 +899,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<docs>
<![CDATA[
If the \c HIDE_UNDOC_CLASSES tag is set to \c YES, doxygen will hide all
- undocumented classes that are normally visible in the class hierarchy.
+ undocumented classes that are normally visible in the class hierarchy.
If set to \c NO, these classes will be included in the
various overviews.
This option has no effect if \ref cfg_extract_all "EXTRACT_ALL" is enabled.
@@ -909,9 +919,9 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='HIDE_IN_BODY_DOCS' defval='0'>
<docs>
<![CDATA[
- If the \c HIDE_IN_BODY_DOCS tag is set to \c YES, doxygen will hide any
+ If the \c HIDE_IN_BODY_DOCS tag is set to \c YES, doxygen will hide any
documentation blocks found inside the body of a function.
- If set to \c NO, these blocks will be appended to the
+ If set to \c NO, these blocks will be appended to the
function's detailed documentation block.
]]>
</docs>
@@ -941,9 +951,9 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='HIDE_SCOPE_NAMES' defval='0'>
<docs>
<![CDATA[
- If the \c HIDE_SCOPE_NAMES tag is set to \c NO then doxygen
+ If the \c HIDE_SCOPE_NAMES tag is set to \c NO then doxygen
will show members with their full class and namespace scopes in the
- documentation. If set to \c YES, the scope will be hidden.
+ documentation. If set to \c YES, the scope will be hidden.
]]>
</docs>
</option>
@@ -952,7 +962,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<![CDATA[
If the \c HIDE_COMPOUND_REFERENCE tag is set to \c NO (default) then
doxygen will append additional text to a page's title, such as Class Reference.
- If set to \c YES the compound reference will be hidden.
+ If set to \c YES the compound reference will be hidden.
]]>
</docs>
</option>
@@ -960,7 +970,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<docs>
<![CDATA[
If the \c SHOW_INCLUDE_FILES tag is set to \c YES then doxygen
- will put a list of the files that are included by a file in the documentation
+ will put a list of the files that are included by a file in the documentation
of that file.
]]>
</docs>
@@ -968,7 +978,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='SHOW_GROUPED_MEMB_INC' defval='0'>
<docs>
<![CDATA[
- If the SHOW_GROUPED_MEMB_INC tag is set to \c YES then Doxygen
+ If the SHOW_GROUPED_MEMB_INC tag is set to \c YES then Doxygen
will add for each grouped member an include statement to the documentation,
telling the reader which file to include in order to use the member.
]]>
@@ -977,8 +987,8 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='FORCE_LOCAL_INCLUDES' defval='0'>
<docs>
<![CDATA[
- If the \c FORCE_LOCAL_INCLUDES tag is set to \c YES then doxygen
- will list include files with double quotes in the documentation
+ If the \c FORCE_LOCAL_INCLUDES tag is set to \c YES then doxygen
+ will list include files with double quotes in the documentation
rather than with sharp brackets.
]]>
</docs>
@@ -1030,9 +1040,9 @@ Go to the <a href="commands.html">next</a> section or return to the
<option type='bool' id='SORT_GROUP_NAMES' defval='0'>
<docs>
<![CDATA[
- If the \c SORT_GROUP_NAMES tag is set to \c YES then doxygen will sort the
+ If the \c SORT_GROUP_NAMES tag is set to \c YES then doxygen will sort the
hierarchy of group names into alphabetical order. If set to \c NO
- the group names will appear in their defined order.
+ the group names will appear in their defined order.
]]>
</docs>
</option>
@@ -1044,7 +1054,7 @@ Go to the <a href="commands.html">next</a> section or return to the
\c NO, the class list will be sorted only by class name,
not including the namespace part.
\note This option is not very useful if \ref cfg_hide_scope_names "HIDE_SCOPE_NAMES" is set to \c YES.
- \note This option applies only to the class list, not to the
+ \note This option applies only to the class list, not to the
alphabetical list.
]]>
</docs>
@@ -1053,10 +1063,10 @@ Go to the <a href="commands.html">next</a> section or return to the
<docs>
<![CDATA[
If the \c STRICT_PROTO_MATCHING option is enabled and doxygen fails to
- do proper type resolution of all parameters of a function it will reject a
+ do proper type resolution of all parameters of a function it will reject a
match between the prototype and the implementation of a member function even
if there is only one candidate or it is obvious which candidate to choose
- by doing a simple string match. By disabling \c STRICT_PROTO_MATCHING doxygen
+ by doing a simple string match. By disabling \c STRICT_PROTO_MATCHING doxygen
will still accept a match between prototype and implementation in such cases.
]]>
</docs>
@@ -1065,7 +1075,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<docs>
<![CDATA[
The \c GENERATE_TODOLIST tag can be used to enable (\c YES) or
- disable (\c NO) the todo list. This list is created by
+ disable (\c NO) the todo list. This list is created by
putting \ref cmdtodo "\\todo" commands in the documentation.
]]>
</docs>
@@ -1074,7 +1084,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<docs>
<![CDATA[
The \c GENERATE_TESTLIST tag can be used to enable (\c YES) or
- disable (\c NO) the test list. This list is created by
+ disable (\c NO) the test list. This list is created by
putting \ref cmdtest "\\test" commands in the documentation.
]]>
</docs>
@@ -1083,7 +1093,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<docs>
<![CDATA[
The \c GENERATE_BUGLIST tag can be used to enable (\c YES) or
- disable (\c NO) the bug list. This list is created by
+ disable (\c NO) the bug list. This list is created by
putting \ref cmdbug "\\bug" commands in the documentation.
]]>
</docs>
@@ -1092,7 +1102,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<docs>
<![CDATA[
The \c GENERATE_DEPRECATEDLIST tag can be used to enable (\c YES) or
- disable (\c NO) the deprecated list. This list is created by
+ disable (\c NO) the deprecated list. This list is created by
putting \ref cmddeprecated "\\deprecated"
commands in the documentation.
]]>
@@ -1102,7 +1112,7 @@ Go to the <a href="commands.html">next</a> section or return to the
<docs>
<![CDATA[
The \c ENABLED_SECTIONS tag can be used to enable conditional
- documentation sections, marked by \ref cmdif "\\if" \<section_label\> ...
+ documentation sections, marked by \ref cmdif "\\if" \<section_label\> ...
\ref cmdendif "\\endif" and \ref cmdcond "\\cond" \<section_label\> ...
\ref cmdendcond "\\endcond" blocks.
]]>
@@ -1154,9 +1164,9 @@ Go to the <a href="commands.html">next</a> section or return to the
The \c FILE_VERSION_FILTER tag can be used to specify a program or script that
doxygen should invoke to get the current version for each file (typically from the
version control system). Doxygen will invoke the program by executing (via
- <code>popen()</code>) the command <code>command input-file</code>, where \c command is
- the value of the \c FILE_VERSION_FILTER tag, and \c input-file is the name
- of an input file provided by doxygen.
+ <code>popen()</code>) the command <code>command input-file</code>, where \c command is
+ the value of the \c FILE_VERSION_FILTER tag, and \c input-file is the name
+ of an input file provided by doxygen.
Whatever the program writes to standard output is used as the file version.
]]>
</docs>
@@ -1173,8 +1183,8 @@ Example shell script for CVS:
\verbatim
#!/bin/sh
cvs status $1 | sed -n 's/^[ \]*Working revision:[ \t]*\([0-9][0-9\.]*\).*/\1/p'
-\endverbatim
-<br>
+\endverbatim
+<br>
Example shell script for Subversion:
\verbatim
#!/bin/sh
@@ -1202,8 +1212,8 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
doxygen's defaults, run doxygen with the `-l` option. You can optionally specify a
file name after the option, if omitted \c DoxygenLayout.xml will be used as the name
of the layout file.
- <br>Note that if you run doxygen from a directory containing
- a file called \c DoxygenLayout.xml, doxygen will parse it automatically even if
+ <br>Note that if you run doxygen from a directory containing
+ a file called \c DoxygenLayout.xml, doxygen will parse it automatically even if
the \c LAYOUT_FILE tag is left empty.
]]>
</docs>
@@ -1211,11 +1221,11 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<option type='list' id='CITE_BIB_FILES' format='file'>
<docs>
<![CDATA[
- The \c CITE_BIB_FILES tag can be used to specify one or more \c bib files
- containing the reference definitions. This must be a list of <code>.bib</code> files. The
- <code>.bib</code> extension is automatically appended if omitted. This requires the
+ The \c CITE_BIB_FILES tag can be used to specify one or more \c bib files
+ containing the reference definitions. This must be a list of <code>.bib</code> files. The
+ <code>.bib</code> extension is automatically appended if omitted. This requires the
\c bibtex tool to be installed. See also https://en.wikipedia.org/wiki/BibTeX for
- more info. For \f$\mbox{\LaTeX}\f$ the style of the bibliography can be controlled
+ more info. For \f$\mbox{\LaTeX}\f$ the style of the bibliography can be controlled
using \ref cfg_latex_bib_style "LATEX_BIB_STYLE".
To use this feature you need \c bibtex and \c perl available in the search path.
See also \ref cmdcite "\\cite" for info how to create references.
@@ -1236,7 +1246,7 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<docs>
<![CDATA[
The \c WARNINGS tag can be used to turn on/off the warning messages that are
- generated to standard error (\c stderr) by doxygen. If \c WARNINGS is set to
+ generated to standard error (\c stderr) by doxygen. If \c WARNINGS is set to
\c YES this implies that the warnings are on.
<br>
\b Tip: Turn warnings on while writing the documentation.
@@ -1258,14 +1268,14 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
If the \c WARN_IF_DOC_ERROR tag is set to \c YES, doxygen will generate warnings for
potential errors in the documentation, such as not documenting some
parameters in a documented function, or documenting parameters that
- don't exist or using markup commands wrongly.
+ don't exist or using markup commands wrongly.
]]>
</docs>
</option>
<option type='bool' id='WARN_NO_PARAMDOC' defval='0'>
<docs>
<![CDATA[
- This \c WARN_NO_PARAMDOC option can be enabled to get warnings for
+ This \c WARN_NO_PARAMDOC option can be enabled to get warnings for
functions that are documented, but have no documentation for their parameters
or return value. If set to \c NO, doxygen will only warn about
wrong or incomplete parameter documentation, but not about the absence of
@@ -1287,13 +1297,13 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<docs>
<![CDATA[
The \c WARN_FORMAT tag determines the format of the warning messages that
- doxygen can produce. The string should contain the <code>\$file</code>,
- <code>\$line</code>, and <code>\$text</code>
+ doxygen can produce. The string should contain the <code>\$file</code>,
+ <code>\$line</code>, and <code>\$text</code>
tags, which will be replaced by the file and line number from which the
warning originated and the warning text.
- Optionally the format may contain
- <code>$version</code>, which will be replaced by the version of the file (if it could
- be obtained via \ref cfg_file_version_filter "FILE_VERSION_FILTER")
+ Optionally the format may contain
+ <code>$version</code>, which will be replaced by the version of the file (if it could
+ be obtained via \ref cfg_file_version_filter "FILE_VERSION_FILTER")
]]>
</docs>
</option>
@@ -1301,7 +1311,7 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<docs>
<![CDATA[
The \c WARN_LOGFILE tag can be used to specify a file to which warning
- and error messages should be written. If left blank the output is written
+ and error messages should be written. If left blank the output is written
to standard error (`stderr`).
]]>
</docs>
@@ -1311,9 +1321,9 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<option type='list' id='INPUT' format='filedir'>
<docs>
<![CDATA[
- The \c INPUT tag is used to specify the files and/or directories that contain
- documented source files. You may enter file names like
- \c myfile.cpp or directories like \c /usr/src/myproject.
+ The \c INPUT tag is used to specify the files and/or directories that contain
+ documented source files. You may enter file names like
+ \c myfile.cpp or directories like \c /usr/src/myproject.
Separate the files or directories with spaces. See also
\ref cfg_file_patterns "FILE_PATTERNS" and
\ref cfg_extension_mapping "EXTENSION_MAPPING"
@@ -1326,10 +1336,10 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<option type='string' id='INPUT_ENCODING' format='string' defval='UTF-8'>
<docs>
<![CDATA[
- This tag can be used to specify the character encoding of the source files that
+ This tag can be used to specify the character encoding of the source files that
doxygen parses. Internally doxygen uses the UTF-8 encoding.
- Doxygen uses `libiconv` (or the `iconv` built into `libc`) for the transcoding.
- See <a href="https://www.gnu.org/software/libiconv/">the libiconv documentation</a> for
+ Doxygen uses `libiconv` (or the `iconv` built into `libc`) for the transcoding.
+ See <a href="https://www.gnu.org/software/libiconv/">the libiconv documentation</a> for
the list of possible encodings.
]]>
</docs>
@@ -1337,9 +1347,9 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<option type='list' id='FILE_PATTERNS' format='string'>
<docs>
<![CDATA[
- If the value of the \ref cfg_input "INPUT" tag contains directories, you can use the
- \c FILE_PATTERNS tag to specify one or more wildcard patterns
- (like `*.cpp` and `*.h`) to filter out the source-files
+ If the value of the \ref cfg_input "INPUT" tag contains directories, you can use the
+ \c FILE_PATTERNS tag to specify one or more wildcard patterns
+ (like `*.cpp` and `*.h`) to filter out the source-files
in the directories.<br>
Note that for custom extensions or not directly supported extensions you also
need to set \ref cfg_extension_mapping "EXTENSION_MAPPING" for the extension
@@ -1391,6 +1401,7 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<value name='*.vhdl'/>
<value name='*.ucf'/>
<value name='*.qsf'/>
+ <value name='*.ice'/>
</option>
<option type='bool' id='RECURSIVE' defval='0'>
<docs>
@@ -1413,7 +1424,7 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<option type='bool' id='EXCLUDE_SYMLINKS' defval='0'>
<docs>
<![CDATA[
- The \c EXCLUDE_SYMLINKS tag can be used to select whether or not files or directories
+ The \c EXCLUDE_SYMLINKS tag can be used to select whether or not files or directories
that are symbolic links (a Unix file system feature) are excluded from the input.
]]>
</docs>
@@ -1424,8 +1435,8 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
If the value of the \ref cfg_input "INPUT" tag contains directories, you can use the
\c EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
certain files from those directories.
- <br>Note that the wildcards are matched
- against the file with absolute path, so to exclude all test directories
+ <br>Note that the wildcards are matched
+ against the file with absolute path, so to exclude all test directories
for example use the pattern `*``/test/``*`
]]>
</docs>
@@ -1433,13 +1444,13 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<option type='list' id='EXCLUDE_SYMBOLS' format='string'>
<docs>
<![CDATA[
- The \c EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
- (namespaces, classes, functions, etc.) that should be excluded from the
- output. The symbol name can be a fully qualified name, a word, or if the
- wildcard `*` is used, a substring. Examples: `ANamespace`, `AClass`,
- `AClass::ANamespace`, `ANamespace::*Test`
- <br>Note that the wildcards are matched against the file with absolute path,
- so to exclude all test directories use the pattern
+ The \c EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+ (namespaces, classes, functions, etc.) that should be excluded from the
+ output. The symbol name can be a fully qualified name, a word, or if the
+ wildcard `*` is used, a substring. Examples: `ANamespace`, `AClass`,
+ `AClass::ANamespace`, `ANamespace::*Test`
+ <br>Note that the wildcards are matched against the file with absolute path,
+ so to exclude all test directories use the pattern
`*``/test/``*`
]]>
</docs>
@@ -1456,7 +1467,7 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<option type='list' id='EXAMPLE_PATTERNS' format='string'>
<docs>
<![CDATA[
- If the value of the \ref cfg_example_path "EXAMPLE_PATH" tag contains directories,
+ If the value of the \ref cfg_example_path "EXAMPLE_PATH" tag contains directories,
you can use the
\c EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like `*.cpp`
and `*.h`) to filter out the source-files in the directories. If left
@@ -1470,8 +1481,8 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<![CDATA[
If the \c EXAMPLE_RECURSIVE tag is set to \c YES then subdirectories will be
searched for input files to be used with the \ref cmdinclude "\\include" or
- \ref cmddontinclude "\\dontinclude"
- commands irrespective of the value of the \ref cfg_recursive "RECURSIVE" tag.
+ \ref cmddontinclude "\\dontinclude"
+ commands irrespective of the value of the \ref cfg_recursive "RECURSIVE" tag.
]]>
</docs>
</option>
@@ -1479,7 +1490,7 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<docs>
<![CDATA[
The \c IMAGE_PATH tag can be used to specify one or more files or
- directories that contain images that are to be included in the
+ directories that contain images that are to be included in the
documentation (see the \ref cmdimage "\\image" command).
]]>
</docs>
@@ -1496,9 +1507,9 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
where <code>\<filter\></code>
is the value of the \c INPUT_FILTER tag, and <code>\<input-file\></code> is the name of an
input file. Doxygen will then use the output that the filter program writes
- to standard output. If \ref cfg_filter_patterns "FILTER_PATTERNS" is specified, this tag will be ignored.
- <br>Note that the filter must not add or remove lines; it is applied before the
- code is scanned, but not when the output code is generated. If lines are added
+ to standard output. If \ref cfg_filter_patterns "FILTER_PATTERNS" is specified, this tag will be ignored.
+ <br>Note that the filter must not add or remove lines; it is applied before the
+ code is scanned, but not when the output code is generated. If lines are added
or removed, the anchors will not be placed correctly.
<br>Note that for custom extensions or not directly supported extensions you also
need to set \ref cfg_extension_mapping "EXTENSION_MAPPING" for the extension
@@ -1515,7 +1526,7 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
filter if there is a match. The filters are a list of the form:
pattern=filter (like `*.cpp=my_cpp_filter`). See \ref cfg_input_filter "INPUT_FILTER" for further
information on how filters are used. If the \c FILTER_PATTERNS tag is empty or if
- none of the patterns match the file name, \ref cfg_input_filter "INPUT_FILTER" is
+ none of the patterns match the file name, \ref cfg_input_filter "INPUT_FILTER" is
applied.
<br>Note that for custom extensions or not directly supported extensions you also
need to set \ref cfg_extension_mapping "EXTENSION_MAPPING" for the extension
@@ -1528,7 +1539,7 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<![CDATA[
If the \c FILTER_SOURCE_FILES tag is set to \c YES, the input filter (if set using
\ref cfg_input_filter "INPUT_FILTER") will also be used to filter the input
- files that are used for producing the source files to browse
+ files that are used for producing the source files to browse
(i.e. when \ref cfg_source_browser "SOURCE_BROWSER" is set to \c YES).
]]>
</docs>
@@ -1536,10 +1547,10 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<option type='list' id='FILTER_SOURCE_PATTERNS' format='string' depends='FILTER_SOURCE_FILES'>
<docs>
<![CDATA[
- The \c FILTER_SOURCE_PATTERNS tag can be used to specify source filters per
- file pattern. A pattern will override the setting
- for \ref cfg_filter_patterns "FILTER_PATTERN" (if any)
- and it is also possible to disable source filtering for a specific pattern
+ The \c FILTER_SOURCE_PATTERNS tag can be used to specify source filters per
+ file pattern. A pattern will override the setting
+ for \ref cfg_filter_patterns "FILTER_PATTERN" (if any)
+ and it is also possible to disable source filtering for a specific pattern
using `*.ext=` (so without naming a filter).
]]>
</docs>
@@ -1547,9 +1558,9 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<option type='string' id='USE_MDFILE_AS_MAINPAGE' format='string' defval=''>
<docs>
<![CDATA[
- If the \c USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
- is part of the input, its contents will be placed on the main page (`index.html`).
- This can be useful if you have a project on for instance GitHub and want to reuse
+ If the \c USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
+ is part of the input, its contents will be placed on the main page (`index.html`).
+ This can be useful if you have a project on for instance GitHub and want to reuse
the introduction page also for the doxygen output.
]]>
</docs>
@@ -1588,7 +1599,7 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<![CDATA[
If the \c REFERENCED_BY_RELATION tag is set to \c YES
then for each documented entity all documented
- functions referencing it will be listed.
+ functions referencing it will be listed.
]]>
</docs>
</option>
@@ -1597,7 +1608,7 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<![CDATA[
If the \c REFERENCES_RELATION tag is set to \c YES
then for each documented function all documented entities
- called/used by that function will be listed.
+ called/used by that function will be listed.
]]>
</docs>
</option>
@@ -1605,9 +1616,9 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<docs>
<![CDATA[
If the \c REFERENCES_LINK_SOURCE tag is set to \c YES
- and \ref cfg_source_browser "SOURCE_BROWSER" tag is set to \c YES then the hyperlinks from
+ and \ref cfg_source_browser "SOURCE_BROWSER" tag is set to \c YES then the hyperlinks from
functions in \ref cfg_references_relation "REFERENCES_RELATION" and
- \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION" lists will
+ \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION" lists will
link to the source code. Otherwise they will link to the documentation.
]]>
</docs>
@@ -1615,11 +1626,11 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
<option type='bool' id='SOURCE_TOOLTIPS' defval='1' depends='SOURCE_BROWSER'>
<docs>
<![CDATA[
-If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
-source code will show a tooltip with additional information such as prototype,
-brief description and links to the definition and documentation. Since this will
-make the HTML file larger and loading of large files a bit slower, you can opt
-to disable this feature.
+If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
+source code will show a tooltip with additional information such as prototype,
+brief description and links to the definition and documentation. Since this will
+make the HTML file larger and loading of large files a bit slower, you can opt
+to disable this feature.
]]>
</docs>
</option>
@@ -1629,8 +1640,8 @@ to disable this feature.
If the \c USE_HTAGS tag is set to \c YES then the references to source code
will point to the HTML generated by the \c htags(1) tool instead of doxygen
built-in source browser. The \c htags tool is part of GNU's global source
- tagging system (see https://www.gnu.org/software/global/global.html). You
- will need version 4.8.6 or higher.
+ tagging system (see https://www.gnu.org/software/global/global.html). You
+ will need version 4.8.6 or higher.
<br>
To use it do the following:
-# Install the latest version of \c global
@@ -1660,10 +1671,10 @@ to disable this feature.
<option type='bool' id='CLANG_ASSISTED_PARSING' setting='USE_LIBCLANG' defval='0'>
<docs>
<![CDATA[
- If the \c CLANG_ASSISTED_PARSING tag is set to \c YES then doxygen will use the
- <a href="http://clang.llvm.org/">clang parser</a> for more accurate parsing
- at the cost of reduced performance. This can be particularly helpful with
- template rich C++ code for which doxygen's built-in parser lacks the
+ If the \c CLANG_ASSISTED_PARSING tag is set to \c YES then doxygen will use the
+ <a href="http://clang.llvm.org/">clang parser</a> for more accurate parsing
+ at the cost of reduced performance. This can be particularly helpful with
+ template rich C++ code for which doxygen's built-in parser lacks the
necessary type information.
@note The availability of this option depends on whether or not doxygen
@@ -1674,9 +1685,9 @@ to disable this feature.
<option type='list' id='CLANG_OPTIONS' format='string' setting='USE_LIBCLANG' depends='CLANG_ASSISTED_PARSING'>
<docs>
<![CDATA[
- If clang assisted parsing is enabled you can provide the compiler with command
- line options that you would normally use when invoking the compiler. Note that
- the include paths will already be set by doxygen for the files and directories
+ If clang assisted parsing is enabled you can provide the compiler with command
+ line options that you would normally use when invoking the compiler. Note that
+ the include paths will already be set by doxygen for the files and directories
specified with \ref cfg_input "INPUT" and \ref cfg_include_path "INCLUDE_PATH".
]]>
</docs>
@@ -1701,7 +1712,7 @@ to disable this feature.
<docs>
<![CDATA[
If the \c ALPHABETICAL_INDEX tag is set to \c YES, an alphabetical index
- of all compounds will be generated. Enable this if the project contains
+ of all compounds will be generated. Enable this if the project contains
a lot of classes, structs, unions or interfaces.
]]>
</docs>
@@ -1709,7 +1720,7 @@ to disable this feature.
<option type='int' id='COLS_IN_ALPHA_INDEX' minval='1' maxval='20' defval='5' depends='ALPHABETICAL_INDEX'>
<docs>
<![CDATA[
- The \c COLS_IN_ALPHA_INDEX tag can be
+ The \c COLS_IN_ALPHA_INDEX tag can be
used to specify the number of columns in which the alphabetical index list will be split.
]]>
</docs>
@@ -1717,9 +1728,9 @@ to disable this feature.
<option type='list' id='IGNORE_PREFIX' format='string' depends='ALPHABETICAL_INDEX'>
<docs>
<![CDATA[
- In case all classes in a project start with a common prefix, all classes will
+ In case all classes in a project start with a common prefix, all classes will
be put under the same header in the alphabetical index.
- The \c IGNORE_PREFIX tag can be used to specify a prefix
+ The \c IGNORE_PREFIX tag can be used to specify a prefix
(or a list of prefixes) that should be ignored while generating the index headers.
]]>
</docs>
@@ -1746,7 +1757,7 @@ to disable this feature.
<option type='string' id='HTML_FILE_EXTENSION' format='string' defval='.html' depends='GENERATE_HTML'>
<docs>
<![CDATA[
- The \c HTML_FILE_EXTENSION tag can be used to specify the file extension for
+ The \c HTML_FILE_EXTENSION tag can be used to specify the file extension for
each generated HTML page (for example: <code>.htm, .php, .asp</code>).
]]>
</docs>
@@ -1754,10 +1765,10 @@ to disable this feature.
<option type='string' id='HTML_HEADER' format='file' defval='' depends='GENERATE_HTML'>
<docs>
<![CDATA[
- The \c HTML_HEADER tag can be used to specify a user-defined HTML
- header file for each generated HTML page.
- If the tag is left blank doxygen will generate a
- standard header.
+ The \c HTML_HEADER tag can be used to specify a user-defined HTML
+ header file for each generated HTML page.
+ If the tag is left blank doxygen will generate a
+ standard header.
<br>
To get valid HTML the header file that
includes any scripts and style sheets that doxygen
@@ -1773,7 +1784,7 @@ doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFil
the default header that doxygen normally uses.
@note The header is subject to change so you typically
- have to regenerate the default header when upgrading to a newer version of
+ have to regenerate the default header when upgrading to a newer version of
doxygen.
]]>
</docs>
@@ -1786,7 +1797,7 @@ doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFil
<dt><code>\$date</code><dd>will be replaced with the current date.
<dt><code>\$year</code><dd>will be replaces with the current year.
<dt><code>\$doxygenversion</code><dd>will be replaced with the version of doxygen
- <dt><code>\$projectname</code><dd>will be replaced with the name of
+ <dt><code>\$projectname</code><dd>will be replaced with the name of
the project (see \ref cfg_project_name "PROJECT_NAME")
<dt><code>\$projectnumber</code><dd>will be replaced with the project number
(see \ref cfg_project_number "PROJECT_NUMBER")
@@ -1794,25 +1805,25 @@ doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFil
description (see \ref cfg_project_brief "PROJECT_BRIEF")
<dt><code>\$projectlogo</code><dd>will be replaced with the project logo
(see \ref cfg_project_logo "PROJECT_LOGO")
- <dt><code>\$treeview</code><dd>will be replaced with links to
- the javascript and style sheets needed for the navigation tree
- (or an empty string when \ref cfg_generate_treeview "GENERATE_TREEVIEW"
+ <dt><code>\$treeview</code><dd>will be replaced with links to
+ the javascript and style sheets needed for the navigation tree
+ (or an empty string when \ref cfg_generate_treeview "GENERATE_TREEVIEW"
is disabled).
- <dt><code>\$search</code><dd>will be replaced with a links to
- the javascript and style sheets needed for the search engine
- (or an empty string when \ref cfg_searchengine "SEARCHENGINE"
+ <dt><code>\$search</code><dd>will be replaced with a links to
+ the javascript and style sheets needed for the search engine
+ (or an empty string when \ref cfg_searchengine "SEARCHENGINE"
is disabled).
- <dt><code>\$mathjax</code><dd>will be replaced with a links to
- the javascript and style sheets needed for the MathJax feature
+ <dt><code>\$mathjax</code><dd>will be replaced with a links to
+ the javascript and style sheets needed for the MathJax feature
(or an empty string when \ref cfg_use_mathjax "USE_MATHJAX" is disabled).
<dt><code>\$relpath^</code><dd>
- If \ref cfg_create_subdirs "CREATE_SUBDIRS" is enabled, the command <code>\$relpath^</code> can be
+ If \ref cfg_create_subdirs "CREATE_SUBDIRS" is enabled, the command <code>\$relpath^</code> can be
used to produce a relative path to the root of the HTML output directory,
e.g. use <code>\$relpath^doxygen.css</code>, to refer to the standard style sheet.
</dl>
- To cope with differences in the layout of the header and footer that depend on
- configuration settings, the header can also contain special blocks that
+ To cope with differences in the layout of the header and footer that depend on
+ configuration settings, the header can also contain special blocks that
will be copied to the output or skipped depending on the configuration.
Such blocks have the following form:
\verbatim
@@ -1841,9 +1852,9 @@ doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFil
when the \ref cfg_project_logo "PROJECT_LOGO" option is not empty.
<dt><code>TITLEAREA</code><dd>Content within this block is copied to the output
when a title is visible at the top of each page. This is the case
- if either \ref cfg_project_name "PROJECT_NAME",
- \ref cfg_project_brief "PROJECT_BRIEF", \ref cfg_project_logo "PROJECT_LOGO"
- is filled in or if both \ref cfg_disable_index "DISABLE_INDEX" and
+ if either \ref cfg_project_name "PROJECT_NAME",
+ \ref cfg_project_brief "PROJECT_BRIEF", \ref cfg_project_logo "PROJECT_LOGO"
+ is filled in or if both \ref cfg_disable_index "DISABLE_INDEX" and
\ref cfg_searchengine "SEARCHENGINE" are enabled.
</dl>
]]>
@@ -1858,12 +1869,12 @@ doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFil
<option type='string' id='HTML_FOOTER' format='file' defval='' depends='GENERATE_HTML'>
<docs>
<![CDATA[
- The \c HTML_FOOTER tag can be used to specify a user-defined HTML footer for
- each generated HTML page.
+ The \c HTML_FOOTER tag can be used to specify a user-defined HTML footer for
+ each generated HTML page.
If the tag is left blank doxygen will generate a standard footer.
- See \ref cfg_html_header "HTML_HEADER" for more information on
- how to generate a default footer and what special commands can be
+ See \ref cfg_html_header "HTML_HEADER" for more information on
+ how to generate a default footer and what special commands can be
used inside the footer.
See also section \ref doxygen_usage for information on how to generate
@@ -1874,17 +1885,17 @@ doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFil
<option type='string' id='HTML_STYLESHEET' format='file' defval='' depends='GENERATE_HTML'>
<docs>
<![CDATA[
- The \c HTML_STYLESHEET tag can be used to specify a user-defined cascading
- style sheet that is used by each HTML page. It can be used to
- fine-tune the look of the HTML output. If left blank doxygen
- will generate a default style sheet.
-
+ The \c HTML_STYLESHEET tag can be used to specify a user-defined cascading
+ style sheet that is used by each HTML page. It can be used to
+ fine-tune the look of the HTML output. If left blank doxygen
+ will generate a default style sheet.
+
See also section \ref doxygen_usage for information on how to generate
the style sheet that doxygen normally uses.
- \note It is recommended to use
+ \note It is recommended to use
\ref cfg_html_extra_stylesheet "HTML_EXTRA_STYLESHEET" instead of this tag,
- as it is more robust and
+ as it is more robust and
this tag (<code>HTML_STYLESHEET</code>) will in the future become obsolete.
]]>
</docs>
@@ -1892,12 +1903,12 @@ doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFil
<option type='list' id='HTML_EXTRA_STYLESHEET' format='file' defval='' depends='GENERATE_HTML'>
<docs>
<![CDATA[
- The \c HTML_EXTRA_STYLESHEET tag can be used to specify additional
- user-defined cascading style sheets that are included after the standard
- style sheets created by doxygen. Using this option one can overrule
- certain style aspects. This is preferred over using \ref cfg_html_stylesheet "HTML_STYLESHEET"
- since it does not replace the standard style sheet and is therefore more
- robust against future updates. Doxygen will copy the style sheet files to
+ The \c HTML_EXTRA_STYLESHEET tag can be used to specify additional
+ user-defined cascading style sheets that are included after the standard
+ style sheets created by doxygen. Using this option one can overrule
+ certain style aspects. This is preferred over using \ref cfg_html_stylesheet "HTML_STYLESHEET"
+ since it does not replace the standard style sheet and is therefore more
+ robust against future updates. Doxygen will copy the style sheet files to
the output directory.
\note The order of the extra style sheet files is of importance (e.g. the last
style sheet in the list overrules the setting of the previous ones in the list).
@@ -1946,12 +1957,12 @@ hr.footer {
<option type='list' id='HTML_EXTRA_FILES' format='file' depends='GENERATE_HTML'>
<docs>
<![CDATA[
- The \c HTML_EXTRA_FILES tag can be used to specify one or more extra images or
- other source files which should be copied to the HTML output directory. Note
- that these files will be copied to the base HTML output directory. Use the
+ The \c HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+ other source files which should be copied to the HTML output directory. Note
+ that these files will be copied to the base HTML output directory. Use the
<code>$relpath^</code> marker in the \ref cfg_html_header "HTML_HEADER" and/or
- \ref cfg_html_footer "HTML_FOOTER" files to load these
- files. In the \ref cfg_html_stylesheet "HTML_STYLESHEET" file, use the file name only. Also note that
+ \ref cfg_html_footer "HTML_FOOTER" files to load these
+ files. In the \ref cfg_html_stylesheet "HTML_STYLESHEET" file, use the file name only. Also note that
the files will be copied as-is; there are no commands or markers available.
]]>
</docs>
@@ -1959,32 +1970,32 @@ hr.footer {
<option type='int' id='HTML_COLORSTYLE_HUE' minval='0' maxval='359' defval='220' depends='GENERATE_HTML'>
<docs>
<![CDATA[
- The \c HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
- Doxygen will adjust the colors in the style sheet and background images
- according to this color. Hue is specified as an angle on a colorwheel,
- see https://en.wikipedia.org/wiki/Hue for more information.
- For instance the value 0 represents red, 60 is yellow, 120 is green,
- 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
+ The \c HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
+ Doxygen will adjust the colors in the style sheet and background images
+ according to this color. Hue is specified as an angle on a colorwheel,
+ see https://en.wikipedia.org/wiki/Hue for more information.
+ For instance the value 0 represents red, 60 is yellow, 120 is green,
+ 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
]]>
</docs>
</option>
<option type='int' id='HTML_COLORSTYLE_SAT' minval='0' maxval='255' defval='100' depends='GENERATE_HTML'>
<docs>
<![CDATA[
- The \c HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
- the colors in the HTML output. For a value of 0 the output will use
- grayscales only. A value of 255 will produce the most vivid colors.
+ The \c HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
+ the colors in the HTML output. For a value of 0 the output will use
+ grayscales only. A value of 255 will produce the most vivid colors.
]]>
</docs>
</option>
<option type='int' id='HTML_COLORSTYLE_GAMMA' minval='40' maxval='240' defval='80' depends='GENERATE_HTML'>
<docs>
<![CDATA[
- The \c HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
- the luminance component of the colors in the HTML output. Values below
- 100 gradually make the output lighter, whereas values above 100 make
- the output darker. The value divided by 100 is the actual gamma applied,
- so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
+ The \c HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
+ the luminance component of the colors in the HTML output. Values below
+ 100 gradually make the output lighter, whereas values above 100 make
+ the output darker. The value divided by 100 is the actual gamma applied,
+ so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
and 100 does not change the gamma.
]]>
</docs>
@@ -1992,9 +2003,9 @@ hr.footer {
<option type='bool' id='HTML_TIMESTAMP' defval='0' depends='GENERATE_HTML'>
<docs>
<![CDATA[
- If the \c HTML_TIMESTAMP tag is set to \c YES then the footer of
- each generated HTML page will contain the date and time when the page
- was generated. Setting this to \c YES can help to show when doxygen was last run
+ If the \c HTML_TIMESTAMP tag is set to \c YES then the footer of
+ each generated HTML page will contain the date and time when the page
+ was generated. Setting this to \c YES can help to show when doxygen was last run
and thus if the documentation is up to date.
]]>
</docs>
@@ -2002,11 +2013,11 @@ hr.footer {
<option type='bool' id='HTML_DYNAMIC_MENUS' defval='1' depends='GENERATE_HTML'>
<docs>
<![CDATA[
- If the \c HTML_DYNAMIC_MENUS tag is set to \c YES then the generated HTML
- documentation will contain a main index with vertical navigation menus that
- are dynamically created via Javascript. If disabled, the navigation index will consists of
- multiple levels of tabs that are statically embedded in every HTML page.
- Disable this option to support browsers that do not have Javascript, like
+ If the \c HTML_DYNAMIC_MENUS tag is set to \c YES then the generated HTML
+ documentation will contain a main index with vertical navigation menus that
+ are dynamically created via Javascript. If disabled, the navigation index will consists of
+ multiple levels of tabs that are statically embedded in every HTML page.
+ Disable this option to support browsers that do not have Javascript, like
the Qt help browser.
]]>
</docs>
@@ -2016,20 +2027,20 @@ hr.footer {
<![CDATA[
If the \c HTML_DYNAMIC_SECTIONS tag is set to \c YES then the generated HTML
documentation will contain sections that can be hidden and shown after the
- page has loaded.
+ page has loaded.
]]>
</docs>
</option>
<option type='int' id='HTML_INDEX_NUM_ENTRIES' minval='0' maxval='9999' defval='100' depends='GENERATE_HTML'>
<docs>
<![CDATA[
- With \c HTML_INDEX_NUM_ENTRIES one can control the preferred number of
- entries shown in the various tree structured indices initially; the user
- can expand and collapse entries dynamically later on. Doxygen will expand
- the tree to such a level that at most the specified number of entries are
- visible (unless a fully collapsed tree already exceeds this amount).
- So setting the number of entries 1 will produce a full collapsed tree by
- default. 0 is a special value representing an infinite number of entries
+ With \c HTML_INDEX_NUM_ENTRIES one can control the preferred number of
+ entries shown in the various tree structured indices initially; the user
+ can expand and collapse entries dynamically later on. Doxygen will expand
+ the tree to such a level that at most the specified number of entries are
+ visible (unless a fully collapsed tree already exceeds this amount).
+ So setting the number of entries 1 will produce a full collapsed tree by
+ default. 0 is a special value representing an infinite number of entries
and will result in a full expanded tree by default.
]]>
</docs>
@@ -2038,13 +2049,13 @@ hr.footer {
<docs>
<![CDATA[
If the \c GENERATE_DOCSET tag is set to \c YES, additional index files
- will be generated that can be used as input for
+ will be generated that can be used as input for
<a href="https://developer.apple.com/tools/xcode/">Apple's Xcode 3
integrated development environment</a>, introduced with OSX 10.5 (Leopard).
To create a documentation set, doxygen will generate a Makefile in the
HTML output directory. Running \c make will produce the docset in that
- directory and running <code>make install</code> will install the docset in
- <code>~/Library/Developer/Shared/Documentation/DocSets</code>
+ directory and running <code>make install</code> will install the docset in
+ <code>~/Library/Developer/Shared/Documentation/DocSets</code>
so that Xcode will find it at startup. See
https://developer.apple.com/tools/creatingdocsetswithdoxygen.html for
more information.
@@ -2056,7 +2067,7 @@ hr.footer {
<![CDATA[
This tag determines the name of the docset
feed. A documentation feed provides an umbrella under which multiple
- documentation sets from a single provider (such as a company or product suite)
+ documentation sets from a single provider (such as a company or product suite)
can be grouped.
]]>
</docs>
@@ -2066,7 +2077,7 @@ hr.footer {
<![CDATA[
This tag specifies a string that
should uniquely identify the documentation set bundle. This should be a
- reverse domain-name style string, e.g. <code>com.mycompany.MyDocSet</code>.
+ reverse domain-name style string, e.g. <code>com.mycompany.MyDocSet</code>.
Doxygen will append <code>.docset</code> to the name.
]]>
</docs>
@@ -2075,8 +2086,8 @@ hr.footer {
<docs>
<![CDATA[
The \c DOCSET_PUBLISHER_ID
-tag specifies a string that should uniquely identify
-the documentation publisher. This should be a reverse domain-name style
+tag specifies a string that should uniquely identify
+the documentation publisher. This should be a reverse domain-name style
string, e.g. <code>com.mycompany.MyDocSet.documentation</code>.
]]>
</docs>
@@ -2092,14 +2103,14 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
<docs>
<![CDATA[
If the \c GENERATE_HTMLHELP tag is set to \c YES then
- doxygen generates three additional HTML index files:
- \c index.hhp, \c index.hhc, and \c index.hhk. The \c index.hhp is a
- project file that can be read by
+ doxygen generates three additional HTML index files:
+ \c index.hhp, \c index.hhc, and \c index.hhk. The \c index.hhp is a
+ project file that can be read by
<a href="http://www.microsoft.com/en-us/download/details.aspx?id=21138">
Microsoft's HTML Help Workshop</a>
on Windows.
<br>
- The HTML Help Workshop contains a compiler that can convert all HTML output
+ The HTML Help Workshop contains a compiler that can convert all HTML output
generated by doxygen into a single compiled HTML file (`.chm`). Compiled
HTML files are now used as the Windows 98 help format, and will replace
the old Windows help format (`.hlp`) on all Windows platforms in the future.
@@ -2123,7 +2134,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
<docs>
<![CDATA[
The \c HHC_LOCATION tag can
- be used to specify the location (absolute path including file name) of
+ be used to specify the location (absolute path including file name) of
the HTML help compiler (\c hhc.exe). If non-empty, doxygen will try to run
the HTML help compiler on the generated \c index.hhp.
]]>
@@ -2141,9 +2152,9 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
<option type='string' id='CHM_INDEX_ENCODING' format='string' defval='' depends='GENERATE_HTMLHELP'>
<docs>
<![CDATA[
- The \c CHM_INDEX_ENCODING
- is used to encode HtmlHelp index (\c hhk), content (\c hhc) and project file
- content.
+ The \c CHM_INDEX_ENCODING
+ is used to encode HtmlHelp index (\c hhk), content (\c hhc) and project file
+ content.
]]>
</docs>
</option>
@@ -2160,8 +2171,8 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
<option type='bool' id='TOC_EXPAND' defval='0' depends='GENERATE_HTMLHELP'>
<docs>
<![CDATA[
- The \c TOC_EXPAND flag can be set to \c YES to add extra items for
- group members to the table of contents of the HTML help documentation
+ The \c TOC_EXPAND flag can be set to \c YES to add extra items for
+ group members to the table of contents of the HTML help documentation
and to the tree view.
]]>
</docs>
@@ -2240,15 +2251,15 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
<option type='bool' id='GENERATE_ECLIPSEHELP' defval='0' depends='GENERATE_HTML'>
<docs>
<![CDATA[
- If the \c GENERATE_ECLIPSEHELP tag is set to \c YES, additional index files
- will be generated, together with the HTML files, they form an `Eclipse` help
- plugin.
+ If the \c GENERATE_ECLIPSEHELP tag is set to \c YES, additional index files
+ will be generated, together with the HTML files, they form an `Eclipse` help
+ plugin.
- To install this plugin and make it available under the help contents
- menu in `Eclipse`, the contents of the directory containing the HTML and XML
- files needs to be copied into the plugins directory of eclipse. The name of
- the directory within the plugins directory should be the same as
- the \ref cfg_eclipse_doc_id "ECLIPSE_DOC_ID" value.
+ To install this plugin and make it available under the help contents
+ menu in `Eclipse`, the contents of the directory containing the HTML and XML
+ files needs to be copied into the plugins directory of eclipse. The name of
+ the directory within the plugins directory should be the same as
+ the \ref cfg_eclipse_doc_id "ECLIPSE_DOC_ID" value.
After copying `Eclipse` needs to be restarted before the help appears.
]]>
@@ -2257,8 +2268,8 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
<option type='string' id='ECLIPSE_DOC_ID' format='string' defval='org.doxygen.Project' depends='GENERATE_ECLIPSEHELP'>
<docs>
<![CDATA[
- A unique identifier for the `Eclipse` help plugin. When installing the plugin
- the directory name containing the HTML and XML files should also have
+ A unique identifier for the `Eclipse` help plugin. When installing the plugin
+ the directory name containing the HTML and XML files should also have
this name. Each documentation set should have its own identifier.
]]>
</docs>
@@ -2270,8 +2281,8 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
might be necessary to disable the index and replace it with your own.
The \c DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at
top of each HTML page. A value of \c NO enables the index and the
- value \c YES disables it. Since the tabs in the index contain the same
- information as the navigation tree, you can set this option to \c YES if
+ value \c YES disables it. Since the tabs in the index contain the same
+ information as the navigation tree, you can set this option to \c YES if
you also set \ref cfg_generate_treeview "GENERATE_TREEVIEW" to \c YES.
]]>
</docs>
@@ -2294,7 +2305,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
the \ref cfg_project_name "PROJECT_NAME".
Since the tree basically has the same information as the tab index, you could
- consider setting \ref cfg_disable_index "DISABLE_INDEX" to \c YES when
+ consider setting \ref cfg_disable_index "DISABLE_INDEX" to \c YES when
enabling this option.
]]>
</docs>
@@ -2304,7 +2315,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
<docs>
<![CDATA[
The \c ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
- that doxygen will group on one line in the generated HTML documentation.
+ that doxygen will group on one line in the generated HTML documentation.
<br>Note that a value of 0 will completely suppress the enum values from
appearing in the overview section.
]]>
@@ -2322,8 +2333,8 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
<option type='bool' id='EXT_LINKS_IN_WINDOW' defval='0' depends='GENERATE_HTML'>
<docs>
<![CDATA[
- If the \c EXT_LINKS_IN_WINDOW option is set to \c YES, doxygen will open
- links to external symbols imported via tag files in a separate window.
+ If the \c EXT_LINKS_IN_WINDOW option is set to \c YES, doxygen will open
+ links to external symbols imported via tag files in a separate window.
]]>
</docs>
</option>
@@ -2333,7 +2344,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
Use this tag to change the font size of \f$\mbox{\LaTeX}\f$ formulas included
as images in the HTML documentation.
When you change the font size after a successful doxygen run you need
- to manually remove any `form_*.png` images from the HTML
+ to manually remove any `form_*.png` images from the HTML
output directory to force them to be regenerated.
]]>
</docs>
@@ -2341,23 +2352,23 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
<option type='bool' id='FORMULA_TRANSPARENT' defval='1' depends='GENERATE_HTML'>
<docs>
<![CDATA[
- Use the \c FORMULA_TRANSPARENT tag to determine whether or not the images
- generated for formulas are transparent PNGs. Transparent PNGs are
- not supported properly for IE 6.0, but are supported on all modern browsers.
- <br>Note that when changing this option you need to delete any `form_*.png` files
- in the HTML output directory before the changes have effect.
+ Use the \c FORMULA_TRANSPARENT tag to determine whether or not the images
+ generated for formulas are transparent PNGs. Transparent PNGs are
+ not supported properly for IE 6.0, but are supported on all modern browsers.
+ <br>Note that when changing this option you need to delete any `form_*.png` files
+ in the HTML output directory before the changes have effect.
]]>
</docs>
</option>
<option type='bool' id='USE_MATHJAX' defval='0' depends='GENERATE_HTML'>
<docs>
<![CDATA[
- Enable the \c USE_MATHJAX option to render \f$\mbox{\LaTeX}\f$ formulas using MathJax
- (see https://www.mathjax.org) which uses client side Javascript for the
- rendering instead of using pre-rendered bitmaps. Use this if you do not
- have \f$\mbox{\LaTeX}\f$ installed or if you want to formulas look prettier in the HTML
- output. When enabled you may also need to install MathJax separately and
- configure the path to it using the \ref cfg_mathjax_relpath "MATHJAX_RELPATH"
+ Enable the \c USE_MATHJAX option to render \f$\mbox{\LaTeX}\f$ formulas using MathJax
+ (see https://www.mathjax.org) which uses client side Javascript for the
+ rendering instead of using pre-rendered bitmaps. Use this if you do not
+ have \f$\mbox{\LaTeX}\f$ installed or if you want to formulas look prettier in the HTML
+ output. When enabled you may also need to install MathJax separately and
+ configure the path to it using the \ref cfg_mathjax_relpath "MATHJAX_RELPATH"
option.
]]>
</docs>
@@ -2365,7 +2376,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
<option type='enum' id='MATHJAX_FORMAT' defval='HTML-CSS' depends='USE_MATHJAX'>
<docs>
<![CDATA[
- When MathJax is enabled you can set the default output format to be used for
+ When MathJax is enabled you can set the default output format to be used for
the MathJax output.
See <a href="http://docs.mathjax.org/en/latest/output.html">the MathJax site</a>
for more details.
@@ -2378,13 +2389,13 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
<option type='string' id='MATHJAX_RELPATH' format='string' defval='https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/' depends='USE_MATHJAX'>
<docs>
<![CDATA[
- When MathJax is enabled you need to specify the location relative to the
- HTML output directory using the \c MATHJAX_RELPATH option. The destination
- directory should contain the `MathJax.js` script. For instance, if the \c mathjax
- directory is located at the same level as the HTML output directory, then
- \c MATHJAX_RELPATH should be <code>../mathjax</code>. The default value points to
- the MathJax Content Delivery Network so you can quickly see the result without
- installing MathJax. However, it is strongly recommended to install a local
+ When MathJax is enabled you need to specify the location relative to the
+ HTML output directory using the \c MATHJAX_RELPATH option. The destination
+ directory should contain the `MathJax.js` script. For instance, if the \c mathjax
+ directory is located at the same level as the HTML output directory, then
+ \c MATHJAX_RELPATH should be <code>../mathjax</code>. The default value points to
+ the MathJax Content Delivery Network so you can quickly see the result without
+ installing MathJax. However, it is strongly recommended to install a local
copy of MathJax from https://www.mathjax.org before deployment.
]]>
</docs>
@@ -2392,7 +2403,7 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
<option type='list' id='MATHJAX_EXTENSIONS' format='string' depends='USE_MATHJAX'>
<docs>
<![CDATA[
- The \c MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax extension
+ The \c MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax extension
names that should be enabled during MathJax rendering. For example
\verbatim
MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
@@ -2403,9 +2414,9 @@ MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
<option type='string' id='MATHJAX_CODEFILE' format='string' depends='USE_MATHJAX'>
<docs>
<![CDATA[
- The \c MATHJAX_CODEFILE tag can be used to specify a file with javascript
- pieces of code that will be used on startup of the MathJax code.
- See
+ The \c MATHJAX_CODEFILE tag can be used to specify a file with javascript
+ pieces of code that will be used on startup of the MathJax code.
+ See
<a href="http://docs.mathjax.org/en/latest/output.html">the MathJax site</a>
for more details.
]]>
@@ -2422,7 +2433,7 @@ MATHJAX_CODEFILE = disableRenderer.js
MathJax.Hub.Config({
menuSettings: {
showRenderer: false,
- }
+ }
});
\endverbatim
]]>
@@ -2437,24 +2448,24 @@ MATHJAX_CODEFILE = disableRenderer.js
<docs>
<![CDATA[
When the \c SEARCHENGINE tag is enabled doxygen will generate a search box
- for the HTML output. The underlying search engine uses javascript
+ for the HTML output. The underlying search engine uses javascript
and DHTML and should work on any modern browser. Note that when using
- HTML help (\ref cfg_generate_htmlhelp "GENERATE_HTMLHELP"),
+ HTML help (\ref cfg_generate_htmlhelp "GENERATE_HTMLHELP"),
Qt help (\ref cfg_generate_qhp "GENERATE_QHP"), or docsets
- (\ref cfg_generate_docset "GENERATE_DOCSET") there is already a search
- function so this one should typically be disabled. For large projects
- the javascript based search engine can be slow, then enabling
- \ref cfg_server_based_search "SERVER_BASED_SEARCH" may provide a
- better solution.
+ (\ref cfg_generate_docset "GENERATE_DOCSET") there is already a search
+ function so this one should typically be disabled. For large projects
+ the javascript based search engine can be slow, then enabling
+ \ref cfg_server_based_search "SERVER_BASED_SEARCH" may provide a
+ better solution.
It is possible to search using the keyboard;
to jump to the search box use <code>\<access key\> + S</code> (what the <code>\<access key\></code> is
depends on the OS and browser, but it is typically <code>\<CTRL\></code>, <code>\<ALT\></code>/<code>\<option\></code>, or both).
- Inside the search box use the <code>\<cursor down key\></code> to jump into the search
+ Inside the search box use the <code>\<cursor down key\></code> to jump into the search
results window, the results can be navigated using the <code>\<cursor keys\></code>.
Press <code>\<Enter\></code> to select an item or <code>\<escape\></code> to cancel the search. The
filter options can be selected when the cursor is inside the search box
- by pressing <code>\<Shift\>+\<cursor down\></code>. Also here use the <code>\<cursor keys\></code> to
+ by pressing <code>\<Shift\>+\<cursor down\></code>. Also here use the <code>\<cursor keys\></code> to
select a filter and <code>\<Enter\></code> or <code>\<escape\></code> to activate or cancel the filter option.
]]>
</docs>
@@ -2462,14 +2473,14 @@ MATHJAX_CODEFILE = disableRenderer.js
<option type='bool' id='SERVER_BASED_SEARCH' defval='0' depends='SEARCHENGINE'>
<docs>
<![CDATA[
-When the \c SERVER_BASED_SEARCH tag is enabled the search engine will be
-implemented using a web server instead of a web client using Javascript.
+When the \c SERVER_BASED_SEARCH tag is enabled the search engine will be
+implemented using a web server instead of a web client using Javascript.
-There are two flavors of web server based searching depending on the
-\ref cfg_external_search "EXTERNAL_SEARCH" setting. When disabled,
-doxygen will generate a PHP script for searching and an index file used
-by the script. When \ref cfg_external_search "EXTERNAL_SEARCH" is
-enabled the indexing and searching needs to be provided by external tools.
+There are two flavors of web server based searching depending on the
+\ref cfg_external_search "EXTERNAL_SEARCH" setting. When disabled,
+doxygen will generate a PHP script for searching and an index file used
+by the script. When \ref cfg_external_search "EXTERNAL_SEARCH" is
+enabled the indexing and searching needs to be provided by external tools.
See the section \ref extsearch for details.
]]>
</docs>
@@ -2477,14 +2488,14 @@ See the section \ref extsearch for details.
<option type='bool' id='EXTERNAL_SEARCH' defval='0' depends='SEARCHENGINE'>
<docs>
<![CDATA[
- When \c EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
- script for searching. Instead the search results are written to an XML file
- which needs to be processed by an external indexer. Doxygen will invoke an
- external search engine pointed to by the
- \ref cfg_searchengine_url "SEARCHENGINE_URL" option to obtain
+ When \c EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
+ script for searching. Instead the search results are written to an XML file
+ which needs to be processed by an external indexer. Doxygen will invoke an
+ external search engine pointed to by the
+ \ref cfg_searchengine_url "SEARCHENGINE_URL" option to obtain
the search results.
- <br>Doxygen ships with an example indexer (\c doxyindexer) and
- search engine (<code>doxysearch.cgi</code>) which are based on the open source search
+ <br>Doxygen ships with an example indexer (\c doxyindexer) and
+ search engine (<code>doxysearch.cgi</code>) which are based on the open source search
engine library <a href="https://xapian.org/">Xapian</a>.
<br>See the section \ref extsearch for details.
]]>
@@ -2493,11 +2504,11 @@ See the section \ref extsearch for details.
<option type='string' id='SEARCHENGINE_URL' format='string' defval='' depends='SEARCHENGINE'>
<docs>
<![CDATA[
- The \c SEARCHENGINE_URL should point to a search engine hosted by a web server
- which will return the search results when \ref cfg_external_search "EXTERNAL_SEARCH"
+ The \c SEARCHENGINE_URL should point to a search engine hosted by a web server
+ which will return the search results when \ref cfg_external_search "EXTERNAL_SEARCH"
is enabled.
- <br>Doxygen ships with an example indexer (\c doxyindexer) and
- search engine (<code>doxysearch.cgi</code>) which are based on the open source search
+ <br>Doxygen ships with an example indexer (\c doxyindexer) and
+ search engine (<code>doxysearch.cgi</code>) which are based on the open source search
engine library <a href="https://xapian.org/">Xapian</a>.
See the section \ref extsearch for details.
]]>
@@ -2506,9 +2517,9 @@ See the section \ref extsearch for details.
<option type='string' id='SEARCHDATA_FILE' format='file' defval='searchdata.xml' depends='SEARCHENGINE'>
<docs>
<![CDATA[
-When \ref cfg_server_based_search "SERVER_BASED_SEARCH" and
-\ref cfg_external_search "EXTERNAL_SEARCH" are both enabled the unindexed
-search data is written to a file for indexing by an external tool. With the
+When \ref cfg_server_based_search "SERVER_BASED_SEARCH" and
+\ref cfg_external_search "EXTERNAL_SEARCH" are both enabled the unindexed
+search data is written to a file for indexing by an external tool. With the
\c SEARCHDATA_FILE tag the name of this file can be specified.
]]>
</docs>
@@ -2516,10 +2527,10 @@ search data is written to a file for indexing by an external tool. With the
<option type='string' id='EXTERNAL_SEARCH_ID' format='string' defval='' depends='SEARCHENGINE'>
<docs>
<![CDATA[
-When \ref cfg_server_based_search "SERVER_BASED_SEARCH" and
-\ref cfg_external_search "EXTERNAL_SEARCH" are both enabled the
-\c EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
-useful in combination with \ref cfg_extra_search_mappings "EXTRA_SEARCH_MAPPINGS"
+When \ref cfg_server_based_search "SERVER_BASED_SEARCH" and
+\ref cfg_external_search "EXTERNAL_SEARCH" are both enabled the
+\c EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
+useful in combination with \ref cfg_extra_search_mappings "EXTRA_SEARCH_MAPPINGS"
to search through multiple projects and redirect the results back to the right project.
]]>
</docs>
@@ -2527,16 +2538,16 @@ to search through multiple projects and redirect the results back to the right p
<option type='list' id='EXTRA_SEARCH_MAPPINGS' format='string' depends='SEARCHENGINE'>
<docs>
<![CDATA[
- The \c EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
- projects other than the one defined by this configuration file, but that are
- all added to the same external search index. Each project needs to have a
- unique id set via \ref cfg_external_search_id "EXTERNAL_SEARCH_ID".
- The search mapping then maps the id of to a relative location where the
- documentation can be found.
+ The \c EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
+ projects other than the one defined by this configuration file, but that are
+ all added to the same external search index. Each project needs to have a
+ unique id set via \ref cfg_external_search_id "EXTERNAL_SEARCH_ID".
+ The search mapping then maps the id of to a relative location where the
+ documentation can be found.
- The format is:
+ The format is:
\verbatim
-EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
+EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
\endverbatim
]]>
</docs>
@@ -2554,7 +2565,7 @@ EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
<option type='string' id='LATEX_OUTPUT' format='dir' defval='latex' depends='GENERATE_LATEX'>
<docs>
<![CDATA[
- The \c LATEX_OUTPUT tag is used to specify where the \f$\mbox{\LaTeX}\f$
+ The \c LATEX_OUTPUT tag is used to specify where the \f$\mbox{\LaTeX}\f$
docs will be put.
If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be
put in front of it.
@@ -2564,7 +2575,7 @@ EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
<option type='string' id='LATEX_CMD_NAME' format='file' defval='' depends='GENERATE_LATEX'>
<docs>
<![CDATA[
- The \c LATEX_CMD_NAME tag can be used to specify the \f$\mbox{\LaTeX}\f$ command name to be invoked.
+ The \c LATEX_CMD_NAME tag can be used to specify the \f$\mbox{\LaTeX}\f$ command name to be invoked.
<br>Note that when not enabling \ref cfg_use_pdflatex "USE_PDFLATEX" the default is \c latex when
enabling \ref cfg_use_pdflatex "USE_PDFLATEX" the default is \c pdflatex and when in the later case
\c latex is chosen this is overwritten by \c pdflatex. For specific output languages the default can
@@ -2575,7 +2586,7 @@ EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
<option type='string' id='MAKEINDEX_CMD_NAME' format='file' defval='makeindex' depends='GENERATE_LATEX'>
<docs>
<![CDATA[
- The \c MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+ The \c MAKEINDEX_CMD_NAME tag can be used to specify the command name to
generate index for \f$\mbox{\LaTeX}\f$.
@note This tag is used in the `Makefile` / `make.bat`.
@@ -2586,7 +2597,7 @@ EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
<option type='string' id='LATEX_MAKEINDEX_CMD' defval='\makeindex' depends='GENERATE_LATEX'>
<docs>
<![CDATA[
- The \c LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
+ The \c LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
generate index for \f$\mbox{\LaTeX}\f$.
@note This tag is used in the generated output file (`.tex`).
@@ -2618,7 +2629,7 @@ EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
<option type='list' id='EXTRA_PACKAGES' format='string' depends='GENERATE_LATEX'>
<docs>
<![CDATA[
- The \c EXTRA_PACKAGES tag can be used to specify one or more \f$\mbox{\LaTeX}\f$
+ The \c EXTRA_PACKAGES tag can be used to specify one or more \f$\mbox{\LaTeX}\f$
package names that should be included in the \f$\mbox{\LaTeX}\f$ output. The package
can be specified just by its name or with the correct syntax as to be used with the
\f$\mbox{\LaTeX}\f$ `\usepackage` command.
@@ -2626,7 +2637,7 @@ EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
To get the `times` font for instance you can specify :
\verbatim
EXTRA_PACKAGES=times
-or
+or
EXTRA_PACKAGES={times}
\endverbatim
To use the option `intlimits` with the `amsmath` package you can specify:
@@ -2640,21 +2651,21 @@ or
<option type='string' id='LATEX_HEADER' format='file' defval='' depends='GENERATE_LATEX'>
<docs>
<![CDATA[
- The \c LATEX_HEADER tag can be used to specify a personal \f$\mbox{\LaTeX}\f$
- header for the generated \f$\mbox{\LaTeX}\f$ document.
- The header should contain everything until the first chapter.
+ The \c LATEX_HEADER tag can be used to specify a personal \f$\mbox{\LaTeX}\f$
+ header for the generated \f$\mbox{\LaTeX}\f$ document.
+ The header should contain everything until the first chapter.
- If it is left blank doxygen will generate a
- standard header. See section \ref doxygen_usage for information on how to
+ If it is left blank doxygen will generate a
+ standard header. See section \ref doxygen_usage for information on how to
let doxygen write the default header to a separate file.
-
+
<br>Note: Only use a user-defined header if you know what you are doing!
The following commands have a special meaning inside the header:
<code>\$title</code>, <code>\$datetime</code>, <code>\$date</code>,
- <code>\$doxygenversion</code>, <code>\$projectname</code>,
- <code>\$projectnumber</code>, <code>\$projectbrief</code>,
- <code>\$projectlogo</code>.
+ <code>\$doxygenversion</code>, <code>\$projectname</code>,
+ <code>\$projectnumber</code>, <code>\$projectbrief</code>,
+ <code>\$projectlogo</code>.
Doxygen will replace <code>\$title</code> with the empty string, for the replacement values of the
other commands the user is referred to \ref cfg_html_header "HTML_HEADER".
]]>
@@ -2663,14 +2674,14 @@ or
<option type='string' id='LATEX_FOOTER' format='file' defval='' depends='GENERATE_LATEX'>
<docs>
<![CDATA[
- The \c LATEX_FOOTER tag can be used to specify a personal \f$\mbox{\LaTeX}\f$ footer for
- the generated \f$\mbox{\LaTeX}\f$ document. The footer should contain everything after
- the last chapter. If it is left blank doxygen will generate a
+ The \c LATEX_FOOTER tag can be used to specify a personal \f$\mbox{\LaTeX}\f$ footer for
+ the generated \f$\mbox{\LaTeX}\f$ document. The footer should contain everything after
+ the last chapter. If it is left blank doxygen will generate a
standard footer.
- See \ref cfg_latex_header "LATEX_HEADER" for more information on
- how to generate a default footer and what special commands can be
+ See \ref cfg_latex_header "LATEX_HEADER" for more information on
+ how to generate a default footer and what special commands can be
used inside the footer.
-
+
<br>Note: Only use a user-defined footer if you know what you are doing!
]]>
</docs>
@@ -2678,10 +2689,10 @@ or
<option type='list' id='LATEX_EXTRA_STYLESHEET' format='file' defval='' depends='GENERATE_LATEX'>
<docs>
<![CDATA[
- The \c LATEX_EXTRA_STYLESHEET tag can be used to specify additional
- user-defined \f$\mbox{\LaTeX}\f$ style sheets that are included after the standard
- style sheets created by doxygen. Using this option one can overrule
- certain style aspects. Doxygen will copy the style sheet files to
+ The \c LATEX_EXTRA_STYLESHEET tag can be used to specify additional
+ user-defined \f$\mbox{\LaTeX}\f$ style sheets that are included after the standard
+ style sheets created by doxygen. Using this option one can overrule
+ certain style aspects. Doxygen will copy the style sheet files to
the output directory.
\note The order of the extra style sheet files is of importance (e.g. the last
style sheet in the list overrules the setting of the previous ones in the list).
@@ -2702,8 +2713,8 @@ or
<option type='bool' id='PDF_HYPERLINKS' defval='1' depends='GENERATE_LATEX'>
<docs>
<![CDATA[
- If the \c PDF_HYPERLINKS tag is set to \c YES, the \f$\mbox{\LaTeX}\f$ that
- is generated is prepared for conversion to PDF (using \c ps2pdf or \c pdflatex).
+ If the \c PDF_HYPERLINKS tag is set to \c YES, the \f$\mbox{\LaTeX}\f$ that
+ is generated is prepared for conversion to PDF (using \c ps2pdf or \c pdflatex).
The PDF file will
contain links (just like the HTML output) instead of page references.
This makes the output suitable for online browsing using a PDF viewer.
@@ -2715,7 +2726,7 @@ or
<![CDATA[
If the \c USE_PDFLATEX tag is set to \c YES, doxygen will use
\c pdflatex to generate the PDF file directly from the \f$\mbox{\LaTeX}\f$
- files. Set this option to \c YES, to get a higher quality PDF documentation.
+ files. Set this option to \c YES, to get a higher quality PDF documentation.
]]>
</docs>
</option>
@@ -2723,9 +2734,9 @@ or
<docs>
<![CDATA[
If the \c LATEX_BATCHMODE tag is set to \c YES, doxygen will add the \c \\batchmode
- command to the generated \f$\mbox{\LaTeX}\f$ files. This will
- instruct \f$\mbox{\LaTeX}\f$ to keep running if errors occur, instead of
- asking the user for help. This option is also used when generating formulas
+ command to the generated \f$\mbox{\LaTeX}\f$ files. This will
+ instruct \f$\mbox{\LaTeX}\f$ to keep running if errors occur, instead of
+ asking the user for help. This option is also used when generating formulas
in HTML.
]]>
</docs>
@@ -2734,17 +2745,17 @@ or
<docs>
<![CDATA[
If the \c LATEX_HIDE_INDICES tag is set to \c YES then doxygen will not
- include the index chapters (such as File Index, Compound Index, etc.)
- in the output.
+ include the index chapters (such as File Index, Compound Index, etc.)
+ in the output.
]]>
</docs>
</option>
<option type='bool' id='LATEX_SOURCE_CODE' defval='0' depends='GENERATE_LATEX'>
<docs>
<![CDATA[
- If the \c LATEX_SOURCE_CODE tag is set to \c YES then doxygen will include
- source code with syntax highlighting in the \f$\mbox{\LaTeX}\f$ output.
- <br>Note that which sources are shown also depends on other settings
+ If the \c LATEX_SOURCE_CODE tag is set to \c YES then doxygen will include
+ source code with syntax highlighting in the \f$\mbox{\LaTeX}\f$ output.
+ <br>Note that which sources are shown also depends on other settings
such as \ref cfg_source_browser "SOURCE_BROWSER".
]]>
</docs>
@@ -2752,8 +2763,8 @@ or
<option type='string' id='LATEX_BIB_STYLE' format='string' defval='plain' depends='GENERATE_LATEX'>
<docs>
<![CDATA[
- The \c LATEX_BIB_STYLE tag can be used to specify the style to use for the
- bibliography, e.g. \c plainnat, or \c ieeetr.
+ The \c LATEX_BIB_STYLE tag can be used to specify the style to use for the
+ bibliography, e.g. \c plainnat, or \c ieeetr.
See https://en.wikipedia.org/wiki/BibTeX and \ref cmdcite "\\cite"
for more info.
]]>
@@ -2828,8 +2839,8 @@ or
<docs>
<![CDATA[
Set optional variables used in the generation of an RTF document.
- Syntax is similar to doxygen's configuration file.
- A template extensions file can be generated using
+ Syntax is similar to doxygen's configuration file.
+ A template extensions file can be generated using
<code>doxygen -e rtf extensionFile</code>.
]]>
</docs>
@@ -2859,8 +2870,8 @@ or
<![CDATA[
The \c MAN_OUTPUT tag is used to specify where the man pages will be put.
If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be
- put in front of it.
- A directory \c man3 will be created inside the directory specified by
+ put in front of it.
+ A directory \c man3 will be created inside the directory specified by
\c MAN_OUTPUT.
]]>
</docs>
@@ -2887,10 +2898,10 @@ or
<option type='bool' id='MAN_LINKS' defval='0' depends='GENERATE_MAN'>
<docs>
<![CDATA[
- If the \c MAN_LINKS tag is set to \c YES and doxygen generates man output,
- then it will generate one additional man file for each entity documented in
- the real man page(s). These additional files only source the real man page,
- but without them the \c man command would be unable to find the correct page.
+ If the \c MAN_LINKS tag is set to \c YES and doxygen generates man output,
+ then it will generate one additional man file for each entity documented in
+ the real man page(s). These additional files only source the real man page,
+ but without them the \c man command would be unable to find the correct page.
]]>
</docs>
</option>
@@ -2901,15 +2912,15 @@ or
<![CDATA[
If the \c GENERATE_XML tag is set to \c YES, doxygen will
generate an XML file that captures the structure of
- the code including all documentation.
+ the code including all documentation.
]]>
</docs>
</option>
<option type='string' id='XML_OUTPUT' format='dir' defval='xml' depends='GENERATE_XML'>
<docs>
<![CDATA[
- The \c XML_OUTPUT tag is used to specify where the XML pages will be put.
- If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be
+ The \c XML_OUTPUT tag is used to specify where the XML pages will be put.
+ If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be
put in front of it.
]]>
</docs>
@@ -2929,7 +2940,7 @@ or
<option type='bool' id='GENERATE_DOCBOOK' defval='0'>
<docs>
<![CDATA[
-If the \c GENERATE_DOCBOOK tag is set to \c YES, doxygen will generate Docbook files
+If the \c GENERATE_DOCBOOK tag is set to \c YES, doxygen will generate Docbook files
that can be used to generate PDF.
]]>
</docs>
@@ -2937,8 +2948,8 @@ that can be used to generate PDF.
<option type='string' id='DOCBOOK_OUTPUT' format='dir' defval='docbook' depends='GENERATE_DOCBOOK'>
<docs>
<![CDATA[
-The \c DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
-If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be put in
+The \c DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
+If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be put in
front of it.
]]>
</docs>
@@ -2961,8 +2972,8 @@ front of it.
If the \c GENERATE_AUTOGEN_DEF tag is set to \c YES, doxygen will
generate an AutoGen Definitions (see http://autogen.sourceforge.net/) file
that captures the structure of the code including all
- documentation. Note that this feature is still experimental
- and incomplete at the moment.
+ documentation. Note that this feature is still experimental
+ and incomplete at the moment.
]]>
</docs>
</option>
@@ -2980,8 +2991,8 @@ If the \c GENERATE_SQLITE3 tag is set to \c YES doxygen will generate a
<option type='string' id='SQLITE3_OUTPUT' format='dir' defval='sqlite3' depends='GENERATE_SQLITE3'>
<docs>
<![CDATA[
-The \c SQLITE3_OUTPUT tag is used to specify where the \c Sqlite3 database will be put.
-If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be
+The \c SQLITE3_OUTPUT tag is used to specify where the \c Sqlite3 database will be put.
+If a relative path is entered the value of \ref cfg_output_directory "OUTPUT_DIRECTORY" will be
put in front of it.
]]>
</docs>
@@ -2996,7 +3007,7 @@ put in front of it.
If the \c GENERATE_PERLMOD tag is set to \c YES, doxygen will
generate a Perl module file that captures the structure of
the code including all documentation.
- <br>Note that this
+ <br>Note that this
feature is still experimental and incomplete at the
moment.
]]>
@@ -3005,28 +3016,28 @@ put in front of it.
<option type='bool' id='PERLMOD_LATEX' defval='0' depends='GENERATE_PERLMOD'>
<docs>
<![CDATA[
- If the \c PERLMOD_LATEX tag is set to \c YES, doxygen will generate
- the necessary \c Makefile rules, \c Perl scripts and \f$\mbox{\LaTeX}\f$ code to be able
- to generate PDF and DVI output from the Perl module output.
+ If the \c PERLMOD_LATEX tag is set to \c YES, doxygen will generate
+ the necessary \c Makefile rules, \c Perl scripts and \f$\mbox{\LaTeX}\f$ code to be able
+ to generate PDF and DVI output from the Perl module output.
]]>
</docs>
</option>
<option type='bool' id='PERLMOD_PRETTY' defval='1' depends='GENERATE_PERLMOD'>
<docs>
<![CDATA[
- If the \c PERLMOD_PRETTY tag is set to \c YES, the Perl module output will be
- nicely formatted so it can be parsed by a human reader. This is useful
+ If the \c PERLMOD_PRETTY tag is set to \c YES, the Perl module output will be
+ nicely formatted so it can be parsed by a human reader. This is useful
if you want to understand what is going on. On the other hand, if this
tag is set to \c NO, the size of the Perl module output will be much smaller
- and Perl will parse it just the same.
+ and Perl will parse it just the same.
]]>
</docs>
</option>
<option type='string' id='PERLMOD_MAKEVAR_PREFIX' format='string' defval='' depends='GENERATE_PERLMOD'>
<docs>
<![CDATA[
- The names of the make variables in the generated `doxyrules.make` file
- are prefixed with the string contained in \c PERLMOD_MAKEVAR_PREFIX.
+ The names of the make variables in the generated `doxyrules.make` file
+ are prefixed with the string contained in \c PERLMOD_MAKEVAR_PREFIX.
This is useful so different `doxyrules.make` files included by the same
`Makefile` don't overwrite each other's variables.
]]>
@@ -3039,7 +3050,7 @@ put in front of it.
<![CDATA[
If the \c ENABLE_PREPROCESSING tag is set to \c YES, doxygen will
evaluate all C-preprocessor directives found in the sources and include
- files.
+ files.
]]>
</docs>
</option>
@@ -3047,7 +3058,7 @@ put in front of it.
<docs>
<![CDATA[
If the \c MACRO_EXPANSION tag is set to \c YES, doxygen will expand all macro
- names in the source code. If set to \c NO, only conditional
+ names in the source code. If set to \c NO, only conditional
compilation will be performed. Macro expansion can be done in a controlled
way by setting \ref cfg_expand_only_predef "EXPAND_ONLY_PREDEF" to \c YES.
]]>
@@ -3082,10 +3093,10 @@ put in front of it.
<option type='list' id='INCLUDE_FILE_PATTERNS' format='string' depends='ENABLE_PREPROCESSING'>
<docs>
<![CDATA[
- You can use the \c INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
- patterns (like `*.h` and `*.hpp`) to filter out the header-files in the
- directories. If left blank, the patterns specified with \ref cfg_file_patterns "FILE_PATTERNS" will
- be used.
+ You can use the \c INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+ patterns (like `*.h` and `*.hpp`) to filter out the header-files in the
+ directories. If left blank, the patterns specified with \ref cfg_file_patterns "FILE_PATTERNS" will
+ be used.
]]>
</docs>
</option>
@@ -3095,7 +3106,7 @@ put in front of it.
The \c PREDEFINED tag can be used to specify one or more macro names that
are defined before the preprocessor is started (similar to the `-D` option of
e.g. \c gcc). The argument of the tag is a list of macros of the form:
- <code>name</code> or <code>name=definition</code> (no spaces).
+ <code>name</code> or <code>name=definition</code> (no spaces).
If the definition and the \c "=" are omitted, \c "=1" is assumed. To prevent
a macro definition from being undefined via \c \#undef or recursively expanded
use the <code>:=</code> operator instead of the \c = operator.
@@ -3110,18 +3121,18 @@ put in front of it.
this tag can be used to specify a list of macro names that should be expanded.
The macro definition that is found in the sources will be used.
Use the \ref cfg_predefined "PREDEFINED" tag if you want to use a different macro definition that
- overrules the definition found in the source code.
+ overrules the definition found in the source code.
]]>
</docs>
</option>
<option type='bool' id='SKIP_FUNCTION_MACROS' defval='1' depends='ENABLE_PREPROCESSING'>
<docs>
<![CDATA[
- If the \c SKIP_FUNCTION_MACROS tag is set to \c YES then
- doxygen's preprocessor will remove all references to function-like macros that are alone
- on a line, have an all uppercase name, and do not end with a semicolon.
- Such function macros are typically
- used for boiler-plate code, and will confuse the parser if not removed.
+ If the \c SKIP_FUNCTION_MACROS tag is set to \c YES then
+ doxygen's preprocessor will remove all references to function-like macros that are alone
+ on a line, have an all uppercase name, and do not end with a semicolon.
+ Such function macros are typically
+ used for boiler-plate code, and will confuse the parser if not removed.
]]>
</docs>
</option>
@@ -3130,25 +3141,25 @@ put in front of it.
<option type='list' id='TAGFILES' format='file'>
<docs>
<![CDATA[
- The \c TAGFILES tag can be used to specify one or more tag files.
+ The \c TAGFILES tag can be used to specify one or more tag files.
-For each
-tag file the location of the external documentation should be added. The
-format of a tag file without this location is as follows:
+For each
+tag file the location of the external documentation should be added. The
+format of a tag file without this location is as follows:
\verbatim
- TAGFILES = file1 file2 ...
+ TAGFILES = file1 file2 ...
\endverbatim
-Adding location for the tag files is done as follows:
+Adding location for the tag files is done as follows:
\verbatim
- TAGFILES = file1=loc1 "file2 = loc2" ...
+ TAGFILES = file1=loc1 "file2 = loc2" ...
\endverbatim
where `loc1` and `loc2` can be relative or absolute paths or URLs.
See the section \ref external for more information about the use of tag files.
\note
- Each tag file must have a unique name
+ Each tag file must have a unique name
(where the name does \e NOT include the path).
- If a tag file is not located in the directory in which doxygen
+ If a tag file is not located in the directory in which doxygen
is run, you must also specify the path to the tagfile here.
]]>
</docs>
@@ -3158,7 +3169,7 @@ where `loc1` and `loc2` can be relative or absolute paths or URLs.
<![CDATA[
When a file name is specified after \c GENERATE_TAGFILE, doxygen will create
a tag file that is based on the input files it reads.
- See section \ref external for more information about the usage of
+ See section \ref external for more information about the usage of
tag files.
]]>
</docs>
@@ -3184,9 +3195,9 @@ where `loc1` and `loc2` can be relative or absolute paths or URLs.
<option type='bool' id='EXTERNAL_PAGES' defval='1'>
<docs>
<![CDATA[
- If the \c EXTERNAL_PAGES tag is set to \c YES, all external pages will be listed
- in the related pages index. If set to \c NO, only the current project's
- pages will be listed.
+ If the \c EXTERNAL_PAGES tag is set to \c YES, all external pages will be listed
+ in the related pages index. If set to \c NO, only the current project's
+ pages will be listed.
]]>
</docs>
</option>
@@ -3205,19 +3216,19 @@ where `loc1` and `loc2` can be relative or absolute paths or URLs.
<![CDATA[
If the \c CLASS_DIAGRAMS tag is set to \c YES, doxygen will
generate a class diagram (in HTML and \f$\mbox{\LaTeX}\f$) for classes with base or
- super classes. Setting the tag to \c NO turns the diagrams off. Note that
- this option also works with \ref cfg_have_dot "HAVE_DOT" disabled, but it is recommended to
- install and use \c dot, since it yields more powerful graphs.
+ super classes. Setting the tag to \c NO turns the diagrams off. Note that
+ this option also works with \ref cfg_have_dot "HAVE_DOT" disabled, but it is recommended to
+ install and use \c dot, since it yields more powerful graphs.
]]>
</docs>
</option>
<option type='string' id='MSCGEN_PATH' format='dir' defval=''>
<docs>
<![CDATA[
- You can define message sequence charts within doxygen comments using the \ref cmdmsc "\\msc"
- command. Doxygen will then run the <a href="http://www.mcternan.me.uk/mscgen/">mscgen tool</a>) to
- produce the chart and insert it in the documentation. The <code>MSCGEN_PATH</code> tag allows you to
- specify the directory where the \c mscgen tool resides. If left empty the tool is assumed to
+ You can define message sequence charts within doxygen comments using the \ref cmdmsc "\\msc"
+ command. Doxygen will then run the <a href="http://www.mcternan.me.uk/mscgen/">mscgen tool</a>) to
+ produce the chart and insert it in the documentation. The <code>MSCGEN_PATH</code> tag allows you to
+ specify the directory where the \c mscgen tool resides. If left empty the tool is assumed to
be found in the default search path.
]]>
</docs>
@@ -3225,9 +3236,9 @@ where `loc1` and `loc2` can be relative or absolute paths or URLs.
<option type='string' id='DIA_PATH' format='dir' defval=''>
<docs>
<![CDATA[
-You can include diagrams made with dia in doxygen documentation. Doxygen will then run
-dia to produce the diagram and insert it in the documentation. The DIA_PATH tag allows
-you to specify the directory where the dia binary resides. If left empty dia is assumed
+You can include diagrams made with dia in doxygen documentation. Doxygen will then run
+dia to produce the diagram and insert it in the documentation. The DIA_PATH tag allows
+you to specify the directory where the dia binary resides. If left empty dia is assumed
to be found in the default search path.
]]>
</docs>
@@ -3245,9 +3256,9 @@ to be found in the default search path.
<docs>
<![CDATA[
If you set the \c HAVE_DOT tag to \c YES then doxygen will assume the \c dot tool is
- available from the \c path. This tool is part of
- <a href="http://www.graphviz.org/">Graphviz</a>, a graph
- visualization toolkit from AT\&T and Lucent Bell Labs. The other options in
+ available from the \c path. This tool is part of
+ <a href="http://www.graphviz.org/">Graphviz</a>, a graph
+ visualization toolkit from AT\&T and Lucent Bell Labs. The other options in
this section have no effect if this option is set to \c NO
]]>
</docs>
@@ -3255,11 +3266,11 @@ to be found in the default search path.
<option type='int' id='DOT_NUM_THREADS' defval='0' minval='0' maxval='32' depends='HAVE_DOT'>
<docs>
<![CDATA[
- The \c DOT_NUM_THREADS specifies the number of \c dot invocations doxygen is
- allowed to run in parallel. When set to \c 0 doxygen will
- base this on the number of processors available in the system. You can set it
- explicitly to a value larger than 0 to get control over the balance
- between CPU load and processing speed.
+ The \c DOT_NUM_THREADS specifies the number of \c dot invocations doxygen is
+ allowed to run in parallel. When set to \c 0 doxygen will
+ base this on the number of processors available in the system. You can set it
+ explicitly to a value larger than 0 to get control over the balance
+ between CPU load and processing speed.
]]>
</docs>
</option>
@@ -3267,11 +3278,11 @@ to be found in the default search path.
<docs>
<![CDATA[
When you want a differently looking font in the dot files that doxygen generates
- you can specify the font name
- using \c DOT_FONTNAME. You need to make sure dot is able to find the font,
- which can be done by putting it in a standard location or by setting the
- \c DOTFONTPATH environment variable or by setting \ref cfg_dot_fontpath "DOT_FONTPATH" to the
- directory containing the font.
+ you can specify the font name
+ using \c DOT_FONTNAME. You need to make sure dot is able to find the font,
+ which can be done by putting it in a standard location or by setting the
+ \c DOTFONTPATH environment variable or by setting \ref cfg_dot_fontpath "DOT_FONTPATH" to the
+ directory containing the font.
]]>
</docs>
</option>
@@ -3286,8 +3297,8 @@ to be found in the default search path.
<docs>
<![CDATA[
By default doxygen will tell \c dot to use the default font as specified with \ref cfg_dot_fontname "DOT_FONTNAME".
- If you specify a
- different font using \ref cfg_dot_fontname "DOT_FONTNAME" you can set the path where \c dot
+ If you specify a
+ different font using \ref cfg_dot_fontname "DOT_FONTNAME" you can set the path where \c dot
can find it using this tag.
]]>
</docs>
@@ -3297,7 +3308,7 @@ to be found in the default search path.
<![CDATA[
If the \c CLASS_GRAPH tag is set to \c YES then doxygen
will generate a graph for each documented class showing the direct and
- indirect inheritance relations. Setting this tag to \c YES will force
+ indirect inheritance relations. Setting this tag to \c YES will force
the \ref cfg_class_diagrams "CLASS_DIAGRAMS" tag to \c NO.
]]>
</docs>
@@ -3332,10 +3343,10 @@ to be found in the default search path.
<option type='int' id='UML_LIMIT_NUM_FIELDS' defval='10' minval='0' maxval='100' depends='HAVE_DOT'>
<docs>
<![CDATA[
- If the \ref cfg_uml_look "UML_LOOK" tag is enabled, the fields and methods are shown inside
- the class node. If there are many fields or methods and many nodes the
- graph may become too big to be useful. The \c UML_LIMIT_NUM_FIELDS
- threshold limits the number of items for each type to make the size more
+ If the \ref cfg_uml_look "UML_LOOK" tag is enabled, the fields and methods are shown inside
+ the class node. If there are many fields or methods and many nodes the
+ graph may become too big to be useful. The \c UML_LIMIT_NUM_FIELDS
+ threshold limits the number of items for each type to make the size more
manageable. Set this to 0 for no limit. Note that the threshold may be
exceeded by 50% before the limit is enforced. So when you set the threshold
to 10, up to 15 fields may appear, but if the number exceeds 15, the
@@ -3346,7 +3357,7 @@ to be found in the default search path.
<option type='bool' id='TEMPLATE_RELATIONS' defval='0' depends='HAVE_DOT'>
<docs>
<![CDATA[
- If the \c TEMPLATE_RELATIONS tag is set to \c YES then
+ If the \c TEMPLATE_RELATIONS tag is set to \c YES then
the inheritance and collaboration graphs will show the relations between templates and their instances.
]]>
</docs>
@@ -3355,7 +3366,7 @@ to be found in the default search path.
<docs>
<![CDATA[
If the \c INCLUDE_GRAPH, \ref cfg_enable_preprocessing "ENABLE_PREPROCESSING" and
- \ref cfg_search_includes "SEARCH_INCLUDES"
+ \ref cfg_search_includes "SEARCH_INCLUDES"
tags are set to \c YES then doxygen will generate a graph for each documented file
showing the direct and indirect include dependencies of the file with other
documented files.
@@ -3376,12 +3387,12 @@ to be found in the default search path.
<option type='bool' id='CALL_GRAPH' defval='0' depends='HAVE_DOT'>
<docs>
<![CDATA[
- If the \c CALL_GRAPH tag is set to \c YES then doxygen will
- generate a call dependency graph for every global function or class method.
+ If the \c CALL_GRAPH tag is set to \c YES then doxygen will
+ generate a call dependency graph for every global function or class method.
<br>Note that enabling this option will significantly increase the time of a run.
- So in most cases it will be better to enable call graphs for selected
- functions only using the \ref cmdcallgraph "\\callgraph" command.
- Disabling a call graph can be accomplished by means of the command
+ So in most cases it will be better to enable call graphs for selected
+ functions only using the \ref cmdcallgraph "\\callgraph" command.
+ Disabling a call graph can be accomplished by means of the command
\ref cmdhidecallgraph "\\hidecallgraph".
]]>
</docs>
@@ -3389,12 +3400,12 @@ to be found in the default search path.
<option type='bool' id='CALLER_GRAPH' defval='0' depends='HAVE_DOT'>
<docs>
<![CDATA[
- If the \c CALLER_GRAPH tag is set to \c YES then doxygen will
- generate a caller dependency graph for every global function or class method.
+ If the \c CALLER_GRAPH tag is set to \c YES then doxygen will
+ generate a caller dependency graph for every global function or class method.
<br>Note that enabling this option will significantly increase the time of a run.
- So in most cases it will be better to enable caller graphs for selected
- functions only using the \ref cmdcallergraph "\\callergraph" command.
- Disabling a caller graph can be accomplished by means of the command
+ So in most cases it will be better to enable caller graphs for selected
+ functions only using the \ref cmdcallergraph "\\callergraph" command.
+ Disabling a caller graph can be accomplished by means of the command
\ref cmdhidecallergraph "\\hidecallergraph".
]]>
</docs>
@@ -3402,7 +3413,7 @@ to be found in the default search path.
<option type='bool' id='GRAPHICAL_HIERARCHY' defval='1' depends='HAVE_DOT'>
<docs>
<![CDATA[
- If the \c GRAPHICAL_HIERARCHY tag is set to \c YES then
+ If the \c GRAPHICAL_HIERARCHY tag is set to \c YES then
doxygen will graphical hierarchy of all classes instead of a textual one.
]]>
</docs>
@@ -3410,7 +3421,7 @@ to be found in the default search path.
<option type='bool' id='DIRECTORY_GRAPH' defval='1' depends='HAVE_DOT'>
<docs>
<![CDATA[
- If the \c DIRECTORY_GRAPH tag is set
+ If the \c DIRECTORY_GRAPH tag is set
to \c YES then doxygen will show the dependencies a directory has on other directories
in a graphical way. The dependency relations are determined by the \c \#include
relations between the files in the directories.
@@ -3424,7 +3435,7 @@ to be found in the default search path.
generated by \c dot. For an explanation of the image formats see the section output formats
in the documentation of the \c dot tool
(<a href="http://www.graphviz.org/">Graphviz</a>).
- \note If you choose \c svg you need to set
+ \note If you choose \c svg you need to set
\ref cfg_html_file_extension "HTML_FILE_EXTENSION" to \c xhtml in order to make the SVG files
visible in IE 9+ (other browsers do not have this requirement).
]]>
@@ -3446,10 +3457,10 @@ to be found in the default search path.
<docs>
<![CDATA[
If \ref cfg_dot_image_format "DOT_IMAGE_FORMAT" is set to \c svg, then this option can be set to \c YES to
- enable generation of interactive SVG images that allow zooming and panning.
- <br>Note that this requires a modern browser other than Internet Explorer.
+ enable generation of interactive SVG images that allow zooming and panning.
+ <br>Note that this requires a modern browser other than Internet Explorer.
Tested and working are Firefox, Chrome, Safari, and Opera.
- \note For IE 9+ you need to set \ref cfg_html_file_extension "HTML_FILE_EXTENSION" to \c xhtml in order
+ \note For IE 9+ you need to set \ref cfg_html_file_extension "HTML_FILE_EXTENSION" to \c xhtml in order
to make the SVG files visible. Older versions of IE do not have SVG support.
]]>
</docs>
@@ -3457,15 +3468,15 @@ to be found in the default search path.
<option type='string' id='DOT_PATH' format='dir' defval='' depends='HAVE_DOT'>
<docs>
<![CDATA[
- The \c DOT_PATH tag can be used to specify the path where the \c dot tool can be found.
- If left blank, it is assumed the \c dot tool can be found in the \c path.
+ The \c DOT_PATH tag can be used to specify the path where the \c dot tool can be found.
+ If left blank, it is assumed the \c dot tool can be found in the \c path.
]]>
</docs>
</option>
<option type='list' id='DOTFILE_DIRS' format='dir' depends='HAVE_DOT'>
<docs>
<![CDATA[
- The \c DOTFILE_DIRS tag can be used to specify one or more directories that
+ The \c DOTFILE_DIRS tag can be used to specify one or more directories that
contain dot files that are included in the documentation (see the
\ref cmddotfile "\\dotfile" command).
]]>
@@ -3474,7 +3485,7 @@ to be found in the default search path.
<option type='list' id='MSCFILE_DIRS' format='dir'>
<docs>
<![CDATA[
- The \c MSCFILE_DIRS tag can be used to specify one or more directories that
+ The \c MSCFILE_DIRS tag can be used to specify one or more directories that
contain msc files that are included in the documentation (see the
\ref cmdmscfile "\\mscfile" command).
]]>
@@ -3483,7 +3494,7 @@ to be found in the default search path.
<option type='list' id='DIAFILE_DIRS' format='dir'>
<docs>
<![CDATA[
- The \c DIAFILE_DIRS tag can be used to specify one or more directories that
+ The \c DIAFILE_DIRS tag can be used to specify one or more directories that
contain dia files that are included in the documentation (see the
\ref cmddiafile "\\diafile" command).
]]>
@@ -3492,9 +3503,9 @@ to be found in the default search path.
<option type='string' id='PLANTUML_JAR_PATH' format='dir' defval=''>
<docs>
<![CDATA[
- When using plantuml, the \c PLANTUML_JAR_PATH tag should be used to specify the path where
- java can find the \c plantuml.jar file. If left blank, it is assumed PlantUML is not used or
- called during a preprocessing step. Doxygen will generate a warning when it encounters a
+ When using plantuml, the \c PLANTUML_JAR_PATH tag should be used to specify the path where
+ java can find the \c plantuml.jar file. If left blank, it is assumed PlantUML is not used or
+ called during a preprocessing step. Doxygen will generate a warning when it encounters a
\ref cmdstartuml "\\startuml" command in this case and will not generate output for the diagram.
]]>
</docs>
@@ -3502,7 +3513,7 @@ to be found in the default search path.
<option type='string' id='PLANTUML_CFG_FILE' format='file' defval=''>
<docs>
<![CDATA[
- When using plantuml, the \c PLANTUML_CFG_FILE tag can be used to specify a configuration
+ When using plantuml, the \c PLANTUML_CFG_FILE tag can be used to specify a configuration
file for plantuml.
]]>
</docs>
@@ -3511,16 +3522,16 @@ to be found in the default search path.
<docs>
<![CDATA[
When using plantuml, the specified paths are searched for files specified by the \c !include
- statement in a plantuml block.
+ statement in a plantuml block.
]]>
</docs>
</option>
<option type='int' id='DOT_GRAPH_MAX_NODES' minval='0' maxval='10000' defval='50' depends='HAVE_DOT'>
<docs>
<![CDATA[
- The \c DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
+ The \c DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
nodes that will be shown in the graph. If the number of nodes in a graph
- becomes larger than this value, doxygen will truncate the graph, which is
+ becomes larger than this value, doxygen will truncate the graph, which is
visualized by representing a node as a red box. Note that doxygen if the number
of direct children of the root node in a graph is already larger than
\c DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
@@ -3531,7 +3542,7 @@ to be found in the default search path.
<option type='int' id='MAX_DOT_GRAPH_DEPTH' minval='0' maxval='1000' defval='0' depends='HAVE_DOT'>
<docs>
<![CDATA[
- The \c MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+ The \c MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
graphs generated by \c dot. A depth value of 3 means that only nodes reachable
from the root by following a path via at most 3 edges will be shown. Nodes
that lay further from the root node will be omitted. Note that setting this
@@ -3545,12 +3556,12 @@ to be found in the default search path.
<docs>
<![CDATA[
Set the \c DOT_TRANSPARENT tag to \c YES to generate images with a transparent
- background. This is disabled by default, because dot on Windows does not
+ background. This is disabled by default, because dot on Windows does not
seem to support this out of the box.
<br>
- Warning: Depending on the platform used,
- enabling this option may lead to badly anti-aliased labels on the edges of
- a graph (i.e. they become hard to read).
+ Warning: Depending on the platform used,
+ enabling this option may lead to badly anti-aliased labels on the edges of
+ a graph (i.e. they become hard to read).
]]>
</docs>
</option>
diff --git a/src/context.cpp b/src/context.cpp
index 33e7dcf..ed94ff8 100644
--- a/src/context.cpp
+++ b/src/context.cpp
@@ -658,7 +658,7 @@ class TranslateContext::Private
{
return theTranslator->trPackages();
}
- else if (m_fortranOpt)
+ else if (m_fortranOpt || m_sliceOpt)
{
return theTranslator->trModules();
}
@@ -689,7 +689,7 @@ class TranslateContext::Private
{
return theTranslator->trPackages();
}
- else if (m_fortranOpt)
+ else if (m_fortranOpt || m_sliceOpt)
{
return theTranslator->trModulesList();
}
@@ -704,7 +704,7 @@ class TranslateContext::Private
{
return theTranslator->trPackageMembers();
}
- else if (m_fortranOpt)
+ else if (m_fortranOpt || m_sliceOpt)
{
return theTranslator->trModulesMembers();
}
@@ -933,7 +933,8 @@ class TranslateContext::Private
}
TemplateVariant variables() const
{
- return theTranslator->trVariables();
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
+ return sliceOpt ? theTranslator->trConstants() : theTranslator->trVariables();
}
TemplateVariant typedefs() const
{
@@ -1209,6 +1210,7 @@ class TranslateContext::Private
m_javaOpt = Config_getBool(OPTIMIZE_OUTPUT_JAVA);
m_fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
m_vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
+ m_sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
}
TemplateVariant get(const char *n) const
{
@@ -1218,6 +1220,7 @@ class TranslateContext::Private
bool m_javaOpt;
bool m_fortranOpt;
bool m_vhdlOpt;
+ bool m_sliceOpt;
static PropertyMapper<TranslateContext::Private> s_inst;
};
//%% }
@@ -1525,6 +1528,7 @@ class DefinitionContext
case SrcLangExt_SQL: result="sql"; break;
case SrcLangExt_Tcl: result="tcl"; break;
case SrcLangExt_Markdown: result="markdown"; break;
+ case SrcLangExt_Slice: result="slice"; break;
}
return result;
}
@@ -2670,24 +2674,29 @@ class NamespaceContext::Private : public DefinitionContext<NamespaceContext::Pri
if (!init)
{
addBaseProperties(s_inst);
- s_inst.addProperty("title", &Private::title);
- s_inst.addProperty("highlight", &Private::highlight);
- s_inst.addProperty("subhighlight", &Private::subHighlight);
- s_inst.addProperty("compoundType", &Private::compoundType);
- s_inst.addProperty("hasDetails", &Private::hasDetails);
- s_inst.addProperty("classes", &Private::classes);
- s_inst.addProperty("namespaces", &Private::namespaces);
- s_inst.addProperty("constantgroups", &Private::constantgroups);
- s_inst.addProperty("typedefs", &Private::typedefs);
- s_inst.addProperty("enums", &Private::enums);
- s_inst.addProperty("functions", &Private::functions);
- s_inst.addProperty("variables", &Private::variables);
- s_inst.addProperty("memberGroups", &Private::memberGroups);
- s_inst.addProperty("detailedTypedefs", &Private::detailedTypedefs);
- s_inst.addProperty("detailedEnums", &Private::detailedEnums);
- s_inst.addProperty("detailedFunctions", &Private::detailedFunctions);
- s_inst.addProperty("detailedVariables", &Private::detailedVariables);
- s_inst.addProperty("inlineClasses", &Private::inlineClasses);
+ s_inst.addProperty("title", &Private::title);
+ s_inst.addProperty("highlight", &Private::highlight);
+ s_inst.addProperty("subhighlight", &Private::subHighlight);
+ s_inst.addProperty("compoundType", &Private::compoundType);
+ s_inst.addProperty("hasDetails", &Private::hasDetails);
+ s_inst.addProperty("classes", &Private::classes);
+ //s_inst.addProperty("interfaces", &Private::interfaces);
+ s_inst.addProperty("namespaces", &Private::namespaces);
+ s_inst.addProperty("constantgroups", &Private::constantgroups);
+ s_inst.addProperty("typedefs", &Private::typedefs);
+ s_inst.addProperty("sequences", &Private::sequences);
+ s_inst.addProperty("dictionaries", &Private::dictionaries);
+ s_inst.addProperty("enums", &Private::enums);
+ s_inst.addProperty("functions", &Private::functions);
+ s_inst.addProperty("variables", &Private::variables);
+ s_inst.addProperty("memberGroups", &Private::memberGroups);
+ s_inst.addProperty("detailedTypedefs", &Private::detailedTypedefs);
+ s_inst.addProperty("detailedSequences", &Private::detailedSequences);
+ s_inst.addProperty("detailedDictionaries", &Private::detailedDictionaries);
+ s_inst.addProperty("detailedEnums", &Private::detailedEnums);
+ s_inst.addProperty("detailedFunctions", &Private::detailedFunctions);
+ s_inst.addProperty("detailedVariables", &Private::detailedVariables);
+ s_inst.addProperty("inlineClasses", &Private::inlineClasses);
init=TRUE;
}
if (!nd->cookie()) { nd->setCookie(new NamespaceContext::Private::Cachable(nd)); }
@@ -2722,6 +2731,7 @@ class NamespaceContext::Private : public DefinitionContext<NamespaceContext::Pri
Cachable &cache = getCache();
if (!cache.classes)
{
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
TemplateList *classList = TemplateList::alloc();
if (m_namespaceDef->getClassSDict())
{
@@ -2729,6 +2739,10 @@ class NamespaceContext::Private : public DefinitionContext<NamespaceContext::Pri
ClassDef *cd;
for (sdi.toFirst();(cd=sdi.current());++sdi)
{
+ if (sliceOpt && (cd->isStruct() || cd->isInterface() || cd->isException()))
+ {
+ continue; // These types appear in their own sections.
+ }
if (cd->visibleInParentsDeclList())
{
classList->append(ClassContext::alloc(cd));
@@ -2807,6 +2821,14 @@ class NamespaceContext::Private : public DefinitionContext<NamespaceContext::Pri
{
return getMemberList(getCache().typedefs,MemberListType_decTypedefMembers,theTranslator->trTypedefs());
}
+ TemplateVariant sequences() const
+ {
+ return getMemberList(getCache().sequences,MemberListType_decSequenceMembers,theTranslator->trSequences());
+ }
+ TemplateVariant dictionaries() const
+ {
+ return getMemberList(getCache().dictionaries,MemberListType_decDictionaryMembers,theTranslator->trDictionaries());
+ }
TemplateVariant enums() const
{
return getMemberList(getCache().enums,MemberListType_decEnumMembers,theTranslator->trEnumerations());
@@ -2821,7 +2843,9 @@ class NamespaceContext::Private : public DefinitionContext<NamespaceContext::Pri
}
TemplateVariant variables() const
{
- return getMemberList(getCache().variables,MemberListType_decVarMembers,theTranslator->trVariables());
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
+ return getMemberList(getCache().variables,MemberListType_decVarMembers,
+ sliceOpt ? theTranslator->trConstants() : theTranslator->trVariables());
}
TemplateVariant memberGroups() const
{
@@ -2843,6 +2867,14 @@ class NamespaceContext::Private : public DefinitionContext<NamespaceContext::Pri
{
return getMemberList(getCache().detailedTypedefs,MemberListType_docTypedefMembers,theTranslator->trTypedefDocumentation());
}
+ TemplateVariant detailedSequences() const
+ {
+ return getMemberList(getCache().detailedSequences,MemberListType_docSequenceMembers,theTranslator->trSequenceDocumentation());
+ }
+ TemplateVariant detailedDictionaries() const
+ {
+ return getMemberList(getCache().detailedDictionaries,MemberListType_docDictionaryMembers,theTranslator->trDictionaryDocumentation());
+ }
TemplateVariant detailedEnums() const
{
return getMemberList(getCache().detailedEnums,MemberListType_docEnumMembers,theTranslator->trEnumerationTypeDocumentation());
@@ -2856,7 +2888,10 @@ class NamespaceContext::Private : public DefinitionContext<NamespaceContext::Pri
}
TemplateVariant detailedVariables() const
{
- return getMemberList(getCache().detailedVariables,MemberListType_docVarMembers,theTranslator->trVariableDocumentation());
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
+ return getMemberList(getCache().detailedVariables,MemberListType_docVarMembers,
+ sliceOpt ? theTranslator->trConstantDocumentation() :
+ theTranslator->trVariableDocumentation());
}
TemplateVariant inlineClasses() const
{
@@ -2889,14 +2924,19 @@ class NamespaceContext::Private : public DefinitionContext<NamespaceContext::Pri
{
Cachable(NamespaceDef *nd) : DefinitionContext<NamespaceContext::Private>::Cachable(nd) {}
SharedPtr<TemplateList> classes;
+ SharedPtr<TemplateList> interfaces;
SharedPtr<TemplateList> namespaces;
SharedPtr<TemplateList> constantgroups;
SharedPtr<MemberListInfoContext> typedefs;
+ SharedPtr<MemberListInfoContext> sequences;
+ SharedPtr<MemberListInfoContext> dictionaries;
SharedPtr<MemberListInfoContext> enums;
SharedPtr<MemberListInfoContext> functions;
SharedPtr<MemberListInfoContext> variables;
SharedPtr<MemberGroupListContext> memberGroups;
SharedPtr<MemberListInfoContext> detailedTypedefs;
+ SharedPtr<MemberListInfoContext> detailedSequences;
+ SharedPtr<MemberListInfoContext> detailedDictionaries;
SharedPtr<MemberListInfoContext> detailedEnums;
SharedPtr<MemberListInfoContext> detailedFunctions;
SharedPtr<MemberListInfoContext> detailedVariables;
@@ -2961,12 +3001,16 @@ class FileContext::Private : public DefinitionContext<FileContext::Private>
s_inst.addProperty("constantgroups", &Private::constantgroups);
s_inst.addProperty("macros", &Private::macros);
s_inst.addProperty("typedefs", &Private::typedefs);
+ s_inst.addProperty("sequences", &Private::sequences);
+ s_inst.addProperty("dictionaries", &Private::dictionaries);
s_inst.addProperty("enums", &Private::enums);
s_inst.addProperty("functions", &Private::functions);
s_inst.addProperty("variables", &Private::variables);
s_inst.addProperty("memberGroups", &Private::memberGroups);
s_inst.addProperty("detailedMacros", &Private::detailedMacros);
s_inst.addProperty("detailedTypedefs", &Private::detailedTypedefs);
+ s_inst.addProperty("detailedSequences", &Private::detailedSequences);
+ s_inst.addProperty("detailedDictionaries", &Private::detailedDictionaries);
s_inst.addProperty("detailedEnums", &Private::detailedEnums);
s_inst.addProperty("detailedFunctions", &Private::detailedFunctions);
s_inst.addProperty("detailedVariables", &Private::detailedVariables);
@@ -3240,6 +3284,14 @@ class FileContext::Private : public DefinitionContext<FileContext::Private>
{
return getMemberList(getCache().typedefs,MemberListType_decTypedefMembers,theTranslator->trTypedefs());
}
+ TemplateVariant sequences() const
+ {
+ return getMemberList(getCache().sequences,MemberListType_decSequenceMembers,theTranslator->trSequences());
+ }
+ TemplateVariant dictionaries() const
+ {
+ return getMemberList(getCache().dictionaries,MemberListType_decDictionaryMembers,theTranslator->trDictionaries());
+ }
TemplateVariant enums() const
{
return getMemberList(getCache().enums,MemberListType_decEnumMembers,theTranslator->trEnumerations());
@@ -3254,7 +3306,9 @@ class FileContext::Private : public DefinitionContext<FileContext::Private>
}
TemplateVariant variables() const
{
- return getMemberList(getCache().variables,MemberListType_decVarMembers,theTranslator->trVariables());
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
+ return getMemberList(getCache().variables,MemberListType_decVarMembers,
+ sliceOpt ? theTranslator->trConstants() : theTranslator->trVariables());
}
TemplateVariant memberGroups() const
{
@@ -3280,6 +3334,14 @@ class FileContext::Private : public DefinitionContext<FileContext::Private>
{
return getMemberList(getCache().detailedTypedefs,MemberListType_docTypedefMembers,theTranslator->trTypedefDocumentation());
}
+ TemplateVariant detailedSequences() const
+ {
+ return getMemberList(getCache().detailedSequences,MemberListType_docSequenceMembers,theTranslator->trSequenceDocumentation());
+ }
+ TemplateVariant detailedDictionaries() const
+ {
+ return getMemberList(getCache().detailedDictionaries,MemberListType_docDictionaryMembers,theTranslator->trDictionaryDocumentation());
+ }
TemplateVariant detailedEnums() const
{
return getMemberList(getCache().detailedEnums,MemberListType_docEnumMembers,theTranslator->trEnumerationTypeDocumentation());
@@ -3339,12 +3401,16 @@ class FileContext::Private : public DefinitionContext<FileContext::Private>
SharedPtr<TemplateList> constantgroups;
SharedPtr<MemberListInfoContext> macros;
SharedPtr<MemberListInfoContext> typedefs;
+ SharedPtr<MemberListInfoContext> sequences;
+ SharedPtr<MemberListInfoContext> dictionaries;
SharedPtr<MemberListInfoContext> enums;
SharedPtr<MemberListInfoContext> functions;
SharedPtr<MemberListInfoContext> variables;
SharedPtr<MemberGroupListContext> memberGroups;
SharedPtr<MemberListInfoContext> detailedMacros;
SharedPtr<MemberListInfoContext> detailedTypedefs;
+ SharedPtr<MemberListInfoContext> detailedSequences;
+ SharedPtr<MemberListInfoContext> detailedDictionaries;
SharedPtr<MemberListInfoContext> detailedEnums;
SharedPtr<MemberListInfoContext> detailedFunctions;
SharedPtr<MemberListInfoContext> detailedVariables;
@@ -5494,7 +5560,9 @@ class ModuleContext::Private : public DefinitionContext<ModuleContext::Private>
}
TemplateVariant variables() const
{
- return getMemberList(getCache().variables,MemberListType_decVarMembers,theTranslator->trVariables());
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
+ return getMemberList(getCache().variables,MemberListType_decVarMembers,
+ sliceOpt ? theTranslator->trConstants() : theTranslator->trVariables());
}
TemplateVariant signals() const
{
@@ -6428,7 +6496,7 @@ class NestingContext::Private : public GenericNodeListContext
if (nd->localName().find('@')==-1 &&
(!rootOnly || nd->getOuterScope()==Doxygen::globalScope))
{
- bool hasChildren = namespaceHasVisibleChild(nd,addClasses);
+ bool hasChildren = namespaceHasVisibleChild(nd,addClasses,false,ClassDef::Class);
bool isLinkable = nd->isLinkableInProject();
if (isLinkable || hasChildren)
{
@@ -6943,11 +7011,12 @@ class NamespaceTreeContext::Private
static bool javaOpt = Config_getBool(OPTIMIZE_OUTPUT_JAVA);
static bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
static bool vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
if (javaOpt || vhdlOpt)
{
return theTranslator->trPackages();
}
- else if (fortranOpt)
+ else if (fortranOpt || sliceOpt)
{
return theTranslator->trModulesList();
}
diff --git a/src/defgen.cpp b/src/defgen.cpp
index cd69ab2..c75bacd 100644
--- a/src/defgen.cpp
+++ b/src/defgen.cpp
@@ -89,20 +89,22 @@ void generateDEFForMember(MemberDef *md,
bool isFunc=FALSE;
switch (md->memberType())
{
- case MemberType_Define: memType="define"; break;
- case MemberType_EnumValue: ASSERT(0); break;
- case MemberType_Property: memType="property"; break;
- case MemberType_Event: memType="event"; break;
- case MemberType_Variable: memType="variable"; break;
- case MemberType_Typedef: memType="typedef"; break;
- case MemberType_Enumeration: memType="enum"; break;
- case MemberType_Interface: memType="interface"; break;
- case MemberType_Service: memType="service"; break;
- case MemberType_Function: memType="function"; isFunc=TRUE; break;
- case MemberType_Signal: memType="signal"; isFunc=TRUE; break;
- case MemberType_Friend: memType="friend"; isFunc=TRUE; break;
- case MemberType_DCOP: memType="dcop"; isFunc=TRUE; break;
- case MemberType_Slot: memType="slot"; isFunc=TRUE; break;
+ case MemberType_Define: memType="define"; break;
+ case MemberType_EnumValue: ASSERT(0); break;
+ case MemberType_Property: memType="property"; break;
+ case MemberType_Event: memType="event"; break;
+ case MemberType_Variable: memType="variable"; break;
+ case MemberType_Typedef: memType="typedef"; break;
+ case MemberType_Enumeration: memType="enum"; break;
+ case MemberType_Interface: memType="interface"; break;
+ case MemberType_Service: memType="service"; break;
+ case MemberType_Sequence: memType="sequence"; break;
+ case MemberType_Dictionary: memType="dictionary"; break;
+ case MemberType_Function: memType="function"; isFunc=TRUE; break;
+ case MemberType_Signal: memType="signal"; isFunc=TRUE; break;
+ case MemberType_Friend: memType="friend"; isFunc=TRUE; break;
+ case MemberType_DCOP: memType="dcop"; isFunc=TRUE; break;
+ case MemberType_Slot: memType="slot"; isFunc=TRUE; break;
}
t << memPrefix << "kind = '" << memType << "';" << endl;
@@ -511,6 +513,8 @@ void generateDEFForNamespace(NamespaceDef *nd,FTextStream &t)
generateDEFSection(nd,t,nd->getMemberList(MemberListType_decDefineMembers),"define");
generateDEFSection(nd,t,nd->getMemberList(MemberListType_decProtoMembers),"prototype");
generateDEFSection(nd,t,nd->getMemberList(MemberListType_decTypedefMembers),"typedef");
+ generateDEFSection(nd,t,nd->getMemberList(MemberListType_decSequenceMembers),"sequence");
+ generateDEFSection(nd,t,nd->getMemberList(MemberListType_decDictionaryMembers),"dictionary");
generateDEFSection(nd,t,nd->getMemberList(MemberListType_decEnumMembers),"enum");
generateDEFSection(nd,t,nd->getMemberList(MemberListType_decFuncMembers),"func");
generateDEFSection(nd,t,nd->getMemberList(MemberListType_decVarMembers),"var");
@@ -538,6 +542,8 @@ void generateDEFForFile(FileDef *fd,FTextStream &t)
generateDEFSection(fd,t,fd->getMemberList(MemberListType_decDefineMembers),"define");
generateDEFSection(fd,t,fd->getMemberList(MemberListType_decProtoMembers),"prototype");
generateDEFSection(fd,t,fd->getMemberList(MemberListType_decTypedefMembers),"typedef");
+ generateDEFSection(fd,t,fd->getMemberList(MemberListType_decSequenceMembers),"sequence");
+ generateDEFSection(fd,t,fd->getMemberList(MemberListType_decDictionaryMembers),"dictionary");
generateDEFSection(fd,t,fd->getMemberList(MemberListType_decEnumMembers),"enum");
generateDEFSection(fd,t,fd->getMemberList(MemberListType_decFuncMembers),"func");
generateDEFSection(fd,t,fd->getMemberList(MemberListType_decVarMembers),"var");
diff --git a/src/dirdef.cpp b/src/dirdef.cpp
index 6631ed7..7294e4f 100644
--- a/src/dirdef.cpp
+++ b/src/dirdef.cpp
@@ -485,8 +485,14 @@ void DirDef::writeDocumentation(OutputList &ol)
case LayoutDocEntry::NamespaceNestedNamespaces:
case LayoutDocEntry::NamespaceNestedConstantGroups:
case LayoutDocEntry::NamespaceClasses:
+ case LayoutDocEntry::NamespaceInterfaces:
+ case LayoutDocEntry::NamespaceStructs:
+ case LayoutDocEntry::NamespaceExceptions:
case LayoutDocEntry::NamespaceInlineClasses:
case LayoutDocEntry::FileClasses:
+ case LayoutDocEntry::FileInterfaces:
+ case LayoutDocEntry::FileStructs:
+ case LayoutDocEntry::FileExceptions:
case LayoutDocEntry::FileNamespaces:
case LayoutDocEntry::FileConstantGroups:
case LayoutDocEntry::FileIncludes:
diff --git a/src/docbookgen.cpp b/src/docbookgen.cpp
index 9398f59..09ff14f 100644
--- a/src/docbookgen.cpp
+++ b/src/docbookgen.cpp
@@ -107,6 +107,8 @@ class DocbookSectionMapper : public QIntDict<char>
insert(MemberListType_decDefineMembers,"define");
insert(MemberListType_decProtoMembers,"prototype");
insert(MemberListType_decTypedefMembers,"typedef");
+ insert(MemberListType_decSequenceMembers,"sequence");
+ insert(MemberListType_decDictionaryMembers,"dictionary");
insert(MemberListType_decEnumMembers,"enum");
insert(MemberListType_decFuncMembers,"func");
insert(MemberListType_decVarMembers,"var");
@@ -660,20 +662,22 @@ static void generateDocbookForMember(MemberDef *md,FTextStream &t,Definition *de
QCString memType;
switch (md->memberType())
{
- 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;
+ 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;
+ case MemberType_Sequence: memType="sequence"; break;
+ case MemberType_Dictionary: memType="dictionary"; break;
}
QCString scopeName;
if (md->getClassDef())
@@ -794,7 +798,8 @@ static void generateDocbookForMember(MemberDef *md,FTextStream &t,Definition *de
}
}
}
- else if (md->memberType()==MemberType_Typedef)
+ else if (md->memberType()==MemberType_Typedef || md->memberType()==MemberType_Sequence ||
+ md->memberType()==MemberType_Dictionary)
{
t << " <para>" << memType;
t << " ";
@@ -1115,6 +1120,8 @@ static void generateDocbookSection(Definition *d,FTextStream &t,MemberList *ml,c
case MemberListType_priMethods: title=theTranslator->trPrivateMembers(); desctitle=""; break;
case MemberListType_decTypedefMembers: title=theTranslator->trTypedefs(); desctitle=theTranslator->trTypedefDocumentation(); break;
+ case MemberListType_decSequenceMembers: title=theTranslator->trSequences(); desctitle=theTranslator->trSequenceDocumentation(); break;
+ case MemberListType_decDictionaryMembers: title=theTranslator->trDictionaries(); desctitle=theTranslator->trDictionaryDocumentation(); 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;
@@ -2688,7 +2695,7 @@ DB_GEN_C2("IndexSections " << is)
bool found=FALSE;
for (cli.toFirst();(cd=cli.current()) && !found;++cli)
{
- if (cd->isLinkableInProject() &&
+ if (cd->isLinkableInProject() &&
cd->templateMaster()==0 &&
!cd->isEmbeddedInOuterScope()
)
@@ -2699,13 +2706,13 @@ DB_GEN_C2("IndexSections " << is)
}
for (;(cd=cli.current());++cli)
{
- if (cd->isLinkableInProject() &&
+ 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 << "</chapter>\n";
@@ -2714,7 +2721,7 @@ DB_GEN_C2("IndexSections " << is)
{
t << "</title>" << endl;
bool isFirst=TRUE;
- FileNameListIterator fnli(*Doxygen::inputNameList);
+ FileNameListIterator fnli(*Doxygen::inputNameList);
FileName *fn;
for (fnli.toFirst();(fn=fnli.current());++fnli)
{
@@ -2892,7 +2899,7 @@ void DocbookGenerator::startGroupHeader(int extraIndentLevel)
{
DB_GEN_C2("m_inLevel " << m_inLevel)
DB_GEN_C2("extraIndentLevel " << extraIndentLevel)
- m_firstMember = TRUE;
+ m_firstMember = TRUE;
if (m_inSimpleSect[m_levelListItem]) t << "</simplesect>" << endl;
m_inSimpleSect[m_levelListItem] = FALSE;
if (m_inLevel != -1) m_inGroup = TRUE;
diff --git a/src/docsets.cpp b/src/docsets.cpp
index 29b7616..1327d80 100644
--- a/src/docsets.cpp
+++ b/src/docsets.cpp
@@ -334,6 +334,7 @@ void DocSets::addIndexItem(Definition *context,MemberDef *md,
case SrcLangExt_SQL: lang="sql"; break; // Sql
case SrcLangExt_Tcl: lang="tcl"; break; // Tcl
case SrcLangExt_Markdown:lang="markdown"; break; // Markdown
+ case SrcLangExt_Slice: lang="slice"; break; // Slice
case SrcLangExt_Unknown: lang="unknown"; break; // should not happen!
}
@@ -401,6 +402,10 @@ void DocSets::addIndexItem(Definition *context,MemberDef *md,
type="ifc"; break;
case MemberType_Service:
type="svc"; break;
+ case MemberType_Sequence:
+ type="sequence"; break;
+ case MemberType_Dictionary:
+ type="dictionary"; break;
}
cd = md->getClassDef();
nd = md->getNamespaceDef();
diff --git a/src/dot.cpp b/src/dot.cpp
index f07a365..d82ffa8 100644
--- a/src/dot.cpp
+++ b/src/dot.cpp
@@ -2328,7 +2328,10 @@ void DotGfxHierarchyTable::createGraph(DotNode *n,FTextStream &out,
QCString baseName;
QCString imgExt = getDotImageExtension();
QCString imgFmt = Config_getEnum(DOT_IMAGE_FORMAT);
- baseName.sprintf("inherit_graph_%d",id);
+ if (m_prefix.isEmpty())
+ baseName.sprintf("inherit_graph_%d",id);
+ else
+ baseName.sprintf("%sinherit_graph_%d",m_prefix.data(),id);
QCString imgName = baseName+"."+ imgExt;
QCString mapName = baseName+".map";
QCString absImgName = QCString(d.absPath().data())+"/"+imgName;
@@ -2520,6 +2523,7 @@ void DotGfxHierarchyTable::addHierarchy(DotNode *n,ClassDef *cd,bool hideSuper)
void DotGfxHierarchyTable::addClassList(ClassSDict *cl)
{
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
ClassSDict::Iterator cli(*cl);
ClassDef *cd;
for (cli.toLast();(cd=cli.current());--cli)
@@ -2531,6 +2535,10 @@ void DotGfxHierarchyTable::addClassList(ClassSDict *cl)
{
continue;
}
+ if (sliceOpt && cd->compoundType() != m_classType)
+ {
+ continue;
+ }
if (!hasVisibleRoot(cd->baseClasses()) &&
cd->isVisibleInHierarchy()
) // root node in the forest
@@ -2563,7 +2571,10 @@ void DotGfxHierarchyTable::addClassList(ClassSDict *cl)
}
}
-DotGfxHierarchyTable::DotGfxHierarchyTable() : m_curNodeNumber(1)
+DotGfxHierarchyTable::DotGfxHierarchyTable(const char *prefix,ClassDef::CompoundType ct)
+ : m_prefix(prefix)
+ , m_classType(ct)
+ , m_curNodeNumber(1)
{
m_rootNodes = new QList<DotNode>;
m_usedNodes = new QDict<DotNode>(1009);
diff --git a/src/dot.h b/src/dot.h
index 3a70d8b..20a1f29 100644
--- a/src/dot.h
+++ b/src/dot.h
@@ -26,8 +26,8 @@
#include <qqueue.h>
#include <qthread.h>
#include "sortdict.h"
+#include "classdef.h"
-class ClassDef;
class FileDef;
class FTextStream;
class DotNodeList;
@@ -156,7 +156,7 @@ class DotNodeList : public QList<DotNode>
class DotGfxHierarchyTable
{
public:
- DotGfxHierarchyTable();
+ DotGfxHierarchyTable(const char *prefix="",ClassDef::CompoundType ct=ClassDef::Class);
~DotGfxHierarchyTable();
void writeGraph(FTextStream &t,const char *path, const char *fileName) const;
void createGraph(DotNode *rootNode,FTextStream &t,const char *path,const char *fileName,int id) const;
@@ -166,10 +166,12 @@ class DotGfxHierarchyTable
void addHierarchy(DotNode *n,ClassDef *cd,bool hide);
void addClassList(ClassSDict *cl);
- QList<DotNode> *m_rootNodes;
- QDict<DotNode> *m_usedNodes;
- int m_curNodeNumber;
- DotNodeList *m_rootSubgraphs;
+ QCString m_prefix;
+ ClassDef::CompoundType m_classType;
+ QList<DotNode> *m_rootNodes;
+ QDict<DotNode> *m_usedNodes;
+ int m_curNodeNumber;
+ DotNodeList *m_rootSubgraphs;
};
/** Representation of a class inheritance or dependency graph */
diff --git a/src/doxygen.cpp b/src/doxygen.cpp
index 7eb7968..b12b354 100644
--- a/src/doxygen.cpp
+++ b/src/doxygen.cpp
@@ -1303,6 +1303,8 @@ static void addClassToContext(EntryNav *rootNav)
}
cd->setCompoundType(convertToCompoundType(root->section,root->spec));
+
+ cd->setMetaData(root->metaData);
}
else // new class
{
@@ -1367,6 +1369,8 @@ static void addClassToContext(EntryNav *rootNav)
cd->setBodySegment(root->bodyLine,root->endBodyLine);
cd->setBodyDef(fd);
+ cd->setMetaData(root->metaData);
+
// see if the class is found inside a namespace
//bool found=addNamespace(root,cd);
@@ -1586,7 +1590,7 @@ static ClassDef *createTagLessInstance(ClassDef *rootCd,ClassDef *templ,const QC
md->typeString(),md->name(),md->argsString(),md->excpString(),
md->protection(),md->virtualness(),md->isStatic(),Member,
md->memberType(),
- 0,0);
+ 0,0,"");
imd->setMemberClass(cd);
imd->setDocumentation(md->documentation(),md->docFile(),md->docLine());
imd->setBriefDescription(md->briefDescription(),md->briefFile(),md->briefLine());
@@ -1758,6 +1762,7 @@ static void buildNamespaceList(EntryNav *rootNav)
nd->setReference("");
nd->setFileName(fullName);
}
+ nd->setMetaData(root->metaData);
// file definition containing the namespace nd
FileDef *fd=rootNav->fileDef();
@@ -1787,6 +1792,7 @@ static void buildNamespaceList(EntryNav *rootNav)
nd->setArtificial(root->artificial);
nd->setLanguage(root->lang);
nd->setId(root->id);
+ nd->setMetaData(root->metaData);
//printf("Adding namespace to group\n");
addNamespaceToGroups(root,nd);
@@ -1962,6 +1968,7 @@ static void findUsingDirectives(EntryNav *rootNav)
nd->setArtificial(TRUE);
nd->setLanguage(root->lang);
nd->setId(root->id);
+ nd->setMetaData(root->metaData);
QListIterator<Grouping> gli(*root->groups);
Grouping *g;
@@ -2167,7 +2174,7 @@ static void findUsingDeclImports(EntryNav *rootNav)
md->typeString(),memName,md->argsString(),
md->excpString(),root->protection,root->virt,
md->isStatic(),Member,md->memberType(),
- templAl,al
+ templAl,al,root->metaData
);
}
newMd->setMemberClass(cd);
@@ -2360,7 +2367,7 @@ static MemberDef *addVariableToClass(
fileName,root->startLine,root->startColumn,
root->type,name,root->args,root->exception,
prot,Normal,root->stat,related,
- mtype,root->tArgLists ? root->tArgLists->getLast() : 0,0);
+ mtype,root->tArgLists ? root->tArgLists->getLast() : 0,0, root->metaData);
md->setTagInfo(rootNav->tagInfo());
md->setMemberClass(cd); // also sets outer scope (i.e. getOuterScope())
//md->setDefFile(root->fileName);
@@ -2603,7 +2610,7 @@ static MemberDef *addVariableToFile(
fileName,root->startLine,root->startColumn,
root->type,name,root->args,0,
root->protection, Normal,root->stat,Member,
- mtype,root->tArgLists ? root->tArgLists->getLast() : 0,0);
+ mtype,root->tArgLists ? root->tArgLists->getLast() : 0,0, root->metaData);
md->setTagInfo(rootNav->tagInfo());
md->setMemberSpecifiers(root->spec);
md->setDocumentation(root->doc,root->docFile,root->docLine);
@@ -2821,6 +2828,8 @@ done:
static void addVariable(EntryNav *rootNav,int isFuncPtr=-1)
{
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
+
rootNav->loadEntry(g_storage);
Entry *root = rootNav->entry();
@@ -2940,6 +2949,10 @@ static void addVariable(EntryNav *rootNav,int isFuncPtr=-1)
mtype=MemberType_Property;
else if (root->mtype==Event)
mtype=MemberType_Event;
+ else if (type.find("sequence<") != -1)
+ mtype=sliceOpt ? MemberType_Sequence : MemberType_Typedef;
+ else if (type.find("dictionary<") != -1)
+ mtype=sliceOpt ? MemberType_Dictionary : MemberType_Typedef;
else
mtype=MemberType_Variable;
@@ -3054,6 +3067,58 @@ static void buildTypedefList(EntryNav *rootNav)
}
//----------------------------------------------------------------------
+// Searches the Entry tree for sequence documentation sections.
+// If found they are stored in the global list.
+static void buildSequenceList(EntryNav *rootNav)
+{
+ if (!rootNav->name().isEmpty() &&
+ rootNav->section()==Entry::VARIABLE_SEC &&
+ rootNav->type().find("sequence<")!=-1 // it's a sequence
+ )
+ {
+ addVariable(rootNav);
+ }
+ if (rootNav->children())
+ {
+ EntryNavListIterator eli(*rootNav->children());
+ EntryNav *e;
+ for (;(e=eli.current());++eli)
+ {
+ if (e->section()!=Entry::ENUM_SEC)
+ {
+ buildSequenceList(e);
+ }
+ }
+ }
+}
+
+//----------------------------------------------------------------------
+// Searches the Entry tree for dictionary documentation sections.
+// If found they are stored in the global list.
+static void buildDictionaryList(EntryNav *rootNav)
+{
+ if (!rootNav->name().isEmpty() &&
+ rootNav->section()==Entry::VARIABLE_SEC &&
+ rootNav->type().find("dictionary<")!=-1 // it's a dictionary
+ )
+ {
+ addVariable(rootNav);
+ }
+ if (rootNav->children())
+ {
+ EntryNavListIterator eli(*rootNav->children());
+ EntryNav *e;
+ for (;(e=eli.current());++eli)
+ {
+ if (e->section()!=Entry::ENUM_SEC)
+ {
+ buildDictionaryList(e);
+ }
+ }
+ }
+}
+
+//----------------------------------------------------------------------
// Searches the Entry tree for Variable documentation sections.
// If found they are stored in their class or in the global list.
@@ -3114,7 +3179,7 @@ static void addInterfaceOrServiceToServiceOrSingleton(
MemberDef *const md = new MemberDef(
fileName, root->startLine, root->startColumn, root->type, rname,
"", "", root->protection, root->virt, root->stat, Member,
- type, 0, root->argList);
+ type, 0, root->argList, root->metaData);
md->setTagInfo(rootNav->tagInfo());
md->setMemberClass(cd);
md->setDocumentation(root->doc,root->docFile,root->docLine);
@@ -3301,7 +3366,7 @@ static void addMethodToClass(EntryNav *rootNav,ClassDef *cd,
root->stat && root->relatesType != MemberOf,
root->relates.isEmpty() ? Member :
root->relatesType == MemberOf ? Foreign : Related,
- mtype,root->tArgLists ? root->tArgLists->getLast() : 0,root->argList);
+ mtype,root->tArgLists ? root->tArgLists->getLast() : 0,root->argList, root->metaData);
md->setTagInfo(rootNav->tagInfo());
md->setMemberClass(cd);
md->setDocumentation(root->doc,root->docFile,root->docLine);
@@ -3691,7 +3756,7 @@ static void buildFunctionList(EntryNav *rootNav)
root->fileName,root->startLine,root->startColumn,
root->type,name,root->args,root->exception,
root->protection,root->virt,root->stat,Member,
- MemberType_Function,tArgList,root->argList);
+ MemberType_Function,tArgList,root->argList,root->metaData);
md->setTagInfo(rootNav->tagInfo());
md->setLanguage(root->lang);
@@ -6436,7 +6501,7 @@ static void findMember(EntryNav *rootNav,
funcType,funcName,funcArgs,exceptions,
declMd ? declMd->protection() : root->protection,
root->virt,root->stat,Member,
- mtype,tArgList,root->argList);
+ mtype,tArgList,root->argList,root->metaData);
//printf("new specialized member %s args=`%s'\n",md->name().data(),funcArgs.data());
md->setTagInfo(rootNav->tagInfo());
md->setLanguage(root->lang);
@@ -6503,7 +6568,7 @@ static void findMember(EntryNav *rootNav,
root->fileName,root->startLine,root->startColumn,
funcType,funcName,funcArgs,exceptions,
root->protection,root->virt,root->stat,Related,
- mtype,tArgList,root->argList);
+ mtype,tArgList,root->argList,root->metaData);
md->setTagInfo(rootNav->tagInfo());
md->setLanguage(root->lang);
md->setId(root->id);
@@ -6641,7 +6706,7 @@ static void findMember(EntryNav *rootNav,
isMemberOf ? Foreign : Related,
mtype,
(root->tArgLists ? root->tArgLists->getLast() : 0),
- funcArgs.isEmpty() ? 0 : root->argList);
+ funcArgs.isEmpty() ? 0 : root->argList,root->metaData);
if (isDefine && mdDefine)
{
@@ -6779,7 +6844,7 @@ localObjCMethod:
root->fileName,root->startLine,root->startColumn,
funcType,funcName,funcArgs,exceptions,
root->protection,root->virt,root->stat,Member,
- MemberType_Function,0,root->argList);
+ MemberType_Function,0,root->argList,root->metaData);
md->setTagInfo(rootNav->tagInfo());
md->setLanguage(root->lang);
md->setId(root->id);
@@ -7115,7 +7180,7 @@ static void findEnums(EntryNav *rootNav)
root->protection,Normal,FALSE,
isMemberOf ? Foreign : isRelated ? Related : Member,
MemberType_Enumeration,
- 0,0);
+ 0,0,root->metaData);
md->setTagInfo(rootNav->tagInfo());
md->setLanguage(root->lang);
md->setId(root->id);
@@ -7337,7 +7402,7 @@ static void addEnumValuesToEnums(EntryNav *rootNav)
fileName,root->startLine,root->startColumn,
root->type,root->name,root->args,0,
root->protection, Normal,root->stat,Member,
- MemberType_EnumValue,0,0);
+ MemberType_EnumValue,0,0,root->metaData);
if (md->getClassDef()) fmd->setMemberClass(md->getClassDef());
else if (md->getNamespaceDef()) fmd->setNamespace(md->getNamespaceDef());
else if (md->getFileDef()) fmd->setFileDef(md->getFileDef());
@@ -8467,7 +8532,7 @@ static void findDefineDocumentation(EntryNav *rootNav)
{
MemberDef *md=new MemberDef(rootNav->tagInfo()->tagName,1,1,
"#define",root->name,root->args,0,
- Public,Normal,FALSE,Member,MemberType_Define,0,0);
+ Public,Normal,FALSE,Member,MemberType_Define,0,0,"");
md->setTagInfo(rootNav->tagInfo());
md->setLanguage(root->lang);
//printf("Searching for `%s' fd=%p\n",filePathName.data(),fd);
@@ -9052,8 +9117,33 @@ static void generateGroupDocs()
//----------------------------------------------------------------------------
// generate module pages
+static void generateNamespaceClassDocs(ClassSDict *d)
+{
+ // for each class in the namespace...
+ ClassSDict::Iterator cli(*d);
+ ClassDef *cd;
+ for ( ; (cd=cli.current()) ; ++cli )
+ {
+ if ( ( cd->isLinkableInProject() &&
+ cd->templateMaster()==0
+ ) // skip external references, anonymous compounds and
+ // template instances and nested classes
+ && !cd->isHidden() && !cd->isEmbeddedInOuterScope()
+ )
+ {
+ msg("Generating docs for compound %s...\n",cd->name().data());
+
+ cd->writeDocumentation(*g_outputList);
+ cd->writeMemberList(*g_outputList);
+ }
+ cd->writeDocumentationForInnerClasses(*g_outputList);
+ }
+}
+
static void generateNamespaceDocs()
{
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
+
//writeNamespaceIndex(*g_outputList);
NamespaceSDict::Iterator nli(*Doxygen::namespaceSDict);
@@ -9068,24 +9158,12 @@ static void generateNamespaceDocs()
nd->writeDocumentation(*g_outputList);
}
- // for each class in the namespace...
- ClassSDict::Iterator cli(*nd->getClassSDict());
- ClassDef *cd;
- for ( ; (cd=cli.current()) ; ++cli )
+ generateNamespaceClassDocs(nd->getClassSDict());
+ if (sliceOpt)
{
- if ( ( cd->isLinkableInProject() &&
- cd->templateMaster()==0
- ) // skip external references, anonymous compounds and
- // template instances and nested classes
- && !cd->isHidden() && !cd->isEmbeddedInOuterScope()
- )
- {
- msg("Generating docs for compound %s...\n",cd->name().data());
-
- cd->writeDocumentation(*g_outputList);
- cd->writeMemberList(*g_outputList);
- }
- cd->writeDocumentationForInnerClasses(*g_outputList);
+ generateNamespaceClassDocs(nd->getInterfaceSDict());
+ generateNamespaceClassDocs(nd->getStructSDict());
+ generateNamespaceClassDocs(nd->getExceptionSDict());
}
}
}
@@ -11275,6 +11353,17 @@ void parseInput()
buildTypedefList(rootNav);
g_s.end();
+ if (Config_getBool(OPTIMIZE_OUTPUT_SLICE))
+ {
+ g_s.begin("Searching for documented sequences...\n");
+ buildSequenceList(rootNav);
+ g_s.end();
+
+ g_s.begin("Searching for documented dictionaries...\n");
+ buildDictionaryList(rootNav);
+ g_s.end();
+ }
+
g_s.begin("Searching for members imported via using declarations...\n");
// this should be after buildTypedefList in order to properly import
// used typedefs
diff --git a/src/entry.cpp b/src/entry.cpp
index a0460da..534603a 100644
--- a/src/entry.cpp
+++ b/src/entry.cpp
@@ -264,6 +264,7 @@ void Entry::reset()
protection = Public;
groupDocType = GROUPDOC_NORMAL;
id.resize(0);
+ metaData.resize(0);
m_sublist->clear();
extends->clear();
groups->clear();
diff --git a/src/entry.h b/src/entry.h
index 739b128..be0eef9 100644
--- a/src/entry.h
+++ b/src/entry.h
@@ -1,12 +1,12 @@
/******************************************************************************
*
- *
+ *
*
* Copyright (C) 1997-2015 by Dimitri van Heesch.
*
* Permission to use, copy, modify, and distribute this software and its
- * documentation under the terms of the GNU General Public License is hereby
- * granted. No representations are made about the suitability of this software
+ * documentation under the terms of the GNU General Public License is hereby
+ * granted. No representations are made about the suitability of this software
* for any purpose. It is provided "as is" without express or implied warranty.
* See the GNU General Public License for more details.
*
@@ -33,21 +33,21 @@ class ArgumentList;
struct ListItemInfo;
/** This class stores information about an inheritance relation
- */
-struct BaseInfo
+ */
+struct BaseInfo
{
/*! Creates an object representing an inheritance relation */
- BaseInfo(const char *n,Protection p,Specifier v) :
+ BaseInfo(const char *n,Protection p,Specifier v) :
name(n),prot(p),virt(v) {}
QCString name; //!< the name of the base class
Protection prot; //!< inheritance type
Specifier virt; //!< virtualness
};
-/** This struct is used to capture the tag file information
- * for an Entry.
+/** This struct is used to capture the tag file information
+ * for an Entry.
*/
-struct TagInfo
+struct TagInfo
{
QCString tagName;
QCString fileName;
@@ -55,7 +55,7 @@ struct TagInfo
};
/** Represents an unstructured piece of information, about an
- * entity found in the sources.
+ * entity found in the sources.
*
* parseMain() in scanner.l will generate a tree of these
* entries.
@@ -65,13 +65,13 @@ class Entry
public:
/*! Kind of entries that are supported */
- enum Sections {
- CLASS_SEC = 0x00000001,
+ enum Sections {
+ CLASS_SEC = 0x00000001,
NAMESPACE_SEC = 0x00000010,
COMPOUND_MASK = CLASS_SEC,
SCOPE_MASK = COMPOUND_MASK | NAMESPACE_SEC,
-
- CLASSDOC_SEC = 0x00000800,
+
+ CLASSDOC_SEC = 0x00000800,
STRUCTDOC_SEC = 0x00001000,
UNIONDOC_SEC = 0x00002000,
EXCEPTIONDOC_SEC = 0x00004000,
@@ -81,7 +81,7 @@ class Entry
CATEGORYDOC_SEC = 0x00040000,
SERVICEDOC_SEC = 0x00080000,
SINGLETONDOC_SEC = 0x00100000,
- COMPOUNDDOC_MASK = CLASSDOC_SEC | STRUCTDOC_SEC | UNIONDOC_SEC |
+ COMPOUNDDOC_MASK = CLASSDOC_SEC | STRUCTDOC_SEC | UNIONDOC_SEC |
INTERFACEDOC_SEC | EXCEPTIONDOC_SEC | PROTOCOLDOC_SEC |
CATEGORYDOC_SEC | SERVICEDOC_SEC | SINGLETONDOC_SEC,
@@ -134,7 +134,8 @@ class Entry
static const uint64 Enum = (1ULL<<12); // for Java-style enums
static const uint64 Service = (1ULL<<13); // UNO IDL
static const uint64 Singleton = (1ULL<<14); // UNO IDL
- static const uint64 ForwardDecl = (1ULL<<15); // forward declarad template classes
+ static const uint64 ForwardDecl = (1ULL<<15); // forward declared template classes
+ static const uint64 Local = (1ULL<<16); // for Slice types
// member specifiers (add new items to the beginning)
static const uint64 PrivateGettable = (1ULL<<20); // C# private getter
@@ -205,7 +206,7 @@ class Entry
/*! Returns the parent for this Entry or 0 if this entry has no parent. */
Entry *parent() const { return m_parent; }
- /*! Returns the list of children for this Entry
+ /*! Returns the list of children for this Entry
* @see addSubEntry() and removeSubEntry()
*/
const QList<Entry> *children() const { return m_sublist; }
@@ -213,14 +214,14 @@ class Entry
/*! Adds entry \a e as a child to this entry */
void addSubEntry (Entry* e) ;
- /*! Removes entry \a e from the list of children.
- * Returns a pointer to the entry or 0 if the entry was not a child.
+ /*! Removes entry \a e from the list of children.
+ * Returns a pointer to the entry or 0 if the entry was not a child.
* Note the entry will not be deleted.
- */
+ */
Entry *removeSubEntry(Entry *e);
/*! Restore the state of this Entry to the default value it has
- * at construction time.
+ * at construction time.
*/
void reset();
@@ -234,7 +235,7 @@ class Entry
// identification
int section; //!< entry type (see Sections);
- QCString type; //!< member type
+ QCString type; //!< member type
QCString name; //!< member name
TagInfo *tagInfo; //!< tag file info
@@ -242,14 +243,14 @@ class Entry
Protection protection; //!< class protection
MethodTypes mtype; //!< signal, slot, (dcop) method, or property?
uint64 spec; //!< class/member specifiers
- int initLines; //!< define/variable initializer lines to show
+ int initLines; //!< define/variable initializer lines to show
bool stat; //!< static ?
bool explicitExternal; //!< explicitly defined as external?
bool proto; //!< prototype ?
bool subGrouping; //!< automatically group class members?
bool callGraph; //!< do we need to draw the call graph?
bool callerGraph; //!< do we need to draw the caller graph?
- Specifier virt; //!< virtualness of the entry
+ Specifier virt; //!< virtualness of the entry
QCString args; //!< member argument string
QCString bitfields; //!< member's bit fields
ArgumentList *argList; //!< member arguments as a list
@@ -277,7 +278,7 @@ class Entry
int bodyLine; //!< line number of the definition in the source
int endBodyLine; //!< line number where the definition ends
int mGrpId; //!< member group id
- QList<BaseInfo> *extends; //!< list of base classes
+ QList<BaseInfo> *extends; //!< list of base classes
QList<Grouping> *groups; //!< list of groups this entry belongs to
QList<SectionInfo> *anchors; //!< list of anchors defined in this entry
QCString fileName; //!< file this entry was extracted from
@@ -290,6 +291,7 @@ class Entry
GroupDocType groupDocType;
QCString id; //!< libclang id
LocalToc localToc;
+ QCString metaData; //!< Slice metadata
static int num; //!< counts the total number of entries
@@ -297,7 +299,7 @@ class Entry
/// return the command name used to define GROUPDOC_SEC
const char *groupDocCmd() const
{
- switch( groupDocType )
+ switch( groupDocType )
{
case GROUPDOC_NORMAL: return "\\defgroup";
case GROUPDOC_ADD: return "\\addgroup";
@@ -307,11 +309,11 @@ class Entry
}
Grouping::GroupPri_t groupingPri() const
{
- if( section != GROUPDOC_SEC )
+ if( section != GROUPDOC_SEC )
{
return Grouping::GROUPING_LOWEST;
}
- switch( groupDocType )
+ switch( groupDocType )
{
case GROUPDOC_NORMAL: return Grouping::GROUPING_AUTO_DEF;
case GROUPDOC_ADD: return Grouping::GROUPING_AUTO_ADD;
@@ -320,11 +322,11 @@ class Entry
}
}
- private:
+ private:
void createSubtreeIndex(EntryNav *nav,FileStorage *storage,FileDef *fd);
Entry *m_parent; //!< parent node in the tree
QList<Entry> *m_sublist; //!< entries that are children of this one
- Entry &operator=(const Entry &);
+ Entry &operator=(const Entry &);
};
/** Wrapper for a node in the Entry tree.
@@ -357,13 +359,13 @@ class EntryNav
private:
- // navigation
+ // navigation
EntryNav *m_parent; //!< parent node in the tree
QList<EntryNav> *m_subList; //!< entries that are children of this one
// identification
int m_section; //!< entry type (see Sections);
- QCString m_type; //!< member type
+ QCString m_type; //!< member type
QCString m_name; //!< member name
TagInfo *m_tagInfo; //!< tag file info
FileDef *m_fileDef;
diff --git a/src/filedef.cpp b/src/filedef.cpp
index d9eaa4b..e2f671c 100644
--- a/src/filedef.cpp
+++ b/src/filedef.cpp
@@ -85,6 +85,9 @@ FileDef::FileDef(const char *p,const char *nm,
setReference(lref);
setDiskName(dn?dn:nm);
m_classSDict = 0;
+ m_interfaceSDict = 0;
+ m_structSDict = 0;
+ m_exceptionSDict = 0;
m_includeList = 0;
m_includeDict = 0;
m_includedByList = 0;
@@ -112,6 +115,9 @@ FileDef::FileDef(const char *p,const char *nm,
FileDef::~FileDef()
{
delete m_classSDict;
+ delete m_interfaceSDict;
+ delete m_structSDict;
+ delete m_exceptionSDict;
delete m_includeDict;
delete m_includeList;
delete m_includedByDict;
@@ -239,18 +245,25 @@ void FileDef::writeTagFile(FTextStream &tagFile)
case LayoutDocEntry::FileClasses:
{
if (m_classSDict)
- {
- SDict<ClassDef>::Iterator ci(*m_classSDict);
- ClassDef *cd;
- for (ci.toFirst();(cd=ci.current());++ci)
- {
- if (cd->isLinkableInProject())
- {
- tagFile << " <class kind=\"" << cd->compoundTypeString() <<
- "\">" << convertToXML(cd->name()) << "</class>" << endl;
- }
- }
- }
+ writeClassesToTagFile(tagFile, m_classSDict);
+ }
+ break;
+ case LayoutDocEntry::FileInterfaces:
+ {
+ if (m_interfaceSDict)
+ writeClassesToTagFile(tagFile, m_interfaceSDict);
+ }
+ break;
+ case LayoutDocEntry::FileStructs:
+ {
+ if (m_structSDict)
+ writeClassesToTagFile(tagFile, m_structSDict);
+ }
+ break;
+ case LayoutDocEntry::FileExceptions:
+ {
+ if (m_exceptionSDict)
+ writeClassesToTagFile(tagFile, m_exceptionSDict);
}
break;
case LayoutDocEntry::FileNamespaces:
@@ -417,6 +430,20 @@ void FileDef::writeBriefDescription(OutputList &ol)
ol.writeSynopsis();
}
+void FileDef::writeClassesToTagFile(FTextStream &tagFile, ClassSDict *d)
+{
+ SDict<ClassDef>::Iterator ci(*d);
+ ClassDef *cd;
+ for (ci.toFirst();(cd=ci.current());++ci)
+ {
+ if (cd->isLinkableInProject())
+ {
+ tagFile << " <class kind=\"" << cd->compoundTypeString() <<
+ "\">" << convertToXML(cd->name()) << "</class>" << endl;
+ }
+ }
+}
+
void FileDef::writeIncludeFiles(OutputList &ol)
{
if (m_includeList && m_includeList->count()>0)
@@ -557,10 +584,10 @@ void FileDef::writeNamespaceDeclarations(OutputList &ol,const QCString &title,
if (m_namespaceSDict) m_namespaceSDict->writeDeclaration(ol,title,isConstantGroup);
}
-void FileDef::writeClassDeclarations(OutputList &ol,const QCString &title)
+void FileDef::writeClassDeclarations(OutputList &ol,const QCString &title,ClassSDict *d)
{
// write list of classes
- if (m_classSDict) m_classSDict->writeDeclaration(ol,0,title,FALSE);
+ if (d) d->writeDeclaration(ol,0,title,FALSE);
}
void FileDef::writeInlineClasses(OutputList &ol)
@@ -646,10 +673,11 @@ void FileDef::writeSummaryLinks(OutputList &ol)
SrcLangExt lang=getLanguage();
for (eli.toFirst();(lde=eli.current());++eli)
{
- if ((lde->kind()==LayoutDocEntry::FileClasses &&
- m_classSDict && m_classSDict->declVisible()) ||
- (lde->kind()==LayoutDocEntry::FileNamespaces &&
- m_namespaceSDict && m_namespaceSDict->declVisible())
+ if ((lde->kind()==LayoutDocEntry::FileClasses && m_classSDict && m_classSDict->declVisible()) ||
+ (lde->kind()==LayoutDocEntry::FileInterfaces && m_interfaceSDict && m_interfaceSDict->declVisible()) ||
+ (lde->kind()==LayoutDocEntry::FileStructs && m_structSDict && m_structSDict->declVisible()) ||
+ (lde->kind()==LayoutDocEntry::FileExceptions && m_exceptionSDict && m_exceptionSDict->declVisible()) ||
+ (lde->kind()==LayoutDocEntry::FileNamespaces && m_namespaceSDict && m_namespaceSDict->declVisible())
)
{
LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
@@ -781,9 +809,27 @@ void FileDef::writeDocumentation(OutputList &ol)
case LayoutDocEntry::FileClasses:
{
LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
- writeClassDeclarations(ol,ls->title(lang));
+ writeClassDeclarations(ol,ls->title(lang),m_classSDict);
}
- break;
+ break;
+ case LayoutDocEntry::FileInterfaces:
+ {
+ LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
+ writeClassDeclarations(ol,ls->title(lang),m_interfaceSDict);
+ }
+ break;
+ case LayoutDocEntry::FileStructs:
+ {
+ LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
+ writeClassDeclarations(ol,ls->title(lang),m_structSDict);
+ }
+ break;
+ case LayoutDocEntry::FileExceptions:
+ {
+ LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
+ writeClassDeclarations(ol,ls->title(lang),m_exceptionSDict);
+ }
+ break;
case LayoutDocEntry::FileNamespaces:
{
LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
@@ -842,6 +888,9 @@ void FileDef::writeDocumentation(OutputList &ol)
case LayoutDocEntry::NamespaceNestedNamespaces:
case LayoutDocEntry::NamespaceNestedConstantGroups:
case LayoutDocEntry::NamespaceClasses:
+ case LayoutDocEntry::NamespaceInterfaces:
+ case LayoutDocEntry::NamespaceStructs:
+ case LayoutDocEntry::NamespaceExceptions:
case LayoutDocEntry::NamespaceInlineClasses:
case LayoutDocEntry::GroupClasses:
case LayoutDocEntry::GroupInlineClasses:
@@ -1160,6 +1209,14 @@ void FileDef::insertMember(MemberDef *md)
addMemberToList(MemberListType_decTypedefMembers,md);
addMemberToList(MemberListType_docTypedefMembers,md);
break;
+ case MemberType_Sequence:
+ addMemberToList(MemberListType_decSequenceMembers,md);
+ addMemberToList(MemberListType_docSequenceMembers,md);
+ break;
+ case MemberType_Dictionary:
+ addMemberToList(MemberListType_decDictionaryMembers,md);
+ addMemberToList(MemberListType_docDictionaryMembers,md);
+ break;
case MemberType_Enumeration:
addMemberToList(MemberListType_decEnumMembers,md);
addMemberToList(MemberListType_docEnumMembers,md);
@@ -1184,17 +1241,50 @@ void FileDef::insertMember(MemberDef *md)
void FileDef::insertClass(ClassDef *cd)
{
if (cd->isHidden()) return;
- if (m_classSDict==0)
+
+ ClassSDict *d;
+
+ if (Config_getBool(OPTIMIZE_OUTPUT_SLICE))
{
- m_classSDict = new ClassSDict(17);
+ if (cd->isInterface())
+ {
+ if (m_interfaceSDict==0)
+ m_interfaceSDict = new ClassSDict(17);
+ d = m_interfaceSDict;
+ }
+ else if (cd->isStruct())
+ {
+ if (m_structSDict==0)
+ m_structSDict = new ClassSDict(17);
+ d = m_structSDict;
+ }
+ else if (cd->isException())
+ {
+ if (m_exceptionSDict==0)
+ m_exceptionSDict = new ClassSDict(17);
+ d = m_exceptionSDict;
+ }
+ else
+ {
+ if (m_classSDict==0)
+ m_classSDict = new ClassSDict(17);
+ d = m_classSDict;
+ }
+ }
+ else
+ {
+ if (m_classSDict==0)
+ m_classSDict = new ClassSDict(17);
+ d = m_classSDict;
}
+
if (Config_getBool(SORT_BRIEF_DOCS))
{
- m_classSDict->inSort(cd->name(),cd);
+ d->inSort(cd->name(),cd);
}
else
{
- m_classSDict->append(cd->name(),cd);
+ d->append(cd->name(),cd);
}
}
diff --git a/src/filedef.h b/src/filedef.h
index 9167249..fe3c81d 100644
--- a/src/filedef.h
+++ b/src/filedef.h
@@ -201,7 +201,7 @@ class FileDef : public Definition
void writeSourceLink(OutputList &ol);
void writeNamespaceDeclarations(OutputList &ol,const QCString &title,
bool isConstantGroup);
- void writeClassDeclarations(OutputList &ol,const QCString &title);
+ void writeClassDeclarations(OutputList &ol,const QCString &title,ClassSDict *d);
void writeInlineClasses(OutputList &ol);
void startMemberDeclarations(OutputList &ol);
void endMemberDeclarations(OutputList &ol);
@@ -209,6 +209,7 @@ class FileDef : public Definition
void endMemberDocumentation(OutputList &ol);
void writeDetailedDescription(OutputList &ol,const QCString &title);
void writeBriefDescription(OutputList &ol);
+ void writeClassesToTagFile(FTextStream &t,ClassSDict *d);
QDict<IncludeInfo> *m_includeDict;
QList<IncludeInfo> *m_includeList;
@@ -233,6 +234,9 @@ class FileDef : public Definition
MemberGroupSDict *m_memberGroupSDict;
NamespaceSDict *m_namespaceSDict;
ClassSDict *m_classSDict;
+ ClassSDict *m_interfaceSDict;
+ ClassSDict *m_structSDict;
+ ClassSDict *m_exceptionSDict;
bool m_subGrouping;
};
diff --git a/src/ftvhelp.cpp b/src/ftvhelp.cpp
index 8c46fd5..a13d45f 100644
--- a/src/ftvhelp.cpp
+++ b/src/ftvhelp.cpp
@@ -35,6 +35,7 @@
#include "docparser.h"
#include "htmldocvisitor.h"
#include "filedef.h"
+#include "classdef.h"
#include "util.h"
#include "resourcemgr.h"
@@ -359,11 +360,41 @@ void FTVHelp::generateTree(FTextStream &t, const QList<FTVNode> &nl,int level,in
}
else if (n->def && n->def->definitionType()==Definition::TypeNamespace)
{
- t << "<span class=\"icona\"><span class=\"icon\">N</span></span>";
+ if (n->def->getLanguage() == SrcLangExt_Slice)
+ {
+ t << "<span class=\"icona\"><span class=\"icon\">M</span></span>";
+ }
+ else
+ {
+ t << "<span class=\"icona\"><span class=\"icon\">N</span></span>";
+ }
}
else if (n->def && n->def->definitionType()==Definition::TypeClass)
{
- t << "<span class=\"icona\"><span class=\"icon\">C</span></span>";
+ if (n->def->getLanguage() == SrcLangExt_Slice)
+ {
+ ClassDef *cd = dynamic_cast<ClassDef*>(n->def);
+ if (cd->isInterface())
+ {
+ t << "<span class=\"icona\"><span class=\"icon\">I</span></span>";
+ }
+ else if (cd->isStruct())
+ {
+ t << "<span class=\"icona\"><span class=\"icon\">S</span></span>";
+ }
+ else if (cd->isException())
+ {
+ t << "<span class=\"icona\"><span class=\"icon\">E</span></span>";
+ }
+ else
+ {
+ t << "<span class=\"icona\"><span class=\"icon\">C</span></span>";
+ }
+ }
+ else
+ {
+ t << "<span class=\"icona\"><span class=\"icon\">C</span></span>";
+ }
}
else
{
@@ -407,11 +438,41 @@ void FTVHelp::generateTree(FTextStream &t, const QList<FTVNode> &nl,int level,in
}
else if (n->def && n->def->definitionType()==Definition::TypeNamespace)
{
- t << "<span class=\"icona\"><span class=\"icon\">N</span></span>";
+ if (n->def->getLanguage() == SrcLangExt_Slice)
+ {
+ t << "<span class=\"icona\"><span class=\"icon\">M</span></span>";
+ }
+ else
+ {
+ t << "<span class=\"icona\"><span class=\"icon\">N</span></span>";
+ }
}
else if (n->def && n->def->definitionType()==Definition::TypeClass)
{
- t << "<span class=\"icona\"><span class=\"icon\">C</span></span>";
+ if (n->def->getLanguage() == SrcLangExt_Slice)
+ {
+ ClassDef *cd = dynamic_cast<ClassDef*>(n->def);
+ if (cd->isInterface())
+ {
+ t << "<span class=\"icona\"><span class=\"icon\">I</span></span>";
+ }
+ else if (cd->isStruct())
+ {
+ t << "<span class=\"icona\"><span class=\"icon\">S</span></span>";
+ }
+ else if (cd->isException())
+ {
+ t << "<span class=\"icona\"><span class=\"icon\">E</span></span>";
+ }
+ else
+ {
+ t << "<span class=\"icona\"><span class=\"icon\">C</span></span>";
+ }
+ }
+ else
+ {
+ t << "<span class=\"icona\"><span class=\"icon\">C</span></span>";
+ }
}
else
{
diff --git a/src/groupdef.cpp b/src/groupdef.cpp
index ccfa0df..e918b1f 100644
--- a/src/groupdef.cpp
+++ b/src/groupdef.cpp
@@ -1220,8 +1220,14 @@ void GroupDef::writeDocumentation(OutputList &ol)
case LayoutDocEntry::NamespaceNestedNamespaces:
case LayoutDocEntry::NamespaceNestedConstantGroups:
case LayoutDocEntry::NamespaceClasses:
+ case LayoutDocEntry::NamespaceInterfaces:
+ case LayoutDocEntry::NamespaceStructs:
+ case LayoutDocEntry::NamespaceExceptions:
case LayoutDocEntry::NamespaceInlineClasses:
case LayoutDocEntry::FileClasses:
+ case LayoutDocEntry::FileInterfaces:
+ case LayoutDocEntry::FileStructs:
+ case LayoutDocEntry::FileExceptions:
case LayoutDocEntry::FileNamespaces:
case LayoutDocEntry::FileConstantGroups:
case LayoutDocEntry::FileIncludes:
diff --git a/src/htmlgen.cpp b/src/htmlgen.cpp
index f0f627c..8de836d 100644
--- a/src/htmlgen.cpp
+++ b/src/htmlgen.cpp
@@ -2185,9 +2185,17 @@ static void writeDefaultQuickLinks(FTextStream &t,bool compact,
case HLI_Modules: kind = LayoutNavEntry::Modules; break;
//case HLI_Directories: kind = LayoutNavEntry::Dirs; break;
case HLI_Namespaces: kind = LayoutNavEntry::NamespaceList; altKind = LayoutNavEntry::Namespaces; break;
- case HLI_Hierarchy: kind = LayoutNavEntry::ClassHierarchy; break;
+ case HLI_ClassHierarchy: kind = LayoutNavEntry::ClassHierarchy; break;
+ case HLI_InterfaceHierarchy: kind = LayoutNavEntry::InterfaceHierarchy; break;
+ case HLI_ExceptionHierarchy: kind = LayoutNavEntry::ExceptionHierarchy; break;
case HLI_Classes: kind = LayoutNavEntry::ClassIndex; altKind = LayoutNavEntry::Classes; break;
- case HLI_Annotated: kind = LayoutNavEntry::ClassList; altKind = LayoutNavEntry::Classes; break;
+ case HLI_Interfaces: kind = LayoutNavEntry::InterfaceIndex; altKind = LayoutNavEntry::Interfaces; break;
+ case HLI_Structs: kind = LayoutNavEntry::StructIndex; altKind = LayoutNavEntry::Structs; break;
+ case HLI_Exceptions: kind = LayoutNavEntry::ExceptionIndex; altKind = LayoutNavEntry::Exceptions; break;
+ case HLI_AnnotatedClasses: kind = LayoutNavEntry::ClassList; altKind = LayoutNavEntry::Classes; break;
+ case HLI_AnnotatedInterfaces: kind = LayoutNavEntry::InterfaceList; altKind = LayoutNavEntry::Interfaces; break;
+ case HLI_AnnotatedStructs: kind = LayoutNavEntry::StructList; altKind = LayoutNavEntry::Structs; break;
+ case HLI_AnnotatedExceptions: kind = LayoutNavEntry::ExceptionList; altKind = LayoutNavEntry::Exceptions; break;
case HLI_Files: kind = LayoutNavEntry::FileList; altKind = LayoutNavEntry::Files; break;
case HLI_NamespaceMembers: kind = LayoutNavEntry::NamespaceMembers; break;
case HLI_Functions: kind = LayoutNavEntry::ClassMembers; break;
@@ -2197,6 +2205,12 @@ static void writeDefaultQuickLinks(FTextStream &t,bool compact,
case HLI_UserGroup: kind = LayoutNavEntry::UserGroup; break;
case HLI_ClassVisible: kind = LayoutNavEntry::ClassList; altKind = LayoutNavEntry::Classes;
highlightParent = TRUE; break;
+ case HLI_InterfaceVisible: kind = LayoutNavEntry::InterfaceList; altKind = LayoutNavEntry::Interfaces;
+ highlightParent = TRUE; break;
+ case HLI_StructVisible: kind = LayoutNavEntry::StructList; altKind = LayoutNavEntry::Structs;
+ highlightParent = TRUE; break;
+ case HLI_ExceptionVisible: kind = LayoutNavEntry::ExceptionList; altKind = LayoutNavEntry::Exceptions;
+ highlightParent = TRUE; break;
case HLI_NamespaceVisible: kind = LayoutNavEntry::NamespaceList; altKind = LayoutNavEntry::Namespaces;
highlightParent = TRUE; break;
case HLI_FileVisible: kind = LayoutNavEntry::FileList; altKind = LayoutNavEntry::Files;
diff --git a/src/index.cpp b/src/index.cpp
index 8be6b24..fd2d1d8 100644
--- a/src/index.cpp
+++ b/src/index.cpp
@@ -56,6 +56,14 @@
int annotatedClasses;
int annotatedClassesPrinted;
int hierarchyClasses;
+int annotatedInterfaces;
+int annotatedInterfacesPrinted;
+int hierarchyInterfaces;
+int annotatedStructs;
+int annotatedStructsPrinted;
+int annotatedExceptions;
+int annotatedExceptionsPrinted;
+int hierarchyExceptions;
int documentedFiles;
int documentedGroups;
int documentedNamespaces;
@@ -67,23 +75,34 @@ int documentedHtmlFiles;
int documentedPages;
int documentedDirs;
-static int countClassHierarchy();
+static int countClassHierarchy(ClassDef::CompoundType ct);
static void countFiles(int &htmlFiles,int &files);
static int countGroups();
static int countDirs();
static int countNamespaces();
-static int countAnnotatedClasses(int *cp);
+static int countAnnotatedClasses(int *cp,ClassDef::CompoundType ct);
static void countRelatedPages(int &docPages,int &indexPages);
void countDataStructures()
{
- annotatedClasses = countAnnotatedClasses(&annotatedClassesPrinted); // "classes" + "annotated"
- hierarchyClasses = countClassHierarchy(); // "hierarchy"
- countFiles(documentedHtmlFiles,documentedFiles); // "files"
- countRelatedPages(documentedPages,indexedPages); // "pages"
- documentedGroups = countGroups(); // "modules"
- documentedNamespaces = countNamespaces(); // "namespaces"
- documentedDirs = countDirs(); // "dirs"
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
+ annotatedClasses = countAnnotatedClasses(&annotatedClassesPrinted, ClassDef::Class); // "classes" + "annotated"
+ hierarchyClasses = countClassHierarchy(ClassDef::Class); // "hierarchy"
+ // "interfaces" + "annotated"
+ annotatedInterfaces = sliceOpt ? countAnnotatedClasses(&annotatedInterfacesPrinted, ClassDef::Interface) : 0;
+ // "interfacehierarchy"
+ hierarchyInterfaces = sliceOpt ? countClassHierarchy(ClassDef::Interface) : 0;
+ // "structs" + "annotated"
+ annotatedStructs = sliceOpt ? countAnnotatedClasses(&annotatedStructsPrinted, ClassDef::Struct) : 0;
+ // "exceptions" + "annotated"
+ annotatedExceptions = sliceOpt ? countAnnotatedClasses(&annotatedExceptionsPrinted, ClassDef::Exception) : 0;
+ // "exceptionhierarchy"
+ hierarchyExceptions = sliceOpt ? countClassHierarchy(ClassDef::Exception) : 0;
+ countFiles(documentedHtmlFiles,documentedFiles); // "files"
+ countRelatedPages(documentedPages,indexedPages); // "pages"
+ documentedGroups = countGroups(); // "modules"
+ documentedNamespaces = countNamespaces(); // "namespaces"
+ documentedDirs = countDirs(); // "dirs"
// "globals"
// "namespacemembers"
// "functions"
@@ -805,8 +824,10 @@ static void writeDirHierarchy(OutputList &ol, FTVHelp* ftv,bool addToIndex)
//----------------------------------------------------------------------------
-static void writeClassTreeForList(OutputList &ol,ClassSDict *cl,bool &started,FTVHelp* ftv,bool addToIndex)
+static void writeClassTreeForList(OutputList &ol,ClassSDict *cl,bool &started,FTVHelp* ftv,bool addToIndex,
+ ClassDef::CompoundType ct)
{
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
ClassSDict::Iterator cli(*cl);
ClassDef *cd;
for (;(cd=cli.current());++cli)
@@ -825,6 +846,10 @@ static void writeClassTreeForList(OutputList &ol,ClassSDict *cl,bool &started,FT
}
b=!hasVisibleRoot(cd->subClasses());
}
+ else if (sliceOpt && cd->compoundType() != ct)
+ {
+ continue;
+ }
else
{
b=!hasVisibleRoot(cd->baseClasses());
@@ -899,7 +924,7 @@ static void writeClassTreeForList(OutputList &ol,ClassSDict *cl,bool &started,FT
}
}
-static void writeClassHierarchy(OutputList &ol, FTVHelp* ftv,bool addToIndex)
+static void writeClassHierarchy(OutputList &ol, FTVHelp* ftv,bool addToIndex,ClassDef::CompoundType ct)
{
initClassHierarchy(Doxygen::classSDict);
initClassHierarchy(Doxygen::hiddenClasses);
@@ -909,8 +934,8 @@ static void writeClassHierarchy(OutputList &ol, FTVHelp* ftv,bool addToIndex)
ol.disable(OutputGenerator::Html);
}
bool started=FALSE;
- writeClassTreeForList(ol,Doxygen::classSDict,started,ftv,addToIndex);
- writeClassTreeForList(ol,Doxygen::hiddenClasses,started,ftv,addToIndex);
+ writeClassTreeForList(ol,Doxygen::classSDict,started,ftv,addToIndex,ct);
+ writeClassTreeForList(ol,Doxygen::hiddenClasses,started,ftv,addToIndex,ct);
if (started)
{
endIndexHierarchy(ol,0);
@@ -927,13 +952,18 @@ static void writeClassHierarchy(OutputList &ol, FTVHelp* ftv,bool addToIndex)
//----------------------------------------------------------------------------
-static int countClassesInTreeList(const ClassSDict &cl)
+static int countClassesInTreeList(const ClassSDict &cl, ClassDef::CompoundType ct)
{
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
int count=0;
ClassSDict::Iterator cli(cl);
ClassDef *cd;
for (;(cd=cli.current());++cli)
{
+ if (sliceOpt && cd->compoundType() != ct)
+ {
+ continue;
+ }
if (!hasVisibleRoot(cd->baseClasses())) // filter on root classes
{
if (cd->isVisibleInHierarchy()) // should it be visible
@@ -948,13 +978,13 @@ static int countClassesInTreeList(const ClassSDict &cl)
return count;
}
-static int countClassHierarchy()
+static int countClassHierarchy(ClassDef::CompoundType ct)
{
int count=0;
initClassHierarchy(Doxygen::classSDict);
initClassHierarchy(Doxygen::hiddenClasses);
- count+=countClassesInTreeList(*Doxygen::classSDict);
- count+=countClassesInTreeList(*Doxygen::hiddenClasses);
+ count+=countClassesInTreeList(*Doxygen::classSDict, ct);
+ count+=countClassesInTreeList(*Doxygen::hiddenClasses, ct);
return count;
}
@@ -972,7 +1002,7 @@ static void writeHierarchicalIndex(OutputList &ol)
QCString title = lne ? lne->title() : theTranslator->trClassHierarchy();
bool addToIndex = lne==0 || lne->visible();
- startFile(ol,"hierarchy",0, title, HLI_Hierarchy);
+ startFile(ol,"hierarchy",0, title, HLI_ClassHierarchy);
startTitle(ol,0);
ol.parseText(title);
endTitle(ol,0,0);
@@ -1003,7 +1033,7 @@ static void writeHierarchicalIndex(OutputList &ol)
ol.disable(OutputGenerator::Html);
Doxygen::indexList->disable();
- writeClassHierarchy(ol,0,addToIndex);
+ writeClassHierarchy(ol,0,addToIndex,ClassDef::Class);
Doxygen::indexList->enable();
ol.popGeneratorState();
@@ -1022,7 +1052,7 @@ static void writeHierarchicalIndex(OutputList &ol)
Doxygen::indexList->addContentsItem(TRUE,title,0,"hierarchy",0,TRUE,TRUE);
}
FTVHelp* ftv = new FTVHelp(FALSE);
- writeClassHierarchy(ol,ftv,addToIndex);
+ writeClassHierarchy(ol,ftv,addToIndex,ClassDef::Class);
QGString outStr;
FTextStream t(&outStr);
ftv->generateTreeViewInline(t);
@@ -1049,7 +1079,7 @@ static void writeGraphicalClassHierarchy(OutputList &ol)
ol.disableAllBut(OutputGenerator::Html);
LayoutNavEntry *lne = LayoutDocManager::instance().rootNavEntry()->find(LayoutNavEntry::ClassHierarchy);
QCString title = lne ? lne->title() : theTranslator->trClassHierarchy();
- startFile(ol,"inherits",0,title,HLI_Hierarchy,FALSE,"hierarchy");
+ startFile(ol,"inherits",0,title,HLI_ClassHierarchy,FALSE,"hierarchy");
startTitle(ol,0);
ol.parseText(title);
endTitle(ol,0,0);
@@ -1069,6 +1099,220 @@ static void writeGraphicalClassHierarchy(OutputList &ol)
//----------------------------------------------------------------------------
+static void writeHierarchicalInterfaceIndex(OutputList &ol)
+{
+ if (hierarchyInterfaces==0) return;
+ ol.pushGeneratorState();
+ //1.{
+ ol.disable(OutputGenerator::Man);
+
+ LayoutNavEntry *lne = LayoutDocManager::instance().rootNavEntry()->find(LayoutNavEntry::InterfaceHierarchy);
+ QCString title = lne ? lne->title() : theTranslator->trInterfaceHierarchy();
+ bool addToIndex = lne==0 || lne->visible();
+
+ startFile(ol,"interfacehierarchy",0, title, HLI_InterfaceHierarchy);
+ startTitle(ol,0);
+ ol.parseText(title);
+ endTitle(ol,0,0);
+ ol.startContents();
+ ol.startTextBlock();
+
+ if (Config_getBool(HAVE_DOT) && Config_getBool(GRAPHICAL_HIERARCHY))
+ {
+ ol.disable(OutputGenerator::Latex);
+ ol.disable(OutputGenerator::RTF);
+ ol.startParagraph();
+ ol.startTextLink("interfaceinherits",0);
+ ol.parseText(theTranslator->trGotoGraphicalHierarchy());
+ ol.endTextLink();
+ ol.endParagraph();
+ ol.enable(OutputGenerator::Latex);
+ ol.enable(OutputGenerator::RTF);
+ }
+ ol.parseText(lne ? lne->intro() : theTranslator->trInterfaceHierarchyDescription());
+ ol.endTextBlock();
+
+ // ---------------
+ // Static interface hierarchy for Latex/RTF
+ // ---------------
+ ol.pushGeneratorState();
+ //2.{
+ ol.disable(OutputGenerator::Html);
+ Doxygen::indexList->disable();
+
+ writeClassHierarchy(ol,0,addToIndex,ClassDef::Interface);
+
+ Doxygen::indexList->enable();
+ ol.popGeneratorState();
+ //2.}
+
+ // ---------------
+ // Dynamic interface hierarchical index for HTML
+ // ---------------
+ ol.pushGeneratorState();
+ //2.{
+ ol.disableAllBut(OutputGenerator::Html);
+
+ {
+ if (addToIndex)
+ {
+ Doxygen::indexList->addContentsItem(TRUE,title,0,"interfacehierarchy",0,TRUE,TRUE);
+ }
+ FTVHelp* ftv = new FTVHelp(FALSE);
+ writeClassHierarchy(ol,ftv,addToIndex,ClassDef::Interface);
+ QGString outStr;
+ FTextStream t(&outStr);
+ ftv->generateTreeViewInline(t);
+ ol.pushGeneratorState();
+ ol.disableAllBut(OutputGenerator::Html);
+ ol.writeString(outStr);
+ ol.popGeneratorState();
+ delete ftv;
+ }
+ ol.popGeneratorState();
+ //2.}
+ // ------
+
+ endFile(ol);
+ ol.popGeneratorState();
+ //1.}
+}
+
+//----------------------------------------------------------------------------
+
+static void writeGraphicalInterfaceHierarchy(OutputList &ol)
+{
+ if (hierarchyInterfaces==0) return;
+ ol.disableAllBut(OutputGenerator::Html);
+ LayoutNavEntry *lne = LayoutDocManager::instance().rootNavEntry()->find(LayoutNavEntry::InterfaceHierarchy);
+ QCString title = lne ? lne->title() : theTranslator->trInterfaceHierarchy();
+ startFile(ol,"interfaceinherits",0,title,HLI_InterfaceHierarchy,FALSE,"interfacehierarchy");
+ startTitle(ol,0);
+ ol.parseText(title);
+ endTitle(ol,0,0);
+ ol.startContents();
+ ol.startTextBlock();
+ ol.startParagraph();
+ ol.startTextLink("interfacehierarchy",0);
+ ol.parseText(theTranslator->trGotoTextualHierarchy());
+ ol.endTextLink();
+ ol.endParagraph();
+ ol.endTextBlock();
+ DotGfxHierarchyTable g("interface_",ClassDef::Interface);
+ ol.writeGraphicalHierarchy(g);
+ endFile(ol);
+ ol.enableAll();
+}
+
+//----------------------------------------------------------------------------
+
+static void writeHierarchicalExceptionIndex(OutputList &ol)
+{
+ if (hierarchyExceptions==0) return;
+ ol.pushGeneratorState();
+ //1.{
+ ol.disable(OutputGenerator::Man);
+
+ LayoutNavEntry *lne = LayoutDocManager::instance().rootNavEntry()->find(LayoutNavEntry::ExceptionHierarchy);
+ QCString title = lne ? lne->title() : theTranslator->trExceptionHierarchy();
+ bool addToIndex = lne==0 || lne->visible();
+
+ startFile(ol,"exceptionhierarchy",0, title, HLI_ExceptionHierarchy);
+ startTitle(ol,0);
+ ol.parseText(title);
+ endTitle(ol,0,0);
+ ol.startContents();
+ ol.startTextBlock();
+
+ if (Config_getBool(HAVE_DOT) && Config_getBool(GRAPHICAL_HIERARCHY))
+ {
+ ol.disable(OutputGenerator::Latex);
+ ol.disable(OutputGenerator::RTF);
+ ol.startParagraph();
+ ol.startTextLink("exceptioninherits",0);
+ ol.parseText(theTranslator->trGotoGraphicalHierarchy());
+ ol.endTextLink();
+ ol.endParagraph();
+ ol.enable(OutputGenerator::Latex);
+ ol.enable(OutputGenerator::RTF);
+ }
+ ol.parseText(lne ? lne->intro() : theTranslator->trExceptionHierarchyDescription());
+ ol.endTextBlock();
+
+ // ---------------
+ // Static exception hierarchy for Latex/RTF
+ // ---------------
+ ol.pushGeneratorState();
+ //2.{
+ ol.disable(OutputGenerator::Html);
+ Doxygen::indexList->disable();
+
+ writeClassHierarchy(ol,0,addToIndex,ClassDef::Exception);
+
+ Doxygen::indexList->enable();
+ ol.popGeneratorState();
+ //2.}
+
+ // ---------------
+ // Dynamic exception hierarchical index for HTML
+ // ---------------
+ ol.pushGeneratorState();
+ //2.{
+ ol.disableAllBut(OutputGenerator::Html);
+
+ {
+ if (addToIndex)
+ {
+ Doxygen::indexList->addContentsItem(TRUE,title,0,"exceptionhierarchy",0,TRUE,TRUE);
+ }
+ FTVHelp* ftv = new FTVHelp(FALSE);
+ writeClassHierarchy(ol,ftv,addToIndex,ClassDef::Exception);
+ QGString outStr;
+ FTextStream t(&outStr);
+ ftv->generateTreeViewInline(t);
+ ol.pushGeneratorState();
+ ol.disableAllBut(OutputGenerator::Html);
+ ol.writeString(outStr);
+ ol.popGeneratorState();
+ delete ftv;
+ }
+ ol.popGeneratorState();
+ //2.}
+ // ------
+
+ endFile(ol);
+ ol.popGeneratorState();
+ //1.}
+}
+
+//----------------------------------------------------------------------------
+
+static void writeGraphicalExceptionHierarchy(OutputList &ol)
+{
+ if (hierarchyExceptions==0) return;
+ ol.disableAllBut(OutputGenerator::Html);
+ LayoutNavEntry *lne = LayoutDocManager::instance().rootNavEntry()->find(LayoutNavEntry::ExceptionHierarchy);
+ QCString title = lne ? lne->title() : theTranslator->trExceptionHierarchy();
+ startFile(ol,"exceptioninherits",0,title,HLI_ExceptionHierarchy,FALSE,"exceptionhierarchy");
+ startTitle(ol,0);
+ ol.parseText(title);
+ endTitle(ol,0,0);
+ ol.startContents();
+ ol.startTextBlock();
+ ol.startParagraph();
+ ol.startTextLink("exceptionhierarchy",0);
+ ol.parseText(theTranslator->trGotoTextualHierarchy());
+ ol.endTextLink();
+ ol.endParagraph();
+ ol.endTextBlock();
+ DotGfxHierarchyTable g("exception_",ClassDef::Exception);
+ ol.writeGraphicalHierarchy(g);
+ endFile(ol);
+ ol.enableAll();
+}
+
+//----------------------------------------------------------------------------
+
static void countFiles(int &htmlFiles,int &files)
{
htmlFiles=0;
@@ -1327,8 +1571,9 @@ static int countNamespaces()
//----------------------------------------------------------------------------
-void writeClassTree(ClassSDict *clDict,FTVHelp *ftv,bool addToIndex,bool globalOnly)
+void writeClassTree(ClassSDict *clDict,FTVHelp *ftv,bool addToIndex,bool globalOnly,ClassDef::CompoundType ct)
{
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
if (clDict)
{
ClassSDict::Iterator cli(*clDict);
@@ -1350,6 +1595,11 @@ void writeClassTree(ClassSDict *clDict,FTVHelp *ftv,bool addToIndex,bool globalO
}
}
+ if (sliceOpt && cd->compoundType() != ct)
+ {
+ continue;
+ }
+
if (!globalOnly ||
cd->getOuterScope()==0 ||
cd->getOuterScope()==Doxygen::globalScope
@@ -1387,7 +1637,7 @@ void writeClassTree(ClassSDict *clDict,FTVHelp *ftv,bool addToIndex,bool globalO
if (count>0)
{
ftv->incContentsDepth();
- writeClassTree(cd->getClassSDict(),ftv,addToIndex,FALSE);
+ writeClassTree(cd->getClassSDict(),ftv,addToIndex,FALSE,ct);
ftv->decContentsDepth();
}
}
@@ -1397,8 +1647,9 @@ void writeClassTree(ClassSDict *clDict,FTVHelp *ftv,bool addToIndex,bool globalO
}
static void writeNamespaceTree(NamespaceSDict *nsDict,FTVHelp *ftv,
- bool rootOnly,bool showClasses,bool addToIndex)
+ bool rootOnly,bool showClasses,bool addToIndex,ClassDef::CompoundType ct)
{
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
if (nsDict)
{
NamespaceSDict::Iterator nli(*nsDict);
@@ -1409,7 +1660,7 @@ static void writeNamespaceTree(NamespaceSDict *nsDict,FTVHelp *ftv,
(!rootOnly || nd->getOuterScope()==Doxygen::globalScope))
{
- bool hasChildren = namespaceHasVisibleChild(nd,showClasses);
+ bool hasChildren = namespaceHasVisibleChild(nd,showClasses,sliceOpt,ct);
bool isLinkable = nd->isLinkableInProject();
QCString ref;
@@ -1440,10 +1691,34 @@ static void writeNamespaceTree(NamespaceSDict *nsDict,FTVHelp *ftv,
{
if (addToIndex) Doxygen::indexList->incContentsDepth();
ftv->incContentsDepth();
- writeNamespaceTree(nd->getNamespaceSDict(),ftv,FALSE,showClasses,addToIndex);
+ writeNamespaceTree(nd->getNamespaceSDict(),ftv,FALSE,showClasses,addToIndex,ct);
if (showClasses)
{
- writeClassTree(nd->getClassSDict(),ftv,addToIndex,FALSE);
+ ClassSDict *d;
+ if (sliceOpt)
+ {
+ if (ct == ClassDef::Interface)
+ {
+ d = nd->getInterfaceSDict();
+ }
+ else if (ct == ClassDef::Struct)
+ {
+ d = nd->getStructSDict();
+ }
+ else if (ct == ClassDef::Exception)
+ {
+ d = nd->getExceptionSDict();
+ }
+ else
+ {
+ d = nd->getClassSDict();
+ }
+ }
+ else
+ {
+ d = nd->getClassSDict();
+ }
+ writeClassTree(d,ftv,addToIndex,FALSE,ct);
}
ftv->decContentsDepth();
if (addToIndex) Doxygen::indexList->decContentsDepth();
@@ -1543,7 +1818,7 @@ static void writeNamespaceIndex(OutputList &ol)
Doxygen::indexList->incContentsDepth();
}
FTVHelp* ftv = new FTVHelp(FALSE);
- writeNamespaceTree(Doxygen::namespaceSDict,ftv,TRUE,FALSE,addToIndex);
+ writeNamespaceTree(Doxygen::namespaceSDict,ftv,TRUE,FALSE,addToIndex,ClassDef::Class);
QGString outStr;
FTextStream t(&outStr);
ftv->generateTreeViewInline(t);
@@ -1564,14 +1839,19 @@ static void writeNamespaceIndex(OutputList &ol)
//----------------------------------------------------------------------------
-static int countAnnotatedClasses(int *cp)
+static int countAnnotatedClasses(int *cp, ClassDef::CompoundType ct)
{
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
int count=0;
int countPrinted=0;
ClassSDict::Iterator cli(*Doxygen::classSDict);
ClassDef *cd;
for (;(cd=cli.current());++cli)
{
+ if (sliceOpt && cd->compoundType() != ct)
+ {
+ continue;
+ }
if (cd->isLinkableInProject() && cd->templateMaster()==0)
{
if (!cd->isEmbeddedInOuterScope())
@@ -1586,12 +1866,15 @@ static int countAnnotatedClasses(int *cp)
}
-static void writeAnnotatedClassList(OutputList &ol)
+static void writeAnnotatedClassList(OutputList &ol,ClassDef::CompoundType ct)
{
//LayoutNavEntry *lne = LayoutDocManager::instance().rootNavEntry()->find(LayoutNavEntry::ClassList);
//bool addToIndex = lne==0 || lne->visible();
bool first=TRUE;
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
+
+ ol.startIndexList();
ClassSDict::Iterator cli(*Doxygen::classSDict);
ClassDef *cd;
@@ -1610,6 +1893,11 @@ static void writeAnnotatedClassList(OutputList &ol)
first=FALSE;
}
+ if (sliceOpt && cd->compoundType() != ct)
+ {
+ continue;
+ }
+
ol.pushGeneratorState();
if (cd->isEmbeddedInOuterScope())
{
@@ -1780,8 +2068,10 @@ class UsedIndexLetters : public SIntDict<uint>
};
// write an alphabetical index of all class with a header for each letter
-static void writeAlphabeticalClassList(OutputList &ol)
+static void writeAlphabeticalClassList(OutputList &ol, ClassDef::CompoundType ct, int annotatedCount)
{
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
+
// What starting letters are used
UsedIndexLetters indexLettersUsed;
@@ -1792,6 +2082,8 @@ static void writeAlphabeticalClassList(OutputList &ol)
int headerItems=0;
for (;(cd=cli.current());++cli)
{
+ if (sliceOpt && cd->compoundType() != ct)
+ continue;
if (cd->isLinkableInProject() && cd->templateMaster()==0)
{
if (cd->getLanguage()==SrcLangExt_VHDL && !((VhdlDocGen::VhdlClasses)cd->protection()==VhdlDocGen::ENTITYCLASS ))// no architecture
@@ -1827,7 +2119,7 @@ static void writeAlphabeticalClassList(OutputList &ol)
const int columns = Config_getInt(COLS_IN_ALPHA_INDEX);
int i,j;
- int totalItems = headerItems*2 + annotatedClasses; // number of items in the table (headers span 2 items)
+ int totalItems = headerItems*2 + annotatedCount; // number of items in the table (headers span 2 items)
int rows = (totalItems + columns - 1)/columns; // number of rows in the table
//printf("headerItems=%d totalItems=%d columns=%d rows=%d itemsInLastRow=%d\n",
@@ -1844,6 +2136,8 @@ static void writeAlphabeticalClassList(OutputList &ol)
startLetter=0;
for (cli.toFirst();(cd=cli.current());++cli)
{
+ if (sliceOpt && cd->compoundType() != ct)
+ continue;
if (cd->getLanguage()==SrcLangExt_VHDL && !((VhdlDocGen::VhdlClasses)cd->protection()==VhdlDocGen::ENTITYCLASS ))// no architecture
continue;
@@ -2033,7 +2327,6 @@ static void writeAlphabeticalIndex(OutputList &ol)
if (annotatedClasses==0) return;
ol.pushGeneratorState();
ol.disableAllBut(OutputGenerator::Html);
- ol.disable(OutputGenerator::Docbook);
LayoutNavEntry *lne = LayoutDocManager::instance().rootNavEntry()->find(LayoutNavEntry::ClassIndex);
QCString title = lne ? lne->title() : theTranslator->trCompoundIndex();
bool addToIndex = lne==0 || lne->visible();
@@ -2050,7 +2343,94 @@ static void writeAlphabeticalIndex(OutputList &ol)
}
ol.startContents();
- writeAlphabeticalClassList(ol);
+ writeAlphabeticalClassList(ol, ClassDef::Class, annotatedClasses);
+ endFile(ol); // contains ol.endContents()
+
+ ol.popGeneratorState();
+}
+
+//----------------------------------------------------------------------------
+
+static void writeAlphabeticalInterfaceIndex(OutputList &ol)
+{
+ if (annotatedInterfaces==0) return;
+ ol.pushGeneratorState();
+ ol.disableAllBut(OutputGenerator::Html);
+ LayoutNavEntry *lne = LayoutDocManager::instance().rootNavEntry()->find(LayoutNavEntry::InterfaceIndex);
+ QCString title = lne ? lne->title() : theTranslator->trInterfaceIndex();
+ bool addToIndex = lne==0 || lne->visible();
+
+ startFile(ol,"interfaces",0,title,HLI_Interfaces);
+
+ startTitle(ol,0);
+ ol.parseText(title);
+ endTitle(ol,0,0);
+
+ if (addToIndex)
+ {
+ Doxygen::indexList->addContentsItem(FALSE,title,0,"interfaces",0,FALSE,TRUE);
+ }
+
+ ol.startContents();
+ writeAlphabeticalClassList(ol, ClassDef::Interface, annotatedInterfaces);
+ endFile(ol); // contains ol.endContents()
+
+ ol.popGeneratorState();
+}
+
+//----------------------------------------------------------------------------
+
+static void writeAlphabeticalStructIndex(OutputList &ol)
+{
+ if (annotatedStructs==0) return;
+ ol.pushGeneratorState();
+ ol.disableAllBut(OutputGenerator::Html);
+ LayoutNavEntry *lne = LayoutDocManager::instance().rootNavEntry()->find(LayoutNavEntry::StructIndex);
+ QCString title = lne ? lne->title() : theTranslator->trStructIndex();
+ bool addToIndex = lne==0 || lne->visible();
+
+ startFile(ol,"structs",0,title,HLI_Structs);
+
+ startTitle(ol,0);
+ ol.parseText(title);
+ endTitle(ol,0,0);
+
+ if (addToIndex)
+ {
+ Doxygen::indexList->addContentsItem(FALSE,title,0,"structs",0,FALSE,TRUE);
+ }
+
+ ol.startContents();
+ writeAlphabeticalClassList(ol, ClassDef::Struct, annotatedStructs);
+ endFile(ol); // contains ol.endContents()
+
+ ol.popGeneratorState();
+}
+
+//----------------------------------------------------------------------------
+
+static void writeAlphabeticalExceptionIndex(OutputList &ol)
+{
+ if (annotatedExceptions==0) return;
+ ol.pushGeneratorState();
+ ol.disableAllBut(OutputGenerator::Html);
+ LayoutNavEntry *lne = LayoutDocManager::instance().rootNavEntry()->find(LayoutNavEntry::ExceptionIndex);
+ QCString title = lne ? lne->title() : theTranslator->trExceptionIndex();
+ bool addToIndex = lne==0 || lne->visible();
+
+ startFile(ol,"exceptions",0,title,HLI_Exceptions);
+
+ startTitle(ol,0);
+ ol.parseText(title);
+ endTitle(ol,0,0);
+
+ if (addToIndex)
+ {
+ Doxygen::indexList->addContentsItem(FALSE,title,0,"exceptions",0,FALSE,TRUE);
+ }
+
+ ol.startContents();
+ writeAlphabeticalClassList(ol, ClassDef::Exception, annotatedExceptions);
endFile(ol); // contains ol.endContents()
ol.popGeneratorState();
@@ -2066,7 +2446,6 @@ static void writeAnnotatedIndex(OutputList &ol)
ol.pushGeneratorState();
ol.disable(OutputGenerator::Man);
- ol.disable(OutputGenerator::Docbook);
if (annotatedClassesPrinted==0)
{
ol.disable(OutputGenerator::Latex);
@@ -2078,7 +2457,7 @@ static void writeAnnotatedIndex(OutputList &ol)
bool addToIndex = lne==0 || lne->visible();
- startFile(ol,"annotated",0,title,HLI_Annotated);
+ startFile(ol,"annotated",0,title,HLI_AnnotatedClasses);
startTitle(ol,0);
ol.parseText(title);
@@ -2097,7 +2476,7 @@ static void writeAnnotatedIndex(OutputList &ol)
ol.disable(OutputGenerator::Html);
Doxygen::indexList->disable();
- writeAnnotatedClassList(ol);
+ writeAnnotatedClassList(ol, ClassDef::Class);
Doxygen::indexList->enable();
ol.popGeneratorState();
@@ -2115,8 +2494,239 @@ static void writeAnnotatedIndex(OutputList &ol)
Doxygen::indexList->incContentsDepth();
}
FTVHelp* ftv = new FTVHelp(FALSE);
- writeNamespaceTree(Doxygen::namespaceSDict,ftv,TRUE,TRUE,addToIndex);
- writeClassTree(Doxygen::classSDict,ftv,addToIndex,TRUE);
+ writeNamespaceTree(Doxygen::namespaceSDict,ftv,TRUE,TRUE,addToIndex,ClassDef::Class);
+ writeClassTree(Doxygen::classSDict,ftv,addToIndex,TRUE,ClassDef::Class);
+ QGString outStr;
+ FTextStream t(&outStr);
+ ftv->generateTreeViewInline(t);
+ ol.writeString(outStr);
+ delete ftv;
+ if (addToIndex)
+ {
+ Doxygen::indexList->decContentsDepth();
+ }
+ }
+
+ ol.popGeneratorState();
+ // ------
+
+ endFile(ol); // contains ol.endContents()
+ ol.popGeneratorState();
+}
+
+//----------------------------------------------------------------------------
+
+static void writeAnnotatedInterfaceIndex(OutputList &ol)
+{
+ //printf("writeAnnotatedInterfaceIndex: count=%d printed=%d\n",
+ // annotatedInterfaces,annotatedInterfacesPrinted);
+ if (annotatedInterfaces==0) return;
+
+ ol.pushGeneratorState();
+ ol.disable(OutputGenerator::Man);
+ if (annotatedInterfacesPrinted==0)
+ {
+ ol.disable(OutputGenerator::Latex);
+ ol.disable(OutputGenerator::RTF);
+ }
+ LayoutNavEntry *lne = LayoutDocManager::instance().rootNavEntry()->find(LayoutNavEntry::InterfaceList);
+ if (lne==0) lne = LayoutDocManager::instance().rootNavEntry()->find(LayoutNavEntry::Interfaces); // fall back
+ QCString title = lne ? lne->title() : theTranslator->trInterfaceList();
+ bool addToIndex = lne==0 || lne->visible();
+
+ startFile(ol,"annotatedinterfaces",0,title,HLI_AnnotatedInterfaces);
+
+ startTitle(ol,0);
+ ol.parseText(title);
+ endTitle(ol,0,0);
+
+ ol.startContents();
+
+ ol.startTextBlock();
+ ol.parseText(lne ? lne->intro() : theTranslator->trInterfaceListDescription());
+ ol.endTextBlock();
+
+ // ---------------
+ // Linear interface index for Latex/RTF
+ // ---------------
+ ol.pushGeneratorState();
+ ol.disable(OutputGenerator::Html);
+ Doxygen::indexList->disable();
+
+ writeAnnotatedClassList(ol, ClassDef::Interface);
+
+ Doxygen::indexList->enable();
+ ol.popGeneratorState();
+
+ // ---------------
+ // Hierarchical interface index for HTML
+ // ---------------
+ ol.pushGeneratorState();
+ ol.disableAllBut(OutputGenerator::Html);
+
+ {
+ if (addToIndex)
+ {
+ Doxygen::indexList->addContentsItem(TRUE,title,0,"annotatedinterfaces",0,TRUE,TRUE);
+ Doxygen::indexList->incContentsDepth();
+ }
+ FTVHelp* ftv = new FTVHelp(FALSE);
+ writeNamespaceTree(Doxygen::namespaceSDict,ftv,TRUE,TRUE,addToIndex,ClassDef::Interface);
+ writeClassTree(Doxygen::classSDict,ftv,addToIndex,TRUE,ClassDef::Interface);
+ QGString outStr;
+ FTextStream t(&outStr);
+ ftv->generateTreeViewInline(t);
+ ol.writeString(outStr);
+ delete ftv;
+ if (addToIndex)
+ {
+ Doxygen::indexList->decContentsDepth();
+ }
+ }
+
+ ol.popGeneratorState();
+ // ------
+
+ endFile(ol); // contains ol.endContents()
+ ol.popGeneratorState();
+}
+
+//----------------------------------------------------------------------------
+
+static void writeAnnotatedStructIndex(OutputList &ol)
+{
+ //printf("writeAnnotatedStructIndex: count=%d printed=%d\n",
+ // annotatedStructs,annotatedStructsPrinted);
+ if (annotatedStructs==0) return;
+
+ ol.pushGeneratorState();
+ ol.disable(OutputGenerator::Man);
+ if (annotatedStructsPrinted==0)
+ {
+ ol.disable(OutputGenerator::Latex);
+ ol.disable(OutputGenerator::RTF);
+ }
+ LayoutNavEntry *lne = LayoutDocManager::instance().rootNavEntry()->find(LayoutNavEntry::StructList);
+ if (lne==0) lne = LayoutDocManager::instance().rootNavEntry()->find(LayoutNavEntry::Structs); // fall back
+ QCString title = lne ? lne->title() : theTranslator->trStructList();
+ bool addToIndex = lne==0 || lne->visible();
+
+ startFile(ol,"annotatedstructs",0,title,HLI_AnnotatedStructs);
+
+ startTitle(ol,0);
+ ol.parseText(title);
+ endTitle(ol,0,0);
+
+ ol.startContents();
+
+ ol.startTextBlock();
+ ol.parseText(lne ? lne->intro() : theTranslator->trStructListDescription());
+ ol.endTextBlock();
+
+ // ---------------
+ // Linear struct index for Latex/RTF
+ // ---------------
+ ol.pushGeneratorState();
+ ol.disable(OutputGenerator::Html);
+ Doxygen::indexList->disable();
+
+ writeAnnotatedClassList(ol, ClassDef::Struct);
+
+ Doxygen::indexList->enable();
+ ol.popGeneratorState();
+
+ // ---------------
+ // Hierarchical struct index for HTML
+ // ---------------
+ ol.pushGeneratorState();
+ ol.disableAllBut(OutputGenerator::Html);
+
+ {
+ if (addToIndex)
+ {
+ Doxygen::indexList->addContentsItem(TRUE,title,0,"annotatedstructs",0,TRUE,TRUE);
+ Doxygen::indexList->incContentsDepth();
+ }
+ FTVHelp* ftv = new FTVHelp(FALSE);
+ writeNamespaceTree(Doxygen::namespaceSDict,ftv,TRUE,TRUE,addToIndex,ClassDef::Struct);
+ writeClassTree(Doxygen::classSDict,ftv,addToIndex,TRUE,ClassDef::Struct);
+ QGString outStr;
+ FTextStream t(&outStr);
+ ftv->generateTreeViewInline(t);
+ ol.writeString(outStr);
+ delete ftv;
+ if (addToIndex)
+ {
+ Doxygen::indexList->decContentsDepth();
+ }
+ }
+
+ ol.popGeneratorState();
+ // ------
+
+ endFile(ol); // contains ol.endContents()
+ ol.popGeneratorState();
+}
+
+//----------------------------------------------------------------------------
+
+static void writeAnnotatedExceptionIndex(OutputList &ol)
+{
+ //printf("writeAnnotatedExceptionIndex: count=%d printed=%d\n",
+ // annotatedExceptions,annotatedExceptionsPrinted);
+ if (annotatedExceptions==0) return;
+
+ ol.pushGeneratorState();
+ ol.disable(OutputGenerator::Man);
+ if (annotatedExceptionsPrinted==0)
+ {
+ ol.disable(OutputGenerator::Latex);
+ ol.disable(OutputGenerator::RTF);
+ }
+ LayoutNavEntry *lne = LayoutDocManager::instance().rootNavEntry()->find(LayoutNavEntry::ExceptionList);
+ if (lne==0) lne = LayoutDocManager::instance().rootNavEntry()->find(LayoutNavEntry::Exceptions); // fall back
+ QCString title = lne ? lne->title() : theTranslator->trExceptionList();
+ bool addToIndex = lne==0 || lne->visible();
+
+ startFile(ol,"annotatedexceptions",0,title,HLI_AnnotatedExceptions);
+
+ startTitle(ol,0);
+ ol.parseText(title);
+ endTitle(ol,0,0);
+
+ ol.startContents();
+
+ ol.startTextBlock();
+ ol.parseText(lne ? lne->intro() : theTranslator->trExceptionListDescription());
+ ol.endTextBlock();
+
+ // ---------------
+ // Linear interface index for Latex/RTF
+ // ---------------
+ ol.pushGeneratorState();
+ ol.disable(OutputGenerator::Html);
+ Doxygen::indexList->disable();
+
+ writeAnnotatedClassList(ol, ClassDef::Exception);
+
+ Doxygen::indexList->enable();
+ ol.popGeneratorState();
+
+ // ---------------
+ // Hierarchical interface index for HTML
+ // ---------------
+ ol.pushGeneratorState();
+ ol.disableAllBut(OutputGenerator::Html);
+
+ {
+ if (addToIndex)
+ {
+ Doxygen::indexList->addContentsItem(TRUE,title,0,"annotatedexceptions",0,TRUE,TRUE);
+ Doxygen::indexList->incContentsDepth();
+ }
+ FTVHelp* ftv = new FTVHelp(FALSE);
+ writeNamespaceTree(Doxygen::namespaceSDict,ftv,TRUE,TRUE,addToIndex,ClassDef::Exception);
+ writeClassTree(Doxygen::classSDict,ftv,addToIndex,TRUE,ClassDef::Exception);
QGString outStr;
FTextStream t(&outStr);
ftv->generateTreeViewInline(t);
@@ -2402,6 +3012,16 @@ void addNamespaceMemberNameToIndex(MemberDef *md)
g_namespaceIndexLetterUsed[NMHL_Typedefs].append(letter,md);
documentedNamespaceMembers[NMHL_Typedefs]++;
}
+ else if (md->isSequence())
+ {
+ g_namespaceIndexLetterUsed[NMHL_Sequences].append(letter,md);
+ documentedNamespaceMembers[NMHL_Sequences]++;
+ }
+ else if (md->isDictionary())
+ {
+ g_namespaceIndexLetterUsed[NMHL_Dictionaries].append(letter,md);
+ documentedNamespaceMembers[NMHL_Dictionaries]++;
+ }
else if (md->isEnumerate())
{
g_namespaceIndexLetterUsed[NMHL_Enums].append(letter,md);
@@ -2459,6 +3079,16 @@ void addFileMemberNameToIndex(MemberDef *md)
g_fileIndexLetterUsed[FMHL_Typedefs].append(letter,md);
documentedFileMembers[FMHL_Typedefs]++;
}
+ else if (md->isSequence())
+ {
+ g_fileIndexLetterUsed[FMHL_Sequences].append(letter,md);
+ documentedFileMembers[FMHL_Sequences]++;
+ }
+ else if (md->isDictionary())
+ {
+ g_fileIndexLetterUsed[FMHL_Dictionaries].append(letter,md);
+ documentedFileMembers[FMHL_Dictionaries]++;
+ }
else if (md->isEnumerate())
{
g_fileIndexLetterUsed[FMHL_Enums].append(letter,md);
@@ -2702,6 +3332,7 @@ static const FmhlInfo *getFmhlInfo(int hl)
{
static bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
static bool vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
static FmhlInfo fmhlInfo[] =
{
FmhlInfo("globals", theTranslator->trAll()),
@@ -2709,7 +3340,7 @@ static const FmhlInfo *getFmhlInfo(int hl)
fortranOpt ? theTranslator->trSubprograms() :
vhdlOpt ? theTranslator->trFunctionAndProc() :
theTranslator->trFunctions()),
- FmhlInfo("globals_vars",theTranslator->trVariables()),
+ FmhlInfo("globals_vars",sliceOpt ? theTranslator->trConstants() : theTranslator->trVariables()),
FmhlInfo("globals_type",theTranslator->trTypedefs()),
FmhlInfo("globals_enum",theTranslator->trEnumerations()),
FmhlInfo("globals_eval",theTranslator->trEnumerationValues()),
@@ -2846,6 +3477,8 @@ static void writeFileMemberIndex(OutputList &ol)
writeFileMemberIndexFiltered(ol,FMHL_Functions);
writeFileMemberIndexFiltered(ol,FMHL_Variables);
writeFileMemberIndexFiltered(ol,FMHL_Typedefs);
+ writeFileMemberIndexFiltered(ol,FMHL_Sequences);
+ writeFileMemberIndexFiltered(ol,FMHL_Dictionaries);
writeFileMemberIndexFiltered(ol,FMHL_Enums);
writeFileMemberIndexFiltered(ol,FMHL_EnumValues);
writeFileMemberIndexFiltered(ol,FMHL_Defines);
@@ -2870,6 +3503,7 @@ static const NmhlInfo *getNmhlInfo(int hl)
{
static bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
static bool vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
static NmhlInfo nmhlInfo[] =
{
NmhlInfo("namespacemembers", theTranslator->trAll()),
@@ -2877,8 +3511,10 @@ static const NmhlInfo *getNmhlInfo(int hl)
fortranOpt ? theTranslator->trSubprograms() :
vhdlOpt ? theTranslator->trFunctionAndProc() :
theTranslator->trFunctions()),
- NmhlInfo("namespacemembers_vars",theTranslator->trVariables()),
+ NmhlInfo("namespacemembers_vars",sliceOpt ? theTranslator->trConstants() : theTranslator->trVariables()),
NmhlInfo("namespacemembers_type",theTranslator->trTypedefs()),
+ NmhlInfo("namespacemembers_sequ",theTranslator->trSequences()),
+ NmhlInfo("namespacemembers_dict",theTranslator->trDictionaries()),
NmhlInfo("namespacemembers_enum",theTranslator->trEnumerations()),
NmhlInfo("namespacemembers_eval",theTranslator->trEnumerationValues())
};
@@ -3018,6 +3654,8 @@ static void writeNamespaceMemberIndex(OutputList &ol)
writeNamespaceMemberIndexFiltered(ol,NMHL_Functions);
writeNamespaceMemberIndexFiltered(ol,NMHL_Variables);
writeNamespaceMemberIndexFiltered(ol,NMHL_Typedefs);
+ writeNamespaceMemberIndexFiltered(ol,NMHL_Sequences);
+ writeNamespaceMemberIndexFiltered(ol,NMHL_Dictionaries);
writeNamespaceMemberIndexFiltered(ol,NMHL_Enums);
writeNamespaceMemberIndexFiltered(ol,NMHL_EnumValues);
if (documentedNamespaceMembers[NMHL_All]>0 && addToIndex)
@@ -4044,6 +4682,12 @@ static void writeIndex(OutputList &ol)
ol.parseText(/*projPrefix+*/(fortranOpt?theTranslator->trModulesIndex():theTranslator->trNamespaceIndex()));
ol.endIndexSection(isNamespaceIndex);
}
+ if (hierarchyInterfaces>0)
+ {
+ ol.startIndexSection(isClassHierarchyIndex);
+ ol.parseText(/*projPrefix+*/theTranslator->trHierarchicalIndex());
+ ol.endIndexSection(isClassHierarchyIndex);
+ }
if (hierarchyClasses>0)
{
ol.startIndexSection(isClassHierarchyIndex);
@@ -4054,6 +4698,18 @@ static void writeIndex(OutputList &ol)
));
ol.endIndexSection(isClassHierarchyIndex);
}
+ if (hierarchyExceptions>0)
+ {
+ ol.startIndexSection(isClassHierarchyIndex);
+ ol.parseText(/*projPrefix+*/theTranslator->trHierarchicalIndex());
+ ol.endIndexSection(isClassHierarchyIndex);
+ }
+ if (annotatedInterfacesPrinted>0)
+ {
+ ol.startIndexSection(isCompoundIndex);
+ ol.parseText(/*projPrefix+*/theTranslator->trInterfaceIndex());
+ ol.endIndexSection(isCompoundIndex);
+ }
if (annotatedClassesPrinted>0)
{
ol.startIndexSection(isCompoundIndex);
@@ -4064,6 +4720,18 @@ static void writeIndex(OutputList &ol)
));
ol.endIndexSection(isCompoundIndex);
}
+ if (annotatedStructsPrinted>0)
+ {
+ ol.startIndexSection(isCompoundIndex);
+ ol.parseText(/*projPrefix+*/theTranslator->trStructIndex());
+ ol.endIndexSection(isCompoundIndex);
+ }
+ if (annotatedExceptionsPrinted>0)
+ {
+ ol.startIndexSection(isCompoundIndex);
+ ol.parseText(/*projPrefix+*/theTranslator->trExceptionIndex());
+ ol.endIndexSection(isCompoundIndex);
+ }
if (documentedFiles>0)
{
ol.startIndexSection(isFileIndex);
@@ -4085,12 +4753,30 @@ static void writeIndex(OutputList &ol)
ol.parseText(/*projPrefix+*/(fortranOpt?theTranslator->trModuleDocumentation():theTranslator->trNamespaceDocumentation()));
ol.endIndexSection(isNamespaceDocumentation);
}
+ if (annotatedInterfacesPrinted>0)
+ {
+ ol.startIndexSection(isClassDocumentation);
+ ol.parseText(/*projPrefix+*/theTranslator->trInterfaceDocumentation());
+ ol.endIndexSection(isClassDocumentation);
+ }
if (annotatedClassesPrinted>0)
{
ol.startIndexSection(isClassDocumentation);
ol.parseText(/*projPrefix+*/(fortranOpt?theTranslator->trTypeDocumentation():theTranslator->trClassDocumentation()));
ol.endIndexSection(isClassDocumentation);
}
+ if (annotatedStructsPrinted>0)
+ {
+ ol.startIndexSection(isClassDocumentation);
+ ol.parseText(/*projPrefix+*/theTranslator->trStructDocumentation());
+ ol.endIndexSection(isClassDocumentation);
+ }
+ if (annotatedExceptionsPrinted>0)
+ {
+ ol.startIndexSection(isClassDocumentation);
+ ol.parseText(/*projPrefix+*/theTranslator->trExceptionDocumentation());
+ ol.endIndexSection(isClassDocumentation);
+ }
if (documentedFiles>0)
{
ol.startIndexSection(isFileDocumentation);
@@ -4129,6 +4815,7 @@ static QArray<bool> indexWritten;
static void writeIndexHierarchyEntries(OutputList &ol,const QList<LayoutNavEntry> &entries)
{
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
QListIterator<LayoutNavEntry> li(entries);
LayoutNavEntry *lne;
for (li.toFirst();(lne=li.current());++li)
@@ -4226,8 +4913,101 @@ static void writeIndexHierarchyEntries(OutputList &ol,const QList<LayoutNavEntry
}
break;
case LayoutNavEntry::ClassMembers:
- msg("Generating member index...\n");
- writeClassMemberIndex(ol);
+ if (!sliceOpt)
+ {
+ msg("Generating member index...\n");
+ writeClassMemberIndex(ol);
+ }
+ break;
+ case LayoutNavEntry::Interfaces:
+ if (sliceOpt && annotatedInterfaces>0 && addToIndex)
+ {
+ Doxygen::indexList->addContentsItem(TRUE,lne->title(),0,lne->baseFile(),0);
+ Doxygen::indexList->incContentsDepth();
+ needsClosing=TRUE;
+ }
+ break;
+ case LayoutNavEntry::InterfaceList:
+ if (sliceOpt)
+ {
+ msg("Generating annotated interface index...\n");
+ writeAnnotatedInterfaceIndex(ol);
+ }
+ break;
+ case LayoutNavEntry::InterfaceIndex:
+ if (sliceOpt)
+ {
+ msg("Generating alphabetical interface index...\n");
+ writeAlphabeticalInterfaceIndex(ol);
+ }
+ break;
+ case LayoutNavEntry::InterfaceHierarchy:
+ if (sliceOpt)
+ {
+ msg("Generating hierarchical interface index...\n");
+ writeHierarchicalInterfaceIndex(ol);
+ if (Config_getBool(HAVE_DOT) && Config_getBool(GRAPHICAL_HIERARCHY))
+ {
+ msg("Generating graphical interface hierarchy...\n");
+ writeGraphicalInterfaceHierarchy(ol);
+ }
+ }
+ break;
+ case LayoutNavEntry::Structs:
+ if (sliceOpt && annotatedStructs>0 && addToIndex)
+ {
+ Doxygen::indexList->addContentsItem(TRUE,lne->title(),0,lne->baseFile(),0);
+ Doxygen::indexList->incContentsDepth();
+ needsClosing=TRUE;
+ }
+ break;
+ case LayoutNavEntry::StructList:
+ if (sliceOpt)
+ {
+ msg("Generating annotated struct index...\n");
+ writeAnnotatedStructIndex(ol);
+ }
+ break;
+ case LayoutNavEntry::StructIndex:
+ if (sliceOpt)
+ {
+ msg("Generating alphabetical struct index...\n");
+ writeAlphabeticalStructIndex(ol);
+ }
+ break;
+ case LayoutNavEntry::Exceptions:
+ if (sliceOpt && annotatedExceptions>0 && addToIndex)
+ {
+ Doxygen::indexList->addContentsItem(TRUE,lne->title(),0,lne->baseFile(),0);
+ Doxygen::indexList->incContentsDepth();
+ needsClosing=TRUE;
+ }
+ break;
+ case LayoutNavEntry::ExceptionList:
+ if (sliceOpt)
+ {
+ msg("Generating annotated exception index...\n");
+ writeAnnotatedExceptionIndex(ol);
+ }
+ break;
+ case LayoutNavEntry::ExceptionIndex:
+ if (sliceOpt)
+ {
+ msg("Generating alphabetical exception index...\n");
+ writeAlphabeticalExceptionIndex(ol);
+ }
+ break;
+ case LayoutNavEntry::ExceptionHierarchy:
+ if (sliceOpt)
+ {
+ msg("Generating hierarchical exception index...\n");
+ writeHierarchicalExceptionIndex(ol);
+ if (Config_getBool(HAVE_DOT) && Config_getBool(GRAPHICAL_HIERARCHY))
+ {
+ msg("Generating graphical exception hierarchy...\n");
+ writeGraphicalExceptionHierarchy(ol);
+ }
+ }
break;
case LayoutNavEntry::Files:
{
@@ -4341,26 +5121,38 @@ static bool quickLinkVisible(LayoutNavEntry::Kind kind)
{
static bool showFiles = Config_getBool(SHOW_FILES);
static bool showNamespaces = Config_getBool(SHOW_NAMESPACES);
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
switch (kind)
{
- case LayoutNavEntry::MainPage: return TRUE;
- case LayoutNavEntry::User: return TRUE;
- case LayoutNavEntry::UserGroup: return TRUE;
- case LayoutNavEntry::Pages: return indexedPages>0;
- case LayoutNavEntry::Modules: return documentedGroups>0;
- case LayoutNavEntry::Namespaces: return documentedNamespaces>0 && showNamespaces;
- case LayoutNavEntry::NamespaceList: return documentedNamespaces>0 && showNamespaces;
- case LayoutNavEntry::NamespaceMembers: return documentedNamespaceMembers[NMHL_All]>0;
- case LayoutNavEntry::Classes: return annotatedClasses>0;
- case LayoutNavEntry::ClassList: return annotatedClasses>0;
- case LayoutNavEntry::ClassIndex: return annotatedClasses>0;
- case LayoutNavEntry::ClassHierarchy: return hierarchyClasses>0;
- case LayoutNavEntry::ClassMembers: return documentedClassMembers[CMHL_All]>0;
- case LayoutNavEntry::Files: return documentedHtmlFiles>0 && showFiles;
- case LayoutNavEntry::FileList: return documentedHtmlFiles>0 && showFiles;
- case LayoutNavEntry::FileGlobals: return documentedFileMembers[FMHL_All]>0;
+ case LayoutNavEntry::MainPage: return TRUE;
+ case LayoutNavEntry::User: return TRUE;
+ case LayoutNavEntry::UserGroup: return TRUE;
+ case LayoutNavEntry::Pages: return indexedPages>0;
+ case LayoutNavEntry::Modules: return documentedGroups>0;
+ case LayoutNavEntry::Namespaces: return documentedNamespaces>0 && showNamespaces;
+ case LayoutNavEntry::NamespaceList: return documentedNamespaces>0 && showNamespaces;
+ case LayoutNavEntry::NamespaceMembers: return documentedNamespaceMembers[NMHL_All]>0;
+ case LayoutNavEntry::Classes: return annotatedClasses>0;
+ case LayoutNavEntry::ClassList: return annotatedClasses>0;
+ case LayoutNavEntry::ClassIndex: return annotatedClasses>0;
+ case LayoutNavEntry::ClassHierarchy: return hierarchyClasses>0;
+ case LayoutNavEntry::ClassMembers: return documentedClassMembers[CMHL_All]>0 && !sliceOpt;
+ case LayoutNavEntry::Interfaces: return annotatedInterfaces>0;
+ case LayoutNavEntry::InterfaceList: return annotatedInterfaces>0;
+ case LayoutNavEntry::InterfaceIndex: return annotatedInterfaces>0;
+ case LayoutNavEntry::InterfaceHierarchy: return hierarchyInterfaces>0;
+ case LayoutNavEntry::Structs: return annotatedStructs>0;
+ case LayoutNavEntry::StructList: return annotatedStructs>0;
+ case LayoutNavEntry::StructIndex: return annotatedStructs>0;
+ case LayoutNavEntry::Exceptions: return annotatedExceptions>0;
+ case LayoutNavEntry::ExceptionList: return annotatedExceptions>0;
+ case LayoutNavEntry::ExceptionIndex: return annotatedExceptions>0;
+ case LayoutNavEntry::ExceptionHierarchy: return hierarchyExceptions>0;
+ case LayoutNavEntry::Files: return documentedHtmlFiles>0 && showFiles;
+ case LayoutNavEntry::FileList: return documentedHtmlFiles>0 && showFiles;
+ case LayoutNavEntry::FileGlobals: return documentedFileMembers[FMHL_All]>0;
//case LayoutNavEntry::Dirs: return documentedDirs>0;
- case LayoutNavEntry::Examples: return Doxygen::exampleSDict->count()>0;
+ case LayoutNavEntry::Examples: return Doxygen::exampleSDict->count()>0;
case LayoutNavEntry::None: // should never happen, means not properly initialized
assert(kind != LayoutNavEntry::None);
return FALSE;
diff --git a/src/index.h b/src/index.h
index ace3614..63dd494 100644
--- a/src/index.h
+++ b/src/index.h
@@ -184,9 +184,17 @@ enum HighlightedItem
HLI_Modules,
//HLI_Directories,
HLI_Namespaces,
- HLI_Hierarchy,
+ HLI_ClassHierarchy,
+ HLI_InterfaceHierarchy,
+ HLI_ExceptionHierarchy,
HLI_Classes,
- HLI_Annotated,
+ HLI_Interfaces,
+ HLI_Structs,
+ HLI_Exceptions,
+ HLI_AnnotatedClasses,
+ HLI_AnnotatedInterfaces,
+ HLI_AnnotatedStructs,
+ HLI_AnnotatedExceptions,
HLI_Files,
HLI_NamespaceMembers,
HLI_Functions,
@@ -197,6 +205,9 @@ enum HighlightedItem
HLI_UserGroup,
HLI_ClassVisible,
+ HLI_InterfaceVisible,
+ HLI_StructVisible,
+ HLI_ExceptionVisible,
HLI_NamespaceVisible,
HLI_FileVisible
};
@@ -221,6 +232,8 @@ enum FileMemberHighlight
FMHL_Functions,
FMHL_Variables,
FMHL_Typedefs,
+ FMHL_Sequences,
+ FMHL_Dictionaries,
FMHL_Enums,
FMHL_EnumValues,
FMHL_Defines,
@@ -233,6 +246,8 @@ enum NamespaceMemberHighlight
NMHL_Functions,
NMHL_Variables,
NMHL_Typedefs,
+ NMHL_Sequences,
+ NMHL_Dictionaries,
NMHL_Enums,
NMHL_EnumValues,
NMHL_Total = NMHL_EnumValues+1
diff --git a/src/layout.cpp b/src/layout.cpp
index a3849b5..9a6b972 100644
--- a/src/layout.cpp
+++ b/src/layout.cpp
@@ -50,6 +50,9 @@ static const char layout_default[] =
#define COMPILE_FOR_4_OPTIONS(def,langId1,text1,langId2,text2,langId3,text3,langId4,text4) \
COMPILE_FOR_3_OPTIONS(def,langId1,text1,langId2,text2,langId3,text3)+ADD_OPTION(langId4,text4)
+#define COMPILE_FOR_5_OPTIONS(def,langId1,text1,langId2,text2,langId3,text3,langId4,text4,langId5,text5) \
+ COMPILE_FOR_4_OPTIONS(def,langId1,text1,langId2,text2,langId3,text3,langId4,text4)+ADD_OPTION(langId5,text5)
+
static bool elemIsVisible(const QXmlAttributes &attrib,bool defVal=TRUE)
{
QCString visible = attrib.value("visible").utf8();
@@ -265,6 +268,7 @@ class LayoutParser : public QXmlDefaultHandler
//bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
//bool vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
//bool javaOpt = Config_getBool(OPTIMIZE_OUTPUT_JAVA);
+ bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
// start & end handlers
m_sHandler.insert("doxygenlayout",
@@ -331,9 +335,10 @@ class LayoutParser : public QXmlDefaultHandler
m_sHandler.insert("class/memberdecl/publicmethods",
new StartElementHandlerMember(this,&LayoutParser::startMemberDeclEntry,
MemberListType_pubMethods,
- COMPILE_FOR_1_OPTION(
+ COMPILE_FOR_2_OPTIONS(
theTranslator->trPublicMembers(),
- SrcLangExt_ObjC,theTranslator->trInstanceMethods()
+ SrcLangExt_ObjC,theTranslator->trInstanceMethods(),
+ SrcLangExt_Slice,theTranslator->trOperations()
)));
m_sHandler.insert("class/memberdecl/publicstaticmethods",
new StartElementHandlerMember(this,&LayoutParser::startMemberDeclEntry,
@@ -344,7 +349,11 @@ class LayoutParser : public QXmlDefaultHandler
)));
m_sHandler.insert("class/memberdecl/publicattributes",
new StartElementHandlerMember(this,&LayoutParser::startMemberDeclEntry,
- MemberListType_pubAttribs,theTranslator->trPublicAttribs()));
+ MemberListType_pubAttribs,
+ COMPILE_FOR_1_OPTION(
+ theTranslator->trPublicAttribs(),
+ SrcLangExt_Slice,theTranslator->trDataMembers()
+ )));
m_sHandler.insert("class/memberdecl/publicstaticattributes",
new StartElementHandlerMember(this,&LayoutParser::startMemberDeclEntry,
MemberListType_pubStaticAttribs,theTranslator->trStaticPublicAttribs()));
@@ -440,17 +449,22 @@ class LayoutParser : public QXmlDefaultHandler
m_sHandler.insert("class/memberdef/functions",
new StartElementHandlerMember(this,&LayoutParser::startMemberDefEntry,
MemberListType_functionMembers,
- COMPILE_FOR_2_OPTIONS(
+ COMPILE_FOR_3_OPTIONS(
theTranslator->trMemberFunctionDocumentation(),
SrcLangExt_ObjC,theTranslator->trMethodDocumentation(),
- SrcLangExt_Fortran,theTranslator->trMemberFunctionDocumentationFortran()
+ SrcLangExt_Fortran,theTranslator->trMemberFunctionDocumentationFortran(),
+ SrcLangExt_Slice,theTranslator->trOperationDocumentation()
)));
m_sHandler.insert("class/memberdef/related",
new StartElementHandlerMember(this,&LayoutParser::startMemberDefEntry,
MemberListType_relatedMembers,theTranslator->trRelatedFunctionDocumentation()));
m_sHandler.insert("class/memberdef/variables",
new StartElementHandlerMember(this,&LayoutParser::startMemberDefEntry,
- MemberListType_variableMembers,theTranslator->trMemberDataDocumentation()));
+ MemberListType_variableMembers,
+ COMPILE_FOR_1_OPTION(
+ theTranslator->trMemberDataDocumentation(),
+ SrcLangExt_Slice,theTranslator->trDataMemberDocumentation()
+ )));
m_sHandler.insert("class/memberdef/properties",
new StartElementHandlerMember(this,&LayoutParser::startMemberDefEntry,
MemberListType_propertyMembers,theTranslator->trPropertyDocumentation()));
@@ -477,16 +491,21 @@ class LayoutParser : public QXmlDefaultHandler
new StartElementHandler(this,&LayoutParser::startMemberDecl));
m_sHandler.insert("namespace/memberdecl/nestednamespaces",
new StartElementHandlerSection(this,LayoutDocEntry::NamespaceNestedNamespaces,&LayoutParser::startSectionEntry,
- COMPILE_FOR_4_OPTIONS(
+ COMPILE_FOR_5_OPTIONS(
theTranslator->trNamespaces(),
SrcLangExt_Java,theTranslator->trPackages(),
SrcLangExt_VHDL,theTranslator->trPackages(),
SrcLangExt_IDL,theTranslator->trModules(),
- SrcLangExt_Fortran,theTranslator->trModules()
+ SrcLangExt_Fortran,theTranslator->trModules(),
+ SrcLangExt_Slice,sliceOpt ? theTranslator->trModules() :
+ theTranslator->trNamespaces()
)));
m_sHandler.insert("namespace/memberdecl/constantgroups",
new StartElementHandlerSection(this,LayoutDocEntry::NamespaceNestedConstantGroups,&LayoutParser::startSectionEntry,
theTranslator->trConstantGroups()));
+ m_sHandler.insert("namespace/memberdecl/interfaces",
+ new StartElementHandlerSection(this,LayoutDocEntry::NamespaceInterfaces,&LayoutParser::startSectionEntry,
+ theTranslator->trSliceInterfaces()));
m_sHandler.insert("namespace/memberdecl/classes",
new StartElementHandlerSection(this,LayoutDocEntry::NamespaceClasses,&LayoutParser::startSectionEntry,
COMPILE_FOR_2_OPTIONS(
@@ -494,11 +513,23 @@ class LayoutParser : public QXmlDefaultHandler
SrcLangExt_VHDL,theTranslator->trVhdlType(VhdlDocGen::ENTITY,FALSE),
SrcLangExt_Fortran,theTranslator->trDataTypes()
)));
+ m_sHandler.insert("namespace/memberdecl/structs",
+ new StartElementHandlerSection(this,LayoutDocEntry::NamespaceStructs,&LayoutParser::startSectionEntry,
+ theTranslator->trStructs()));
+ m_sHandler.insert("namespace/memberdecl/exceptions",
+ new StartElementHandlerSection(this,LayoutDocEntry::NamespaceExceptions,&LayoutParser::startSectionEntry,
+ theTranslator->trExceptions()));
m_sHandler.insert("namespace/memberdecl/membergroups",
new StartElementHandlerKind(this,LayoutDocEntry::MemberGroups,&LayoutParser::startSimpleEntry));
m_sHandler.insert("namespace/memberdecl/typedefs",
new StartElementHandlerMember(this,&LayoutParser::startMemberDeclEntry,
MemberListType_decTypedefMembers,theTranslator->trTypedefs()));
+ m_sHandler.insert("namespace/memberdecl/sequences",
+ new StartElementHandlerMember(this,&LayoutParser::startMemberDeclEntry,
+ MemberListType_decSequenceMembers,theTranslator->trSequences()));
+ m_sHandler.insert("namespace/memberdecl/dictionaries",
+ new StartElementHandlerMember(this,&LayoutParser::startMemberDeclEntry,
+ MemberListType_decDictionaryMembers,theTranslator->trDictionaries()));
m_sHandler.insert("namespace/memberdecl/enums",
new StartElementHandlerMember(this,&LayoutParser::startMemberDeclEntry,
MemberListType_decEnumMembers,theTranslator->trEnumerations()));
@@ -512,7 +543,8 @@ class LayoutParser : public QXmlDefaultHandler
)));
m_sHandler.insert("namespace/memberdecl/variables",
new StartElementHandlerMember(this,&LayoutParser::startMemberDeclEntry,
- MemberListType_decVarMembers,theTranslator->trVariables()));
+ MemberListType_decVarMembers,
+ sliceOpt ? theTranslator->trConstants() : theTranslator->trVariables()));
m_eHandler.insert("namespace/memberdecl",
new EndElementHandler(this,&LayoutParser::endMemberDecl));
m_sHandler.insert("namespace/memberdef",
@@ -526,6 +558,13 @@ class LayoutParser : public QXmlDefaultHandler
m_sHandler.insert("namespace/memberdef/typedefs",
new StartElementHandlerMember(this,&LayoutParser::startMemberDefEntry,
MemberListType_docTypedefMembers,theTranslator->trTypedefDocumentation()));
+ m_sHandler.insert("namespace/memberdef/sequences",
+ new StartElementHandlerMember(this,&LayoutParser::startMemberDefEntry,
+ MemberListType_docSequenceMembers,theTranslator->trSequenceDocumentation()));
+ m_sHandler.insert("namespace/memberdef/dictionaries",
+ new StartElementHandlerMember(this,&LayoutParser::startMemberDefEntry,
+ MemberListType_docDictionaryMembers,
+ theTranslator->trDictionaryDocumentation()));
m_sHandler.insert("namespace/memberdef/enums",
new StartElementHandlerMember(this,&LayoutParser::startMemberDefEntry,
MemberListType_docEnumMembers,theTranslator->trEnumerationTypeDocumentation()));
@@ -538,7 +577,9 @@ class LayoutParser : public QXmlDefaultHandler
)));
m_sHandler.insert("namespace/memberdef/variables",
new StartElementHandlerMember(this,&LayoutParser::startMemberDefEntry,
- MemberListType_docVarMembers,theTranslator->trVariableDocumentation()));
+ MemberListType_docVarMembers,
+ sliceOpt ? theTranslator->trConstantDocumentation() :
+ theTranslator->trVariableDocumentation()));
m_eHandler.insert("namespace/memberdef",
new EndElementHandler(this,&LayoutParser::endMemberDef));
m_eHandler.insert("namespace",
@@ -566,6 +607,9 @@ class LayoutParser : public QXmlDefaultHandler
new StartElementHandlerKind(this,LayoutDocEntry::MemberGroups,&LayoutParser::startSimpleEntry));
m_sHandler.insert("file/memberdecl",
new StartElementHandler(this,&LayoutParser::startMemberDecl));
+ m_sHandler.insert("file/memberdecl/interfaces",
+ new StartElementHandlerSection(this,LayoutDocEntry::FileInterfaces,&LayoutParser::startSectionEntry,
+ theTranslator->trSliceInterfaces()));
m_sHandler.insert("file/memberdecl/classes",
new StartElementHandlerSection(this,LayoutDocEntry::FileClasses,&LayoutParser::startSectionEntry,
COMPILE_FOR_2_OPTIONS(
@@ -573,13 +617,20 @@ class LayoutParser : public QXmlDefaultHandler
SrcLangExt_VHDL,theTranslator->trVhdlType(VhdlDocGen::ENTITY,FALSE),
SrcLangExt_Fortran,theTranslator->trDataTypes()
)));
+ m_sHandler.insert("file/memberdecl/structs",
+ new StartElementHandlerSection(this,LayoutDocEntry::FileStructs,&LayoutParser::startSectionEntry,
+ theTranslator->trStructs()));
+ m_sHandler.insert("file/memberdecl/exceptions",
+ new StartElementHandlerSection(this,LayoutDocEntry::FileExceptions,&LayoutParser::startSectionEntry,
+ theTranslator->trExceptions()));
m_sHandler.insert("file/memberdecl/namespaces",
new StartElementHandlerSection(this,LayoutDocEntry::FileNamespaces,&LayoutParser::startSectionEntry,
- COMPILE_FOR_3_OPTIONS(
+ COMPILE_FOR_4_OPTIONS(
theTranslator->trNamespaces(),
SrcLangExt_Java,theTranslator->trPackages(),
SrcLangExt_IDL,theTranslator->trModules(),
- SrcLangExt_Fortran,theTranslator->trModules()
+ SrcLangExt_Fortran,theTranslator->trModules(),
+ SrcLangExt_Slice,theTranslator->trModules()
)));
m_sHandler.insert("file/memberdecl/constantgroups",
new StartElementHandlerSection(this,LayoutDocEntry::FileConstantGroups,&LayoutParser::startSectionEntry,
@@ -590,6 +641,12 @@ class LayoutParser : public QXmlDefaultHandler
m_sHandler.insert("file/memberdecl/typedefs",
new StartElementHandlerMember(this,&LayoutParser::startMemberDeclEntry,
MemberListType_decTypedefMembers,theTranslator->trTypedefs()));
+ m_sHandler.insert("file/memberdecl/sequences",
+ new StartElementHandlerMember(this,&LayoutParser::startMemberDeclEntry,
+ MemberListType_decSequenceMembers,theTranslator->trSequences()));
+ m_sHandler.insert("file/memberdecl/dictionaries",
+ new StartElementHandlerMember(this,&LayoutParser::startMemberDeclEntry,
+ MemberListType_decDictionaryMembers,theTranslator->trDictionaries()));
m_sHandler.insert("file/memberdecl/enums",
new StartElementHandlerMember(this,&LayoutParser::startMemberDeclEntry,
MemberListType_decEnumMembers,theTranslator->trEnumerations()));
@@ -603,7 +660,8 @@ class LayoutParser : public QXmlDefaultHandler
)));
m_sHandler.insert("file/memberdecl/variables",
new StartElementHandlerMember(this,&LayoutParser::startMemberDeclEntry,
- MemberListType_decVarMembers,theTranslator->trVariables()));
+ MemberListType_decVarMembers,
+ sliceOpt ? theTranslator->trConstants() : theTranslator->trVariables()));
m_eHandler.insert("file/memberdecl",
new EndElementHandler(this,&LayoutParser::endMemberDecl));
@@ -621,6 +679,13 @@ class LayoutParser : public QXmlDefaultHandler
m_sHandler.insert("file/memberdef/typedefs",
new StartElementHandlerMember(this,&LayoutParser::startMemberDefEntry,
MemberListType_docTypedefMembers,theTranslator->trTypedefDocumentation()));
+ m_sHandler.insert("file/memberdef/sequences",
+ new StartElementHandlerMember(this,&LayoutParser::startMemberDefEntry,
+ MemberListType_docSequenceMembers,theTranslator->trSequenceDocumentation()));
+ m_sHandler.insert("file/memberdef/dictionaries",
+ new StartElementHandlerMember(this,&LayoutParser::startMemberDefEntry,
+ MemberListType_docDictionaryMembers,
+ theTranslator->trDictionaryDocumentation()));
m_sHandler.insert("file/memberdef/enums",
new StartElementHandlerMember(this,&LayoutParser::startMemberDefEntry,
MemberListType_docEnumMembers,
@@ -689,6 +754,12 @@ class LayoutParser : public QXmlDefaultHandler
m_sHandler.insert("group/memberdecl/typedefs",
new StartElementHandlerMember(this,&LayoutParser::startMemberDeclEntry,
MemberListType_decTypedefMembers,theTranslator->trTypedefs()));
+ m_sHandler.insert("group/memberdecl/sequences",
+ new StartElementHandlerMember(this,&LayoutParser::startMemberDeclEntry,
+ MemberListType_decSequenceMembers,theTranslator->trSequences()));
+ m_sHandler.insert("group/memberdecl/dictionaries",
+ new StartElementHandlerMember(this,&LayoutParser::startMemberDeclEntry,
+ MemberListType_decDictionaryMembers,theTranslator->trDictionaries()));
m_sHandler.insert("group/memberdecl/enums",
new StartElementHandlerMember(this,&LayoutParser::startMemberDeclEntry,
MemberListType_decEnumMembers,theTranslator->trEnumerations()));
@@ -745,6 +816,13 @@ class LayoutParser : public QXmlDefaultHandler
m_sHandler.insert("group/memberdef/typedefs",
new StartElementHandlerMember(this,&LayoutParser::startMemberDefEntry,
MemberListType_docTypedefMembers,theTranslator->trTypedefDocumentation()));
+ m_sHandler.insert("group/memberdef/sequences",
+ new StartElementHandlerMember(this,&LayoutParser::startMemberDefEntry,
+ MemberListType_docSequenceMembers,theTranslator->trSequenceDocumentation()));
+ m_sHandler.insert("group/memberdef/dictionaries",
+ new StartElementHandlerMember(this,&LayoutParser::startMemberDefEntry,
+ MemberListType_docDictionaryMembers,
+ theTranslator->trDictionaryDocumentation()));
m_sHandler.insert("group/memberdef/enums",
new StartElementHandlerMember(this,&LayoutParser::startMemberDefEntry,
MemberListType_docEnumMembers,theTranslator->trEnumerationTypeDocumentation()));
@@ -897,6 +975,7 @@ class LayoutParser : public QXmlDefaultHandler
static bool javaOpt = Config_getBool(OPTIMIZE_OUTPUT_JAVA);
static bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
static bool vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
+ static bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
static bool hasGraphicalHierarchy = Config_getBool(HAVE_DOT) &&
Config_getBool(GRAPHICAL_HIERARCHY);
static bool extractAll = Config_getBool(EXTRACT_ALL);
@@ -933,23 +1012,23 @@ class LayoutParser : public QXmlDefaultHandler
},
{ "namespaces",
LayoutNavEntry::Namespaces,
- javaOpt || vhdlOpt ? theTranslator->trPackages() : fortranOpt ? theTranslator->trModules() : theTranslator->trNamespaces(),
- javaOpt || vhdlOpt ? theTranslator->trPackages() : fortranOpt ? theTranslator->trModulesList() : theTranslator->trNamespaceList(),
- javaOpt || vhdlOpt ? theTranslator->trPackageListDescription() : fortranOpt ? theTranslator->trModulesListDescription(extractAll) : theTranslator->trNamespaceListDescription(extractAll),
+ javaOpt || vhdlOpt ? theTranslator->trPackages() : fortranOpt || sliceOpt ? theTranslator->trModules() : theTranslator->trNamespaces(),
+ javaOpt || vhdlOpt ? theTranslator->trPackages() : fortranOpt || sliceOpt ? theTranslator->trModulesList() : theTranslator->trNamespaceList(),
+ javaOpt || vhdlOpt ? theTranslator->trPackageListDescription() : fortranOpt || sliceOpt ? theTranslator->trModulesListDescription(extractAll) : theTranslator->trNamespaceListDescription(extractAll),
"namespaces"
},
{ "namespacelist",
LayoutNavEntry::NamespaceList,
- javaOpt || vhdlOpt ? theTranslator->trPackages() : fortranOpt ? theTranslator->trModulesList() : theTranslator->trNamespaceList(),
+ javaOpt || vhdlOpt ? theTranslator->trPackages() : fortranOpt || sliceOpt ? theTranslator->trModulesList() : theTranslator->trNamespaceList(),
QCString(),
- javaOpt || vhdlOpt ? theTranslator->trPackageListDescription() : fortranOpt ? theTranslator->trModulesListDescription(extractAll) : theTranslator->trNamespaceListDescription(extractAll),
+ javaOpt || vhdlOpt ? theTranslator->trPackageListDescription() : fortranOpt || sliceOpt ? theTranslator->trModulesListDescription(extractAll) : theTranslator->trNamespaceListDescription(extractAll),
"namespaces"
},
{ "namespacemembers",
LayoutNavEntry::NamespaceMembers,
- javaOpt || vhdlOpt ? theTranslator->trPackageMembers() : fortranOpt ? theTranslator->trModulesMembers() : theTranslator->trNamespaceMembers(),
+ javaOpt || vhdlOpt ? theTranslator->trPackageMembers() : fortranOpt || sliceOpt ? theTranslator->trModulesMembers() : theTranslator->trNamespaceMembers(),
QCString(),
- fortranOpt ? theTranslator->trModulesMemberDescription(extractAll) : theTranslator->trNamespaceMemberDescription(extractAll),
+ fortranOpt || sliceOpt ? theTranslator->trModulesMemberDescription(extractAll) : theTranslator->trNamespaceMemberDescription(extractAll),
"namespacemembers"
},
{ "classindex",
@@ -987,6 +1066,83 @@ class LayoutParser : public QXmlDefaultHandler
fortranOpt ? theTranslator->trCompoundMembersDescriptionFortran(extractAll) : theTranslator->trCompoundMembersDescription(extractAll),
"functions"
},
+ { "interfaceindex",
+ LayoutNavEntry::InterfaceIndex,
+ theTranslator->trInterfaceIndex(),
+ QCString(),
+ QCString(),
+ "interfaces"
+ },
+ { "interfaces",
+ LayoutNavEntry::Interfaces,
+ theTranslator->trSliceInterfaces(),
+ theTranslator->trInterfaceList(),
+ theTranslator->trInterfaceListDescription(),
+ "annotatedinterfaces"
+ },
+ { "interfacelist",
+ LayoutNavEntry::InterfaceList,
+ theTranslator->trInterfaceList(),
+ QCString(),
+ theTranslator->trInterfaceListDescription(),
+ "annotatedinterfaces"
+ },
+ { "interfacehierarchy",
+ LayoutNavEntry::InterfaceHierarchy,
+ theTranslator->trInterfaceHierarchy(),
+ QCString(),
+ theTranslator->trInterfaceHierarchyDescription(),
+ hasGraphicalHierarchy ? "interfaceinherits" : "interfacehierarchy"
+ },
+ { "structindex",
+ LayoutNavEntry::StructIndex,
+ theTranslator->trStructIndex(),
+ QCString(),
+ QCString(),
+ "structs"
+ },
+ { "structs",
+ LayoutNavEntry::Structs,
+ theTranslator->trStructs(),
+ theTranslator->trStructList(),
+ theTranslator->trStructListDescription(),
+ "annotatedstructs"
+ },
+ { "structlist",
+ LayoutNavEntry::StructList,
+ theTranslator->trStructList(),
+ QCString(),
+ theTranslator->trStructListDescription(),
+ "annotatedstructs"
+ },
+ { "exceptionindex",
+ LayoutNavEntry::ExceptionIndex,
+ theTranslator->trExceptionIndex(),
+ QCString(),
+ QCString(),
+ "exceptions"
+ },
+ { "exceptions",
+ LayoutNavEntry::Exceptions,
+ theTranslator->trExceptions(),
+ theTranslator->trExceptionList(),
+ theTranslator->trExceptionListDescription(),
+ "annotatedexceptions"
+ },
+ { "exceptionlist",
+ LayoutNavEntry::ExceptionList,
+ theTranslator->trExceptionList(),
+ QCString(),
+ theTranslator->trExceptionListDescription(),
+ "annotatedexceptions"
+ },
+ { "exceptionhierarchy",
+ LayoutNavEntry::ExceptionHierarchy,
+ theTranslator->trExceptionHierarchy(),
+ QCString(),
+ theTranslator->trExceptionHierarchyDescription(),
+ hasGraphicalHierarchy ? "exceptioninherits" : "exceptionhierarchy"
+ },
{ "files",
LayoutNavEntry::Files,
theTranslator->trFile(TRUE,FALSE),
diff --git a/src/layout.h b/src/layout.h
index 1906a3d..a23fd2f 100644
--- a/src/layout.h
+++ b/src/layout.h
@@ -46,10 +46,11 @@ struct LayoutDocEntry
// Namespace specific items
NamespaceNestedNamespaces, NamespaceNestedConstantGroups,
- NamespaceClasses, NamespaceInlineClasses,
+ NamespaceClasses, NamespaceInterfaces, NamespaceStructs, NamespaceExceptions,
+ NamespaceInlineClasses,
// File specific items
- FileClasses, FileNamespaces, FileConstantGroups,
+ FileClasses, FileInterfaces, FileStructs, FileExceptions, FileConstantGroups, FileNamespaces,
FileIncludes, FileIncludeGraph,
FileIncludedByGraph, FileSourceLink,
FileInlineClasses,
@@ -131,6 +132,17 @@ struct LayoutNavEntry
ClassIndex,
ClassHierarchy,
ClassMembers,
+ Interfaces,
+ InterfaceList,
+ InterfaceIndex,
+ InterfaceHierarchy,
+ Structs,
+ StructList,
+ StructIndex,
+ Exceptions,
+ ExceptionList,
+ ExceptionIndex,
+ ExceptionHierarchy,
Files,
FileList,
FileGlobals,
diff --git a/src/layout_default.xml b/src/layout_default.xml
index f087958..373bb20 100644
--- a/src/layout_default.xml
+++ b/src/layout_default.xml
@@ -9,12 +9,26 @@
<tab type="namespacelist" visible="yes" title="" intro=""/>
<tab type="namespacemembers" visible="yes" title="" intro=""/>
</tab>
+ <tab type="interfaces" visible="yes" title="">
+ <tab type="interfacelist" visible="yes" title="" intro=""/>
+ <tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
+ <tab type="interfacehierarchy" visible="yes" title="" intro=""/>
+ </tab>
<tab type="classes" visible="yes" title="">
<tab type="classlist" visible="yes" title="" intro=""/>
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="hierarchy" visible="yes" title="" intro=""/>
<tab type="classmembers" visible="yes" title="" intro=""/>
</tab>
+ <tab type="structs" visible="yes" title="">
+ <tab type="structlist" visible="yes" title="" intro=""/>
+ <tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
+ </tab>
+ <tab type="exceptions" visible="yes" title="">
+ <tab type="exceptionlist" visible="yes" title="" intro=""/>
+ <tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
+ <tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
+ </tab>
<tab type="files" visible="yes" title="">
<tab type="filelist" visible="yes" title="" intro=""/>
<tab type="globals" visible="yes" title="" intro=""/>
@@ -87,8 +101,13 @@
<memberdecl>
<nestednamespaces visible="yes" title=""/>
<constantgroups visible="yes" title=""/>
+ <interfaces visible="yes" title=""/>
<classes visible="yes" title=""/>
+ <structs visible="yes" title=""/>
+ <exceptions visible="yes" title=""/>
<typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
@@ -98,6 +117,8 @@
<memberdef>
<inlineclasses title=""/>
<typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
@@ -113,11 +134,16 @@
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
<sourcelink visible="yes"/>
<memberdecl>
+ <interfaces visible="yes" title=""/>
<classes visible="yes" title=""/>
+ <structs visible="yes" title=""/>
+ <exceptions visible="yes" title=""/>
<namespaces visible="yes" title=""/>
<constantgroups visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
@@ -128,6 +154,8 @@
<inlineclasses title=""/>
<defines title=""/>
<typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
@@ -147,6 +175,8 @@
<classes visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>
@@ -166,6 +196,8 @@
<inlineclasses title=""/>
<defines title=""/>
<typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>
diff --git a/src/marshal.cpp b/src/marshal.cpp
index f0ed2e8..9223a56 100644
--- a/src/marshal.cpp
+++ b/src/marshal.cpp
@@ -409,6 +409,7 @@ void marshalEntry(StorageIntf *s,Entry *e)
marshalBool(s,e->artificial);
marshalInt(s,(int)e->groupDocType);
marshalQCString(s,e->id);
+ marshalQCString(s,e->metaData);
}
void marshalEntryTree(StorageIntf *s,Entry *e)
@@ -823,6 +824,7 @@ Entry * unmarshalEntry(StorageIntf *s)
e->artificial = unmarshalBool(s);
e->groupDocType = (Entry::GroupDocType)unmarshalInt(s);
e->id = unmarshalQCString(s);
+ e->metaData = unmarshalQCString(s);
return e;
}
diff --git a/src/memberdef.cpp b/src/memberdef.cpp
index 1cedc7f..63a2dd5 100644
--- a/src/memberdef.cpp
+++ b/src/memberdef.cpp
@@ -484,7 +484,7 @@ class MemberDefImpl
void init(Definition *def,const char *t,const char *a,const char *e,
Protection p,Specifier v,bool s,Relationship r,
MemberType mt,const ArgumentList *tal,
- const ArgumentList *al
+ const ArgumentList *al,const char *meta
);
ClassDef *classDef; // member of or related to
@@ -539,6 +539,8 @@ class MemberDefImpl
QList<ArgumentList> *defTmpArgLists; // lists of template argument lists
// (for template functions in nested template classes)
+ QCString metaData; // Slice metadata.
+
ClassDef *cachedAnonymousType; // if the member has an anonymous compound
// as its type then this is computed by
// getClassDefOfAnonymousType() and
@@ -626,7 +628,7 @@ void MemberDefImpl::init(Definition *def,
const char *t,const char *a,const char *e,
Protection p,Specifier v,bool s,Relationship r,
MemberType mt,const ArgumentList *tal,
- const ArgumentList *al
+ const ArgumentList *al,const char *meta
)
{
classDef=0;
@@ -709,6 +711,7 @@ void MemberDefImpl::init(Definition *def,
{
declArgList = 0;
}
+ metaData = meta;
templateMaster = 0;
classSectionSDict = 0;
docsForDefinition = TRUE;
@@ -748,17 +751,18 @@ void MemberDefImpl::init(Definition *def,
* \param tal The template arguments of this member.
* \param al The arguments of this member. This is a structured form of
* the string past as argument \a a.
+ * \param meta Slice metadata.
*/
MemberDef::MemberDef(const char *df,int dl,int dc,
const char *t,const char *na,const char *a,const char *e,
Protection p,Specifier v,bool s,Relationship r,MemberType mt,
- const ArgumentList *tal,const ArgumentList *al
+ const ArgumentList *tal,const ArgumentList *al,const char *meta
) : Definition(df,dl,dc,removeRedundantWhiteSpace(na)), visited(FALSE)
{
//printf("MemberDef::MemberDef(%s)\n",na);
m_impl = new MemberDefImpl;
- m_impl->init(this,t,a,e,p,v,s,r,mt,tal,al);
+ m_impl->init(this,t,a,e,p,v,s,r,mt,tal,al,meta);
number_of_flowkw = 1;
m_isLinkableCached = 0;
m_isConstructorCached = 0;
@@ -1401,7 +1405,7 @@ bool MemberDef::isBriefSectionVisible() const
QCString MemberDef::getDeclType() const
{
QCString ltype(m_impl->type);
- if (m_impl->mtype==MemberType_Typedef)
+ if (isTypedef() && getLanguage() != SrcLangExt_Slice)
{
ltype.prepend("typedef ");
}
@@ -1511,7 +1515,10 @@ void MemberDef::writeDeclaration(OutputList &ol,
// *** write type
QCString ltype(m_impl->type);
- if (m_impl->mtype==MemberType_Typedef) ltype.prepend("typedef ");
+ if (isTypedef() && getLanguage() != SrcLangExt_Slice)
+ {
+ ltype.prepend("typedef ");
+ }
if (isAlias())
{
ltype="using";
@@ -2426,6 +2433,10 @@ QCString MemberDef::displayDefinition() const
else
{
ldef.prepend("enum ");
+ if (isSliceLocal())
+ {
+ ldef.prepend("local ");
+ }
}
}
else if (isEnumValue())
@@ -2603,6 +2614,10 @@ void MemberDef::writeDocumentation(MemberList *ml,
else
{
ldef.prepend("enum ");
+ if (isSliceLocal())
+ {
+ ldef.prepend("local ");
+ }
}
}
else if (isEnumValue())
@@ -2619,6 +2634,17 @@ void MemberDef::writeDocumentation(MemberList *ml,
int i=0,l;
static QRegExp r("@[0-9]+");
+ if (lang == SrcLangExt_Slice)
+ {
+ // Remove the container scope from the member name.
+ QCString prefix = scName + sep;
+ int pos = ldef.findRev(prefix.data());
+ if(pos != -1)
+ {
+ ldef.remove(pos, prefix.length());
+ }
+ }
+
//----------------------------------------
ol.pushGeneratorState();
@@ -2674,6 +2700,13 @@ void MemberDef::writeDocumentation(MemberList *ml,
ol.startDoxyAnchor(cfname,cname,memAnchor,doxyName,doxyArgs);
ol.startMemberDoc(ciname,name(),memAnchor,title,memCount,memTotal,showInline);
+ if (!m_impl->metaData.isEmpty() && getLanguage()==SrcLangExt_Slice)
+ {
+ ol.startMemberDocPrefixItem();
+ ol.docify(m_impl->metaData);
+ ol.endMemberDocPrefixItem();
+ }
+
ClassDef *cd=getClassDef();
NamespaceDef *nd=getNamespaceDef();
if (!Config_getBool(HIDE_SCOPE_NAMES))
@@ -2778,6 +2811,21 @@ void MemberDef::writeDocumentation(MemberList *ml,
{
hasParameterList=VhdlDocGen::writeVHDLTypeDocumentation(this,scopedContainer,ol);
}
+ else if (lang==SrcLangExt_Slice)
+ {
+ // Eliminate the self-reference.
+ int pos = ldef.findRev(' ');
+ linkifyText(TextGeneratorOLImpl(ol),
+ scopedContainer,
+ getBodyDef(),
+ this,
+ ldef.left(pos)
+ );
+ ol.docify(ldef.mid(pos));
+ Definition *scope = cd;
+ if (scope==0) scope = nd;
+ hasParameterList=writeDefArgumentList(ol,scope,this);
+ }
else
{
linkifyText(TextGeneratorOLImpl(ol),
@@ -3082,7 +3130,7 @@ QCString MemberDef::fieldType() const
type = m_impl->type;
}
- if (isTypedef()) type.prepend("typedef ");
+ if (isTypedef() && getLanguage() != SrcLangExt_Slice) type.prepend("typedef ");
return simplifyTypeForTable(type);
}
@@ -3199,6 +3247,8 @@ QCString MemberDef::memberTypeName() const
case MemberType_Event: return "event";
case MemberType_Interface: return "interface";
case MemberType_Service: return "service";
+ case MemberType_Sequence: return "sequence";
+ case MemberType_Dictionary: return "dictionary";
default: return "unknown";
}
}
@@ -3461,7 +3511,7 @@ MemberDef *MemberDef::createTemplateInstanceMember(
methodName,
substituteTemplateArgumentsInString(m_impl->args,formalArgs,actualArgs),
m_impl->exception, m_impl->prot,
- m_impl->virt, m_impl->stat, m_impl->related, m_impl->mtype, 0, 0
+ m_impl->virt, m_impl->stat, m_impl->related, m_impl->mtype, 0, 0, ""
);
imd->setArgumentList(actualArgList);
imd->setDefinition(substituteTemplateArgumentsInString(m_impl->def,formalArgs,actualArgs));
@@ -3623,6 +3673,8 @@ void MemberDef::writeTagFile(FTextStream &tagFile)
case MemberType_Slot: tagFile << "slot"; break;
case MemberType_Interface: tagFile << "interface"; break;
case MemberType_Service: tagFile << "service"; break;
+ case MemberType_Sequence: tagFile << "sequence"; break;
+ case MemberType_Dictionary: tagFile << "dictionary"; break;
}
if (m_impl->prot!=Public)
{
@@ -4185,6 +4237,16 @@ bool MemberDef::isTypedef() const
return m_impl->mtype==MemberType_Typedef;
}
+bool MemberDef::isSequence() const
+{
+ return m_impl->mtype==MemberType_Sequence;
+}
+
+bool MemberDef::isDictionary() const
+{
+ return m_impl->mtype==MemberType_Dictionary;
+}
+
bool MemberDef::isFunction() const
{
return m_impl->mtype==MemberType_Function;
@@ -4522,6 +4584,11 @@ bool MemberDef::livesInsideEnum() const
return m_impl->livesInsideEnum;
}
+bool MemberDef::isSliceLocal() const
+{
+ return (m_impl->memSpec&Entry::Local)!=0;
+}
+
MemberList *MemberDef::enumFieldList() const
{
return m_impl->enumFields;
diff --git a/src/memberdef.h b/src/memberdef.h
index bf7ea9a..eae2572 100644
--- a/src/memberdef.h
+++ b/src/memberdef.h
@@ -48,7 +48,7 @@ class MemberDef : public Definition
const char *type,const char *name,const char *args,
const char *excp,Protection prot,Specifier virt,bool stat,
Relationship related,MemberType t,const ArgumentList *tal,
- const ArgumentList *al);
+ const ArgumentList *al,const char *metaData);
~MemberDef();
DefType definitionType() const { return TypeMember; }
// move this member into a different scope
@@ -109,6 +109,8 @@ class MemberDef : public Definition
bool isEnumerate() const;
bool isEnumValue() const;
bool isTypedef() const;
+ bool isSequence() const;
+ bool isDictionary() const;
bool isFunction() const;
bool isFunctionPtr() const;
bool isDefine() const;
@@ -177,6 +179,7 @@ class MemberDef : public Definition
bool showInCallGraph() const;
bool isStrongEnumValue() const;
bool livesInsideEnum() const;
+ bool isSliceLocal() const;
int numberOfFlowKeyWords();
// derived getters
diff --git a/src/membergroup.cpp b/src/membergroup.cpp
index aaa504f..5ee47ab 100644
--- a/src/membergroup.cpp
+++ b/src/membergroup.cpp
@@ -278,6 +278,16 @@ int MemberGroup::typedefCount() const
return memberList->typedefCount();
}
+int MemberGroup::sequenceCount() const
+{
+ return memberList->sequenceCount();
+}
+
+int MemberGroup::dictionaryCount() const
+{
+ return memberList->dictionaryCount();
+}
+
int MemberGroup::protoCount() const
{
return memberList->protoCount();
diff --git a/src/membergroup.h b/src/membergroup.h
index 29fba07..b590d48 100644
--- a/src/membergroup.h
+++ b/src/membergroup.h
@@ -76,6 +76,8 @@ class MemberGroup
int enumCount() const;
int enumValueCount() const;
int typedefCount() const;
+ int sequenceCount() const;
+ int dictionaryCount() const;
int protoCount() const;
int defineCount() const;
int friendCount() const;
diff --git a/src/memberlist.cpp b/src/memberlist.cpp
index e19cead..a4e5596 100644
--- a/src/memberlist.cpp
+++ b/src/memberlist.cpp
@@ -41,6 +41,8 @@ MemberList::MemberList() : m_listType(MemberListType_pubMethods)
m_enumCnt=0;
m_enumValCnt=0;
m_typeCnt=0;
+ m_seqCnt=0;
+ m_dictCnt=0;
m_protoCnt=0;
m_defCnt=0;
m_friendCnt=0;
@@ -59,6 +61,8 @@ MemberList::MemberList(MemberListType lt) : m_listType(lt)
m_enumCnt=0;
m_enumValCnt=0;
m_typeCnt=0;
+ m_seqCnt=0;
+ m_dictCnt=0;
m_protoCnt=0;
m_defCnt=0;
m_friendCnt=0;
@@ -139,7 +143,7 @@ void MemberList::countDecMembers(bool countEnumValues,GroupDef *gd)
//printf("----- countDecMembers count=%d ----\n",count());
m_varCnt=m_funcCnt=m_enumCnt=m_enumValCnt=0;
- m_typeCnt=m_protoCnt=m_defCnt=m_friendCnt=0;
+ m_typeCnt=m_seqCnt=m_dictCnt=m_protoCnt=m_defCnt=m_friendCnt=0;
m_numDecMembers=0;
QListIterator<MemberDef> mli(*this);
MemberDef *md;
@@ -168,6 +172,8 @@ void MemberList::countDecMembers(bool countEnumValues,GroupDef *gd)
m_enumValCnt++,m_numDecMembers++;
break;
case MemberType_Typedef: m_typeCnt++,m_numDecMembers++; break;
+ case MemberType_Sequence: m_seqCnt++,m_numDecMembers++; break;
+ case MemberType_Dictionary: m_dictCnt++,m_numDecMembers++; break;
//case MemberType_Prototype: m_protoCnt++,m_numDecMembers++; break;
case MemberType_Define: if (Config_getBool(EXTRACT_ALL) ||
md->argsString() ||
@@ -194,6 +200,8 @@ void MemberList::countDecMembers(bool countEnumValues,GroupDef *gd)
m_enumCnt+=mg->enumCount();
m_enumValCnt+=mg->enumValueCount();
m_typeCnt+=mg->typedefCount();
+ m_seqCnt+=mg->sequenceCount();
+ m_dictCnt+=mg->dictionaryCount();
m_protoCnt+=mg->protoCount();
m_defCnt+=mg->defineCount();
m_friendCnt+=mg->friendCount();
@@ -314,16 +322,18 @@ bool MemberList::declVisible() const
{
switch (md->memberType())
{
- case MemberType_Define: // fall through
- case MemberType_Typedef: // fall through
- case MemberType_Variable: // fall through
- case MemberType_Function: // fall through
- case MemberType_Signal: // fall through
- case MemberType_Slot: // fall through
- case MemberType_DCOP: // fall through
- case MemberType_Property: // fall through
- case MemberType_Interface: // fall through
- case MemberType_Service: // fall through
+ case MemberType_Define: // fall through
+ case MemberType_Typedef: // fall through
+ case MemberType_Variable: // fall through
+ case MemberType_Function: // fall through
+ case MemberType_Signal: // fall through
+ case MemberType_Slot: // fall through
+ case MemberType_DCOP: // fall through
+ case MemberType_Property: // fall through
+ case MemberType_Interface: // fall through
+ case MemberType_Service: // fall through
+ case MemberType_Sequence: // fall through
+ case MemberType_Dictionary: // fall through
case MemberType_Event:
return TRUE;
case MemberType_Enumeration:
@@ -383,17 +393,19 @@ void MemberList::writePlainDeclarations(OutputList &ol,
//printf(">>> rendering\n");
switch(md->memberType())
{
- case MemberType_Define: // fall through
+ case MemberType_Define: // fall through
//case MemberType_Prototype: // fall through
- case MemberType_Typedef: // fall through
- case MemberType_Variable: // fall through
- case MemberType_Function: // fall through
- case MemberType_Signal: // fall through
- case MemberType_Slot: // fall through
- case MemberType_DCOP: // fall through
- case MemberType_Property: // fall through
- case MemberType_Interface: // fall through
- case MemberType_Service: // fall through
+ case MemberType_Typedef: // fall through
+ case MemberType_Variable: // fall through
+ case MemberType_Function: // fall through
+ case MemberType_Signal: // fall through
+ case MemberType_Slot: // fall through
+ case MemberType_DCOP: // fall through
+ case MemberType_Property: // fall through
+ case MemberType_Interface: // fall through
+ case MemberType_Service: // fall through
+ case MemberType_Sequence: // fall through
+ case MemberType_Dictionary: // fall through
case MemberType_Event:
{
if (first) ol.startMemberList(),first=FALSE;
@@ -419,6 +431,10 @@ void MemberList::writePlainDeclarations(OutputList &ol,
{
ol.startDoxyAnchor(md->getOutputFileBase(),0,md->anchor(),md->name(),QCString());
}
+ if (md->isSliceLocal())
+ {
+ ol.writeString("local ");
+ }
ol.writeString("enum ");
ol.insertMemberAlign();
md->writeEnumDeclaration(ol,cd,nd,fd,gd);
@@ -921,6 +937,8 @@ void MemberList::marshal(StorageIntf *s)
marshalInt(s,m_enumCnt);
marshalInt(s,m_enumValCnt);
marshalInt(s,m_typeCnt);
+ marshalInt(s,m_seqCnt);
+ marshalInt(s,m_dictCnt);
marshalInt(s,m_protoCnt);
marshalInt(s,m_defCnt);
marshalInt(s,m_friendCnt);
@@ -953,6 +971,8 @@ void MemberList::unmarshal(StorageIntf *s)
m_enumCnt = unmarshalInt(s);
m_enumValCnt = unmarshalInt(s);
m_typeCnt = unmarshalInt(s);
+ m_seqCnt = unmarshalInt(s);
+ m_dictCnt = unmarshalInt(s);
m_protoCnt = unmarshalInt(s);
m_defCnt = unmarshalInt(s);
m_friendCnt = unmarshalInt(s);
@@ -1021,6 +1041,8 @@ QCString MemberList::listTypeAsString(MemberListType type)
case MemberListType_decDefineMembers: return "define-members";
case MemberListType_decProtoMembers: return "proto-members";
case MemberListType_decTypedefMembers: return "typedef-members";
+ case MemberListType_decSequenceMembers: return "sequence-members";
+ case MemberListType_decDictionaryMembers: return "dictionary-members";
case MemberListType_decEnumMembers: return "enum-members";
case MemberListType_decFuncMembers: return "func-members";
case MemberListType_decVarMembers: return "var-members";
diff --git a/src/memberlist.h b/src/memberlist.h
index 38f0e89..a96f61f 100644
--- a/src/memberlist.h
+++ b/src/memberlist.h
@@ -50,17 +50,19 @@ class MemberList : private QList<MemberDef>
MemberDef *take(uint index);
- int varCount() const { ASSERT(m_numDecMembers!=-1); return m_varCnt; }
- int funcCount() const { ASSERT(m_numDecMembers!=-1); return m_funcCnt; }
- int enumCount() const { ASSERT(m_numDecMembers!=-1); return m_enumCnt; }
- int enumValueCount() const { ASSERT(m_numDecMembers!=-1); return m_enumValCnt; }
- int typedefCount() const { ASSERT(m_numDecMembers!=-1); return m_typeCnt; }
- int protoCount() const { ASSERT(m_numDecMembers!=-1); return m_protoCnt; }
- int defineCount() const { ASSERT(m_numDecMembers!=-1); return m_defCnt; }
- int friendCount() const { ASSERT(m_numDecMembers!=-1); return m_friendCnt; }
- int numDecMembers() const { ASSERT(m_numDecMembers!=-1); return m_numDecMembers; }
- int numDocMembers() const { ASSERT(m_numDocMembers!=-1); return m_numDocMembers; }
- bool needsSorting() const { return m_needsSorting; }
+ int varCount() const { ASSERT(m_numDecMembers!=-1); return m_varCnt; }
+ int funcCount() const { ASSERT(m_numDecMembers!=-1); return m_funcCnt; }
+ int enumCount() const { ASSERT(m_numDecMembers!=-1); return m_enumCnt; }
+ int enumValueCount() const { ASSERT(m_numDecMembers!=-1); return m_enumValCnt; }
+ int typedefCount() const { ASSERT(m_numDecMembers!=-1); return m_typeCnt; }
+ int sequenceCount() const { ASSERT(m_numDecMembers!=-1); return m_seqCnt; }
+ int dictionaryCount() const { ASSERT(m_numDecMembers!=-1); return m_dictCnt; }
+ int protoCount() const { ASSERT(m_numDecMembers!=-1); return m_protoCnt; }
+ int defineCount() const { ASSERT(m_numDecMembers!=-1); return m_defCnt; }
+ int friendCount() const { ASSERT(m_numDecMembers!=-1); return m_friendCnt; }
+ int numDecMembers() const { ASSERT(m_numDecMembers!=-1); return m_numDecMembers; }
+ int numDocMembers() const { ASSERT(m_numDocMembers!=-1); return m_numDocMembers; }
+ bool needsSorting() const { return m_needsSorting; }
void countDecMembers(bool countEnumValues=FALSE,GroupDef *gd=0);
void countDocMembers(bool countEnumValues=FALSE);
int countInheritableMembers(ClassDef *inheritedFrom) const;
@@ -98,6 +100,8 @@ class MemberList : private QList<MemberDef>
int m_enumCnt;
int m_enumValCnt;
int m_typeCnt;
+ int m_seqCnt;
+ int m_dictCnt;
int m_protoCnt;
int m_defCnt;
int m_friendCnt;
diff --git a/src/namespacedef.cpp b/src/namespacedef.cpp
index 8e6c881..2ccfb10 100644
--- a/src/namespacedef.cpp
+++ b/src/namespacedef.cpp
@@ -56,6 +56,9 @@ NamespaceDef::NamespaceDef(const char *df,int dl,int dc,
setFileName(name);
}
classSDict = new ClassSDict(17);
+ interfaceSDict = new ClassSDict(17);
+ structSDict = new ClassSDict(17);
+ exceptionSDict = new ClassSDict(17);
namespaceSDict = new NamespaceSDict(17);
m_innerCompounds = new SDict<Definition>(17);
usingDirList = 0;
@@ -87,6 +90,9 @@ NamespaceDef::NamespaceDef(const char *df,int dl,int dc,
NamespaceDef::~NamespaceDef()
{
delete classSDict;
+ delete interfaceSDict;
+ delete structSDict;
+ delete exceptionSDict;
delete namespaceSDict;
delete m_innerCompounds;
delete usingDirList;
@@ -164,12 +170,28 @@ void NamespaceDef::addInnerCompound(Definition *d)
void NamespaceDef::insertClass(ClassDef *cd)
{
- if (classSDict->find(cd->name())==0)
+ ClassSDict *d;
+
+ if (Config_getBool(OPTIMIZE_OUTPUT_SLICE))
+ {
+ if (cd->isInterface())
+ d = interfaceSDict;
+ else if (cd->isStruct())
+ d = structSDict;
+ else if (cd->isException())
+ d = exceptionSDict;
+ else
+ d = classSDict;
+ }
+ else
+ d = classSDict;
+
+ if (d->find(cd->name())==0)
{
if (Config_getBool(SORT_BRIEF_DOCS))
- classSDict->inSort(cd->name(),cd);
+ d->inSort(cd->name(),cd);
else
- classSDict->append(cd->name(),cd);
+ d->append(cd->name(),cd);
}
}
@@ -245,6 +267,14 @@ void NamespaceDef::insertMember(MemberDef *md)
addMemberToList(MemberListType_decTypedefMembers,md);
addMemberToList(MemberListType_docTypedefMembers,md);
break;
+ case MemberType_Sequence:
+ addMemberToList(MemberListType_decSequenceMembers,md);
+ addMemberToList(MemberListType_docSequenceMembers,md);
+ break;
+ case MemberType_Dictionary:
+ addMemberToList(MemberListType_decDictionaryMembers,md);
+ addMemberToList(MemberListType_docDictionaryMembers,md);
+ break;
case MemberType_Enumeration:
addMemberToList(MemberListType_decEnumMembers,md);
addMemberToList(MemberListType_docEnumMembers,md);
@@ -313,18 +343,25 @@ void NamespaceDef::writeTagFile(FTextStream &tagFile)
case LayoutDocEntry::NamespaceClasses:
{
if (classSDict)
- {
- SDict<ClassDef>::Iterator ci(*classSDict);
- ClassDef *cd;
- for (ci.toFirst();(cd=ci.current());++ci)
- {
- if (cd->isLinkableInProject())
- {
- tagFile << " <class kind=\"" << cd->compoundTypeString()
- << "\">" << convertToXML(cd->name()) << "</class>" << endl;
- }
- }
- }
+ writeClassesToTagFile(tagFile, classSDict);
+ }
+ break;
+ case LayoutDocEntry::NamespaceInterfaces:
+ {
+ if (interfaceSDict)
+ writeClassesToTagFile(tagFile, interfaceSDict);
+ }
+ break;
+ case LayoutDocEntry::NamespaceStructs:
+ {
+ if (structSDict)
+ writeClassesToTagFile(tagFile, structSDict);
+ }
+ break;
+ case LayoutDocEntry::NamespaceExceptions:
+ {
+ if (exceptionSDict)
+ writeClassesToTagFile(tagFile, exceptionSDict);
}
break;
case LayoutDocEntry::MemberDecl:
@@ -437,6 +474,24 @@ void NamespaceDef::writeBriefDescription(OutputList &ol)
//ol.newParagraph();
//ol.popGeneratorState();
}
+
+ // Write a summary of the Slice definition including metadata.
+ if (getLanguage() == SrcLangExt_Slice)
+ {
+ ol.startParagraph();
+ ol.startTypewriter();
+ if (!metaData.isEmpty())
+ {
+ ol.docify(metaData);
+ ol.lineBreak();
+ }
+ ol.docify("module ");
+ ol.docify(stripScope(name()));
+ ol.docify(" { ... }");
+ ol.endTypewriter();
+ ol.endParagraph();
+ }
+
ol.writeSynopsis();
}
@@ -468,9 +523,9 @@ void NamespaceDef::endMemberDocumentation(OutputList &ol)
}
}
-void NamespaceDef::writeClassDeclarations(OutputList &ol,const QCString &title)
+void NamespaceDef::writeClassDeclarations(OutputList &ol,const QCString &title,ClassSDict *d)
{
- if (classSDict) classSDict->writeDeclaration(ol,0,title,TRUE);
+ if (d) d->writeDeclaration(ol,0,title,TRUE);
}
void NamespaceDef::writeInlineClasses(OutputList &ol)
@@ -527,6 +582,9 @@ void NamespaceDef::writeSummaryLinks(OutputList &ol)
for (eli.toFirst();(lde=eli.current());++eli)
{
if ((lde->kind()==LayoutDocEntry::NamespaceClasses && classSDict && classSDict->declVisible()) ||
+ (lde->kind()==LayoutDocEntry::NamespaceInterfaces && interfaceSDict && interfaceSDict->declVisible()) ||
+ (lde->kind()==LayoutDocEntry::NamespaceStructs && structSDict && structSDict->declVisible()) ||
+ (lde->kind()==LayoutDocEntry::NamespaceExceptions && exceptionSDict && exceptionSDict->declVisible()) ||
(lde->kind()==LayoutDocEntry::NamespaceNestedNamespaces && namespaceSDict && namespaceSDict->declVisible())
)
{
@@ -567,6 +625,20 @@ void NamespaceDef::addNamespaceAttributes(OutputList &ol)
}
}
+void NamespaceDef::writeClassesToTagFile(FTextStream &tagFile,ClassSDict *d)
+{
+ SDict<ClassDef>::Iterator ci(*d);
+ ClassDef *cd;
+ for (ci.toFirst();(cd=ci.current());++ci)
+ {
+ if (cd->isLinkableInProject())
+ {
+ tagFile << " <class kind=\"" << cd->compoundTypeString()
+ << "\">" << convertToXML(cd->name()) << "</class>" << endl;
+ }
+ }
+}
+
void NamespaceDef::writeDocumentation(OutputList &ol)
{
static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
@@ -619,7 +691,25 @@ void NamespaceDef::writeDocumentation(OutputList &ol)
case LayoutDocEntry::NamespaceClasses:
{
LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
- writeClassDeclarations(ol,ls->title(lang));
+ writeClassDeclarations(ol,ls->title(lang),classSDict);
+ }
+ break;
+ case LayoutDocEntry::NamespaceInterfaces:
+ {
+ LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
+ writeClassDeclarations(ol,ls->title(lang),interfaceSDict);
+ }
+ break;
+ case LayoutDocEntry::NamespaceStructs:
+ {
+ LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
+ writeClassDeclarations(ol,ls->title(lang),structSDict);
+ }
+ break;
+ case LayoutDocEntry::NamespaceExceptions:
+ {
+ LayoutDocEntrySection *ls = (LayoutDocEntrySection*)lde;
+ writeClassDeclarations(ol,ls->title(lang),exceptionSDict);
}
break;
case LayoutDocEntry::NamespaceNestedNamespaces:
@@ -678,6 +768,9 @@ void NamespaceDef::writeDocumentation(OutputList &ol)
case LayoutDocEntry::ClassUsedFiles:
case LayoutDocEntry::ClassInlineClasses:
case LayoutDocEntry::FileClasses:
+ case LayoutDocEntry::FileInterfaces:
+ case LayoutDocEntry::FileStructs:
+ case LayoutDocEntry::FileExceptions:
case LayoutDocEntry::FileNamespaces:
case LayoutDocEntry::FileConstantGroups:
case LayoutDocEntry::FileIncludes:
@@ -780,7 +873,8 @@ int NamespaceDef::countMembers()
{
MemberList *allMemberList = getMemberList(MemberListType_allMembersList);
if (allMemberList) allMemberList->countDocMembers();
- return (allMemberList ? allMemberList->numDocMembers() : 0)+classSDict->count();
+ return (allMemberList ? allMemberList->numDocMembers() : 0) +
+ classSDict->count() + interfaceSDict->count() + structSDict->count() + exceptionSDict->count();
}
void NamespaceDef::addUsingDirective(NamespaceDef *nd)
@@ -1079,14 +1173,24 @@ void NamespaceDef::sortMemberLists()
{
classSDict->sort();
}
+ if (interfaceSDict)
+ {
+ interfaceSDict->sort();
+ }
+ if (structSDict)
+ {
+ structSDict->sort();
+ }
+ if (exceptionSDict)
+ {
+ exceptionSDict->sort();
+ }
if (namespaceSDict)
{
namespaceSDict->sort();
}
}
-
-
MemberList *NamespaceDef::getMemberList(MemberListType lt) const
{
QListIterator<MemberList> mli(m_memberLists);
@@ -1156,7 +1260,7 @@ QCString NamespaceDef::title() const
{
pageTitle = theTranslator->trPackage(displayName());
}
- else if (lang==SrcLangExt_Fortran)
+ else if (lang==SrcLangExt_Fortran || lang==SrcLangExt_Slice)
{
pageTitle = theTranslator->trModuleReference(displayName());
}
@@ -1210,3 +1314,7 @@ QCString NamespaceDef::compoundTypeString() const
return "";
}
+void NamespaceDef::setMetaData(const QCString &m)
+{
+ metaData = m;
+}
diff --git a/src/namespacedef.h b/src/namespacedef.h
index 8b7d7cc..b46d074 100644
--- a/src/namespacedef.h
+++ b/src/namespacedef.h
@@ -97,12 +97,23 @@ class NamespaceDef : public Definition
/*! Returns the classes contained in this namespace */
ClassSDict *getClassSDict() const { return classSDict; }
+ /*! Returns the Slice interfaces contained in this namespace */
+ ClassSDict *getInterfaceSDict() const { return interfaceSDict; }
+
+ /*! Returns the Slice structs contained in this namespace */
+ ClassSDict *getStructSDict() const { return structSDict; }
+
+ /*! Returns the Slice exceptions contained in this namespace */
+ ClassSDict *getExceptionSDict() const { return exceptionSDict; }
+
/*! Returns the namespaces contained in this namespace */
NamespaceSDict *getNamespaceSDict() const { return namespaceSDict; }
QCString title() const;
QCString compoundTypeString() const;
+ void setMetaData(const QCString &m);
+
bool visited;
private:
@@ -114,7 +125,7 @@ class NamespaceDef : public Definition
void writeBriefDescription(OutputList &ol);
void startMemberDeclarations(OutputList &ol);
void endMemberDeclarations(OutputList &ol);
- void writeClassDeclarations(OutputList &ol,const QCString &title);
+ void writeClassDeclarations(OutputList &ol,const QCString &title,ClassSDict *d);
void writeInlineClasses(OutputList &ol);
void writeNamespaceDeclarations(OutputList &ol,const QCString &title,
bool isConstantGroup=false);
@@ -124,6 +135,7 @@ class NamespaceDef : public Definition
void endMemberDocumentation(OutputList &ol);
void writeSummaryLinks(OutputList &ol);
void addNamespaceAttributes(OutputList &ol);
+ void writeClassesToTagFile(FTextStream &,ClassSDict *d);
QCString fileName;
FileList files;
@@ -136,10 +148,14 @@ class NamespaceDef : public Definition
QList<MemberList> m_memberLists;
MemberGroupSDict *memberGroupSDict;
ClassSDict *classSDict;
+ ClassSDict *interfaceSDict;
+ ClassSDict *structSDict;
+ ClassSDict *exceptionSDict;
NamespaceSDict *namespaceSDict;
bool m_subGrouping;
enum { NAMESPACE, MODULE, CONSTANT_GROUP, LIBRARY } m_type;
bool m_isPublished;
+ QCString metaData;
};
/** A list of NamespaceDef objects. */
diff --git a/src/pre.l b/src/pre.l
index b6ebbf8..5eb0c5c 100644
--- a/src/pre.l
+++ b/src/pre.l
@@ -1405,7 +1405,7 @@ void addDefine()
MemberDef *md=new MemberDef(
g_yyFileName,g_yyLineNr-g_yyMLines,g_yyColNr,
"#define",g_defName,g_defArgsStr,0,
- Public,Normal,FALSE,Member,MemberType_Define,0,0);
+ Public,Normal,FALSE,Member,MemberType_Define,0,0,"");
if (!g_defArgsStr.isEmpty())
{
ArgumentList *argList = new ArgumentList;
diff --git a/src/scanner.l b/src/scanner.l
index 08bcee1..0f681e9 100644
--- a/src/scanner.l
+++ b/src/scanner.l
@@ -31,7 +31,7 @@
#include <qstack.h>
#include <qregexp.h>
#include <qfile.h>
-
+
#include "scanner.h"
#include "entry.h"
#include "message.h"
@@ -126,8 +126,11 @@ static bool insidePHP = FALSE; //!< processing PHP code?
static bool insideObjC = FALSE; //!< processing Objective C code?
static bool insideCli = FALSE; //!< processing C++/CLI code?
static bool insideJS = FALSE; //!< processing JavaScript code?
+static bool insideSlice = FALSE; //!< processing Slice code?
static bool insideCpp = TRUE; //!< processing C/C++ code
+static bool sliceOpt = FALSE;
+
static bool insideCppQuote = FALSE;
static bool insideProtocolList = FALSE;
@@ -219,6 +222,7 @@ static void initParser()
insideFormula = FALSE;
insideCode=FALSE;
insideCli=Config_getBool(CPP_CLI_SUPPORT);
+ sliceOpt=Config_getBool(OPTIMIZE_OUTPUT_SLICE);
previous = 0;
firstTypedefEntry = 0;
tempEntry = 0;
@@ -376,15 +380,16 @@ static bool nameIsOperator(QCString &name)
static void setContext()
{
QCString fileName = yyFileName;
- language = getLanguageFromFileName(fileName);
- insideIDL = language==SrcLangExt_IDL;
- insideJava = language==SrcLangExt_Java;
- insideCS = language==SrcLangExt_CSharp;
- insideD = language==SrcLangExt_D;
- insidePHP = language==SrcLangExt_PHP;
- insideObjC = language==SrcLangExt_ObjC;
- insideJS = language==SrcLangExt_JS;
- insideCpp = language==SrcLangExt_Cpp;
+ language = getLanguageFromFileName(fileName);
+ insideIDL = language==SrcLangExt_IDL;
+ insideJava = language==SrcLangExt_Java;
+ insideCS = language==SrcLangExt_CSharp;
+ insideD = language==SrcLangExt_D;
+ insidePHP = language==SrcLangExt_PHP;
+ insideObjC = language==SrcLangExt_ObjC;
+ insideJS = language==SrcLangExt_JS;
+ insideSlice = language==SrcLangExt_Slice;
+ insideCpp = language==SrcLangExt_Cpp;
if ( insidePHP )
{
useOverrideCommands = TRUE;
@@ -763,6 +768,14 @@ OPERATOR "operator"{B}*({ARITHOP}|{ASSIGNOP}|{LOGICOP}|{BITOP})
%x IDLProp
%x IDLPropName
+ /** Slice states */
+
+%x SliceMetadata
+%x SliceSequence
+%x SliceSequenceName
+%x SliceDictionary
+%x SliceDictionaryName
+
/** Prototype scanner states */
%x Prototype
@@ -1220,6 +1233,38 @@ OPERATOR "operator"{B}*({ARITHOP}|{ASSIGNOP}|{LOGICOP}|{BITOP})
unput('{');
BEGIN( Function );
}
+<FindMembers>{B}*"sequence"{BN}*"<"{BN}* {
+ if (insideSlice)
+ {
+ lineCount();
+ current->bodyLine = yyLineNr;
+ current->fileName = yyFileName ;
+ current->startLine = yyLineNr ;
+ current->startColumn = yyColNr;
+ current->args.resize(0);
+ current->section = Entry::TYPEDEF_SEC ;
+ isTypedef = TRUE;
+ BEGIN( SliceSequence );
+ }
+ else
+ REJECT;
+ }
+<FindMembers>{B}*"dictionary"{BN}*"<"{BN}* {
+ if (insideSlice)
+ {
+ lineCount();
+ current->bodyLine = yyLineNr;
+ current->fileName = yyFileName ;
+ current->startLine = yyLineNr ;
+ current->startColumn = yyColNr;
+ current->args.resize(0);
+ current->section = Entry::TYPEDEF_SEC ;
+ isTypedef = TRUE;
+ BEGIN( SliceDictionary );
+ }
+ else
+ REJECT;
+ }
<FindMembers>{BN}{1,80} {
lineCount();
}
@@ -1392,6 +1437,9 @@ OPERATOR "operator"{B}*({ARITHOP}|{ASSIGNOP}|{LOGICOP}|{BITOP})
<FindMembers>{B}*"explicit"{BN}+ { current->spec|=Entry::Explicit;
lineCount();
}
+<FindMembers>{B}*"local"{BN}+ { current->spec|=Entry::Local;
+ lineCount();
+ }
<FindMembers>{B}*"@required"{BN}+ { // Objective C 2.0 protocol required section
current->spec=(current->spec & ~Entry::Optional) | Entry::Required;
lineCount();
@@ -1426,7 +1474,7 @@ OPERATOR "operator"{B}*({ARITHOP}|{ASSIGNOP}|{LOGICOP}|{BITOP})
}
<FindMembers>{B}*"module"{BN}+ {
lineCount();
- if (insideIDL)
+ if (insideIDL || insideSlice)
{
isTypedef=FALSE;
current->section = Entry::NAMESPACE_SEC;
@@ -1529,15 +1577,15 @@ OPERATOR "operator"{B}*({ARITHOP}|{ASSIGNOP}|{LOGICOP}|{BITOP})
current->name = QCString(yytext).stripWhiteSpace();
}
}
-<FindMembers>{BN}*((("disp")?"interface")|"valuetype"){BN}+ { // M$/Corba/UNO IDL/Java interface
+<FindMembers>{BN}*((("disp")?"interface")|"valuetype"){BN}+ { // M$/Corba/UNO IDL/Java/Slice interface
lineCount();
- if (insideIDL || insideJava || insideCS || insideD || insidePHP)
+ if (insideIDL || insideJava || insideCS || insideD || insidePHP || insideSlice)
{
isTypedef=FALSE;
current->section = Entry::CLASS_SEC;
- current->spec = Entry::Interface |
- // preserve UNO IDL [optional] or published
- (current->spec & (Entry::Optional|Entry::Published));
+ current->spec = Entry::Interface |
+ // preserve UNO IDL [optional], published, Slice local
+ (current->spec & (Entry::Optional|Entry::Published|Entry::Local));
addType( current ) ;
current->type += " interface" ;
current->fileName = yyFileName;
@@ -1601,11 +1649,13 @@ OPERATOR "operator"{B}*({ARITHOP}|{ASSIGNOP}|{LOGICOP}|{BITOP})
current->bodyLine = yyLineNr;
BEGIN( CompoundName );
}
-<FindMembers>{B}*"exception"{BN}+ { // Corba IDL exception
+<FindMembers>{B}*"exception"{BN}+ { // Corba IDL/Slice exception
isTypedef=FALSE;
current->section = Entry::CLASS_SEC;
+ // preserve UNO IDL, Slice local
current->spec = Entry::Exception |
- (current->spec & Entry::Published); // preserve UNO IDL
+ (current->spec & Entry::Published) |
+ (current->spec & Entry::Local);
addType( current ) ;
current->type += " exception" ;
current->fileName = yyFileName;
@@ -1624,6 +1674,16 @@ OPERATOR "operator"{B}*({ARITHOP}|{ASSIGNOP}|{LOGICOP}|{BITOP})
bool isVolatile=decl.find("volatile")!=-1;
current->section = Entry::CLASS_SEC;
addType( current ) ;
+ uint64 spec = current->spec;
+ if (insidePHP && current->spec&Entry::Abstract)
+ {
+ // convert Abstract to AbstractClass
+ current->spec=(current->spec&~Entry::Abstract)|Entry::AbstractClass;
+ }
+ if (insideSlice && spec&Entry::Local)
+ {
+ current->spec|=Entry::Local;
+ }
if (isConst)
{
current->type += " const";
@@ -1644,11 +1704,6 @@ OPERATOR "operator"{B}*({ARITHOP}|{ASSIGNOP}|{LOGICOP}|{BITOP})
}
lineCount() ;
if (yytext[yyleng-1]=='{') unput('{');
- if (insidePHP && current->spec&Entry::Abstract)
- {
- // convert Abstract to AbstractClass
- current->spec=(current->spec&~Entry::Abstract)|Entry::AbstractClass;
- }
BEGIN( CompoundName ) ;
}
<FindMembers>{B}*"value class{" | // C++/CLI extension
@@ -1724,10 +1779,13 @@ OPERATOR "operator"{B}*({ARITHOP}|{ASSIGNOP}|{LOGICOP}|{BITOP})
isTypedef=decl.find("typedef")!=-1;
bool isConst=decl.find("const")!=-1;
bool isVolatile=decl.find("volatile")!=-1;
+ uint64 spec = current->spec;
current->section = Entry::CLASS_SEC ;
+ // preserve UNO IDL & Inline attributes, Slice local
current->spec = Entry::Struct |
(current->spec & Entry::Published) |
- (current->spec & Entry::Inline); // preserve UNO IDL & Inline attributes
+ (current->spec & Entry::Inline) |
+ (current->spec & Entry::Local);
// bug 582676: can be a struct nested in an interface so keep insideObjC state
//current->objc = insideObjC = FALSE;
addType( current ) ;
@@ -3448,7 +3506,14 @@ OPERATOR "operator"{B}*({ARITHOP}|{ASSIGNOP}|{LOGICOP}|{BITOP})
}
<FindMembers>"[" {
- if (!insideCS &&
+ if (insideSlice)
+ {
+ squareCount=1;
+ lastSquareContext = YY_START;
+ current->metaData += "[";
+ BEGIN( SliceMetadata );
+ }
+ else if (!insideCS &&
(current->name.isEmpty() ||
current->name=="typedef"
)
@@ -3488,6 +3553,26 @@ OPERATOR "operator"{B}*({ARITHOP}|{ASSIGNOP}|{LOGICOP}|{BITOP})
BEGIN( Array ) ;
}
}
+<SliceMetadata>"[" { // Global metadata.
+ squareCount++;
+ current->metaData += "[";
+ }
+<SliceMetadata>{BN}* {
+ lineCount();
+ }
+<SliceMetadata>\"[^\"]*\" {
+ current->metaData += yytext;
+ }
+<SliceMetadata>"," {
+ current->metaData += yytext;
+ }
+<SliceMetadata>"]" {
+ current->metaData += yytext;
+ if (--squareCount<=0)
+ {
+ BEGIN (lastSquareContext);
+ }
+ }
<IDLAttribute>"]" {
// end of IDL function attribute
if (--squareCount<=0)
@@ -3899,7 +3984,8 @@ OPERATOR "operator"{B}*({ARITHOP}|{ASSIGNOP}|{LOGICOP}|{BITOP})
current = new Entry(*current);
if (current->section==Entry::NAMESPACE_SEC ||
(current->spec==Entry::Interface) ||
- insideJava || insidePHP || insideCS || insideD || insideJS
+ insideJava || insidePHP || insideCS || insideD || insideJS ||
+ insideSlice
)
{ // namespaces and interfaces and java classes ends with a closing bracket without semicolon
current->reset();
@@ -5609,7 +5695,7 @@ OPERATOR "operator"{B}*({ARITHOP}|{ASSIGNOP}|{LOGICOP}|{BITOP})
roundCount=0;
BEGIN(SkipUnionSwitch);
}
- else if ((insideJava || insidePHP || insideJS) && (qstrcmp(yytext,"implements")==0 || qstrcmp(yytext,"extends")==0))
+ else if ((insideJava || insidePHP || insideJS || insideSlice) && (qstrcmp(yytext,"implements")==0 || qstrcmp(yytext,"extends")==0))
{
current->type.resize(0);
baseProt=Public;
@@ -6036,7 +6122,7 @@ OPERATOR "operator"{B}*({ARITHOP}|{ASSIGNOP}|{LOGICOP}|{BITOP})
}
if ((current->spec & (Entry::Interface|Entry::Struct)) ||
insideJava || insidePHP || insideCS ||
- insideD || insideObjC || insideIDL)
+ insideD || insideObjC || insideIDL || insideSlice)
{
baseProt=Public;
}
@@ -6326,8 +6412,67 @@ OPERATOR "operator"{B}*({ARITHOP}|{ASSIGNOP}|{LOGICOP}|{BITOP})
<CSString>\n { lineCount(); }
<CSString>"." {}
+ /* ---- Slice-specific rules ------ */
+
+<SliceSequence>{SCOPEID} {
+ if (current->spec&Entry::Local)
+ {
+ current->type = "local ";
+ }
+ current->type += "sequence<";
+ current->type += yytext;
+ current->type += ">";
+ }
+
+<SliceSequence>{BN}*">"{BN}* {
+ lineCount();
+ BEGIN(SliceSequenceName);
+ }
+
+<SliceSequenceName>{ID}{BN}* {
+ lineCount();
+ current->name = yytext ;
+ current->name = current->name.stripWhiteSpace();
+ }
+
+<SliceSequenceName>";" {
+ current->section = Entry::VARIABLE_SEC;
+ current_root->addSubEntry(current);
+ current = new Entry;
+ initEntry();
+ BEGIN(FindMembers);
+ }
+
+<SliceDictionary>{SCOPEID}{BN}*","{BN}*{SCOPEID} {
+ lineCount();
+ if (current->spec&Entry::Local)
+ {
+ current->type = "local ";
+ }
+ current->type += "dictionary<";
+ current->type += yytext;
+ current->type += ">";
+ current->type = current->type.simplifyWhiteSpace();
+ }
+
+<SliceDictionary>{BN}*">"{BN}* {
+ lineCount();
+ BEGIN(SliceDictionaryName);
+ }
+<SliceDictionaryName>{ID}{BN}* {
+ lineCount();
+ current->name = yytext ;
+ current->name = current->name.stripWhiteSpace();
+ }
+<SliceDictionaryName>";" {
+ current->section = Entry::VARIABLE_SEC;
+ current_root->addSubEntry(current);
+ current = new Entry;
+ initEntry();
+ BEGIN(FindMembers);
+ }
/**********************************************************************************/
/******************** Documentation block related rules ***************************/
@@ -6923,7 +7068,7 @@ static void parseCompounds(Entry *rt)
// set default protection based on the compound type
if( ce->section==Entry::CLASS_SEC ) // class
{
- if (insidePHP || insideD || insideJS || insideIDL)
+ if (insidePHP || insideD || insideJS || insideIDL || insideSlice)
{
current->protection = protection = Public ;
}
diff --git a/src/searchindex.cpp b/src/searchindex.cpp
index 6276eae..74aa138 100644
--- a/src/searchindex.cpp
+++ b/src/searchindex.cpp
@@ -620,6 +620,14 @@ static void addMemberToSearchIndex(MemberDef *md)
{
g_searchIndexInfo[SEARCH_INDEX_VARIABLES].symbolList.append(letter,md);
}
+ else if (md->isSequence())
+ {
+ g_searchIndexInfo[SEARCH_INDEX_SEQUENCES].symbolList.append(letter,md);
+ }
+ else if (md->isDictionary())
+ {
+ g_searchIndexInfo[SEARCH_INDEX_DICTIONARIES].symbolList.append(letter,md);
+ }
else if (md->isTypedef())
{
g_searchIndexInfo[SEARCH_INDEX_TYPEDEFS].symbolList.append(letter,md);
@@ -667,6 +675,14 @@ static void addMemberToSearchIndex(MemberDef *md)
{
g_searchIndexInfo[SEARCH_INDEX_VARIABLES].symbolList.append(letter,md);
}
+ else if (md->isSequence())
+ {
+ g_searchIndexInfo[SEARCH_INDEX_SEQUENCES].symbolList.append(letter,md);
+ }
+ else if (md->isDictionary())
+ {
+ g_searchIndexInfo[SEARCH_INDEX_DICTIONARIES].symbolList.append(letter,md);
+ }
else if (md->isTypedef())
{
g_searchIndexInfo[SEARCH_INDEX_TYPEDEFS].symbolList.append(letter,md);
@@ -717,39 +733,54 @@ static QCString searchId(const QCString &s)
void createJavascriptSearchIndex()
{
+ bool sliceOpt = Config_getBool(OPTIMIZE_OUTPUT_SLICE);
+
// set index names
- g_searchIndexInfo[SEARCH_INDEX_ALL].name = "all";
- g_searchIndexInfo[SEARCH_INDEX_CLASSES].name = "classes";
- g_searchIndexInfo[SEARCH_INDEX_NAMESPACES].name = "namespaces";
- g_searchIndexInfo[SEARCH_INDEX_FILES].name = "files";
- g_searchIndexInfo[SEARCH_INDEX_FUNCTIONS].name = "functions";
- g_searchIndexInfo[SEARCH_INDEX_VARIABLES].name = "variables";
- g_searchIndexInfo[SEARCH_INDEX_TYPEDEFS].name = "typedefs";
- g_searchIndexInfo[SEARCH_INDEX_ENUMS].name = "enums";
- g_searchIndexInfo[SEARCH_INDEX_ENUMVALUES].name = "enumvalues";
- g_searchIndexInfo[SEARCH_INDEX_PROPERTIES].name = "properties";
- g_searchIndexInfo[SEARCH_INDEX_EVENTS].name = "events";
- g_searchIndexInfo[SEARCH_INDEX_RELATED].name = "related";
- g_searchIndexInfo[SEARCH_INDEX_DEFINES].name = "defines";
- g_searchIndexInfo[SEARCH_INDEX_GROUPS].name = "groups";
- g_searchIndexInfo[SEARCH_INDEX_PAGES].name = "pages";
+ g_searchIndexInfo[SEARCH_INDEX_ALL].name = "all";
+ g_searchIndexInfo[SEARCH_INDEX_CLASSES].name = "classes";
+ g_searchIndexInfo[SEARCH_INDEX_INTERFACES].name = "interfaces";
+ g_searchIndexInfo[SEARCH_INDEX_STRUCTS].name = "structs";
+ g_searchIndexInfo[SEARCH_INDEX_EXCEPTIONS].name = "exceptions";
+ g_searchIndexInfo[SEARCH_INDEX_NAMESPACES].name = "namespaces";
+ g_searchIndexInfo[SEARCH_INDEX_FILES].name = "files";
+ g_searchIndexInfo[SEARCH_INDEX_FUNCTIONS].name = "functions";
+ g_searchIndexInfo[SEARCH_INDEX_VARIABLES].name = "variables";
+ g_searchIndexInfo[SEARCH_INDEX_TYPEDEFS].name = "typedefs";
+ g_searchIndexInfo[SEARCH_INDEX_SEQUENCES].name = "sequences";
+ g_searchIndexInfo[SEARCH_INDEX_DICTIONARIES].name = "dictionaries";
+ g_searchIndexInfo[SEARCH_INDEX_ENUMS].name = "enums";
+ g_searchIndexInfo[SEARCH_INDEX_ENUMVALUES].name = "enumvalues";
+ g_searchIndexInfo[SEARCH_INDEX_PROPERTIES].name = "properties";
+ g_searchIndexInfo[SEARCH_INDEX_EVENTS].name = "events";
+ g_searchIndexInfo[SEARCH_INDEX_RELATED].name = "related";
+ g_searchIndexInfo[SEARCH_INDEX_DEFINES].name = "defines";
+ g_searchIndexInfo[SEARCH_INDEX_GROUPS].name = "groups";
+ g_searchIndexInfo[SEARCH_INDEX_PAGES].name = "pages";
// set index texts
- g_searchIndexInfo[SEARCH_INDEX_ALL].text = theTranslator->trAll();
- g_searchIndexInfo[SEARCH_INDEX_CLASSES].text = theTranslator->trClasses();
- g_searchIndexInfo[SEARCH_INDEX_NAMESPACES].text = theTranslator->trNamespace(TRUE,FALSE);
- g_searchIndexInfo[SEARCH_INDEX_FILES].text = theTranslator->trFile(TRUE,FALSE);
- g_searchIndexInfo[SEARCH_INDEX_FUNCTIONS].text = theTranslator->trFunctions();
- g_searchIndexInfo[SEARCH_INDEX_VARIABLES].text = theTranslator->trVariables();
- g_searchIndexInfo[SEARCH_INDEX_TYPEDEFS].text = theTranslator->trTypedefs();
- g_searchIndexInfo[SEARCH_INDEX_ENUMS].text = theTranslator->trEnumerations();
- g_searchIndexInfo[SEARCH_INDEX_ENUMVALUES].text = theTranslator->trEnumerationValues();
- g_searchIndexInfo[SEARCH_INDEX_PROPERTIES].text = theTranslator->trProperties();
- g_searchIndexInfo[SEARCH_INDEX_EVENTS].text = theTranslator->trEvents();
- g_searchIndexInfo[SEARCH_INDEX_RELATED].text = theTranslator->trFriends();
- g_searchIndexInfo[SEARCH_INDEX_DEFINES].text = theTranslator->trDefines();
- g_searchIndexInfo[SEARCH_INDEX_GROUPS].text = theTranslator->trGroup(TRUE,FALSE);
- g_searchIndexInfo[SEARCH_INDEX_PAGES].text = theTranslator->trPage(TRUE,FALSE);
+ g_searchIndexInfo[SEARCH_INDEX_ALL].text = theTranslator->trAll();
+ g_searchIndexInfo[SEARCH_INDEX_CLASSES].text = theTranslator->trClasses();
+ g_searchIndexInfo[SEARCH_INDEX_INTERFACES].text = theTranslator->trSliceInterfaces();
+ g_searchIndexInfo[SEARCH_INDEX_STRUCTS].text = theTranslator->trStructs();
+ g_searchIndexInfo[SEARCH_INDEX_EXCEPTIONS].text = theTranslator->trExceptions();
+ g_searchIndexInfo[SEARCH_INDEX_NAMESPACES].text = sliceOpt ? theTranslator->trModules() :
+ theTranslator->trNamespace(TRUE,FALSE);
+ g_searchIndexInfo[SEARCH_INDEX_FILES].text = theTranslator->trFile(TRUE,FALSE);
+ g_searchIndexInfo[SEARCH_INDEX_FUNCTIONS].text = sliceOpt ? theTranslator->trOperations() :
+ theTranslator->trFunctions();
+ g_searchIndexInfo[SEARCH_INDEX_VARIABLES].text = sliceOpt ? theTranslator->trConstants() :
+ theTranslator->trVariables();
+ g_searchIndexInfo[SEARCH_INDEX_TYPEDEFS].text = theTranslator->trTypedefs();
+ g_searchIndexInfo[SEARCH_INDEX_SEQUENCES].text = theTranslator->trSequences();
+ g_searchIndexInfo[SEARCH_INDEX_DICTIONARIES].text = theTranslator->trDictionaries();
+ g_searchIndexInfo[SEARCH_INDEX_ENUMS].text = theTranslator->trEnumerations();
+ g_searchIndexInfo[SEARCH_INDEX_ENUMVALUES].text = theTranslator->trEnumerationValues();
+ g_searchIndexInfo[SEARCH_INDEX_PROPERTIES].text = theTranslator->trProperties();
+ g_searchIndexInfo[SEARCH_INDEX_EVENTS].text = theTranslator->trEvents();
+ g_searchIndexInfo[SEARCH_INDEX_RELATED].text = theTranslator->trFriends();
+ g_searchIndexInfo[SEARCH_INDEX_DEFINES].text = theTranslator->trDefines();
+ g_searchIndexInfo[SEARCH_INDEX_GROUPS].text = theTranslator->trGroup(TRUE,FALSE);
+ g_searchIndexInfo[SEARCH_INDEX_PAGES].text = theTranslator->trPage(TRUE,FALSE);
// add symbols to letter -> symbol list map
@@ -762,7 +793,29 @@ void createJavascriptSearchIndex()
if (cd->isLinkable() && isId(letter))
{
g_searchIndexInfo[SEARCH_INDEX_ALL].symbolList.append(letter,cd);
- g_searchIndexInfo[SEARCH_INDEX_CLASSES].symbolList.append(letter,cd);
+ if (sliceOpt)
+ {
+ if (cd->isInterface())
+ {
+ g_searchIndexInfo[SEARCH_INDEX_INTERFACES].symbolList.append(letter,cd);
+ }
+ else if (cd->isStruct())
+ {
+ g_searchIndexInfo[SEARCH_INDEX_STRUCTS].symbolList.append(letter,cd);
+ }
+ else if (cd->isException())
+ {
+ g_searchIndexInfo[SEARCH_INDEX_EXCEPTIONS].symbolList.append(letter,cd);
+ }
+ else
+ {
+ g_searchIndexInfo[SEARCH_INDEX_CLASSES].symbolList.append(letter,cd);
+ }
+ }
+ else
+ {
+ g_searchIndexInfo[SEARCH_INDEX_CLASSES].symbolList.append(letter,cd);
+ }
}
}
diff --git a/src/searchindex.h b/src/searchindex.h
index e491f47..0345b41 100644
--- a/src/searchindex.h
+++ b/src/searchindex.h
@@ -112,22 +112,27 @@ class SearchIndexExternal : public SearchIndexIntf
//------- client side search index ----------------------
-#define SEARCH_INDEX_ALL 0
-#define SEARCH_INDEX_CLASSES 1
-#define SEARCH_INDEX_NAMESPACES 2
-#define SEARCH_INDEX_FILES 3
-#define SEARCH_INDEX_FUNCTIONS 4
-#define SEARCH_INDEX_VARIABLES 5
-#define SEARCH_INDEX_TYPEDEFS 6
-#define SEARCH_INDEX_ENUMS 7
-#define SEARCH_INDEX_ENUMVALUES 8
-#define SEARCH_INDEX_PROPERTIES 9
-#define SEARCH_INDEX_EVENTS 10
-#define SEARCH_INDEX_RELATED 11
-#define SEARCH_INDEX_DEFINES 12
-#define SEARCH_INDEX_GROUPS 13
-#define SEARCH_INDEX_PAGES 14
-#define NUM_SEARCH_INDICES 15
+#define SEARCH_INDEX_ALL 0
+#define SEARCH_INDEX_CLASSES 1
+#define SEARCH_INDEX_INTERFACES 2
+#define SEARCH_INDEX_STRUCTS 3
+#define SEARCH_INDEX_EXCEPTIONS 4
+#define SEARCH_INDEX_NAMESPACES 5
+#define SEARCH_INDEX_FILES 6
+#define SEARCH_INDEX_FUNCTIONS 7
+#define SEARCH_INDEX_VARIABLES 8
+#define SEARCH_INDEX_TYPEDEFS 9
+#define SEARCH_INDEX_SEQUENCES 10
+#define SEARCH_INDEX_DICTIONARIES 11
+#define SEARCH_INDEX_ENUMS 12
+#define SEARCH_INDEX_ENUMVALUES 13
+#define SEARCH_INDEX_PROPERTIES 14
+#define SEARCH_INDEX_EVENTS 15
+#define SEARCH_INDEX_RELATED 16
+#define SEARCH_INDEX_DEFINES 17
+#define SEARCH_INDEX_GROUPS 18
+#define SEARCH_INDEX_PAGES 19
+#define NUM_SEARCH_INDICES 20
class SearchDefinitionList : public QList<Definition>
{
diff --git a/src/translator.h b/src/translator.h
index 9da2317..ac55911 100644
--- a/src/translator.h
+++ b/src/translator.h
@@ -46,7 +46,7 @@ class Translator
/*!
* Sets the LaTeX font encoding to be used. The default is set to `T1`,
* in case another font encoding has to be used this can be specified with
- * this routine. In case no font encoding is required the empty string
+ * this routine. In case no font encoding is required the empty string
* can be returned.
*/
virtual QCString latexFontenc() { return "T1"; }
@@ -616,6 +616,36 @@ class Translator
virtual QCString trFunctionAndProc() = 0;
virtual QCString trVhdlType(uint64 type,bool single) = 0;
virtual QCString trCustomReference(const char *name) = 0;
+
+ virtual QCString trConstants() = 0;
+ virtual QCString trConstantDocumentation() = 0;
+ virtual QCString trSequences() = 0;
+ virtual QCString trSequenceDocumentation() = 0;
+ virtual QCString trDictionaries() = 0;
+ virtual QCString trDictionaryDocumentation() = 0;
+ virtual QCString trSliceInterfaces() = 0;
+ virtual QCString trInterfaceIndex() = 0;
+ virtual QCString trInterfaceList() = 0;
+ virtual QCString trInterfaceListDescription() = 0;
+ virtual QCString trInterfaceHierarchy() = 0;
+ virtual QCString trInterfaceHierarchyDescription() = 0;
+ virtual QCString trInterfaceDocumentation() = 0;
+ virtual QCString trStructs() = 0;
+ virtual QCString trStructIndex() = 0;
+ virtual QCString trStructList() = 0;
+ virtual QCString trStructListDescription() = 0;
+ virtual QCString trStructDocumentation() = 0;
+ virtual QCString trExceptionIndex() = 0;
+ virtual QCString trExceptionList() = 0;
+ virtual QCString trExceptionListDescription() = 0;
+ virtual QCString trExceptionHierarchy() = 0;
+ virtual QCString trExceptionHierarchyDescription() = 0;
+ virtual QCString trExceptionDocumentation() = 0;
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal) = 0;
+ virtual QCString trOperations() = 0;
+ virtual QCString trOperationDocumentation() = 0;
+ virtual QCString trDataMembers() = 0;
+ virtual QCString trDataMemberDocumentation() = 0;
};
#endif
diff --git a/src/translator_am.h b/src/translator_am.h
index 5b4c446..b3341b1 100644
--- a/src/translator_am.h
+++ b/src/translator_am.h
@@ -1799,6 +1799,141 @@ class TranslatorArmenian : public TranslatorAdapter_1_8_0
virtual QCString trDirDepGraph(const char *name)
{ return name + QCString("-ի ֆայլադարանների կախվածությունների գծագիր:"); }
+//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
};
#endif
diff --git a/src/translator_ar.h b/src/translator_ar.h
index 24281fd..be611e1 100644
--- a/src/translator_ar.h
+++ b/src/translator_ar.h
@@ -1564,6 +1564,141 @@ class TranslatorArabic : public TranslatorAdapter_1_4_6
"وجد أنها ملائمة. إنها تختلف عن الدالة أعلاه"
"فقط في نوعية ال argument(s) التي تقبلها.";
}
+
+//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
};
#endif
diff --git a/src/translator_br.h b/src/translator_br.h
index 774e554..a8b6859 100644
--- a/src/translator_br.h
+++ b/src/translator_br.h
@@ -2202,6 +2202,141 @@ class TranslatorBrazilian : public Translator
{ return "Referência de " + QCString(name); }
//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
+//////////////////////////////////////////////////////////////////////////
};
diff --git a/src/translator_ca.h b/src/translator_ca.h
index ca9b7e9..12c23a9 100644
--- a/src/translator_ca.h
+++ b/src/translator_ca.h
@@ -1838,6 +1838,141 @@ class TranslatorCatalan : public TranslatorAdapter_1_8_0
virtual QCString trDirDepGraph(const char *name)
{ return QCString("Graf de dependència de directoris per a ")+name+":"; }
+//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
};
#endif
diff --git a/src/translator_cn.h b/src/translator_cn.h
index 0e559c1..d5261bd 100644
--- a/src/translator_cn.h
+++ b/src/translator_cn.h
@@ -1921,6 +1921,141 @@ class TranslatorChinese : public TranslatorAdapter_1_8_15
}
//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
+//////////////////////////////////////////////////////////////////////////
};
#endif
diff --git a/src/translator_cz.h b/src/translator_cz.h
index 9d6c489..7df56a0 100644
--- a/src/translator_cz.h
+++ b/src/translator_cz.h
@@ -2042,6 +2042,141 @@ class TranslatorCzech : public TranslatorAdapter_1_8_15
}
//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
+//////////////////////////////////////////////////////////////////////////
};
diff --git a/src/translator_de.h b/src/translator_de.h
index 8e6ec2c..37d09d0 100644
--- a/src/translator_de.h
+++ b/src/translator_de.h
@@ -133,7 +133,7 @@
// 2017/10/12 Arnd Weber (arnd dot weber at bafg dot de)
// Beatrix Konz
// - Updated for 1.8.13
-// - Resynced trMemberDataDocumentation() and trFileMembers() to include the
+// - Resynced trMemberDataDocumentation() and trFileMembers() to include the
// boolean switch OPTIMIZE_OUTPUT_FOR_C
// - Replaced "\t" by " "
//
@@ -1995,7 +1995,7 @@ class TranslatorGerman : public Translator
/*! Used file list for a Java enum */
virtual QCString trEnumGeneratedFromFiles(bool single)
{ QCString result = "Die Dokumentation für diesen enum wurde aus ";
- if (single)
+ if (single)
result += "der folgenden Datei";
else
result += "den folgenden Dateien";
@@ -2254,6 +2254,138 @@ class TranslatorGerman : public Translator
virtual QCString trCustomReference(const char *name)
{ return QCString(name)+"-Referenz"; }
+ /* Slice */
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
//////////////////////////////////////////////////////////////////////////
};
diff --git a/src/translator_dk.h b/src/translator_dk.h
index 70e9032..63218f3 100644
--- a/src/translator_dk.h
+++ b/src/translator_dk.h
@@ -1765,6 +1765,140 @@ class TranslatorDanish : public TranslatorAdapter_1_8_0
return QCString("Afhængighedsgraf for katalog ")+name+":";
}
+//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
/*---------- For internal use: ----------------------------------------*/
protected:
diff --git a/src/translator_en.h b/src/translator_en.h
index d12621e..400e59c 100644
--- a/src/translator_en.h
+++ b/src/translator_en.h
@@ -253,6 +253,10 @@ class TranslatorEnglish : public Translator
{
return "Here are the data structures with brief descriptions:";
}
+ else if (Config_getBool(OPTIMIZE_OUTPUT_SLICE))
+ {
+ return "Here are the classes with brief descriptions:";
+ }
else
{
return "Here are the classes, structs, "
@@ -2117,6 +2121,138 @@ class TranslatorEnglish : public Translator
virtual QCString trCustomReference(const char *name)
{ return QCString(name)+" Reference"; }
+ /* Slice */
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
//////////////////////////////////////////////////////////////////////////
};
diff --git a/src/translator_eo.h b/src/translator_eo.h
index 28876d7..b0be7f4 100644
--- a/src/translator_eo.h
+++ b/src/translator_eo.h
@@ -1942,6 +1942,141 @@ class TranslatorEsperanto : public TranslatorAdapter_1_8_4
}
//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
+//////////////////////////////////////////////////////////////////////////
};
diff --git a/src/translator_es.h b/src/translator_es.h
index 5f89f24..52b50ed 100644
--- a/src/translator_es.h
+++ b/src/translator_es.h
@@ -2057,6 +2057,141 @@ class TranslatorSpanish : public TranslatorAdapter_1_8_15
}
//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
+//////////////////////////////////////////////////////////////////////////
};
diff --git a/src/translator_fa.h b/src/translator_fa.h
index 5a37330..92b97ac 100644
--- a/src/translator_fa.h
+++ b/src/translator_fa.h
@@ -1779,6 +1779,141 @@ class TranslatorPersian : public TranslatorAdapter_1_7_5
return convertDigitsToFarsi(sdate);
}
+//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
};
#endif
diff --git a/src/translator_fi.h b/src/translator_fi.h
index 2b94f48..1457f76 100644
--- a/src/translator_fi.h
+++ b/src/translator_fi.h
@@ -1854,6 +1854,141 @@ class TranslatorFinnish : public TranslatorAdapter_1_6_0
return "Tyyppien rajoitteet"; // "Type Constraints"
}
+//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
};
#endif
diff --git a/src/translator_fr.h b/src/translator_fr.h
index b0fb5b1..57b7053 100644
--- a/src/translator_fr.h
+++ b/src/translator_fr.h
@@ -2055,6 +2055,141 @@ class TranslatorFrench : public TranslatorAdapter_1_8_15
}
//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
+//////////////////////////////////////////////////////////////////////////
};
diff --git a/src/translator_gr.h b/src/translator_gr.h
index 6ed43db..b0bf900 100644
--- a/src/translator_gr.h
+++ b/src/translator_gr.h
@@ -1980,6 +1980,141 @@ class TranslatorGreek : public TranslatorAdapter_1_8_15
return result;
}
+//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
};
#endif
diff --git a/src/translator_hr.h b/src/translator_hr.h
index 1d17e2a..7f04de2 100644
--- a/src/translator_hr.h
+++ b/src/translator_hr.h
@@ -1568,6 +1568,141 @@ class TranslatorCroatian : public TranslatorAdapter_1_8_2
{ return "Dodatni naslijeđeni članovi"; }
//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
+//////////////////////////////////////////////////////////////////////////
};
diff --git a/src/translator_hu.h b/src/translator_hu.h
index 44363c9..be93e5e 100644
--- a/src/translator_hu.h
+++ b/src/translator_hu.h
@@ -2021,8 +2021,137 @@ class TranslatorHungarian : public TranslatorAdapter_1_8_15
return result;
}
-//////////////////////////////////////////////////////////////////////////
-
+ /* Slice */
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
};
#endif
diff --git a/src/translator_id.h b/src/translator_id.h
index 2039c76..b973a0a 100644
--- a/src/translator_id.h
+++ b/src/translator_id.h
@@ -1812,6 +1812,141 @@ class TranslatorIndonesian : public TranslatorAdapter_1_8_0
virtual QCString trDirDepGraph(const char *name)
{ return QCString("Bagan dependensi directori untuk ")+name+":"; }
+//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
};
#endif
diff --git a/src/translator_it.h b/src/translator_it.h
index 9638a01..a080b8c 100644
--- a/src/translator_it.h
+++ b/src/translator_it.h
@@ -1977,6 +1977,141 @@ class TranslatorItalian : public TranslatorAdapter_1_8_15
}
//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
+//////////////////////////////////////////////////////////////////////////
};
diff --git a/src/translator_jp.h b/src/translator_jp.h
index fc0d65d..295ed64 100644
--- a/src/translator_jp.h
+++ b/src/translator_jp.h
@@ -1986,6 +1986,141 @@ class TranslatorJapanese : public TranslatorAdapter_1_8_15
}
//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
+//////////////////////////////////////////////////////////////////////////
};
diff --git a/src/translator_kr.h b/src/translator_kr.h
index fb1c356..136a5ef 100644
--- a/src/translator_kr.h
+++ b/src/translator_kr.h
@@ -2013,6 +2013,141 @@ class TranslatorKorean : public TranslatorAdapter_1_8_15
}
//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
+//////////////////////////////////////////////////////////////////////////
};
diff --git a/src/translator_lt.h b/src/translator_lt.h
index f47d9d4..f4aef3b 100644
--- a/src/translator_lt.h
+++ b/src/translator_lt.h
@@ -1509,7 +1509,140 @@ class TranslatorLithuanian : public TranslatorAdapter_1_4_6
"Jis skiriasi nuo aukščiau minėto tik argumetais.";
}
+//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
};
#endif
diff --git a/src/translator_lv.h b/src/translator_lv.h
index bd579da..256491a 100644
--- a/src/translator_lv.h
+++ b/src/translator_lv.h
@@ -1945,6 +1945,141 @@ class TranslatorLatvian : public TranslatorAdapter_1_8_4
}
//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
+//////////////////////////////////////////////////////////////////////////
};
diff --git a/src/translator_mk.h b/src/translator_mk.h
index 3fc046e..8e0d0e8 100644
--- a/src/translator_mk.h
+++ b/src/translator_mk.h
@@ -1718,6 +1718,141 @@ class TranslatorMacedonian : public TranslatorAdapter_1_6_0
{
return "Ограничувања на Тип";
}
+
+//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
};
#endif
diff --git a/src/translator_nl.h b/src/translator_nl.h
index c0c8c9b..a672459 100644
--- a/src/translator_nl.h
+++ b/src/translator_nl.h
@@ -1709,6 +1709,138 @@ class TranslatorDutch : public Translator
virtual QCString trCustomReference(const char *name)
{ return QCString(name)+" Referentie"; }
+ /* Slice */
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
//////////////////////////////////////////////////////////////////////////
};
diff --git a/src/translator_no.h b/src/translator_no.h
index eccd952..bcbe01a 100644
--- a/src/translator_no.h
+++ b/src/translator_no.h
@@ -1563,6 +1563,141 @@ class TranslatorNorwegian : public TranslatorAdapter_1_4_6
"generert for deg. Den skiller seg ut fra "
"funksjonen ovenfor i argument(ene) den aksepterer.";
}
+
+//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
};
#endif
diff --git a/src/translator_pl.h b/src/translator_pl.h
index e0ecc8f..c7bf8ad 100644
--- a/src/translator_pl.h
+++ b/src/translator_pl.h
@@ -1867,6 +1867,141 @@ class TranslatorPolish : public TranslatorAdapter_1_8_2
{ return "Dodatkowe Dziedziczone Składowe"; }
//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
+//////////////////////////////////////////////////////////////////////////
};
diff --git a/src/translator_pt.h b/src/translator_pt.h
index 2506f7f..8fea532 100644
--- a/src/translator_pt.h
+++ b/src/translator_pt.h
@@ -2141,6 +2141,141 @@ class TranslatorPortuguese : public Translator
//////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
+//////////////////////////////////////////////////////////////////////////
};
#endif
diff --git a/src/translator_ro.h b/src/translator_ro.h
index 6f0c197..5c6ebf3 100644
--- a/src/translator_ro.h
+++ b/src/translator_ro.h
@@ -2014,6 +2014,141 @@ class TranslatorRomanian : public TranslatorAdapter_1_8_15
}
//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
+//////////////////////////////////////////////////////////////////////////
};
diff --git a/src/translator_ru.h b/src/translator_ru.h
index 9d92888..580ce85 100644
--- a/src/translator_ru.h
+++ b/src/translator_ru.h
@@ -1968,6 +1968,141 @@ class TranslatorRussian : public TranslatorAdapter_1_8_15
return result;
}
+//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
///////////////////////////////////////////////////////////////////////
};
diff --git a/src/translator_sc.h b/src/translator_sc.h
index e8191df..2a8343c 100644
--- a/src/translator_sc.h
+++ b/src/translator_sc.h
@@ -1765,6 +1765,141 @@ class TranslatorSerbianCyrillic : public TranslatorAdapter_1_6_0
return "Ограничења типова";
}
+//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
};
#endif
diff --git a/src/translator_si.h b/src/translator_si.h
index 2dd7e5b..5e84bfb 100644
--- a/src/translator_si.h
+++ b/src/translator_si.h
@@ -1207,6 +1207,141 @@ class TranslatorSlovene : public TranslatorAdapter_1_4_6
"podana je zaradi priročnosti. Metoda se od predhodnje razlikuje "
"samo v številu in/ali tipu formalnih argumentov.";
}
+
+//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
};
#endif
diff --git a/src/translator_sk.h b/src/translator_sk.h
index 9ee8252..14abdb0 100644
--- a/src/translator_sk.h
+++ b/src/translator_sk.h
@@ -1972,6 +1972,141 @@ class TranslatorSlovak : public TranslatorAdapter_1_8_15
}
//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
+//////////////////////////////////////////////////////////////////////////
};
#endif // TRANSLATOR_SK_H
diff --git a/src/translator_sr.h b/src/translator_sr.h
index f5f132f..44b7526 100644
--- a/src/translator_sr.h
+++ b/src/translator_sr.h
@@ -1716,6 +1716,141 @@ class TranslatorSerbian : public TranslatorAdapter_1_6_0
}
//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
+//////////////////////////////////////////////////////////////////////////
// following methods have no corresponding entry in translator_en.h
//////////////////////////////////////////////////////////////////////////
diff --git a/src/translator_sv.h b/src/translator_sv.h
index 5da89df..dfbf6c2 100644
--- a/src/translator_sv.h
+++ b/src/translator_sv.h
@@ -2061,7 +2061,140 @@ class TranslatorSwedish : public TranslatorAdapter_1_8_15
return result;
}
+//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
};
#endif
diff --git a/src/translator_tr.h b/src/translator_tr.h
index d18f800..2961302 100644
--- a/src/translator_tr.h
+++ b/src/translator_tr.h
@@ -1817,6 +1817,141 @@ class TranslatorTurkish : public TranslatorAdapter_1_7_5
}
+//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
};
#endif
diff --git a/src/translator_tw.h b/src/translator_tw.h
index 9e9092d..c513f9b 100644
--- a/src/translator_tw.h
+++ b/src/translator_tw.h
@@ -1978,6 +1978,141 @@ class TranslatorChinesetraditional : public TranslatorAdapter_1_8_15
}
//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
+//////////////////////////////////////////////////////////////////////////
};
diff --git a/src/translator_ua.h b/src/translator_ua.h
index 034cb1b..e899ae9 100644
--- a/src/translator_ua.h
+++ b/src/translator_ua.h
@@ -1910,6 +1910,141 @@ class TranslatorUkrainian : public TranslatorAdapter_1_8_4
}
//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
+//////////////////////////////////////////////////////////////////////////
};
diff --git a/src/translator_vi.h b/src/translator_vi.h
index b391b0c..b7ad3de 100644
--- a/src/translator_vi.h
+++ b/src/translator_vi.h
@@ -1750,6 +1750,141 @@ class TranslatorVietnamese : public TranslatorAdapter_1_6_0
return "Ràng buộc của kiểu (Type)";
}
+//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
};
#endif
diff --git a/src/translator_za.h b/src/translator_za.h
index dd5ddf9..7a8180d 100644
--- a/src/translator_za.h
+++ b/src/translator_za.h
@@ -1718,6 +1718,141 @@ class TranslatorAfrikaans : public TranslatorAdapter_1_6_0
return "Tipe Limiete";
}
+//////////////////////////////////////////////////////////////////////////
+// new since 1.8.14
+//////////////////////////////////////////////////////////////////////////
+
+ virtual QCString trConstants()
+ {
+ return "Constants";
+ }
+ virtual QCString trConstantDocumentation()
+ {
+ return "Constant Documentation";
+ }
+ virtual QCString trSequences()
+ {
+ return "Sequences";
+ }
+ virtual QCString trSequenceDocumentation()
+ {
+ return "Sequence Documentation";
+ }
+ virtual QCString trDictionaries()
+ {
+ return "Dictionaries";
+ }
+ virtual QCString trDictionaryDocumentation()
+ {
+ return "Dictionary Documentation";
+ }
+ virtual QCString trSliceInterfaces()
+ {
+ return "Interfaces";
+ }
+ virtual QCString trInterfaceIndex()
+ {
+ return "Interface Index";
+ }
+ virtual QCString trInterfaceList()
+ {
+ return "Interface List";
+ }
+ virtual QCString trInterfaceListDescription()
+ {
+ return "Here are the interfaces with brief descriptions:";
+ }
+ virtual QCString trInterfaceHierarchy()
+ {
+ return "Interface Hierarchy";
+ }
+ virtual QCString trInterfaceHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trInterfaceDocumentation()
+ {
+ return "Interface Documentation";
+ }
+ virtual QCString trStructs()
+ {
+ return "Structs";
+ }
+ virtual QCString trStructIndex()
+ {
+ return "Struct Index";
+ }
+ virtual QCString trStructList()
+ {
+ return "Struct List";
+ }
+ virtual QCString trStructListDescription()
+ {
+ return "Here are the structs with brief descriptions:";
+ }
+ virtual QCString trStructDocumentation()
+ {
+ return "Struct Documentation";
+ }
+ virtual QCString trExceptionIndex()
+ {
+ return "Exception Index";
+ }
+ virtual QCString trExceptionList()
+ {
+ return "Exception List";
+ }
+ virtual QCString trExceptionListDescription()
+ {
+ return "Here are the exceptions with brief descriptions:";
+ }
+ virtual QCString trExceptionHierarchy()
+ {
+ return "Exception Hierarchy";
+ }
+ virtual QCString trExceptionHierarchyDescription()
+ {
+ return "This inheritance list is sorted roughly, but not completely, alphabetically:";
+ }
+ virtual QCString trExceptionDocumentation()
+ {
+ return "Exception Documentation";
+ }
+ virtual QCString trCompoundReferenceSlice(const char *clName, ClassDef::CompoundType compType, bool isLocal)
+ {
+ QCString result=(QCString)clName;
+ if (isLocal) result+=" Local";
+ switch(compType)
+ {
+ case ClassDef::Class: result+=" Class"; break;
+ case ClassDef::Struct: result+=" Struct"; break;
+ case ClassDef::Union: result+=" Union"; break;
+ case ClassDef::Interface: result+=" Interface"; break;
+ case ClassDef::Protocol: result+=" Protocol"; break;
+ case ClassDef::Category: result+=" Category"; break;
+ case ClassDef::Exception: result+=" Exception"; break;
+ default: break;
+ }
+ result+=" Reference";
+ return result;
+ }
+ virtual QCString trOperations()
+ {
+ return "Operations";
+ }
+ virtual QCString trOperationDocumentation()
+ {
+ return "Operation Documentation";
+ }
+ virtual QCString trDataMembers()
+ {
+ return "Data Members";
+ }
+ virtual QCString trDataMemberDocumentation()
+ {
+ return "Data Member Documentation";
+ }
+
};
#endif
diff --git a/src/types.h b/src/types.h
index d6f0342..78bc1e7 100644
--- a/src/types.h
+++ b/src/types.h
@@ -56,7 +56,8 @@ enum SrcLangExt
SrcLangExt_XML = 0x04000,
SrcLangExt_Tcl = 0x08000,
SrcLangExt_Markdown = 0x10000,
- SrcLangExt_SQL = 0x20000
+ SrcLangExt_SQL = 0x20000,
+ SrcLangExt_Slice = 0x40000
};
/** Grouping info */
@@ -192,6 +193,11 @@ enum MemberListType
MemberListType_interfaceMembers = 71 + MemberListType_detailedLists,
MemberListType_services = 72,
MemberListType_serviceMembers = 73 + MemberListType_detailedLists,
+
+ MemberListType_decSequenceMembers = 74 + MemberListType_declarationLists,
+ MemberListType_docSequenceMembers = 75 + MemberListType_documentationLists,
+ MemberListType_decDictionaryMembers = 76 + MemberListType_declarationLists,
+ MemberListType_docDictionaryMembers = 77 + MemberListType_documentationLists,
};
enum MemberType
@@ -210,6 +216,8 @@ enum MemberType
MemberType_Event,
MemberType_Interface,
MemberType_Service,
+ MemberType_Sequence,
+ MemberType_Dictionary,
};
enum FortranFormat
diff --git a/src/util.cpp b/src/util.cpp
index 7371026..5d2051b 100644
--- a/src/util.cpp
+++ b/src/util.cpp
@@ -333,14 +333,15 @@ int guessSection(const char *name)
n.right(4)==".xml" ||
n.right(4)==".sql"
) return Entry::SOURCE_SEC;
- if (n.right(2)==".h" || // header
- n.right(3)==".hh" ||
- n.right(4)==".hxx" ||
- n.right(4)==".hpp" ||
- n.right(4)==".h++" ||
- n.right(4)==".idl" ||
- n.right(4)==".ddl" ||
- n.right(5)==".pidl"
+ if (n.right(2)==".h" || // header
+ n.right(3)==".hh" ||
+ n.right(4)==".hxx" ||
+ n.right(4)==".hpp" ||
+ n.right(4)==".h++" ||
+ n.right(4)==".idl" ||
+ n.right(4)==".ddl" ||
+ n.right(5)==".pidl" ||
+ n.right(4)==".ice"
) return Entry::HEADER_SEC;
return 0;
}
@@ -7236,6 +7237,7 @@ g_lang2extMap[] =
{ "objective-c", "c", SrcLangExt_ObjC },
{ "c", "c", SrcLangExt_Cpp },
{ "c++", "c", SrcLangExt_Cpp },
+ { "slice", "c", SrcLangExt_Slice },
{ "python", "python", SrcLangExt_Python },
{ "fortran", "fortran", SrcLangExt_Fortran },
{ "fortranfree", "fortranfree", SrcLangExt_Fortran },
@@ -7341,6 +7343,7 @@ void initDefaultExtensionMapping()
updateLanguageMapping(".qsf", "vhdl");
updateLanguageMapping(".md", "md");
updateLanguageMapping(".markdown", "md");
+ updateLanguageMapping(".ice", "slice");
}
void addCodeOnlyMappings()
@@ -8374,6 +8377,7 @@ QCString langToString(SrcLangExt lang)
case SrcLangExt_SQL: return "SQL";
case SrcLangExt_Tcl: return "Tcl";
case SrcLangExt_Markdown: return "Markdown";
+ case SrcLangExt_Slice: return "Slice";
}
return "Unknown";
}
@@ -8613,7 +8617,7 @@ uint getUtf8CodeToUpper( const QCString& s, int idx )
//--------------------------------------------------------------------------------------
-bool namespaceHasVisibleChild(NamespaceDef *nd,bool includeClasses)
+bool namespaceHasVisibleChild(NamespaceDef *nd,bool includeClasses,bool filterClasses,ClassDef::CompoundType ct)
{
if (nd->getNamespaceSDict())
{
@@ -8625,21 +8629,49 @@ bool namespaceHasVisibleChild(NamespaceDef *nd,bool includeClasses)
{
return TRUE;
}
- else if (namespaceHasVisibleChild(cnd,includeClasses))
+ else if (namespaceHasVisibleChild(cnd,includeClasses,filterClasses,ct))
{
return TRUE;
}
}
}
- if (includeClasses && nd->getClassSDict())
+ if (includeClasses)
{
- ClassSDict::Iterator cli(*nd->getClassSDict());
- ClassDef *cd;
- for (;(cd=cli.current());++cli)
+ ClassSDict *d;
+ if (filterClasses)
{
- if (cd->isLinkableInProject() && cd->templateMaster()==0)
- {
- return TRUE;
+ if (ct == ClassDef::Interface)
+ {
+ d = nd->getInterfaceSDict();
+ }
+ else if (ct == ClassDef::Struct)
+ {
+ d = nd->getStructSDict();
+ }
+ else if (ct == ClassDef::Exception)
+ {
+ d = nd->getExceptionSDict();
+ }
+ else
+ {
+ d = nd->getClassSDict();
+ }
+ }
+ else
+ {
+ d = nd->getClassSDict();
+ }
+
+ if (d)
+ {
+ ClassSDict::Iterator cli(*d);
+ ClassDef *cd;
+ for (;(cd=cli.current());++cli)
+ {
+ if (cd->isLinkableInProject() && cd->templateMaster()==0)
+ {
+ return TRUE;
+ }
}
}
}
diff --git a/src/util.h b/src/util.h
index 2ee8b17..f3c8510 100644
--- a/src/util.h
+++ b/src/util.h
@@ -1,12 +1,12 @@
/******************************************************************************
*
- *
+ *
*
* Copyright (C) 1997-2015 by Dimitri van Heesch.
*
* Permission to use, copy, modify, and distribute this software and its
- * documentation under the terms of the GNU General Public License is hereby
- * granted. No representations are made about the suitability of this software
+ * documentation under the terms of the GNU General Public License is hereby
+ * granted. No representations are made about the suitability of this software
* for any purpose. It is provided "as is" without express or implied warranty.
* See the GNU General Public License for more details.
*
@@ -18,7 +18,7 @@
#ifndef UTIL_H
#define UTIL_H
-/*! \file
+/*! \file
* \brief A bunch of utility functions.
*/
@@ -26,6 +26,8 @@
#include <ctype.h>
#include "types.h"
#include "sortdict.h"
+#include "docparser.h"
+#include "classdef.h"
//--------------------------------------------------------------------
@@ -69,7 +71,7 @@ class TextGeneratorIntf
virtual void writeBreak(int indent) const = 0;
virtual void writeLink(const char *extRef,const char *file,
const char *anchor,const char *text
- ) const = 0;
+ ) const = 0;
};
/** Implements TextGeneratorIntf for an OutputDocInterface stream. */
@@ -138,11 +140,11 @@ QCString fileToString(const char *name,bool filter=FALSE,bool isSourceCode=FALSE
QCString dateToString(bool);
bool getDefs(const QCString &scopeName,
- const QCString &memberName,
- const char *,
- MemberDef *&md,
+ const QCString &memberName,
+ const char *,
+ MemberDef *&md,
ClassDef *&cd,
- FileDef *&fd,
+ FileDef *&fd,
NamespaceDef *&nd,
GroupDef *&gd,
bool forceEmptyScope=FALSE,
@@ -260,7 +262,7 @@ void initClassHierarchy(ClassSDict *cl);
bool hasVisibleRoot(BaseClassList *bcl);
bool classHasVisibleChildren(ClassDef *cd);
-bool namespaceHasVisibleChild(NamespaceDef *nd,bool includeClasses);
+bool namespaceHasVisibleChild(NamespaceDef *nd,bool includeClasses,bool filterClasses,ClassDef::CompoundType ct);
bool classVisibleInIndex(ClassDef *cd);
int minClassDistance(const ClassDef *cd,const ClassDef *bcd,int level=0);
@@ -391,7 +393,7 @@ SrcLangExt getLanguageFromFileName(const QCString& fileName);
void initDefaultExtensionMapping();
void addCodeOnlyMappings();
-MemberDef *getMemberFromSymbol(Definition *scope,FileDef *fileScope,
+MemberDef *getMemberFromSymbol(Definition *scope,FileDef *fileScope,
const char *n);
bool checkIfTypedef(Definition *scope,FileDef *fileScope,const char *n);
@@ -487,4 +489,3 @@ void incUsedTableLevels();
void decUsedTableLevels();
#endif
-
diff --git a/src/vhdldocgen.cpp b/src/vhdldocgen.cpp
index 287565b..36392b7 100644
--- a/src/vhdldocgen.cpp
+++ b/src/vhdldocgen.cpp
@@ -2990,7 +2990,8 @@ ferr:
Public, Normal, cur->stat,Member,
MemberType_Variable,
0,
- 0);
+ 0,
+ "");
if (ar->getOutputFileBase())
{
diff --git a/src/xmlgen.cpp b/src/xmlgen.cpp
index e003319..4b12757 100644
--- a/src/xmlgen.cpp
+++ b/src/xmlgen.cpp
@@ -97,6 +97,8 @@ class XmlSectionMapper : public QIntDict<char>
insert(MemberListType_decDefineMembers,"define");
insert(MemberListType_decProtoMembers,"prototype");
insert(MemberListType_decTypedefMembers,"typedef");
+ insert(MemberListType_decSequenceMembers,"sequence");
+ insert(MemberListType_decDictionaryMembers,"dictionary");
insert(MemberListType_decEnumMembers,"enum");
insert(MemberListType_decFuncMembers,"func");
insert(MemberListType_decVarMembers,"var");
@@ -525,20 +527,22 @@ static void generateXMLForMember(MemberDef *md,FTextStream &ti,FTextStream &t,De
bool isFunc=FALSE;
switch (md->memberType())
{
- case MemberType_Define: memType="define"; break;
- case MemberType_Function: memType="function"; isFunc=TRUE; 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"; isFunc=TRUE; break;
- case MemberType_Slot: memType="slot"; isFunc=TRUE; break;
- case MemberType_Friend: memType="friend"; isFunc=TRUE; break;
- case MemberType_DCOP: memType="dcop"; isFunc=TRUE; 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;
+ case MemberType_Define: memType="define"; break;
+ case MemberType_Function: memType="function"; isFunc=TRUE; 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"; isFunc=TRUE; break;
+ case MemberType_Slot: memType="slot"; isFunc=TRUE; break;
+ case MemberType_Friend: memType="friend"; isFunc=TRUE; break;
+ case MemberType_DCOP: memType="dcop"; isFunc=TRUE; 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;
+ case MemberType_Sequence: memType="sequence"; break;
+ case MemberType_Dictionary: memType="dictionary"; break;
}
ti << " <member refid=\"" << memberOutputFileBase(md)