Commit dae59054 authored by Dimitri van Heesch's avatar Dimitri van Heesch

Release-1.3.1-20030609

parent 0c394c58
DOXYGEN Version 1.3.1-20030607 DOXYGEN Version 1.3.1-20030609
Please read the installation section of the manual Please read the installation section of the manual
(http://www.doxygen.org/install.html) for instructions. (http://www.doxygen.org/install.html) for instructions.
-------- --------
Dimitri van Heesch (07 June 2003) Dimitri van Heesch (09 June 2003)
DOXYGEN Version 1.3.1_20030607 DOXYGEN Version 1.3.1_20030609
Please read INSTALL for compilation instructions. Please read INSTALL for compilation instructions.
...@@ -17,4 +17,4 @@ to subscribe to the lists or to visit the archives. ...@@ -17,4 +17,4 @@ to subscribe to the lists or to visit the archives.
Enjoy, Enjoy,
Dimitri van Heesch (dimitri@stack.nl) (07 June 2003) Dimitri van Heesch (dimitri@stack.nl) (09 June 2003)
1.3.1-20030607 1.3.1-20030609
...@@ -406,7 +406,8 @@ doxygen. Unrecognized commands are treated as normal text. ...@@ -406,7 +406,8 @@ doxygen. Unrecognized commands are treated as normal text.
the first chapter (in \f$\mbox{\LaTeX}\f$). the first chapter (in \f$\mbox{\LaTeX}\f$).
The title argument is optional and replaces the default title that The title argument is optional and replaces the default title that
doxygen normally generates. doxygen normally generates. If you do not want any title you can
specify \c notitle as the argument of \\mainpage.
Here is an example: Here is an example:
\verbatim \verbatim
......
...@@ -21,7 +21,7 @@ ...@@ -21,7 +21,7 @@
<li>Requires very little overhead from the writer of the documentation. <li>Requires very little overhead from the writer of the documentation.
Plain text will do, but for more fancy or structured output HTML tags Plain text will do, but for more fancy or structured output HTML tags
and/or some of doxygen's special commands can be used. and/or some of doxygen's special commands can be used.
<li>Supports C/C++, Java, (Corba, Microsoft, and KDE-DCOP) Java, <li>Supports C/C++, Java, (Corba and Microsoft) Java,
IDL, and to some extent C# and PHP sources. IDL, and to some extent C# and PHP sources.
<li>Supports documentation of files, namespaces, classes, structs, unions, <li>Supports documentation of files, namespaces, classes, structs, unions,
templates, variables, functions, typedefs, enums and defines. templates, variables, functions, typedefs, enums and defines.
......
...@@ -27,7 +27,7 @@ Version: $(VERSION) ...@@ -27,7 +27,7 @@ Version: $(VERSION)
<h2>Introduction</h2> <h2>Introduction</h2>
Doxygen is a documentation system for C++, C, Java, IDL Doxygen is a documentation system for C++, C, Java, IDL
(Corba, Microsoft, and KDE-DCOP flavors) and to some extent PHP and C#. (Corba and Microsoft flavors) and to some extent PHP and C#.
It can help you in three ways: It can help you in three ways:
<ol> <ol>
......
...@@ -25,7 +25,7 @@ Doxygen has built-in support for multiple languages. This means ...@@ -25,7 +25,7 @@ Doxygen has built-in support for multiple languages. This means
that the text fragments that doxygen generates can be produced in that the text fragments that doxygen generates can be produced in
languages other than English (the default) at configuration time. languages other than English (the default) at configuration time.
Currently (version 1.3.1), 28 languages Currently (version 1.3-20030430), 28 languages
are supported (sorted alphabetically): are supported (sorted alphabetically):
Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian, Brazilian Portuguese, Catalan, Chinese, Chinese Traditional, Croatian,
Czech, Danish, Dutch, English, Finnish, Czech, Danish, Dutch, English, Finnish,
......
Summary: A documentation system for C/C++. Summary: A documentation system for C/C++.
Name: doxygen Name: doxygen
Version: 1.3.1_20030607 Version: 1.3.1_20030609
Release: 1 Release: 1
Epoch: 1 Epoch: 1
Source0: ftp://ftp.stack.nl/pub/users/dimitri/%{name}-%{version}.src.tar.gz Source0: ftp://ftp.stack.nl/pub/users/dimitri/%{name}-%{version}.src.tar.gz
......
...@@ -126,7 +126,7 @@ void Definition::writeDocAnchorsToTagFile() ...@@ -126,7 +126,7 @@ void Definition::writeDocAnchorsToTagFile()
void Definition::setDocumentation(const char *d,const char *docFile,int docLine,bool stripWhiteSpace) void Definition::setDocumentation(const char *d,const char *docFile,int docLine,bool stripWhiteSpace)
{ {
if (d==0) return; if (d==0) return;
//printf("Definition::setDocumentation(%s,%s,%d)\n",d,docFile,docLine); //printf("Definition::setDocumentation(%s,%s,%d,%d)\n",d,docFile,docLine,stripWhiteSpace);
if (stripWhiteSpace) if (stripWhiteSpace)
{ {
// strip leading empty lines in front of the text, but not the // strip leading empty lines in front of the text, but not the
...@@ -141,6 +141,7 @@ void Definition::setDocumentation(const char *d,const char *docFile,int docLine, ...@@ -141,6 +141,7 @@ void Definition::setDocumentation(const char *d,const char *docFile,int docLine,
p++; p++;
s++; s++;
} }
if (c=='\0') return;
m_doc=d+so; m_doc=d+so;
// zero any trailing whitespace // zero any trailing whitespace
int e=m_doc.length()-1; int e=m_doc.length()-1;
...@@ -150,8 +151,11 @@ void Definition::setDocumentation(const char *d,const char *docFile,int docLine, ...@@ -150,8 +151,11 @@ void Definition::setDocumentation(const char *d,const char *docFile,int docLine,
e--; e--;
} }
} }
else else // don't strip whitespace
{
m_doc=d; m_doc=d;
}
//printf("setting docs for %s: `%s'\n",name().data(),m_doc.data());
m_docFile = docFile; m_docFile = docFile;
m_docLine = docLine; m_docLine = docLine;
} }
......
...@@ -47,8 +47,26 @@ static const char *defaultStyleSheet = ...@@ -47,8 +47,26 @@ static const char *defaultStyleSheet =
" font-family: Geneva, Arial, Helvetica, sans-serif;\n" " font-family: Geneva, Arial, Helvetica, sans-serif;\n"
"}\n" "}\n"
"CAPTION { font-weight: bold }\n" "CAPTION { font-weight: bold }\n"
"A.qindex {}\n" "DIV.qindex { width: 100%;\n"
"A.qindexRef {}\n" " background-color: #ddddee;\n"
" border: 4px solid #ddddee;\n"
" text-align: center;\n"
" margin-bottom: 2px\n"
"}\n"
"A.qindex { text-decoration: none; font-weight: bold; }\n"
"A.qindex:hover { text-decoration: none; background-color: #ccccee }\n"
"A.qindexHL { text-decoration: none; font-weight: bold;\n"
" background-color: #6666cc;\n"
" color: #ffffff\n"
" }\n"
"A.qindexHL:hover { text-decoration: none; background-color: #6666cc }\n"
"A.qindexRef { text-decoration: none; font-weight: bold; }\n"
"A.qindexRef:hover { text-decoration: none; background-color: #ccccee }\n"
"A.qindexRefHL { text-decoration: none; font-weight: bold;\n"
" background-color: #6666cc;\n"
" color: #ffffff\n"
" }\n"
"A.qindexRefHL:hover { text-decoration: none; background-color: #6666cc }\n"
"A.el { text-decoration: none; font-weight: bold }\n" "A.el { text-decoration: none; font-weight: bold }\n"
"A.elRef { font-weight: bold }\n" "A.elRef { font-weight: bold }\n"
"A.code { text-decoration: none; font-weight: normal; color: #4444ee }\n" "A.code { text-decoration: none; font-weight: normal; color: #4444ee }\n"
......
This diff is collapsed.
...@@ -69,25 +69,44 @@ void writePackageIndex(OutputList &ol); ...@@ -69,25 +69,44 @@ void writePackageIndex(OutputList &ol);
void countDataStructures(); void countDataStructures();
#if 0
extern int annotatedClasses; extern int annotatedClasses;
extern int hierarchyClasses; extern int hierarchyClasses;
extern int documentedFunctions; extern int documentedFunctions;
extern int documentedMembers; extern int documentedMembers;
extern int documentedDefines; extern int documentedDefines;
extern int documentedFiles; extern int documentedFiles;
extern int documentedHtmlFiles;
extern int documentedGroups; 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 int indexedPages; extern int indexedPages;
//extern int documentedPackages; #endif
extern int documentedHtmlFiles;
extern int documentedPages;
enum HighlightedItem
{
HLI_None=0,
HLI_Main,
HLI_Modules,
HLI_Namespaces,
HLI_Hierarchy,
HLI_Classes,
HLI_Annotated,
HLI_Files,
HLI_NamespaceMembers,
HLI_Functions,
HLI_Globals,
HLI_Pages,
HLI_Examples,
HLI_Search
};
void startTitle(OutputList &ol,const char *fileName); void startTitle(OutputList &ol,const char *fileName);
void endTitle(OutputList &ol,const char *fileName,const char *name); void endTitle(OutputList &ol,const char *fileName,const char *name);
void startFile(OutputList &ol,const char *name,const char *manName, void startFile(OutputList &ol,const char *name,const char *manName,
const char *title,bool external=FALSE); const char *title,bool external=FALSE,HighlightedItem hli=HLI_None);
void endFile(OutputList &ol,bool external=FALSE); void endFile(OutputList &ol,bool external=FALSE);
#endif #endif
...@@ -1581,7 +1581,7 @@ void MemberDef::writeDocumentation(MemberList *ml,OutputList &ol, ...@@ -1581,7 +1581,7 @@ void MemberDef::writeDocumentation(MemberList *ml,OutputList &ol,
ol.disable(OutputGenerator::Man); ol.disable(OutputGenerator::Man);
ol.newParagraph(); ol.newParagraph();
ol.startCallGraph(); ol.startCallGraph();
//ol.parseText(theTranslator->trCallGraph()); ol.parseText(theTranslator->trCallGraph());
ol.endCallGraph(callGraph); ol.endCallGraph(callGraph);
ol.enableAll(); ol.enableAll();
} }
......
...@@ -492,7 +492,7 @@ static int yyread(char *buf,int max_size) ...@@ -492,7 +492,7 @@ static int yyread(char *buf,int max_size)
/* start command character */ /* start command character */
CMD ("\\"|"@") CMD ("\\"|"@")
SECTIONCMD {CMD}("image"|"author"|"internal"|"version"|"date"|"deprecated"|"param"|"exception"|"return"[s]?|"retval"|"bug"|"warning"|"par"|"sa"|"see"|"pre"|"post"|"invariant"|"note"|"remark"[s]?|"todo"|"test"|"xrefitem"|"ingroup"|"callgraph"|"latexonly"|"htmlonly"|"xmlonly"|"{"|"verbatim"|"dotfile"|"defgroup"|"addtogroup"|"weakgroup"|"class"|"namespace"|"union"|"struct"|"fn"|"var"|"typedef"|"def"|"overload")|("<"{PRE}">") SECTIONCMD {CMD}("image"|"author"|"internal"|"version"|"date"|"deprecated"|"param"|"exception"|"return"[s]?|"retval"|"bug"|"warning"|"par"|"sa"|"see"|"pre"|"post"|"invariant"|"note"|"remark"[s]?|"todo"|"test"|"xrefitem"|"ingroup"|"callgraph"|"latexonly"|"htmlonly"|"xmlonly"|"{"|"verbatim"|"dotfile"|"defgroup"|"addtogroup"|"weakgroup"|"class"|"namespace"|"union"|"struct"|"fn"|"var"|"details"|"typedef"|"def"|"overload")|("<"{PRE}">")
BN [ \t\n\r] BN [ \t\n\r]
BL [ \t\r]*"\n" BL [ \t\r]*"\n"
B [ \t] B [ \t]
...@@ -3448,6 +3448,8 @@ PHPKW ("require"|"require_once"|"include"|"include_once"|"echo")[^a-zA-Z0-9_;] ...@@ -3448,6 +3448,8 @@ PHPKW ("require"|"require_once"|"include"|"include_once"|"echo")[^a-zA-Z0-9_;]
current->startLine = yyLineNr; current->startLine = yyLineNr;
BEGIN( ExampleDocArg1 ); BEGIN( ExampleDocArg1 );
} }
<Doc>{B}*{CMD}"details"{B}+ { /* nop */
}
<LineDoc>{CMD}"name"[^\n]*\n { <LineDoc>{CMD}"name"[^\n]*\n {
lastDefGroup.groupname.resize(0); lastDefGroup.groupname.resize(0);
memberGroupHeader=&yytext[5]; memberGroupHeader=&yytext[5];
...@@ -4139,6 +4141,7 @@ PHPKW ("require"|"require_once"|"include"|"include_once"|"echo")[^a-zA-Z0-9_;] ...@@ -4139,6 +4141,7 @@ PHPKW ("require"|"require_once"|"include"|"include_once"|"echo")[^a-zA-Z0-9_;]
else if (YY_START==ClassDocBrief && else if (YY_START==ClassDocBrief &&
lastBriefContext==Doc) lastBriefContext==Doc)
{ {
//printf("Add docs %s\n",current->doc.data());
current->doc += "\n\n"; current->doc += "\n\n";
BEGIN( lastDocContext ); BEGIN( lastDocContext );
} }
...@@ -4150,7 +4153,7 @@ PHPKW ("require"|"require_once"|"include"|"include_once"|"echo")[^a-zA-Z0-9_;] ...@@ -4150,7 +4153,7 @@ PHPKW ("require"|"require_once"|"include"|"include_once"|"echo")[^a-zA-Z0-9_;]
else else
{ {
current->doc += "\n\n"; current->doc += "\n\n";
//printf("Add docs for class %s\n",current->name.data()); //printf("Add docs for %s\n",current->name.data());
current_root->addSubEntry(current); current_root->addSubEntry(current);
current = new Entry ; current = new Entry ;
initEntry(); initEntry();
...@@ -4379,7 +4382,7 @@ PHPKW ("require"|"require_once"|"include"|"include_once"|"echo")[^a-zA-Z0-9_;] ...@@ -4379,7 +4382,7 @@ PHPKW ("require"|"require_once"|"include"|"include_once"|"echo")[^a-zA-Z0-9_;]
else else
{ {
current->brief += "\n"; current->brief += "\n";
if (!current->doc.isEmpty()) if (!current->doc.stripWhiteSpace().isEmpty())
{ {
current->doc += "<p>"; current->doc += "<p>";
} }
......
...@@ -400,6 +400,13 @@ class Translator ...@@ -400,6 +400,13 @@ class Translator
virtual QCString trPackageAttribs() = 0; virtual QCString trPackageAttribs() = 0;
virtual QCString trStaticPackageAttribs() = 0; virtual QCString trStaticPackageAttribs() = 0;
//////////////////////////////////////////////////////////////////////////
// new since 1.3.1
//////////////////////////////////////////////////////////////////////////
virtual QCString trAll() = 0;
virtual QCString trCallGraph() = 0;
}; };
#endif #endif
...@@ -40,7 +40,19 @@ class TranslatorAdapterBase : public Translator ...@@ -40,7 +40,19 @@ class TranslatorAdapterBase : public Translator
}; };
class TranslatorAdapter_1_3 : public TranslatorAdapterBase class TranslatorAdapter_1_3_1 : public TranslatorAdapterBase
{
public:
virtual QCString updateNeededMessage()
{ return createUpdateNeededMessage(idLanguage(),"release 1.3.1"); }
virtual QCString trAll()
{ return english.trAll(); }
virtual QCString trCallGraph()
{ return english.trCallGraph(); }
};
class TranslatorAdapter_1_3 : public TranslatorAdapter_1_3_1
{ {
public: public:
virtual QCString updateNeededMessage() virtual QCString updateNeededMessage()
...@@ -58,7 +70,6 @@ class TranslatorAdapter_1_3 : public TranslatorAdapterBase ...@@ -58,7 +70,6 @@ class TranslatorAdapter_1_3 : public TranslatorAdapterBase
{ return english.trStaticPackageAttribs(); } { return english.trStaticPackageAttribs(); }
}; };
class TranslatorAdapter_1_2_18 : public TranslatorAdapter_1_3 class TranslatorAdapter_1_2_18 : public TranslatorAdapter_1_3
{ {
public: public:
......
...@@ -27,7 +27,7 @@ ...@@ -27,7 +27,7 @@
#ifndef TRANSLATOR_BR_H #ifndef TRANSLATOR_BR_H
#define TRANSLATOR_BR_H #define TRANSLATOR_BR_H
class TranslatorBrazilian: public Translator class TranslatorBrazilian: public TranslatorAdapter_1_3_1
{ {
public: public:
......
...@@ -168,7 +168,7 @@ ...@@ -168,7 +168,7 @@
// Windows version. The version which does not call the function is // Windows version. The version which does not call the function is
// probably slightly faster. // probably slightly faster.
class TranslatorCzech : public Translator class TranslatorCzech : public TranslatorAdapter_1_3_1
{ {
private: private:
/*! The decode() inline assumes the source written in the /*! The decode() inline assumes the source written in the
......
...@@ -83,7 +83,7 @@ ...@@ -83,7 +83,7 @@
#ifndef TRANSLATOR_DE_H #ifndef TRANSLATOR_DE_H
#define TRANSLATOR_DE_H #define TRANSLATOR_DE_H
class TranslatorGerman : public Translator class TranslatorGerman : public TranslatorAdapter_1_3_1
{ {
public: public:
......
...@@ -1472,6 +1472,23 @@ class TranslatorEnglish : public Translator ...@@ -1472,6 +1472,23 @@ class TranslatorEnglish : public Translator
return "Static Package Attributes"; return "Static Package Attributes";
} }
//////////////////////////////////////////////////////////////////////////
// new since 1.3.1
//////////////////////////////////////////////////////////////////////////
/*! Used in the quick index of a class/file/namespace member list page
* to link to the unfiltered list of all members.
*/
virtual QCString trAll()
{
return "All";
}
/*! Put in front of the call graph for a function. */
virtual QCString trCallGraph()
{
return "Here is the call graph for this function:";
}
}; };
......
...@@ -49,7 +49,7 @@ ...@@ -49,7 +49,7 @@
#ifndef TRANSLATOR_FR_H #ifndef TRANSLATOR_FR_H
#define TRANSLATOR_FR_H #define TRANSLATOR_FR_H
class TranslatorFrench : public Translator class TranslatorFrench : public TranslatorAdapter_1_3_1
{ {
public: public:
QCString idLanguage() QCString idLanguage()
......
...@@ -56,7 +56,7 @@ ...@@ -56,7 +56,7 @@
#ifndef TRANSLATOR_HR_H #ifndef TRANSLATOR_HR_H
#define TRANSLATOR_HR_H #define TRANSLATOR_HR_H
class TranslatorCroatian : public Translator class TranslatorCroatian : public TranslatorAdapter_1_3_1
{ {
private: private:
/*! to avoid macro redefinition from translator_cz.h */ /*! to avoid macro redefinition from translator_cz.h */
......
...@@ -68,7 +68,7 @@ ...@@ -68,7 +68,7 @@
#ifndef TRANSLATOR_IT_H #ifndef TRANSLATOR_IT_H
#define TRANSLATOR_IT_H #define TRANSLATOR_IT_H
class TranslatorItalian : public Translator class TranslatorItalian : public TranslatorAdapter_1_3_1
{ {
public: public:
......
...@@ -1068,6 +1068,23 @@ class TranslatorDutch : public Translator ...@@ -1068,6 +1068,23 @@ class TranslatorDutch : public Translator
{ {
return "Statische Package Attributen"; return "Statische Package Attributen";
} }
//////////////////////////////////////////////////////////////////////////
// new since 1.3.1
//////////////////////////////////////////////////////////////////////////
/*! Used in the quick index of a class/file/namespace member list page
* to link to the unfiltered list of all members.
*/
virtual QCString trAll()
{
return "Alle";
}
/*! Put in front of the call graph for a function. */
virtual QCString trCallGraph()
{
return "Hier is de call graaf voor deze functie:";
}
}; };
......
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