Skip to content

D
doxverilog
Commit a1995ea7 authored by Dimitri van Heesch's avatar Dimitri van Heesch
Browse files
Options

Release-1.2.3-20001126

parent ecaf7fbf
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 2491 additions and 527 deletions
INSTALL
View file @ a1995ea7
DOXYGEN Version 1.2.3-20001118 DOXYGEN Version 1.2.3-20001126
Please read the installation section of the manual for instructions. Please read the installation section of the manual for instructions.
-------- --------
Dimitri van Heesch (18 November 2000) Dimitri van Heesch (26 November 2000)
README
View file @ a1995ea7
DOXYGEN Version 1.2.3-20001118 DOXYGEN Version 1.2.3-20001126
Please read INSTALL for compilation instructions. Please read INSTALL for compilation instructions.
...@@ -7,4 +7,4 @@ The latest version of doxygen can be obtained at ...@@ -7,4 +7,4 @@ The latest version of doxygen can be obtained at
Enjoy, Enjoy,
Dimitri van Heesch (18 November 2000) Dimitri van Heesch (26 November 2000)
VERSION
View file @ a1995ea7
1.2.3-20001118 1.2.3-20001126
addon/configgen/configgen.cpp
View file @ a1995ea7
...@@ -712,8 +712,8 @@ int main(int argc,char * argv[]) ...@@ -712,8 +712,8 @@ int main(int argc,char * argv[])
// process template file // process template file
while (!ctfile.atEnd()) while (!ctfile.atEnd())
{ {
int l=ctfile.readLine(buf,maxLineLen-1); int l = ctfile.readLine(buf,maxLineLen-1);
if (buf[l-2]=='\r') // remove the \r for the folks using Windows if (l>1 && buf[l-2]=='\r') // remove the \r for the folks using Windows
{ {
buf[l-2]='\n'; buf[l-2]='\n';
buf[l-1]='\r'; buf[l-1]='\r';
...@@ -1302,6 +1302,31 @@ void init() ...@@ -1302,6 +1302,31 @@ void init()
1,20 1,20
); );
addDependency("enumValuesPerLine","generateHtml"); addDependency("enumValuesPerLine","generateHtml");
ConfigBool::add( "ftvHelpFlag",
"GENERATE_TREEVIEW",
"FALSE",
"should a folder tree view be generated?",
"If the GENERATE_TREEVIEW tag is set to YES, a side pannel will be\n"
"generated containing a tree-like index structure (just like the one that \n"
"is generated for HTML Help). For this to work a browser that supports \n"
"JavaScript and frames is required (for instance Netscape 4.0+ \n"
"or Internet explorer 4.0+). "
);
addDependency("ftvHelpFlag","generateHtml");
// TODO: integrate this option
// ConfigBool::add( "htmlHelpGroupsOnly",
// "HTMLHELP_GROUPS_ONLY",
// "FALSE",
// "should \\ingroup's be used to create HTML Help hierarchy?",
// "If the HTMLHELP_GROUPS_ONLY tag is set to YES, documented objects are \n"
// "displayed in the HTML Help tree if and only if they are \n"
// "placed in a user-defined group using the \\ingroup markup. \n"
// "Use \\defgroup to define a group before adding objects to a group. \n"
// "Also affects FTV Help (see GENERATE_FTVHELP tag). \n"
// );
// addDependency("htmlHelpGroupsOnly","generateHtml");
//----------------------------------------------------------------------------------------------- //-----------------------------------------------------------------------------------------------
ConfigInfo::add( "LaTeX","configuration options related to the LaTeX output"); ConfigInfo::add( "LaTeX","configuration options related to the LaTeX output");
//----------------------------------------------------------------------------------------------- //-----------------------------------------------------------------------------------------------
......
doc/index.doc
View file @ a1995ea7
...@@ -165,82 +165,13 @@ Thanks go to: ...@@ -165,82 +165,13 @@ Thanks go to:
<li>Matthias Andree for providing a .spec script for building rpms from the <li>Matthias Andree for providing a .spec script for building rpms from the
sources. sources.
<li>Tim Mensch for adding the todo command. <li>Tim Mensch for adding the todo command.
<li>Ken Wong for providing the HTML tree view code.
<li>Jens Breitenstein, Christophe Bordeaux, Samuel Hägglund, Xet Erixon, <li>Jens Breitenstein, Christophe Bordeaux, Samuel Hägglund, Xet Erixon,
Vlastimil Havran, Petr Prikryl, Ahmed Also Faisal, Alessandro Falappa, Vlastimil Havran, Petr Prikryl, Ahmed Also Faisal, Alessandro Falappa,
Kenji Nagamatsu, Francisco Oltra Thennet, Olli Korhonen, Kenji Nagamatsu, Francisco Oltra Thennet, Olli Korhonen,
Boris Bralo, Nickolay Semyonov, and Grzegorz Kowal for providing Boris Bralo, Nickolay Semyonov, and Grzegorz Kowal for providing
translations into various languages. translations into various languages.
<li> <li>many, many others for suggestions, patches and bug reports.
Arnt Gulbrandsen,
Adam P. Jenkins,
Frank van de Pol,
Ulrich Quill,
Karl Robillard,
Frugal the Curious,
Michael Figley,
Eric Bos,
Barry Roberts,
Mark Tigges,
Jan Ekholm,
Andre Johansen,
Martin Franken,
Martin Hofmann,
Ulrich Ring,
Andy Guy,
Ryan Mclean,
Joseph Reklow,
Morten Eriksen,
Arthur Pope,
Andreas Felber,
Matthias Schwartz,
Bj&ouml;rn Bon,
Volker B&ouml;rchers,
Baruch Even,
Kor de Jong,
Thomas Eschenbacher,
Bert Scholten,
Germar Morgenthaler,
Daniel Bellen,
Terry Brown,
Anke Selig,
David Aspinwall,
Hellmar Becker,
Harald Krummeck,
Christoph Koegl,
Martin Reinecke,
Joseph Turian,
Craig P Earls,
Greg Sjaardema,
Vlado Sironja,
Jens Schmidt,
Lutz Sammer,
Robert Dale,
Ionutz Borcoman,
Markus Noga,
Darren Kelly,
Joerg Ott,
Kostya Serebrainy,
Marco Molteni,
Johannes Zellner,
Ole Gerden,
Olaf Meeuwissen,
Feiyi Wang,
Robert J. Clark,
Matthias Baas,
Walter Mueller,
William van Dieten,
Joshua Jensen,
Patrick Alberts,
Jacques Tremblay,
John Sturton,
Moshe Kruger,
David Wong,
Peter Garner,
Fred Labrosse,
Frank Schimmel,
Reinhard Nissl,
Alexander Gidon,
and many others for suggestions, patches and bug reports.
</ul> </ul>
*/ */
packages/rpm/doxygen.spec
View file @ a1995ea7
Name: doxygen Name: doxygen
Version: 1.2.3-20001118 Version: 1.2.3-20001126
Summary: documentation system for C, C++ and IDL Summary: documentation system for C, C++ and IDL
Release: 1 Release: 1
Source0: doxygen-%{version}.src.tar.gz Source0: doxygen-%{version}.src.tar.gz
......
src/classdef.cpp
View file @ a1995ea7
...@@ -617,6 +617,37 @@ ArgumentList *ClassDef::outerTemplateArguments() const ...@@ -617,6 +617,37 @@ ArgumentList *ClassDef::outerTemplateArguments() const
return tempArgs; return tempArgs;
} }
} }
static void writeTemplateSpec(OutputList &ol,ArgumentList *al,
const QCString &pageType,const QCString &name)
{
if (al) // class is a template
{
ol.startSubsubsection();
ol.docify("template<");
Argument *a=al->first();
while (a)
{
ol.docify(a->type);
if (!a->name.isEmpty())
{
ol.docify(" ");
ol.docify(a->name);
}
if (a->defval.length()!=0)
{
ol.docify(" = ");
ol.docify(a->defval);
}
a=al->next();
if (a) ol.docify(", ");
}
ol.docify("> "+pageType.lower()+" "+name);
ol.endSubsubsection();
ol.writeString("\n");
}
}
// write all documentation for this class // write all documentation for this class
void ClassDef::writeDocumentation(OutputList &ol) void ClassDef::writeDocumentation(OutputList &ol)
...@@ -945,32 +976,7 @@ void ClassDef::writeDocumentation(OutputList &ol) ...@@ -945,32 +976,7 @@ void ClassDef::writeDocumentation(OutputList &ol)
ol.endGroupHeader(); ol.endGroupHeader();
ol.startTextBlock(); ol.startTextBlock();
ArgumentList *al=outerTempArgList; writeTemplateSpec(ol,outerTempArgList,pageType,name());
if (al) // class is a template
{
ol.startSubsubsection();
ol.docify("template<");
Argument *a=al->first();
while (a)
{
ol.docify(a->type);
if (!a->name.isEmpty())
{
ol.docify(" ");
ol.docify(a->name);
}
if (a->defval.length()!=0)
{
ol.docify(" = ");
ol.docify(a->defval);
}
a=al->next();
if (a) ol.docify(", ");
}
ol.docify("> "+pageType.lower()+" "+name());
ol.endSubsubsection();
ol.writeString("\n");
}
// repeat brief description // repeat brief description
if (!briefDescription().isEmpty() && Config::repeatBriefFlag) if (!briefDescription().isEmpty() && Config::repeatBriefFlag)
...@@ -1009,6 +1015,10 @@ void ClassDef::writeDocumentation(OutputList &ol) ...@@ -1009,6 +1015,10 @@ void ClassDef::writeDocumentation(OutputList &ol)
writeSourceDef(ol,name()); writeSourceDef(ol,name());
ol.endTextBlock(); ol.endTextBlock();
} }
else
{
writeTemplateSpec(ol,outerTempArgList,pageType,name());
}
typedefMembers.countDocMembers(); typedefMembers.countDocMembers();
if (typedefMembers.totalCount()>0) if (typedefMembers.totalCount()>0)
......
src/config.h
View file @ a1995ea7
/* This file was generated by configgen on Sat Oct 28 15:42:39 2000 /* This file was generated by configgen on Sat Nov 25 21:38:08 2000
* from config_templ.h * from config_templ.h
* *
* DO NOT EDIT! * DO NOT EDIT!
...@@ -97,6 +97,7 @@ struct Config ...@@ -97,6 +97,7 @@ struct Config
static bool htmlHelpFlag; // should html help files be generated? static bool htmlHelpFlag; // should html help files be generated?
static bool noIndexFlag; // generate condensed index flag static bool noIndexFlag; // generate condensed index flag
static int enumValuesPerLine; // number of enum values that are put on one line static int enumValuesPerLine; // number of enum values that are put on one line
static bool ftvHelpFlag; // should a folder tree view be generated?
static bool generateLatex; // generate Latex output static bool generateLatex; // generate Latex output
static QCString latexOutputDir; // the directory to put the Latex files static QCString latexOutputDir; // the directory to put the Latex files
static bool compactLatexFlag; // generate compact LaTeX documentation. static bool compactLatexFlag; // generate compact LaTeX documentation.
......
src/config.l
View file @ a1995ea7
/* This file was generated by configgen on Sat Oct 28 15:42:39 2000 /* This file was generated by configgen on Sat Nov 25 21:38:08 2000
* from config_templ.l * from config_templ.l
* *
* DO NOT EDIT! * DO NOT EDIT!
...@@ -134,6 +134,7 @@ bool Config::htmlAlignMemberFlag = TRUE; ...@@ -134,6 +134,7 @@ bool Config::htmlAlignMemberFlag = TRUE;
bool Config::htmlHelpFlag = FALSE; bool Config::htmlHelpFlag = FALSE;
bool Config::noIndexFlag = FALSE; bool Config::noIndexFlag = FALSE;
int Config::enumValuesPerLine = 4; int Config::enumValuesPerLine = 4;
bool Config::ftvHelpFlag = FALSE;
bool Config::generateLatex = TRUE; bool Config::generateLatex = TRUE;
QCString Config::latexOutputDir = "latex"; QCString Config::latexOutputDir = "latex";
bool Config::compactLatexFlag = FALSE; bool Config::compactLatexFlag = FALSE;
...@@ -411,6 +412,7 @@ static void readIncludeFile(const char *incName) ...@@ -411,6 +412,7 @@ static void readIncludeFile(const char *incName)
<Start>"GENERATE_HTMLHELP"[ \t]*"=" { BEGIN(GetBool); b=&Config::htmlHelpFlag; } <Start>"GENERATE_HTMLHELP"[ \t]*"=" { BEGIN(GetBool); b=&Config::htmlHelpFlag; }
<Start>"DISABLE_INDEX"[ \t]*"=" { BEGIN(GetBool); b=&Config::noIndexFlag; } <Start>"DISABLE_INDEX"[ \t]*"=" { BEGIN(GetBool); b=&Config::noIndexFlag; }
<Start>"ENUM_VALUES_PER_LINE"[ \t]*"=" { BEGIN(GetString); s=&enumValuesPerLineString; s->resize(0); } <Start>"ENUM_VALUES_PER_LINE"[ \t]*"=" { BEGIN(GetString); s=&enumValuesPerLineString; s->resize(0); }
<Start>"GENERATE_TREEVIEW"[ \t]*"=" { BEGIN(GetBool); b=&Config::ftvHelpFlag; }
<Start>"GENERATE_LATEX"[ \t]*"=" { BEGIN(GetBool); b=&Config::generateLatex; } <Start>"GENERATE_LATEX"[ \t]*"=" { BEGIN(GetBool); b=&Config::generateLatex; }
<Start>"LATEX_OUTPUT"[ \t]*"=" { BEGIN(GetString); s=&Config::latexOutputDir; s->resize(0); } <Start>"LATEX_OUTPUT"[ \t]*"=" { BEGIN(GetString); s=&Config::latexOutputDir; s->resize(0); }
<Start>"COMPACT_LATEX"[ \t]*"=" { BEGIN(GetBool); b=&Config::compactLatexFlag; } <Start>"COMPACT_LATEX"[ \t]*"=" { BEGIN(GetBool); b=&Config::compactLatexFlag; }
...@@ -710,6 +712,7 @@ void dumpConfig() ...@@ -710,6 +712,7 @@ void dumpConfig()
printf("htmlHelpFlag=`%d'\n",Config::htmlHelpFlag); printf("htmlHelpFlag=`%d'\n",Config::htmlHelpFlag);
printf("noIndexFlag=`%d'\n",Config::noIndexFlag); printf("noIndexFlag=`%d'\n",Config::noIndexFlag);
printf("enumValuesPerLine=`%d'\n",Config::enumValuesPerLine); printf("enumValuesPerLine=`%d'\n",Config::enumValuesPerLine);
printf("ftvHelpFlag=`%d'\n",Config::ftvHelpFlag);
printf("# configuration options related to the LaTeX output\n"); printf("# configuration options related to the LaTeX output\n");
printf("generateLatex=`%d'\n",Config::generateLatex); printf("generateLatex=`%d'\n",Config::generateLatex);
printf("latexOutputDir=`%s'\n",Config::latexOutputDir.data()); printf("latexOutputDir=`%s'\n",Config::latexOutputDir.data());
...@@ -878,6 +881,7 @@ void Config::init() ...@@ -878,6 +881,7 @@ void Config::init()
Config::htmlHelpFlag = FALSE; Config::htmlHelpFlag = FALSE;
Config::noIndexFlag = FALSE; Config::noIndexFlag = FALSE;
Config::enumValuesPerLine = 4; Config::enumValuesPerLine = 4;
Config::ftvHelpFlag = FALSE;
Config::generateLatex = TRUE; Config::generateLatex = TRUE;
Config::latexOutputDir = "latex"; Config::latexOutputDir = "latex";
Config::compactLatexFlag = FALSE; Config::compactLatexFlag = FALSE;
...@@ -1037,8 +1041,8 @@ void writeTemplateConfig(QFile *f,bool sl) ...@@ -1037,8 +1041,8 @@ void writeTemplateConfig(QFile *f,bool sl)
t << "# information to generate all constant output in the proper language. \n"; t << "# information to generate all constant output in the proper language. \n";
t << "# The default language is English, other supported languages are: \n"; t << "# The default language is English, other supported languages are: \n";
t << "# Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese, \n"; t << "# Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese, \n";
t << "# Korean, Hungarian, Spanish, Romanian, Russian, Croatian, Polish, \n"; t << "# Korean, Hungarian, Norwegian, Spanish, Romanian, Russian, Croatian, \n";
t << "# Portuguese and Slovene.\n"; t << "# Polish, Portuguese and Slovene.\n";
t << "\n"; t << "\n";
} }
t << "OUTPUT_LANGUAGE = "; t << "OUTPUT_LANGUAGE = ";
...@@ -1706,6 +1710,19 @@ void writeTemplateConfig(QFile *f,bool sl) ...@@ -1706,6 +1710,19 @@ void writeTemplateConfig(QFile *f,bool sl)
writeIntValue(t,Config::enumValuesPerLine); writeIntValue(t,Config::enumValuesPerLine);
t << "\n"; t << "\n";
if (!sl) if (!sl)
{
t << "\n";
t << "# If the GENERATE_TREEVIEW tag is set to YES, a side pannel will be\n";
t << "# generated containing a tree-like index structure (just like the one that \n";
t << "# is generated for HTML Help). For this to work a browser that supports \n";
t << "# JavaScript and frames is required (for instance Netscape 4.0+ \n";
t << "# or Internet explorer 4.0+). \n";
t << "\n";
}
t << "GENERATE_TREEVIEW = ";
writeBoolValue(t,Config::ftvHelpFlag);
t << "\n";
if (!sl)
{ {
t << "\n"; t << "\n";
} }
......
src/doc.l
View file @ a1995ea7
...@@ -756,7 +756,7 @@ FILE ({FILESCHAR}*{FILEECHAR}+("."{FILESCHAR}*{FILEECHAR}+)*)|("\""[^\n\"]+ ...@@ -756,7 +756,7 @@ FILE ({FILESCHAR}*{FILEECHAR}+("."{FILESCHAR}*{FILEECHAR}+)*)|("\""[^\n\"]+
ID [a-z_A-Z][a-z_A-Z0-9]* ID [a-z_A-Z][a-z_A-Z0-9]*
SCOPENAME (({ID}?{BN}*"::"{BN}*)*)((~{BN}*)?{ID}) SCOPENAME (({ID}?{BN}*"::"{BN}*)*)((~{BN}*)?{ID})
SCOPEMASK {ID}?(("::"|"#")?(~)?{ID})+ SCOPEMASK {ID}?(("::"|"#")?(~)?{ID})+
URLMASK [a-z_A-Z0-9\~\:\?\@\#\.\-\+\/\=]+ URLMASK [a-z_A-Z0-9\~\:\?\@\%\#\.\-\+\/\=]+
NONTERM [\{\}\[\]\`\~\@\|\-\+\#\$\/\\\!\%\^\&\*()a-z_A-Z<>0-9] NONTERM [\{\}\[\]\`\~\@\|\-\+\#\$\/\\\!\%\^\&\*()a-z_A-Z<>0-9]
WORD ({NONTERM}+([^\n\t ]*{NONTERM}+)?)|("\""[^\n\"]"\"") WORD ({NONTERM}+([^\n\t ]*{NONTERM}+)?)|("\""[^\n\"]"\"")
ATTR ({B}+[^>\n]*)? ATTR ({B}+[^>\n]*)?
...@@ -963,10 +963,13 @@ DOCPARAM ([a-z_A-Z0-9:\<\>\=\.\-]+)|("\"".*"\"") ...@@ -963,10 +963,13 @@ DOCPARAM ([a-z_A-Z0-9:\<\>\=\.\-]+)|("\"".*"\"")
} }
<DocLinkText>. { linkText += *yytext; } <DocLinkText>. { linkText += *yytext; }
<DocLinkText>"\n" { linkText += " "; } <DocLinkText>"\n" { linkText += " "; }
<DocLink,DocLinkText>{CMD}"endlink" { // <- needed for things like \endlink. <DocLink,DocLinkText>{CMD}"endlink" { // <- needed for things like \endlink.
//printf("GenerateLink className=`%s' linkRef=`%s' linkText=`%s'\n", //printf("GenerateLink className=`%s' linkRef=`%s' linkText=`%s'\n",
// className.data(),linkRef.data(),linkText.data()); // className.data(),linkRef.data(),linkText.data());
generateLink(*outDoc,className,linkRef,inSeeBlock,linkText.stripWhiteSpace()); if (!generateLink(*outDoc,className,linkRef,inSeeBlock,linkText.stripWhiteSpace()))
{
warn(yyFileName,yyLineNr,"Warning: link to unknown section %s in the documentation of this entity!",linkRef.data());
}
BEGIN( DocScan ); BEGIN( DocScan );
} }
<DocScan>{CMD}"endlink"/[^a-z_A-Z0-9] { warn(yyFileName,yyLineNr, <DocScan>{CMD}"endlink"/[^a-z_A-Z0-9] { warn(yyFileName,yyLineNr,
...@@ -2007,6 +2010,12 @@ DOCPARAM ([a-z_A-Z0-9:\<\>\=\.\-]+)|("\"".*"\"") ...@@ -2007,6 +2010,12 @@ DOCPARAM ([a-z_A-Z0-9:\<\>\=\.\-]+)|("\"".*"\"")
<DocScan,DocEmphasis,DocBold,DocCode>"%"[a-zA-Z_0-9\-]+ { <DocScan,DocEmphasis,DocBold,DocCode>"%"[a-zA-Z_0-9\-]+ {
outDoc->docify(yytext+1); outDoc->docify(yytext+1);
} }
<DocEmphasis>{FILEMASK} {
outDoc->startEmphasis();
generateFileRef(*outDoc,yytext);
outDoc->endEmphasis();
BEGIN( DocScan );
}
<DocEmphasis>[a-z_A-Z][a-z_A-Z:0-9<>&\-=^%~!\[\]()|\*/]*"("[a-z_A-Z0-9,:\<\> \t\*\&]*")" { <DocEmphasis>[a-z_A-Z][a-z_A-Z:0-9<>&\-=^%~!\[\]()|\*/]*"("[a-z_A-Z0-9,:\<\> \t\*\&]*")" {
outDoc->startEmphasis(); outDoc->startEmphasis();
generateRef(*outDoc,className,yytext,inSeeBlock); generateRef(*outDoc,className,yytext,inSeeBlock);
...@@ -2019,6 +2028,12 @@ DOCPARAM ([a-z_A-Z0-9:\<\>\=\.\-]+)|("\"".*"\"") ...@@ -2019,6 +2028,12 @@ DOCPARAM ([a-z_A-Z0-9:\<\>\=\.\-]+)|("\"".*"\"")
outDoc->endEmphasis(); outDoc->endEmphasis();
BEGIN( DocScan ); BEGIN( DocScan );
} }
<DocBold>{FILEMASK} {
outDoc->startBold();
generateFileRef(*outDoc,yytext);
outDoc->endBold();
BEGIN( DocScan );
}
<DocBold>[a-z_A-Z][a-z_A-Z:0-9<>&\-=^%~!\[\]()|\*/]*"("[a-z_A-Z0-9,:\<\> \t\*\&]*")" { <DocBold>[a-z_A-Z][a-z_A-Z:0-9<>&\-=^%~!\[\]()|\*/]*"("[a-z_A-Z0-9,:\<\> \t\*\&]*")" {
outDoc->startBold(); outDoc->startBold();
generateRef(*outDoc,className,yytext,inSeeBlock); generateRef(*outDoc,className,yytext,inSeeBlock);
...@@ -2031,6 +2046,12 @@ DOCPARAM ([a-z_A-Z0-9:\<\>\=\.\-]+)|("\"".*"\"") ...@@ -2031,6 +2046,12 @@ DOCPARAM ([a-z_A-Z0-9:\<\>\=\.\-]+)|("\"".*"\"")
outDoc->endBold(); outDoc->endBold();
BEGIN( DocScan ); BEGIN( DocScan );
} }
<DocCode>{FILEMASK} {
outDoc->startTypewriter();
generateFileRef(*outDoc,yytext);
outDoc->endTypewriter();
BEGIN( DocScan );
}
<DocCode>[a-z_A-Z][a-z_A-Z:0-9<>&\-=^%~!\[\]()!\*/]*"("[a-z_A-Z0-9,:\<\> \t\*\&]*")" { <DocCode>[a-z_A-Z][a-z_A-Z:0-9<>&\-=^%~!\[\]()!\*/]*"("[a-z_A-Z0-9,:\<\> \t\*\&]*")" {
outDoc->startTypewriter(); outDoc->startTypewriter();
generateRef(*outDoc,className,yytext,inSeeBlock); generateRef(*outDoc,className,yytext,inSeeBlock);
......
src/doxygen.cpp
View file @ a1995ea7
...@@ -51,6 +51,7 @@ ...@@ -51,6 +51,7 @@
#include "language.h" #include "language.h"
#include "debug.h" #include "debug.h"
#include "htmlhelp.h" #include "htmlhelp.h"
#include "ftvhelp.h"
#include "defargs.h" #include "defargs.h"
#include "rtfgen.h" #include "rtfgen.h"
#include "xml.h" #include "xml.h"
...@@ -193,6 +194,7 @@ int documentedGroups; ...@@ -193,6 +194,7 @@ int documentedGroups;
int documentedNamespaces; int documentedNamespaces;
int documentedNamespaceMembers; int documentedNamespaceMembers;
int documentedIncludeFiles; int documentedIncludeFiles;
int documentedPages;
QTextStream tagFile; QTextStream tagFile;
...@@ -218,7 +220,7 @@ const char *getOverloadDocs() ...@@ -218,7 +220,7 @@ const char *getOverloadDocs()
static void addRelatedPage(const char *name,const QCString &ptitle, static void addRelatedPage(const char *name,const QCString &ptitle,
const QCString &doc,QList<QCString> *anchors, const QCString &doc,QList<QCString> *anchors,
const char *fileName,int startLine, const char *fileName,int startLine,
int todoId,int testId int todoId,int testId,GroupDef *gd=0
) )
{ {
PageInfo *pi=0; PageInfo *pi=0;
...@@ -251,6 +253,8 @@ static void addRelatedPage(const char *name,const QCString &ptitle, ...@@ -251,6 +253,8 @@ static void addRelatedPage(const char *name,const QCString &ptitle,
setFileNameForSections(anchors,pageName); setFileNameForSections(anchors,pageName);
pageSDict->append(baseName,pi); pageSDict->append(baseName,pi);
if (gd) gd->addPage(pi);
if (!pi->title.isEmpty()) if (!pi->title.isEmpty())
{ {
...@@ -259,7 +263,14 @@ static void addRelatedPage(const char *name,const QCString &ptitle, ...@@ -259,7 +263,14 @@ static void addRelatedPage(const char *name,const QCString &ptitle,
// a page name is a label as well! // a page name is a label as well!
SectionInfo *si=new SectionInfo( SectionInfo *si=new SectionInfo(
pi->name,pi->title,SectionInfo::Section); pi->name,pi->title,SectionInfo::Section);
si->fileName=pageName; if (gd)
{
si->fileName=gd->getOutputFileBase();
}
else
{
si->fileName=pageName;
}
//printf(" SectionInfo: sec=%p sec->fileName=%s\n",si,si->fileName.data()); //printf(" SectionInfo: sec=%p sec->fileName=%s\n",si,si->fileName.data());
//printf("Adding section info %s\n",pi->name.data()); //printf("Adding section info %s\n",pi->name.data());
sectionDict.insert(pageName,si); sectionDict.insert(pageName,si);
...@@ -267,6 +278,20 @@ static void addRelatedPage(const char *name,const QCString &ptitle, ...@@ -267,6 +278,20 @@ static void addRelatedPage(const char *name,const QCString &ptitle,
} }
} }
static void addRelatedPage(Entry *root)
{
GroupDef *gd=0;
QListIterator<QCString> sli(*root->groups);
QCString *s;
for (;(s=sli.current());++sli)
{
if (!s->isEmpty() && (gd=groupDict[*s])) break;
}
addRelatedPage(root->name,root->args,root->doc,root->anchors,
root->fileName,root->startLine,root->todoId,root->testId,gd
);
}
//---------------------------------------------------------------------------- //----------------------------------------------------------------------------
static void addRefItem(int todoId,int testId,const char *prefix, static void addRefItem(int todoId,int testId,const char *prefix,
...@@ -1754,7 +1779,11 @@ static void buildMemberList(Entry *root) ...@@ -1754,7 +1779,11 @@ static void buildMemberList(Entry *root)
QCString nsName,rnsName; QCString nsName,rnsName;
if (nd) nsName = nd->name().copy(); if (nd) nsName = nd->name().copy();
if (rnd) rnsName = rnd->name().copy(); if (rnd) rnsName = rnd->name().copy();
QCString groupName,rgroupName;
if (md->getGroupDef()) groupName=md->getGroupDef()->name().copy();
if (root->groups && root->groups->first()) rgroupName=root->groups->first()->copy();
//printf("namespace `%s' `%s'\n",nsName.data(),rnsName.data()); //printf("namespace `%s' `%s'\n",nsName.data(),rnsName.data());
//printf("groupNames `%s' `%s'\n",groupName.data(),rgroupName.data());
if ( if (
matchArguments(md->argumentList(),root->argList,0,nsName) matchArguments(md->argumentList(),root->argList,0,nsName)
) )
...@@ -1764,7 +1793,10 @@ static void buildMemberList(Entry *root) ...@@ -1764,7 +1793,10 @@ static void buildMemberList(Entry *root)
((fd!=0 && // no external reference and ((fd!=0 && // no external reference and
fd->absFilePath()==root->fileName // prototype in the same file fd->absFilePath()==root->fileName // prototype in the same file
) || ) ||
md->getGroupDef()!=0 // member is part of a group (
!groupName.isEmpty() || // member is or was part of a group
!rgroupName.isEmpty()
)
); );
// otherwise, allow a duplicate global member with the same argument list // otherwise, allow a duplicate global member with the same argument list
...@@ -4565,9 +4597,7 @@ static void buildPageList(Entry *root) ...@@ -4565,9 +4597,7 @@ static void buildPageList(Entry *root)
{ {
if (!root->name.isEmpty()) if (!root->name.isEmpty())
{ {
addRelatedPage(root->name,root->args,root->doc,root->anchors, addRelatedPage(root);
root->fileName,root->startLine,root->todoId,root->testId
);
} }
} }
else if (root->section == Entry::MAINPAGEDOC_SEC) else if (root->section == Entry::MAINPAGEDOC_SEC)
...@@ -4670,32 +4700,36 @@ static void resolveUserReferences() ...@@ -4670,32 +4700,36 @@ static void resolveUserReferences()
static void generatePageDocs() static void generatePageDocs()
{ {
if (documentedPages==0) return;
PageSDictIterator pdi(*pageSDict); PageSDictIterator pdi(*pageSDict);
PageInfo *pi=0; PageInfo *pi=0;
for (pdi.toFirst();(pi=pdi.current());++pdi) for (pdi.toFirst();(pi=pdi.current());++pdi)
{ {
msg("Generating docs for page %s...\n",pi->name.data()); if (!pi->inGroup)
outputList->disable(OutputGenerator::Man); {
QCString pageName; msg("Generating docs for page %s...\n",pi->name.data());
if (Config::caseSensitiveNames) outputList->disable(OutputGenerator::Man);
pageName=pi->name.copy(); QCString pageName;
else if (Config::caseSensitiveNames)
pageName=pi->name.lower(); pageName=pi->name.copy();
else
startFile(*outputList,pageName,pi->title); pageName=pi->name.lower();
SectionInfo *si=0;
if (!pi->title.isEmpty() && !pi->name.isEmpty() && startFile(*outputList,pageName,pi->title);
(si=sectionDict[pi->name])!=0) SectionInfo *si=0;
{ if (!pi->title.isEmpty() && !pi->name.isEmpty() &&
outputList->startSection(si->label,si->title,FALSE); (si=sectionDict[pi->name])!=0)
outputList->docify(si->title); {
outputList->endSection(si->label,FALSE); outputList->startSection(si->label,si->title,FALSE);
} outputList->docify(si->title);
outputList->startTextBlock(); outputList->endSection(si->label,FALSE);
parseDoc(*outputList,pi->defFileName,pi->defLine,0,0,pi->doc); }
outputList->endTextBlock(); outputList->startTextBlock();
endFile(*outputList); parseDoc(*outputList,pi->defFileName,pi->defLine,0,0,pi->doc);
outputList->enable(OutputGenerator::Man); outputList->endTextBlock();
endFile(*outputList);
outputList->enable(OutputGenerator::Man);
}
} }
} }
...@@ -4724,6 +4758,7 @@ static void buildExampleList(Entry *root) ...@@ -4724,6 +4758,7 @@ static void buildExampleList(Entry *root)
convertFileName(pi->name)+"-example" convertFileName(pi->name)+"-example"
); );
exampleSDict->inSort(root->name,pi); exampleSDict->inSort(root->name,pi);
addExampleToGroups(root,pi);
} }
} }
} }
...@@ -4774,13 +4809,17 @@ static void generateGroupDocs() ...@@ -4774,13 +4809,17 @@ static void generateGroupDocs()
for (;(gd=gli.current());++gli) for (;(gd=gli.current());++gli)
{ {
//printf("group %s #members=%d\n",gd->name().data(),gd->countMembers()); //printf("group %s #members=%d\n",gd->name().data(),gd->countMembers());
if (gd->countMembers()>0) gd->writeDocumentation(*outputList); //if (gd->countMembers()>0)
else //{
{ // gd->writeDocumentation(*outputList);
warn(gd->getDefFileName(),gd->getDefLine(), //}
"Warning: group %s does not have any (documented) members.", //else
gd->name().data()); //{
} // warn(gd->getDefFileName(),gd->getDefLine(),
// "Warning: group %s does not have any (documented) members.",
// gd->name().data());
//}
gd->writeDocumentation(*outputList);
} }
} }
...@@ -5709,6 +5748,7 @@ int main(int argc,char **argv) ...@@ -5709,6 +5748,7 @@ int main(int argc,char **argv)
outputList->add(new HtmlGenerator); outputList->add(new HtmlGenerator);
HtmlGenerator::init(); HtmlGenerator::init();
if (Config::htmlHelpFlag) HtmlHelp::getInstance()->initialize(); if (Config::htmlHelpFlag) HtmlHelp::getInstance()->initialize();
if (Config::ftvHelpFlag) FTVHelp::getInstance()->initialize();
copyStyleSheet(); copyStyleSheet();
} }
if (Config::generateLatex) if (Config::generateLatex)
...@@ -6037,6 +6077,7 @@ int main(int argc,char **argv) ...@@ -6037,6 +6077,7 @@ int main(int argc,char **argv)
documentedGroups = countGroups(); documentedGroups = countGroups();
documentedNamespaces = countNamespaces(); documentedNamespaces = countNamespaces();
documentedNamespaceMembers = countNamespaceMembers(); documentedNamespaceMembers = countNamespaceMembers();
documentedPages = countRelatedPages();
//documentedIncludeFiles = countIncludeFiles(); //documentedIncludeFiles = countIncludeFiles();
// compute the shortest possible names of all files // compute the shortest possible names of all files
...@@ -6154,6 +6195,10 @@ int main(int argc,char **argv) ...@@ -6154,6 +6195,10 @@ int main(int argc,char **argv)
{ {
HtmlHelp::getInstance()->finalize(); HtmlHelp::getInstance()->finalize();
} }
if (Config::generateHtml && Config::ftvHelpFlag)
{
FTVHelp::getInstance()->finalize();
}
if (Config::generateHtml) removeDoxFont(Config::htmlOutputDir); if (Config::generateHtml) removeDoxFont(Config::htmlOutputDir);
......
src/doxygen.h
View file @ a1995ea7
...@@ -116,6 +116,7 @@ extern int documentedGroups; ...@@ -116,6 +116,7 @@ extern int documentedGroups;
extern int documentedNamespaces; extern int documentedNamespaces;
extern int documentedNamespaceMembers; extern int documentedNamespaceMembers;
extern int documentedIncludeFiles; extern int documentedIncludeFiles;
extern int documentedPages;
extern QCString spaces; extern QCString spaces;
extern const char * getOverloadDocs(); extern const char * getOverloadDocs();
......
src/doxygen.pro.in
View file @ a1995ea7
...@@ -27,7 +27,8 @@ HEADERS = doxygen.h scanner.h doc.h classdef.h classlist.h memberdef.h \ ...@@ -27,7 +27,8 @@ HEADERS = doxygen.h scanner.h doc.h classdef.h classlist.h memberdef.h \
translator_it.h formula.h debug.h membergroup.h htmlhelp.h \ translator_it.h formula.h debug.h membergroup.h htmlhelp.h \
translator_ru.h translator_pl.h dot.h rtfgen.h xml.h xml_dtd.h \ translator_ru.h translator_pl.h dot.h rtfgen.h xml.h xml_dtd.h \
reflist.h page.h sortdict.h translator_hu.h translator_kr.h \ reflist.h page.h sortdict.h translator_hu.h translator_kr.h \
translator_ro.h translator_si.h translator_cn.h translator_ro.h translator_si.h translator_cn.h ftvhelp.h \
treeview.h
SOURCES = doxygen.cpp scanner.cpp doc.cpp classdef.cpp classlist.cpp \ SOURCES = doxygen.cpp scanner.cpp doc.cpp classdef.cpp classlist.cpp \
memberdef.cpp membername.cpp index.cpp memberlist.cpp \ memberdef.cpp membername.cpp index.cpp memberlist.cpp \
entry.cpp logos.cpp instdox.cpp message.cpp code.cpp \ entry.cpp logos.cpp instdox.cpp message.cpp code.cpp \
...@@ -38,7 +39,7 @@ SOURCES = doxygen.cpp scanner.cpp doc.cpp classdef.cpp classlist.cpp \ ...@@ -38,7 +39,7 @@ SOURCES = doxygen.cpp scanner.cpp doc.cpp classdef.cpp classlist.cpp \
diagram.cpp gifenc.cpp image.cpp namespacedef.cpp \ diagram.cpp gifenc.cpp image.cpp namespacedef.cpp \
version.cpp language.cpp definition.cpp formula.cpp debug.cpp \ version.cpp language.cpp definition.cpp formula.cpp debug.cpp \
membergroup.cpp htmlhelp.cpp dot.cpp rtfgen.cpp xml.cpp \ membergroup.cpp htmlhelp.cpp dot.cpp rtfgen.cpp xml.cpp \
reflist.cpp reflist.cpp ftvhelp.cpp
unix:LIBS += -L../qtools -lqtools unix:LIBS += -L../qtools -lqtools
win32:INCLUDEPATH += . win32:INCLUDEPATH += .
win32:LIBS += qtools.lib shell32.lib win32:LIBS += qtools.lib shell32.lib
......
src/doxygen.t
View file @ a1995ea7
...@@ -81,3 +81,6 @@ sub GenerateDep { ...@@ -81,3 +81,6 @@ sub GenerateDep {
xml_dtd.h: doxygen.dtd xml_dtd.h: doxygen.dtd
cat doxygen.dtd | sed -e "s/\"/\\\\\"/g" -e "s/^/\"/g" -e "s/$$/\\\\n\"/g" >xml_dtd.h cat doxygen.dtd | sed -e "s/\"/\\\\\"/g" -e "s/^/\"/g" -e "s/$$/\\\\n\"/g" >xml_dtd.h
treeview.h: treeview.js
cat treeview.js | sed -e "s/\\\\/\\\\\\\\/g" -e "s/\"/\\\\\"/g" -e "s/^/\"/g" -e "s/$$/\\\\n\"/g" >treeview.h
src/ftvhelp.cpp 0 → 100644
View file @ a1995ea7
This diff is collapsed.
src/ftvhelp.h 0 → 100644
View file @ a1995ea7
/******************************************************************************
* ftvhelp.h,v 1.0 2000/09/06 16:09:00
*
* Kenney Wong <kwong@ea.com>
*
* Folder Tree View for offline help on browsers that do not support HTML Help.
* Uses the FTV structure from:
* http://www.geocities.com/Paris/LeftBank/2178/ftexample.html
*/
#ifndef FTVHELP_H
#define FTVHELP_H
#include "qtbc.h"
#include <qtextstream.h>
class QFile;
/*! A class that generated the FTV Help specific file.
* This file is used in conjunction with additional FTV web browser code
* that can be obtained from:
* http://www.geocities.com/Paris/LeftBank/2178/ftexample.html
*/
class FTVHelp
{
public:
static FTVHelp *getInstance();
void initialize();
void finalize();
int incContentsDepth();
int decContentsDepth();
/*! return the current depth of the contents tree */
int contentsDepth() { return m_dc; }
void addContentsItem(bool isDir,
const char *name, const char *ref = 0,
const char *anchor = 0);
private:
FTVHelp();
QFile *m_cf;
QTextStream m_cts;
int m_dc;
static FTVHelp *m_theInstance;
};
#endif /* FTVHELP_H */
src/groupdef.cpp
View file @ a1995ea7
...@@ -30,6 +30,7 @@ ...@@ -30,6 +30,7 @@
#include "message.h" #include "message.h"
#include "membergroup.h" #include "membergroup.h"
#include "doxygen.h" #include "doxygen.h"
#include "page.h"
GroupDef::GroupDef(const char *df,int dl,const char *na,const char *t) : GroupDef::GroupDef(const char *df,int dl,const char *na,const char *t) :
Definition(df,dl,na) Definition(df,dl,na)
...@@ -38,7 +39,8 @@ GroupDef::GroupDef(const char *df,int dl,const char *na,const char *t) : ...@@ -38,7 +39,8 @@ GroupDef::GroupDef(const char *df,int dl,const char *na,const char *t) :
classList = new ClassList; classList = new ClassList;
groupList = new GroupList; groupList = new GroupList;
namespaceList = new NamespaceList; namespaceList = new NamespaceList;
pageDict = new PageSDict(257);
exampleDict = new PageSDict(257);
allMemberList = new MemberList; allMemberList = new MemberList;
allMemberDict = new QDict<MemberDef>; allMemberDict = new QDict<MemberDef>;
if (t) if (t)
...@@ -52,6 +54,8 @@ GroupDef::GroupDef(const char *df,int dl,const char *na,const char *t) : ...@@ -52,6 +54,8 @@ GroupDef::GroupDef(const char *df,int dl,const char *na,const char *t) :
memberGroupList = new MemberGroupList; memberGroupList = new MemberGroupList;
memberGroupList->setAutoDelete(TRUE); memberGroupList->setAutoDelete(TRUE);
memberGroupDict = new MemberGroupDict(1009); memberGroupDict = new MemberGroupDict(1009);
visited = 0;
} }
GroupDef::~GroupDef() GroupDef::~GroupDef()
...@@ -60,6 +64,8 @@ GroupDef::~GroupDef() ...@@ -60,6 +64,8 @@ GroupDef::~GroupDef()
delete classList; delete classList;
delete groupList; delete groupList;
delete namespaceList; delete namespaceList;
delete pageDict;
delete exampleDict;
delete allMemberList; delete allMemberList;
delete allMemberDict; delete allMemberDict;
delete memberGroupList; delete memberGroupList;
...@@ -100,6 +106,17 @@ void GroupDef::addNamespace(const NamespaceDef *def) ...@@ -100,6 +106,17 @@ void GroupDef::addNamespace(const NamespaceDef *def)
namespaceList->append(def); namespaceList->append(def);
} }
void GroupDef::addPage(PageInfo *def)
{
pageDict->append(def->name,def);
def->inGroup = this;
}
void GroupDef::addExample(const PageInfo *def)
{
exampleDict->append(def->name,def);
}
void GroupDef::addMemberListToGroup(MemberList *ml, void GroupDef::addMemberListToGroup(MemberList *ml,
bool (MemberDef::*func)() const) bool (MemberDef::*func)() const)
{ {
...@@ -214,7 +231,9 @@ int GroupDef::countMembers() const ...@@ -214,7 +231,9 @@ int GroupDef::countMembers() const
classList->count()+ classList->count()+
namespaceList->count()+ namespaceList->count()+
groupList->count()+ groupList->count()+
allMemberList->count(); allMemberList->count()+
pageDict->count()+
exampleDict->count();
} }
/*! Compute the HTML anchor names for all members in the class */ /*! Compute the HTML anchor names for all members in the class */
...@@ -249,6 +268,8 @@ void GroupDef::writeDocumentation(OutputList &ol) ...@@ -249,6 +268,8 @@ void GroupDef::writeDocumentation(OutputList &ol)
//ol.enable(OutputGenerator::Latex); //ol.enable(OutputGenerator::Latex);
ol.popGeneratorState(); ol.popGeneratorState();
} }
ol.startMemberSections(); ol.startMemberSections();
if (fileList->count()>0) if (fileList->count()>0)
{ {
...@@ -340,31 +361,59 @@ void GroupDef::writeDocumentation(OutputList &ol) ...@@ -340,31 +361,59 @@ void GroupDef::writeDocumentation(OutputList &ol)
allMemberList->writeDeclarations(ol,0,0,0,this,0,0); allMemberList->writeDeclarations(ol,0,0,0,this,0,0);
} }
ol.endMemberSections(); ol.endMemberSections();
//int dl=doc.length();
//doc=doc.stripWhiteSpace();
if (!briefDescription().isEmpty() || !documentation().isEmpty()) if (!briefDescription().isEmpty() || !documentation().isEmpty())
{ {
ol.writeRuler();
ol.pushGeneratorState(); if (pageDict->count()!=countMembers()) // classical layout
ol.disable(OutputGenerator::Latex);
ol.disable(OutputGenerator::RTF);
ol.writeAnchor(0,"_details");
ol.popGeneratorState();
ol.startGroupHeader();
parseText(ol,theTranslator->trDetailedDescription());
ol.endGroupHeader();
// repeat brief description
if (!briefDescription().isEmpty())
{ {
ol+=briefOutput; ol.writeRuler();
ol.newParagraph(); ol.pushGeneratorState();
ol.disable(OutputGenerator::Latex);
ol.disable(OutputGenerator::RTF);
ol.writeAnchor(0,"_details");
ol.popGeneratorState();
ol.startGroupHeader();
parseText(ol,theTranslator->trDetailedDescription());
ol.endGroupHeader();
// repeat brief description
if (!briefDescription().isEmpty() && Config::repeatBriefFlag)
{
ol+=briefOutput;
ol.newParagraph();
}
} }
// write documentation // write documentation
if (!documentation().isEmpty()) if (!documentation().isEmpty())
{ {
parseDoc(ol,defFileName,defLine,name(),0,documentation()+"\n"); parseDoc(ol,defFileName,defLine,name(),0,documentation()+"\n");
} }
} }
PageInfo *pi=0;
PageSDictIterator pdi(*pageDict);
for (pdi.toFirst();(pi=pdi.current());++pdi)
{
QCString pageName;
if (Config::caseSensitiveNames)
pageName=pi->name.copy();
else
pageName=pi->name.lower();
SectionInfo *si=0;
if (!pi->title.isEmpty() && !pi->name.isEmpty() &&
(si=sectionDict[pi->name])!=0)
{
ol.startSection(si->label,si->title,TRUE);
ol.docify(si->title);
ol.endSection(si->label,TRUE);
}
ol.startTextBlock();
parseDoc(ol,pi->defFileName,pi->defLine,0,0,pi->doc);
ol.endTextBlock();
}
defineMembers.countDocMembers(TRUE); defineMembers.countDocMembers(TRUE);
if (defineMembers.totalCount()>0 ) if (defineMembers.totalCount()>0 )
...@@ -507,3 +556,20 @@ void addMemberToGroups(Entry *root,MemberDef *md) ...@@ -507,3 +556,20 @@ void addMemberToGroups(Entry *root,MemberDef *md)
} }
} }
void addExampleToGroups(Entry *root,PageInfo *eg)
{
QListIterator<QCString> sli(*root->groups);
QCString *s;
for (;(s=sli.current());++sli)
{
GroupDef *gd=0;
if (!s->isEmpty() && (gd=groupDict[*s]))
{
gd->addExample(eg);
//printf("Example %s: in group %s\n",eg->name().data(),s->data());
}
}
}
src/groupdef.h
View file @ a1995ea7
...@@ -24,6 +24,7 @@ ...@@ -24,6 +24,7 @@
#include "definition.h" #include "definition.h"
#include "memberlist.h" #include "memberlist.h"
#include "memberdef.h" #include "memberdef.h"
#include "htmlhelp.h"
class FileList; class FileList;
class ClassList; class ClassList;
...@@ -35,6 +36,8 @@ class OutputList; ...@@ -35,6 +36,8 @@ class OutputList;
class NamespaceList; class NamespaceList;
class MemberGroupList; class MemberGroupList;
class MemberGroupDict; class MemberGroupDict;
class PageSDict;
class PageInfo;
class GroupDef : public Definition class GroupDef : public Definition
{ {
...@@ -48,6 +51,8 @@ class GroupDef : public Definition ...@@ -48,6 +51,8 @@ class GroupDef : public Definition
void addClass(const ClassDef *def); void addClass(const ClassDef *def);
void addNamespace(const NamespaceDef *def); void addNamespace(const NamespaceDef *def);
void addGroup(const GroupDef *def); void addGroup(const GroupDef *def);
void addPage(PageInfo *def); // pages in this group
void addExample(const PageInfo *def); // examples in this group
void insertMember(MemberDef *def); void insertMember(MemberDef *def);
void writeDocumentation(OutputList &ol); void writeDocumentation(OutputList &ol);
int countMembers() const; int countMembers() const;
...@@ -64,6 +69,10 @@ class GroupDef : public Definition ...@@ -64,6 +69,10 @@ class GroupDef : public Definition
void addMembersToMemberGroup(); void addMembersToMemberGroup();
void distributeMemberGroupDocumentation(); void distributeMemberGroupDocumentation();
bool visited; // number of times accessed for output - KPW
friend void writeGroupTreeNode(OutputList&, GroupDef*); // make accessible for writing tree view of group in index.cpp - KPW
protected: protected:
void addMemberListToGroup(MemberList *,bool (MemberDef::*)() const); void addMemberListToGroup(MemberList *,bool (MemberDef::*)() const);
...@@ -74,6 +83,8 @@ class GroupDef : public Definition ...@@ -74,6 +83,8 @@ class GroupDef : public Definition
ClassList *classList; // list of classes in the group ClassList *classList; // list of classes in the group
NamespaceList *namespaceList; // list of namespaces in the group NamespaceList *namespaceList; // list of namespaces in the group
GroupList *groupList; // list of sub groups. GroupList *groupList; // list of sub groups.
PageSDict *pageDict; // list of pages in the group
PageSDict *exampleDict; // list of examples in the group
MemberList *allMemberList; // list of all members in the group MemberList *allMemberList; // list of all members in the group
QDict<MemberDef> *allMemberDict; QDict<MemberDef> *allMemberDict;
...@@ -107,5 +118,8 @@ void addClassToGroups(Entry *root,ClassDef *cd); ...@@ -107,5 +118,8 @@ void addClassToGroups(Entry *root,ClassDef *cd);
void addNamespaceToGroups(Entry *root,NamespaceDef *nd); void addNamespaceToGroups(Entry *root,NamespaceDef *nd);
void addGroupToGroups(Entry *root,GroupDef *subGroup); void addGroupToGroups(Entry *root,GroupDef *subGroup);
void addMemberToGroups(Entry *root,MemberDef *md); void addMemberToGroups(Entry *root,MemberDef *md);
void addPageToGroups(Entry *root,PageInfo *pi);
void addExampleToGroups(Entry *root,PageInfo *eg);
#endif #endif
src/htmlgen.cpp
View file @ a1995ea7
...@@ -60,8 +60,6 @@ static const char *defaultStyleSheet = ...@@ -60,8 +60,6 @@ static const char *defaultStyleSheet =
"FONT.charliteral { color: #008080 }\n"; "FONT.charliteral { color: #008080 }\n";
HtmlHelp *HtmlGenerator::htmlHelp = 0;
HtmlGenerator::HtmlGenerator() : OutputGenerator() HtmlGenerator::HtmlGenerator() : OutputGenerator()
{ {
if (!Config::headerFile.isEmpty()) header=fileToString(Config::headerFile); if (!Config::headerFile.isEmpty()) header=fileToString(Config::headerFile);
......
src/htmlgen.h
View file @ a1995ea7
...@@ -22,7 +22,6 @@ ...@@ -22,7 +22,6 @@
#include "outputgen.h" #include "outputgen.h"
class QFile; class QFile;
class HtmlHelp;
class HtmlGenerator : public OutputGenerator class HtmlGenerator : public OutputGenerator
{ {
...@@ -249,7 +248,6 @@ class HtmlGenerator : public OutputGenerator ...@@ -249,7 +248,6 @@ class HtmlGenerator : public OutputGenerator
HtmlGenerator &operator=(const HtmlGenerator &g); HtmlGenerator &operator=(const HtmlGenerator &g);
HtmlGenerator(const HtmlGenerator &g); HtmlGenerator(const HtmlGenerator &g);
static HtmlHelp *htmlHelp;
int col; int col;
}; };
......
src/htmlhelp.cpp
View file @ a1995ea7
...@@ -267,7 +267,7 @@ void HtmlHelp::initialize() ...@@ -267,7 +267,7 @@ void HtmlHelp::initialize()
cts << "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML//EN\">\n" cts << "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML//EN\">\n"
"<HTML><HEAD></HEAD><BODY>\n" "<HTML><HEAD></HEAD><BODY>\n"
"<OBJECT type=\"text/site properties\">\n" "<OBJECT type=\"text/site properties\">\n"
"<param name=\"ImageType\" value=\"Folder\">\n" "<param name=\"FrameName\" value=\"right\">\n"
"</OBJECT>\n" "</OBJECT>\n"
"<UL>\n"; "<UL>\n";
...@@ -284,7 +284,7 @@ void HtmlHelp::initialize() ...@@ -284,7 +284,7 @@ void HtmlHelp::initialize()
kts << "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML//EN\">\n" kts << "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML//EN\">\n"
"<HTML><HEAD></HEAD><BODY>\n" "<HTML><HEAD></HEAD><BODY>\n"
"<OBJECT type=\"text/site properties\">\n" "<OBJECT type=\"text/site properties\">\n"
"<param name=\"ImageType\" value=\"Folder\">\n" "<param name=\"FrameName\" value=\"right\">\n"
"</OBJECT>\n" "</OBJECT>\n"
"<UL>\n"; "<UL>\n";
} }
...@@ -297,19 +297,21 @@ void HtmlHelp::createProjectFile() ...@@ -297,19 +297,21 @@ void HtmlHelp::createProjectFile()
if (f.open(IO_WriteOnly)) if (f.open(IO_WriteOnly))
{ {
QTextStream t(&f); QTextStream t(&f);
QCString indexName="index.html";
if (Config::ftvHelpFlag) indexName="main.html";
t << "[OPTIONS]\n" t << "[OPTIONS]\n"
"Compatibility=1.1\n" "Compatibility=1.1\n"
"Full-text search=Yes\n" "Full-text search=Yes\n"
"Contents file=index.hhc\n" "Contents file=index.hhc\n"
"Default Window=main\n" "Default Window=main\n"
"Default topic=index.html\n" "Default topic=" << indexName << "\n"
"Index file=index.hhk\n" "Index file=index.hhk\n"
"Title=" << Config::projectName << endl << endl; "Title=" << Config::projectName << endl << endl;
t << "[WINDOWS]" << endl; t << "[WINDOWS]" << endl;
t << "main=\"" << Config::projectName << "\",\"index.hhc\"," t << "main=\"" << Config::projectName << "\",\"index.hhc\","
"\"index.hhk\",\"index.html\",\"index.html\",,,,,0x23520,," "\"index.hhk\",\"" << indexName << "\",\"" <<
"0x3006,,,,,,,,0" << endl << endl; indexName << "\",,,,,0x23520,,0x3006,,,,,,,,0" << endl << endl;
t << "[FILES]" << endl; t << "[FILES]" << endl;
char *s = indexFiles.first(); char *s = indexFiles.first();
...@@ -380,19 +382,30 @@ int HtmlHelp::decContentsDepth() ...@@ -380,19 +382,30 @@ int HtmlHelp::decContentsDepth()
* \param name the name of the item. * \param name the name of the item.
* \param ref the URL of to the item. * \param ref the URL of to the item.
*/ */
void HtmlHelp::addContentsItem(const char *name,const char *ref, void HtmlHelp::addContentsItem(bool isDir,
const char *name,const char *ref,
const char *anchor) const char *anchor)
{ {
int i; for (i=0;i<dc;i++) cts << " "; int i; for (i=0;i<dc;i++) cts << " ";
cts << "<LI><OBJECT type=\"text/sitemap\">"; cts << "<LI><OBJECT type=\"text/sitemap\">";
if (ref) cts << "<param name=\"Name\" value=\"" << name << "\">";
if (ref) // made ref optional param - KPW
{ {
cts << "<param name=\"Local\" value=\"" << ref << ".html"; cts << "<param name=\"Local\" value=\"" << ref << ".html";
if (anchor) cts << "#" << anchor; if (anchor) cts << "#" << anchor;
cts << "\">"; cts << "\">";
} }
cts << "<param name=\"Name\" value=\"" << name << "\">" cts << "<param name=\"ImageNumber\" value=\"";
"</OBJECT>\n"; if (isDir) // added - KPW
{
cts << (int)BOOK_CLOSED ;
}
else
{
cts << (int)TEXT;
}
cts << "\">";
cts << "</OBJECT>\n";
} }
/*! Add an list item to the index file. /*! Add an list item to the index file.
...@@ -406,3 +419,4 @@ void HtmlHelp::addIndexItem(const char *level1, const char *level2, ...@@ -406,3 +419,4 @@ void HtmlHelp::addIndexItem(const char *level1, const char *level2,
index->addItem(level1,level2,ref,anchor,TRUE); index->addItem(level1,level2,ref,anchor,TRUE);
index->addItem(level2,level1,ref,anchor,FALSE); index->addItem(level2,level1,ref,anchor,FALSE);
} }
src/htmlhelp.h
View file @ a1995ea7
...@@ -34,6 +34,32 @@ class HtmlHelpIndex; ...@@ -34,6 +34,32 @@ class HtmlHelpIndex;
*/ */
class HtmlHelp class HtmlHelp
{ {
/*! used in imageNumber param of HTMLHelp::addContentsItem() function
to specify document icon in tree view.
Writes <param name="ImageNumber" value="xx"> in .HHC file. */
enum ImageNumber {
BOOK_CLOSED=1, BOOK_OPEN,
BOOK_CLOSED_NEW, BOOK_OPEN_NEW,
FOLDER_CLOSED, FOLDER_OPEN,
FOLDER_CLOSED_NEW,FOLDER_OPEN_NEW,
QUERY, QUERY_NEW,
TEXT, TEXT_NEW,
WEB_DOC, WEB_DOC_NEW,
WEB_LINK, WEB_LINK_NEW,
INFO, INFO_NEW,
LINK, LINK_NEW,
BOOKLET, BOOKLET_NEW,
EMAIL, EMAIL_NEW,
EMAIL2, EMAIL2_NEW,
IMAGE, IMAGE_NEW,
AUDIO, AUDIO_NEW,
MUSIC, MUSIC_NEW,
VIDEO, VIDEO_NEW,
INDEX, INDEX_NEW,
IDEA, IDEA_NEW,
NOTE, NOTE_NEW,
TOOL, TOOL_NEW
};
public: public:
static HtmlHelp *getInstance(); static HtmlHelp *getInstance();
void initialize(); void initialize();
...@@ -42,12 +68,16 @@ class HtmlHelp ...@@ -42,12 +68,16 @@ class HtmlHelp
int decContentsDepth(); int decContentsDepth();
/*! return the current depth of the contents tree */ /*! return the current depth of the contents tree */
int contentsDepth() { return dc; } int contentsDepth() { return dc; }
void addContentsItem(const char *name, const char *ref, // added imageNumber - KPW
void addContentsItem(bool isDir,
const char *name,
const char *ref = 0,
const char *anchor = 0); const char *anchor = 0);
void addIndexItem(const char *level1, const char *level2, void addIndexItem(const char *level1, const char *level2,
const char *ref, const char *anchor); const char *ref, const char *anchor);
void addIndexFile(const char *name); void addIndexFile(const char *name);
private: private:
void createProjectFile(); void createProjectFile();
...@@ -61,3 +91,4 @@ class HtmlHelp ...@@ -61,3 +91,4 @@ class HtmlHelp
}; };
#endif /* HTMLHELP_H */ #endif /* HTMLHELP_H */
src/index.cpp
View file @ a1995ea7
This diff is collapsed.
src/index.h
View file @ a1995ea7
...@@ -73,5 +73,6 @@ int countNamespaces(); ...@@ -73,5 +73,6 @@ int countNamespaces();
int countAnnotatedClasses(); int countAnnotatedClasses();
int countNamespaceMembers(); int countNamespaceMembers();
int countIncludeFiles(); int countIncludeFiles();
int countRelatedPages();
#endif #endif
src/latexgen.cpp
View file @ a1995ea7
...@@ -494,12 +494,9 @@ void LatexGenerator::startIndexSection(IndexSections is) ...@@ -494,12 +494,9 @@ void LatexGenerator::startIndexSection(IndexSections is)
bool found=FALSE; bool found=FALSE;
while (gd && !found) while (gd && !found)
{ {
if (gd->countMembers()>0) if (Config::compactLatexFlag) t << "\\section"; else t << "\\chapter";
{ t << "{"; //Module Documentation}\n";
if (Config::compactLatexFlag) t << "\\section"; else t << "\\chapter"; found=TRUE;
t << "{"; //Module Documentation}\n";
found=TRUE;
}
gd=groupList.next(); gd=groupList.next();
} }
} }
...@@ -619,20 +616,14 @@ void LatexGenerator::endIndexSection(IndexSections is) ...@@ -619,20 +616,14 @@ void LatexGenerator::endIndexSection(IndexSections is)
bool found=FALSE; bool found=FALSE;
while (gd && !found) while (gd && !found)
{ {
if (gd->countMembers()>0) t << "}\n\\input{" << gd->getOutputFileBase() << "}\n";
{ found=TRUE;
t << "}\n\\input{" << gd->getOutputFileBase() << "}\n";
found=TRUE;
}
gd=groupList.next(); gd=groupList.next();
} }
while (gd) while (gd)
{ {
if (gd->countMembers()>0) if (Config::compactLatexFlag) t << "\\input"; else t << "\\include";
{ t << "{" << gd->getOutputFileBase() << "}\n";
if (Config::compactLatexFlag) t << "\\input"; else t << "\\include";
t << "{" << gd->getOutputFileBase() << "}\n";
}
gd=groupList.next(); gd=groupList.next();
} }
} }
...@@ -734,24 +725,20 @@ void LatexGenerator::endIndexSection(IndexSections is) ...@@ -734,24 +725,20 @@ void LatexGenerator::endIndexSection(IndexSections is)
t << "}\n"; t << "}\n";
PageSDictIterator pdi(*pageSDict); PageSDictIterator pdi(*pageSDict);
PageInfo *pi=pdi.toFirst(); PageInfo *pi=pdi.toFirst();
if (pi) bool first=TRUE;
{ for (pdi.toFirst();(pi=pdi.current());++pdi)
QCString pageName;
if (Config::caseSensitiveNames)
pageName=pi->name.copy();
else
pageName=pi->name.lower();
t << "\\input{" << pageName << "}\n";
}
for (++pdi;(pi=pdi.current());++pdi)
{ {
if (Config::compactLatexFlag) t << "\\input" ; else t << "\\include"; if (!pi->inGroup)
QCString pageName; {
if (Config::caseSensitiveNames) QCString pageName;
pageName=pi->name.copy(); if (Config::caseSensitiveNames)
else pageName=pi->name.copy();
pageName=pi->name.lower(); else
t << "{" << pageName << "}\n"; pageName=pi->name.lower();
if (Config::compactLatexFlag || first) t << "\\input" ; else t << "\\include";
t << "{" << pageName << "}\n";
first=FALSE;
}
} }
} }
break; break;
......
src/page.h
View file @ a1995ea7
...@@ -22,7 +22,7 @@ class PageInfo ...@@ -22,7 +22,7 @@ class PageInfo
public: public:
PageInfo(const char *f, int l,const char *n,const char *d,const char *t) : PageInfo(const char *f, int l,const char *n,const char *d,const char *t) :
defFileName(f), defLine(l), name(n), defFileName(f), defLine(l), name(n),
doc(d), title(t), todoId(0), testId(0) {} doc(d), title(t), todoId(0), testId(0),inGroup(0) {}
// where the page definition was found // where the page definition was found
QCString defFileName; QCString defFileName;
...@@ -36,6 +36,9 @@ class PageInfo ...@@ -36,6 +36,9 @@ class PageInfo
// ids // ids
int todoId; int todoId;
int testId; int testId;
// is this page part of a group
GroupDef *inGroup;
}; };
class PageSDict : public SDict<PageInfo> class PageSDict : public SDict<PageInfo>
......
src/rtfgen.cpp
View file @ a1995ea7
...@@ -810,11 +810,8 @@ void RTFGenerator::startIndexSection(IndexSections is) ...@@ -810,11 +810,8 @@ void RTFGenerator::startIndexSection(IndexSections is)
bool found=FALSE; bool found=FALSE;
while (gd && !found) while (gd && !found)
{ {
if (gd->countMembers()>0) beginRTFChapter();
{ found=TRUE;
beginRTFChapter();
found=TRUE;
}
gd=groupList.next(); gd=groupList.next();
} }
} }
...@@ -965,31 +962,13 @@ void RTFGenerator::endIndexSection(IndexSections is) ...@@ -965,31 +962,13 @@ void RTFGenerator::endIndexSection(IndexSections is)
case isModuleDocumentation: case isModuleDocumentation:
{ {
GroupDef *gd=groupList.first(); GroupDef *gd=groupList.first();
bool found=FALSE;
t << "{\\tc \\v " << theTranslator->trModuleDocumentation() << "}"<< endl; t << "{\\tc \\v " << theTranslator->trModuleDocumentation() << "}"<< endl;
while (gd && !found)
{
if (gd->countMembers()>0)
{
t << "\\par " << Rtf_Style_Reset << endl;
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
t << gd->getOutputFileBase();
t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
found=TRUE;
}
gd=groupList.next();
}
while (gd) while (gd)
{ {
if (gd->countMembers()>0) t << "\\par " << Rtf_Style_Reset << endl;
{ t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
t << "\\par " << Rtf_Style_Reset << endl; t << gd->getOutputFileBase();
beginRTFSection(); t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
t << gd->getOutputFileBase();
t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
}
gd=groupList.next(); gd=groupList.next();
} }
} }
...@@ -1120,30 +1099,22 @@ void RTFGenerator::endIndexSection(IndexSections is) ...@@ -1120,30 +1099,22 @@ void RTFGenerator::endIndexSection(IndexSections is)
t << "{\\tc \\v " << theTranslator->trPageDocumentation() << "}"<< endl; t << "{\\tc \\v " << theTranslator->trPageDocumentation() << "}"<< endl;
PageSDictIterator pdi(*pageSDict); PageSDictIterator pdi(*pageSDict);
PageInfo *pi=pdi.toFirst(); PageInfo *pi=pdi.toFirst();
if (pi) bool first=TRUE;
for (pdi.toFirst();(pi=pdi.current());++pdi)
{ {
QCString pageName; if (!pi->inGroup)
if (Config::caseSensitiveNames) {
pageName=pi->name.copy(); QCString pageName;
else if (Config::caseSensitiveNames)
pageName=pi->name.lower(); pageName=pi->name.copy();
t << "\\par " << Rtf_Style_Reset << endl; else
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \""; pageName=pi->name.lower();
t << pageName; if (first) t << "\\par " << Rtf_Style_Reset << endl;
t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n"; t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
} t << pageName;
for (++pdi;(pi=pdi.current());++pdi) t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
{ first=FALSE;
QCString pageName; }
if (Config::caseSensitiveNames)
pageName=pi->name.copy();
else
pageName=pi->name.lower();
//t << "\\par " << Rtf_Style_Reset << endl;
//beginRTFSection();
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
t << pageName;
t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
} }
} }
break; break;
......
src/scanner.l
View file @ a1995ea7
...@@ -3000,6 +3000,11 @@ TITLE [tT][iI][tT][lL][eE] ...@@ -3000,6 +3000,11 @@ TITLE [tT][iI][tT][lL][eE]
} }
<ExampleDoc,PageDoc,ClassDoc>"\n" { yyLineNr++ ; current->doc+=yytext; } <ExampleDoc,PageDoc,ClassDoc>"\n" { yyLineNr++ ; current->doc+=yytext; }
<ExampleDoc,PageDoc,ClassDoc>[a-z_A-Z0-9 \t]+ { current->doc += yytext; } <ExampleDoc,PageDoc,ClassDoc>[a-z_A-Z0-9 \t]+ { current->doc += yytext; }
<ExampleDoc,PageDoc>{CMD}"ingroup"{B}+ {
lastGroupContext = YY_START;
lineCount();
BEGIN( GroupName );
}
<ExampleDoc,PageDoc,ClassDoc>. { current->doc += yytext; } <ExampleDoc,PageDoc,ClassDoc>. { current->doc += yytext; }
<Doc,JavaDoc,LineDoc,ExampleDoc,PageDoc,ClassDoc>^{B}*"//" <Doc,JavaDoc,LineDoc,ExampleDoc,PageDoc,ClassDoc>^{B}*"//"
<Doc,ExampleDoc,PageDoc,ClassDoc>"//" { current->doc += yytext; } <Doc,ExampleDoc,PageDoc,ClassDoc>"//" { current->doc += yytext; }
......
src/treeview.h 0 → 100644
View file @ a1995ea7
This diff is collapsed.
src/treeview.js 0 → 100644
View file @ a1995ea7
This diff is collapsed.
src/util.cpp
View file @ a1995ea7
...@@ -788,7 +788,14 @@ void writeQuickLinks(OutputList &ol,bool compact,bool ext) ...@@ -788,7 +788,14 @@ void writeQuickLinks(OutputList &ol,bool compact,bool ext)
if (compact) ol.startCenter(); else ol.startItemList(); if (compact) ol.startCenter(); else ol.startItemList();
if (!compact) ol.writeListItem(); if (!compact) ol.writeListItem();
ol.startQuickIndexItem(extLink,"index.html"); if (Config::ftvHelpFlag)
{
ol.startQuickIndexItem(extLink,"main.html");
}
else
{
ol.startQuickIndexItem(extLink,"index.html");
}
parseText(ol,theTranslator->trMainPage()); parseText(ol,theTranslator->trMainPage());
ol.endQuickIndexItem(); ol.endQuickIndexItem();
...@@ -869,7 +876,7 @@ void writeQuickLinks(OutputList &ol,bool compact,bool ext) ...@@ -869,7 +876,7 @@ void writeQuickLinks(OutputList &ol,bool compact,bool ext)
parseText(ol,theTranslator->trFileMembers()); parseText(ol,theTranslator->trFileMembers());
ol.endQuickIndexItem(); ol.endQuickIndexItem();
} }
if (pageSDict->count()>0) if (documentedPages>0)
{ {
if (!compact) ol.writeListItem(); if (!compact) ol.writeListItem();
ol.startQuickIndexItem(extLink,"pages.html"); ol.startQuickIndexItem(extLink,"pages.html");
...@@ -2433,8 +2440,19 @@ bool generateLink(OutputList &ol,const char *clName, ...@@ -2433,8 +2440,19 @@ bool generateLink(OutputList &ol,const char *clName,
} }
else if ((pi=pageSDict->find(linkRef))) // link to a page else if ((pi=pageSDict->find(linkRef))) // link to a page
{ {
ol.writeObjectLink(0,pi->name,0,lt); GroupDef *gd = pi->inGroup;
writePageRef(ol,pi->name,0); if (gd)
{
SectionInfo *si=0;
if (!pi->name.isEmpty()) si=sectionDict[pi->name];
ol.writeObjectLink(0,gd->getOutputFileBase(),si ? si->label.data() : 0,lt);
writePageRef(ol,gd->getOutputFileBase(),si ? si->label.data() : 0);
}
else
{
ol.writeObjectLink(0,pi->name,0,lt);
writePageRef(ol,pi->name,0);
}
return TRUE; return TRUE;
} }
else if ((pi=exampleSDict->find(linkRef))) // link to an example else if ((pi=exampleSDict->find(linkRef))) // link to an example
...@@ -2754,7 +2772,28 @@ QCString convertNameToFile(const char *name,bool allowDots) ...@@ -2754,7 +2772,28 @@ QCString convertNameToFile(const char *name,bool allowDots)
break; break;
} }
} }
//printf("convertNameToFile(%s)=`%s'\n",name,result.data()); return result;
}
/*! Converts a string to HTML-encoded string */
QCString convertToHtml(const QCString &s)
{
QCString result;
char c;
const char *p=s.data();
while ((c=*p++)!=0)
{
switch(c)
{
case '<': result+="&lt;"; break;
case '>': result+="&gt;"; break;
case '&': result+="&amp;"; break;
case '"': result+="&quot;"; break;
default:
result+=c;
break;
}
}
return result; return result;
} }
...@@ -2837,3 +2876,4 @@ QCString stripScope(const char *name) ...@@ -2837,3 +2876,4 @@ QCString stripScope(const char *name)
} }
return result; return result;
} }
src/util.h
View file @ a1995ea7
...@@ -144,6 +144,7 @@ void initClassHierarchy(ClassList *cl); ...@@ -144,6 +144,7 @@ void initClassHierarchy(ClassList *cl);
bool hasVisibleRoot(BaseClassList *bcl); bool hasVisibleRoot(BaseClassList *bcl);
int minClassDistance(ClassDef *cd,ClassDef *bcd,int level=0); int minClassDistance(ClassDef *cd,ClassDef *bcd,int level=0);
QCString convertNameToFile(const char *name,bool allowDots=FALSE); QCString convertNameToFile(const char *name,bool allowDots=FALSE);
QCString convertToHtml(const QCString &s);
void extractNamespaceName(const QCString &scopeName, void extractNamespaceName(const QCString &scopeName,
QCString &className,QCString &namespaceName); QCString &className,QCString &namespaceName);
QCString insertTemplateSpecifierInScope(const QCString &scope,const QCString &templ); QCString insertTemplateSpecifierInScope(const QCString &scope,const QCString &templ);
...@@ -151,3 +152,4 @@ QCString stripScope(const char *name); ...@@ -151,3 +152,4 @@ QCString stripScope(const char *name);
int iSystem(const char *command); int iSystem(const char *command);
#endif #endif
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment