From 0d0eec1df129221379625a52e5fe8ff6f21f104c Mon Sep 17 00:00:00 2001 From: Dimitri van Heesch Date: Sun, 1 Oct 2000 17:23:42 +0000 Subject: Release-1.2.2-20001001 --- INSTALL | 4 +- README | 4 +- VERSION | 2 +- addon/configgen/configgen.cpp | 30 +- doc/autolink.doc | 6 +- doc/config.doc | 10 +- doc/docblocks.doc | 31 +- examples/afterdoc.cfg | 17 +- examples/author.cfg | 1 + examples/autolink.cfg | 1 + examples/class.cfg | 1 + examples/define.cfg | 1 + examples/diagrams.cfg | 1 + examples/enum.cfg | 1 + examples/example.cfg | 1 + examples/file.cfg | 1 + examples/func.cfg | 1 + examples/group.cfg | 1 + examples/include.cfg | 1 + examples/jdstyle.cfg | 17 +- examples/memgrp.cfg | 18 +- examples/memgrp.cpp | 3 +- examples/overload.cfg | 1 + examples/page.cfg | 1 + examples/par.cfg | 1 + examples/qtstyle.cfg | 1 + examples/relates.cfg | 1 + examples/restypedef.cfg | 1 + examples/structcmd.cfg | 1 + examples/tag.cfg | 1 + examples/templ.cfg | 1 + packages/rpm/doxygen.spec | 2 +- src/classdef.cpp | 11 +- src/classdef.h | 1 + src/config.h | 4 +- src/config.l | 17 +- src/definition.h | 25 +- src/doc.l | 5 + src/doxygen.cpp | 31 +- src/doxygen.pro.in | 2 +- src/entry.cpp | 3 + src/entry.h | 7 +- src/filedef.h | 1 + src/groupdef.cpp | 22 +- src/groupdef.h | 1 + src/htmlgen.cpp | 6 + src/htmlhelp.cpp | 31 +- src/htmlhelp.h | 6 + src/language.cpp | 5 + src/memberdef.cpp | 40 +-- src/memberdef.h | 4 + src/memberlist.cpp | 38 ++- src/memberlist.h | 2 +- src/namespacedef.h | 1 + src/page.h | 7 +- src/rtfgen.cpp | 10 +- src/scanner.l | 116 ++++---- src/translator_si.h | 671 ++++++++++++++++++++++++++++++++++++++++++ src/util.cpp | 11 +- 59 files changed, 1030 insertions(+), 212 deletions(-) create mode 100644 src/translator_si.h diff --git a/INSTALL b/INSTALL index 6eee5a4..fcc29d6 100644 --- a/INSTALL +++ b/INSTALL @@ -1,6 +1,6 @@ -DOXYGEN Version 1.2.2 +DOXYGEN Version 1.2.2-20001001 Please read the installation section of the manual for instructions. -------- -Dimitri van Heesch (24 September 2000) +Dimitri van Heesch (01 October 2000) diff --git a/README b/README index 6c6b1a3..94dbeff 100644 --- a/README +++ b/README @@ -1,4 +1,4 @@ -DOXYGEN Version 1.2.2 +DOXYGEN Version 1.2.2-20001001 Please read INSTALL for compilation instructions. @@ -7,4 +7,4 @@ The latest version of doxygen can be obtained at Enjoy, -Dimitri van Heesch (24 September 2000) +Dimitri van Heesch (01 October 2000) diff --git a/VERSION b/VERSION index 23aa839..906cfeb 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.2.2 +1.2.2-20001001 diff --git a/addon/configgen/configgen.cpp b/addon/configgen/configgen.cpp index 0a6f2ad..7a11fc0 100644 --- a/addon/configgen/configgen.cpp +++ b/addon/configgen/configgen.cpp @@ -775,26 +775,27 @@ void init() "information to generate all constant output in the proper language. \n" "The default language is English, other supported languages are: \n" "Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese, \n" - "Korean, Hungarian, Spanish, Romanian, Russian, Croatian, Polish, and \n" - "Portuguese.\n" + "Korean, Hungarian, Spanish, Romanian, Russian, Croatian, Polish, \n" + "Portuguese and Slovene.\n" ); - ConfigString::addFixedValue("outputLanguage","English"); + ConfigString::addFixedValue("outputLanguage","Croatian"); + ConfigString::addFixedValue("outputLanguage","Czech"); ConfigString::addFixedValue("outputLanguage","Dutch"); + ConfigString::addFixedValue("outputLanguage","English"); ConfigString::addFixedValue("outputLanguage","French"); - ConfigString::addFixedValue("outputLanguage","Italian"); - ConfigString::addFixedValue("outputLanguage","Czech"); - ConfigString::addFixedValue("outputLanguage","Swedish"); - ConfigString::addFixedValue("outputLanguage","German"); ConfigString::addFixedValue("outputLanguage","Finnish"); + ConfigString::addFixedValue("outputLanguage","German"); ConfigString::addFixedValue("outputLanguage","Hungarian"); + ConfigString::addFixedValue("outputLanguage","Italian"); ConfigString::addFixedValue("outputLanguage","Japanese"); ConfigString::addFixedValue("outputLanguage","Korean"); - ConfigString::addFixedValue("outputLanguage","Spanish"); ConfigString::addFixedValue("outputLanguage","Romanian"); ConfigString::addFixedValue("outputLanguage","Russian"); - ConfigString::addFixedValue("outputLanguage","Croatian"); ConfigString::addFixedValue("outputLanguage","Polish"); ConfigString::addFixedValue("outputLanguage","Portuguese"); + ConfigString::addFixedValue("outputLanguage","Slovene"); + ConfigString::addFixedValue("outputLanguage","Spanish"); + ConfigString::addFixedValue("outputLanguage","Swedish"); ConfigBool::add( "extractAllFlag", "EXTRACT_ALL", "FALSE", @@ -956,12 +957,13 @@ void init() ); ConfigBool::add( "autoBriefFlag", "JAVADOC_AUTOBRIEF", - "TRUE", - "javadoc comments behaves as Qt comments.", - "If the JAVADOC_AUTOBRIEF tag is set to YES (the default) then Doxygen \n" + "FALSE", + "should javadoc comments behaves as Qt comments.", + "If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen \n" "will interpret the first line (until the first dot) of a JavaDoc-style \n" - "comment as the brief description. If set to NO, the Javadoc-style will \n" - "behave just like the Qt-style comments. \n" + "comment as the brief description. If set to NO, the JavaDoc \n" + "comments will behave just like the Qt-style comments (thus requiring an \n" + "explict @brief command for a brief description. \n" ); ConfigBool::add( "inheritDocsFlag", "INHERIT_DOCS", diff --git a/doc/autolink.doc b/doc/autolink.doc index 50214a7..2c18ee1 100644 --- a/doc/autolink.doc +++ b/doc/autolink.doc @@ -69,6 +69,10 @@ \par Note 2: For JavaDoc compatibility a \# may be used instead of a :: in the patterns above. + \par Note 3: + In the documentation of a class containing a member foo, + a reference to a global variable is made using ::foo, whereas \#foo + will link to the member. For non overloaded members the argument list may be omitted. @@ -111,7 +115,7 @@ typedef struct StructName TypeName \par Example: \verbinclude restypedef.cpp \htmlonly - Click here + Click here for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly */ diff --git a/doc/config.doc b/doc/config.doc index 87488a5..9b92688 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -47,10 +47,10 @@ file using a \@INCLUDE tag as follows: \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 \@INCLUDEPATH tag +in the current working directory. Do this by putting a \@INCLUDE_PATH tag with these paths before the \@INCLUDE tag, e.g: \verbatim -@INCLUDEPATH = my_config_dir +@INCLUDE_PATH = my_config_dir \endverbatim The configuration options can be divided into several categories. @@ -370,10 +370,10 @@ followed by the descriptions of the tags grouped by category. \anchor cfg_javadoc_autobrief
\c JAVADOC_AUTOBRIEF
\addindex JAVADOC_AUTOBRIEF - If the \c JAVADOC_AUTOBRIEF is set to \c YES (the default) then Doxygen + If the \c JAVADOC_AUTOBRIEF 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 NO, the Javadoc-style will - behave just like the Qt-style comments. + comment as the brief description. If set to NO (the default), the + Javadoc-style will behave just like the Qt-style comments. \anchor cfg_inherit_docs
\c INHERIT_DOCS
diff --git a/doc/docblocks.doc b/doc/docblocks.doc index 3ac2789..7500eb5 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -66,34 +66,33 @@ sentence of the detailed description to \c NO). Both the brief and the detailed descriptions are optional for the Qt style. -Here is the same piece of code, this time documented using the JavaDoc -style: +By default a JavaDoc style documentation block behaves the same way as a +Qt style documentation block. This is not according the JavaDoc specification +however, where the first sentence of the documentation block is automatically +treated as a brief description. To enable this behaviour you should set +\ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" to YES in the configuration +file. If you enble this option and want to put a dot in the middle of a +sentence without ending it, you should put a backslash and a space after it. +Here is an example: +\verbatim + /** Brief description (e.g.\ using only a few words). Details follow. */ +\endverbatim + +Here is the same piece of code as shown above, this time documented using the +JavaDoc style and \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" set to YES: \verbinclude jdstyle.cpp \htmlonly Click here for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly -Note that by default the first sentence of the documentation (until the .) -is treated as a brief description, whereas the documentation block as a whole -forms the detailed description. If you want to put a dot in the middle of a -sentence you should put a backslash and space behind it. Example: -\verbatim - /** Brief description (e.g.\ using only a few words). Details follow. */ -\endverbatim -The brief description is required for the JavaDoc style, unless you set -\ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" to NO. If you do this, -doxygen treats JavaDoc comments just like Qt comments (i.e. You have -to insert an explicit \ref cmdbrief "\\brief" command to add a brief description). - Unlike most other documentation systems, doxygen also allows you to put the documentation of members (including global functions) in front of the \e definition. This way the documentation can be placed in the source file instead of the header file. This keeps the header file compact, and allows the implementer of the members more direct access to the documentation. As a compromise the brief description could be placed before the -declaration and the detailed description before the member definition -(assuming you use the Qt style comments). +declaration and the detailed description before the member definition. \par Note: Each entity can only have \e one brief and \e one detailed description. If you diff --git a/examples/afterdoc.cfg b/examples/afterdoc.cfg index eb796da..25e1358 100644 --- a/examples/afterdoc.cfg +++ b/examples/afterdoc.cfg @@ -1,8 +1,9 @@ -PROJECT_NAME = "AfterDocs" -OUTPUT_DIRECTORY = afterdoc -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = afterdoc.h -QUIET = YES +PROJECT_NAME = "AfterDocs" +OUTPUT_DIRECTORY = afterdoc +GENERATE_LATEX = NO +GENERATE_MAN = NO +GENERATE_RTF = NO +CASE_SENSE_NAMES = NO +INPUT = afterdoc.h +QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/author.cfg b/examples/author.cfg index 62cf8bb..f1db227 100644 --- a/examples/author.cfg +++ b/examples/author.cfg @@ -6,3 +6,4 @@ GENERATE_RTF = NO CASE_SENSE_NAMES = NO INPUT = author.cpp QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/autolink.cfg b/examples/autolink.cfg index ae590b0..49367fc 100644 --- a/examples/autolink.cfg +++ b/examples/autolink.cfg @@ -6,3 +6,4 @@ GENERATE_RTF = NO CASE_SENSE_NAMES = NO INPUT = autolink.cpp QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/class.cfg b/examples/class.cfg index 24b7e44..99570b8 100644 --- a/examples/class.cfg +++ b/examples/class.cfg @@ -6,3 +6,4 @@ GENERATE_RTF = NO CASE_SENSE_NAMES = NO INPUT = class.h QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/define.cfg b/examples/define.cfg index 22d2a65..30ed03f 100644 --- a/examples/define.cfg +++ b/examples/define.cfg @@ -7,3 +7,4 @@ CASE_SENSE_NAMES = NO INPUT = define.h ENABLE_PREPROCESSING = YES QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/diagrams.cfg b/examples/diagrams.cfg index 4cb3b7e..d343a66 100644 --- a/examples/diagrams.cfg +++ b/examples/diagrams.cfg @@ -10,3 +10,4 @@ ENABLE_PREPROCESSING = YES INPUT = . FILE_PATTERNS = diagrams_*.h QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/enum.cfg b/examples/enum.cfg index 36d1370..05703cc 100644 --- a/examples/enum.cfg +++ b/examples/enum.cfg @@ -6,3 +6,4 @@ GENERATE_RTF = NO CASE_SENSE_NAMES = NO INPUT = enum.h QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/example.cfg b/examples/example.cfg index d157917..9f87df1 100644 --- a/examples/example.cfg +++ b/examples/example.cfg @@ -8,3 +8,4 @@ CASE_SENSE_NAMES = NO INPUT = example.cpp EXAMPLE_PATH = example_test.cpp QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/file.cfg b/examples/file.cfg index b62db7d..be0ecfb 100644 --- a/examples/file.cfg +++ b/examples/file.cfg @@ -6,3 +6,4 @@ GENERATE_RTF = NO CASE_SENSE_NAMES = NO INPUT = file.h QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/func.cfg b/examples/func.cfg index b558d0d..6071ac7 100644 --- a/examples/func.cfg +++ b/examples/func.cfg @@ -6,3 +6,4 @@ GENERATE_RTF = NO CASE_SENSE_NAMES = NO INPUT = func.h QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/group.cfg b/examples/group.cfg index 0cff98f..f37ebd6 100644 --- a/examples/group.cfg +++ b/examples/group.cfg @@ -6,3 +6,4 @@ GENERATE_RTF = NO CASE_SENSE_NAMES = NO INPUT = group.cpp QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/include.cfg b/examples/include.cfg index fbbd684..20c11c0 100644 --- a/examples/include.cfg +++ b/examples/include.cfg @@ -7,3 +7,4 @@ CASE_SENSE_NAMES = NO INPUT = include.cpp EXAMPLE_PATH = example_test.cpp QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/jdstyle.cfg b/examples/jdstyle.cfg index adcb2a4..c79a551 100644 --- a/examples/jdstyle.cfg +++ b/examples/jdstyle.cfg @@ -1,8 +1,9 @@ -PROJECT_NAME = "JavaDoc Style" -OUTPUT_DIRECTORY = jdstyle -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = jdstyle.cpp -QUIET = YES +PROJECT_NAME = "JavaDoc Style" +OUTPUT_DIRECTORY = jdstyle +GENERATE_LATEX = NO +GENERATE_MAN = NO +GENERATE_RTF = NO +CASE_SENSE_NAMES = NO +INPUT = jdstyle.cpp +QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/memgrp.cfg b/examples/memgrp.cfg index 6f613c5..ee7545b 100644 --- a/examples/memgrp.cfg +++ b/examples/memgrp.cfg @@ -1,8 +1,10 @@ -PROJECT_NAME = "Member Grouping" -OUTPUT_DIRECTORY = memgrp -GENERATE_LATEX = NO -GENERATE_MAN = NO -GENERATE_RTF = NO -CASE_SENSE_NAMES = NO -INPUT = memgrp.cpp -QUIET = YES +PROJECT_NAME = "Member Grouping" +OUTPUT_DIRECTORY = memgrp +GENERATE_LATEX = NO +GENERATE_MAN = NO +GENERATE_RTF = NO +CASE_SENSE_NAMES = NO +INPUT = memgrp.cpp +QUIET = YES +DISTRIBUTE_GROUP_DOC = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/memgrp.cpp b/examples/memgrp.cpp index a365e74..394cdbc 100644 --- a/examples/memgrp.cpp +++ b/examples/memgrp.cpp @@ -33,7 +33,8 @@ void Test::func1InGroup2() {} */ //@{ -//! one description for all members of this group +//! one description for all members of this group +//! (because DISTRIBUTE_GROUP_DOC is YES in the config file) #define A 1 #define B 2 void glob_func(); diff --git a/examples/overload.cfg b/examples/overload.cfg index 048f15d..ee6cfc9 100644 --- a/examples/overload.cfg +++ b/examples/overload.cfg @@ -7,3 +7,4 @@ CASE_SENSE_NAMES = NO SORT_MEMBER_DOCS = NO INPUT = overload.cpp QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/page.cfg b/examples/page.cfg index 4f1274e..7dd9ee2 100644 --- a/examples/page.cfg +++ b/examples/page.cfg @@ -6,3 +6,4 @@ GENERATE_RTF = NO CASE_SENSE_NAMES = NO INPUT = page.doc QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/par.cfg b/examples/par.cfg index 32e887f..299eee8 100644 --- a/examples/par.cfg +++ b/examples/par.cfg @@ -6,3 +6,4 @@ GENERATE_RTF = NO CASE_SENSE_NAMES = NO INPUT = par.cpp QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/qtstyle.cfg b/examples/qtstyle.cfg index 06318b8..741b42b 100644 --- a/examples/qtstyle.cfg +++ b/examples/qtstyle.cfg @@ -6,3 +6,4 @@ GENERATE_RTF = NO CASE_SENSE_NAMES = NO INPUT = qtstyle.cpp QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/relates.cfg b/examples/relates.cfg index 822f45c..7eb8f22 100644 --- a/examples/relates.cfg +++ b/examples/relates.cfg @@ -6,3 +6,4 @@ GENERATE_RTF = NO CASE_SENSE_NAMES = NO INPUT = relates.cpp QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/restypedef.cfg b/examples/restypedef.cfg index bbd599f..5c2214f 100644 --- a/examples/restypedef.cfg +++ b/examples/restypedef.cfg @@ -6,3 +6,4 @@ GENERATE_RTF = NO CASE_SENSE_NAMES = NO INPUT = restypedef.cpp QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/structcmd.cfg b/examples/structcmd.cfg index 5ba95c3..a3d70bf 100644 --- a/examples/structcmd.cfg +++ b/examples/structcmd.cfg @@ -6,3 +6,4 @@ GENERATE_RTF = NO CASE_SENSE_NAMES = NO INPUT = structcmd.h QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/tag.cfg b/examples/tag.cfg index 277d0b1..6b71953 100644 --- a/examples/tag.cfg +++ b/examples/tag.cfg @@ -8,3 +8,4 @@ INPUT = tag.cpp TAGFILES = example.tag PERL_PATH = perl QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/examples/templ.cfg b/examples/templ.cfg index 6a0e5d2..4d85734 100644 --- a/examples/templ.cfg +++ b/examples/templ.cfg @@ -6,3 +6,4 @@ GENERATE_RTF = NO CASE_SENSE_NAMES = NO INPUT = templ.cpp QUIET = YES +JAVADOC_AUTOBRIEF = YES diff --git a/packages/rpm/doxygen.spec b/packages/rpm/doxygen.spec index 4675094..bb0d2f8 100644 --- a/packages/rpm/doxygen.spec +++ b/packages/rpm/doxygen.spec @@ -1,5 +1,5 @@ Name: doxygen -Version: 1.2.2 +Version: 1.2.2-20001001 Summary: documentation system for C, C++ and IDL Release: 1 Source0: doxygen-%{version}.src.tar.gz diff --git a/src/classdef.cpp b/src/classdef.cpp index 4d56c74..6a505ec 100644 --- a/src/classdef.cpp +++ b/src/classdef.cpp @@ -386,10 +386,13 @@ void ClassDef::insertMember(MemberDef *md) functionMembers.append(md); break; case Private: - if (Config::sortMembersFlag) - functionMembers.inSort(md); - else - functionMembers.append(md); + if (Config::extractPrivateFlag) + { + if (Config::sortMembersFlag) + functionMembers.inSort(md); + else + functionMembers.append(md); + } break; } break; diff --git a/src/classdef.h b/src/classdef.h index 39c29d1..dd4b16f 100644 --- a/src/classdef.h +++ b/src/classdef.h @@ -58,6 +58,7 @@ class ClassDef : public Definition const char *name,CompoundType ct, const char *ref=0,const char *fName=0); ~ClassDef(); + DefType definitionType() { return TypeClass; } QCString getOutputFileBase() const { return fileName; } QCString displayName() const; CompoundType compoundType() const { return compType; } diff --git a/src/config.h b/src/config.h index cec30e6..724f02b 100644 --- a/src/config.h +++ b/src/config.h @@ -1,4 +1,4 @@ -/* This file was generated by configgen on Sun Sep 24 18:38:07 2000 +/* This file was generated by configgen on Sun Oct 1 13:51:26 2000 * from config_templ.h * * DO NOT EDIT! @@ -60,7 +60,7 @@ struct Config static bool hideScopeNames; // hide the name of the scope. static bool verbatimHeaderFlag; // enable/disable generation of verb headers. static bool showIncFileFlag; // show include file in file documentation? - static bool autoBriefFlag; // javadoc comments behaves as Qt comments. + static bool autoBriefFlag; // should javadoc comments behaves as Qt comments. static bool inheritDocsFlag; // inheritance of documentation enabled? static bool inlineInfoFlag; // show info about inline members? static bool sortMembersFlag; // sort members alphabetically? diff --git a/src/config.l b/src/config.l index 0a3302b..204531f 100644 --- a/src/config.l +++ b/src/config.l @@ -1,4 +1,4 @@ -/* This file was generated by configgen on Sun Sep 24 18:38:07 2000 +/* This file was generated by configgen on Sun Oct 1 13:51:26 2000 * from config_templ.l * * DO NOT EDIT! @@ -97,7 +97,7 @@ bool Config::caseSensitiveNames = TRUE; bool Config::hideScopeNames = FALSE; bool Config::verbatimHeaderFlag = TRUE; bool Config::showIncFileFlag = TRUE; -bool Config::autoBriefFlag = TRUE; +bool Config::autoBriefFlag = FALSE; bool Config::inheritDocsFlag = TRUE; bool Config::inlineInfoFlag = TRUE; bool Config::sortMembersFlag = TRUE; @@ -823,7 +823,7 @@ void Config::init() Config::hideScopeNames = FALSE; Config::verbatimHeaderFlag = TRUE; Config::showIncFileFlag = TRUE; - Config::autoBriefFlag = TRUE; + Config::autoBriefFlag = FALSE; Config::inheritDocsFlag = TRUE; Config::inlineInfoFlag = TRUE; Config::sortMembersFlag = TRUE; @@ -1015,8 +1015,8 @@ void writeTemplateConfig(QFile *f,bool sl) t << "# information to generate all constant output in the proper language. \n"; t << "# The default language is English, other supported languages are: \n"; t << "# Dutch, French, Italian, Czech, Swedish, German, Finnish, Japanese, \n"; - t << "# Korean, Hungarian, Spanish, Romanian, Russian, Croatian, Polish, and \n"; - t << "# Portuguese.\n"; + t << "# Korean, Hungarian, Spanish, Romanian, Russian, Croatian, Polish, \n"; + t << "# Portuguese and Slovene.\n"; t << "\n"; } t << "OUTPUT_LANGUAGE = "; @@ -1240,10 +1240,11 @@ void writeTemplateConfig(QFile *f,bool sl) if (!sl) { t << "\n"; - t << "# If the JAVADOC_AUTOBRIEF tag is set to YES (the default) then Doxygen \n"; + t << "# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen \n"; t << "# will interpret the first line (until the first dot) of a JavaDoc-style \n"; - t << "# comment as the brief description. If set to NO, the Javadoc-style will \n"; - t << "# behave just like the Qt-style comments. \n"; + t << "# comment as the brief description. If set to NO, the JavaDoc \n"; + t << "# comments will behave just like the Qt-style comments (thus requiring an \n"; + t << "# explict @brief command for a brief description. \n"; t << "\n"; } t << "JAVADOC_AUTOBRIEF = "; diff --git a/src/definition.h b/src/definition.h index e8f71d7..7332e61 100644 --- a/src/definition.h +++ b/src/definition.h @@ -32,27 +32,32 @@ class MemberDef; class Definition { public: - /*! create a new definition */ + /*! Types of derived classes */ + enum DefType { TypeClass, TypeMember, TypeFile, TypeGroup, TypeNamespace }; + /*! Use this for dynamic inspection of the derived class */ + virtual DefType definitionType() = 0; + + /*! Create a new definition */ Definition( const char *defFileName,int defLine, const char *name,const char *b=0,const char *d=0); - /*! destroys the definition */ + /*! Destroys the definition */ virtual ~Definition(); - /*! returns the name of the definition */ + /*! Returns the name of the definition */ const QCString& name() const { return n; } - /*! returns the base name of the output file that contains this + /*! Returns the base name of the output file that contains this * definition. */ virtual QCString getOutputFileBase() const = 0; /*! Returns the name of the source listing of this file. */ const QCString sourceName() const { return getOutputFileBase()+"-source"; } - /*! returns the detailed description of this definition */ + /*! Returns the detailed description of this definition */ const QCString& documentation() const { return doc; } - /*! returns the brief description of this definition */ + /*! Returns the brief description of this definition */ const QCString& briefDescription() const { return brief; } - /*! sets a new \a name for the definition */ + /*! Sets a new \a name for the definition */ void setName(const char *name) { n=name; } - /*! sets the documentation of this definition to \a d. */ + /*! Sets the documentation of this definition to \a d. */ void setDocumentation(const char *d,bool stripWhiteSpace=TRUE) { if (stripWhiteSpace) @@ -60,11 +65,11 @@ class Definition else doc=d; } - /*! sets the brief description of this definition to \a b. + /*! Sets the brief description of this definition to \a b. * A dot is added to the sentence if not available. */ void setBriefDescription(const char *b); - /*! returns TRUE iff the definition is documented */ + /*! Returns TRUE iff the definition is documented */ virtual bool hasDocumentation(); virtual bool isLinkableInProject() = 0; virtual bool isLinkable() = 0; diff --git a/src/doc.l b/src/doc.l index 7e262e7..3cc7891 100644 --- a/src/doc.l +++ b/src/doc.l @@ -984,6 +984,11 @@ DOCPARAM ([a-z_A-Z0-9:\<\>\=\.\-]+)|("\"".*"\"") } } (({B}*"\n"){2,}{B}*)?{CMD}"par"{B}* { + QCString t=yytext; + if (t.contains('\n')>1 && insideItemList) + { + forceEndItemList(); + } BEGIN(DocPar); } [^\n]*{BN} { diff --git a/src/doxygen.cpp b/src/doxygen.cpp index b77c746..e01ef56 100644 --- a/src/doxygen.cpp +++ b/src/doxygen.cpp @@ -1107,6 +1107,7 @@ static MemberDef *addVariableToClass( md->setDocumentation(root->doc); md->setBriefDescription(root->brief); md->setDefinition(def); + md->setBitfields(root->bitfields); md->addSectionsToDefinition(root->anchors); md->setFromAnnonymousScope(fromAnnScope); md->setFromAnnonymousMember(fromAnnMemb); @@ -2038,6 +2039,22 @@ static void transferRelatedFunctionDocumentation() } //---------------------------------------------------------------------- +static void replaceNamespaceAliases(QCString &scope,int i) +{ + //printf("replaceNamespaceAliases(%s,%d)\n",scope.data(),i); + while (i>0) + { + QCString *s = namespaceAliasDict[scope.left(i)]; + if (s) + { + scope=*s+scope.right(scope.length()-i); + i=s->length(); + } + i=scope.findRev("::",i-1); + } + //printf("replaceNamespaceAliases() result=%s\n",scope.data()); +} + static bool findBaseClassRelation(Entry *root,ClassDef *cd, BaseInfo *bi, @@ -2109,6 +2126,14 @@ static bool findBaseClassRelation(Entry *root,ClassDef *cd, bool found=baseClass!=0 && baseClass!=cd; NamespaceDef *nd=cd->getNamespaceDef(); + if (!found && (i=baseClassName.findRev("::"))!=-1) + { + // replace any namespace aliases + replaceNamespaceAliases(baseClassName,i); + baseClass=getResolvedClass(baseClassName); + found=baseClass!=0 && baseClass!=cd; + } + if (!found) { FileDef *fd=cd->getFileDef(); @@ -2148,7 +2173,6 @@ static bool findBaseClassRelation(Entry *root,ClassDef *cd, } if (!found && nd) // class is inside a namespace { - //printf(" class %s inside namespace %s\n",cd->name().data(),nd->name().data()); NamespaceList *nl = nd->getUsedNamespaces(); QCString fName = nd->name()+"::"+baseClassName; found = (baseClass=getResolvedClass(fName))!=0 && root->name!=fName; @@ -2264,18 +2288,21 @@ static void computeClassRelations(Entry *root) if ( ( ( + // is it a compound (class, struct, union, interface ...) root->section & Entry::COMPOUND_MASK ) || ( + // is it a documentation block with inheritance info. (root->section & Entry::COMPOUNDDOC_MASK) && root->extends->count()>0 ) ) && - !root->name.isEmpty() + !root->name.isEmpty() // sanity check ) { ClassDef *cd; + // strip any annonymous scopes first QCString bName=stripAnnonymousNamespaceScope(root->name); Debug::print(Debug::Classes,0," Class %s : \n",bName.data()); if ((cd=getClass(bName))) diff --git a/src/doxygen.pro.in b/src/doxygen.pro.in index 9280e22..30312b7 100644 --- a/src/doxygen.pro.in +++ b/src/doxygen.pro.in @@ -27,7 +27,7 @@ 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_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 \ - translator_ro.h + translator_ro.h translator_si.h SOURCES = doxygen.cpp scanner.cpp doc.cpp classdef.cpp classlist.cpp \ memberdef.cpp membername.cpp index.cpp memberlist.cpp \ entry.cpp logos.cpp instdox.cpp message.cpp code.cpp \ diff --git a/src/entry.cpp b/src/entry.cpp index 3e4bc89..a8dfb9b 100644 --- a/src/entry.cpp +++ b/src/entry.cpp @@ -56,6 +56,7 @@ Entry::Entry(const Entry &e) type = e.type.copy(); name = e.name.copy(); args = e.args.copy(); + bitfields = e.bitfields.copy(); exception = e.exception.copy(); program = e.program.copy(); includeFile = e.includeFile.copy(); @@ -197,6 +198,7 @@ void Entry::reset() name.resize(0); type.resize(0); args.resize(0); + bitfields.resize(0); exception.resize(0); program.resize(0); //body.resize(0); @@ -242,6 +244,7 @@ int Entry::getSize() size+=type.length()+1; size+=name.length()+1; size+=args.length()+1; + size+=bitfields.length()+1; size+=exception.length()+1; size+=program.length()+1; //size+=body.length()+1; diff --git a/src/entry.h b/src/entry.h index 7736be7..27035e2 100644 --- a/src/entry.h +++ b/src/entry.h @@ -162,8 +162,6 @@ class Entry int section; // entry type (see Sections); Protection protection; // class protection - //bool sig; // a Qt signal ? - //bool slot; // a Qt slot ? MethodTypes mtype; // signal, slot or dcop method? bool stat; // static ? bool explicitExternal; // explicitly defined as external? @@ -176,6 +174,7 @@ class Entry QCString type; // member type QCString name; // member name QCString args; // member argument string + QCString bitfields; // member's bit fields ArgumentList *argList; // member arguments as a list ArgumentList *tArgList; // template argument list ArgumentList *mtArgList; // member template argument list @@ -183,8 +182,6 @@ class Entry QCString memberSpec; // template specialization of the member QCString program; // the program text QCString initializer; // initial value (for variables) - int bodyLine; // line number of the definition in the source - int endBodyLine; // line number where the definition ends QCString includeFile; // include file (2 arg of \class, must be unique) QCString includeName; // include name (3 arg of \class) QCString doc; // documentation block (partly parsed) @@ -192,6 +189,8 @@ class Entry QCString brief; // brief description (doc block) QCString inside; // name of the class in which documents are found QCString exception; // throw specification + int bodyLine; // line number of the definition in the source + int endBodyLine; // line number where the definition ends int mGrpId; // member group id QList *sublist; // entries that are children of this one QList *extends; // list of base classes diff --git a/src/filedef.h b/src/filedef.h index 78eb138..dea9e73 100644 --- a/src/filedef.h +++ b/src/filedef.h @@ -66,6 +66,7 @@ class FileDef : public Definition FileDef(const char *p,const char *n,const char *ref=0); ~FileDef(); + DefType definitionType() { return TypeFile; } /*! Returns the unique file name (this may include part of the path). */ QCString name() const diff --git a/src/groupdef.cpp b/src/groupdef.cpp index fb17114..eb0611f 100644 --- a/src/groupdef.cpp +++ b/src/groupdef.cpp @@ -366,7 +366,7 @@ void GroupDef::writeDocumentation(OutputList &ol) } } - defineMembers.countDocMembers(); + defineMembers.countDocMembers(TRUE); if (defineMembers.totalCount()>0 ) { ol.writeRuler(); @@ -376,7 +376,7 @@ void GroupDef::writeDocumentation(OutputList &ol) defineMembers.writeDocumentation(ol,name(),this); } - protoMembers.countDocMembers(); + protoMembers.countDocMembers(TRUE); if (protoMembers.totalCount()>0 ) { ol.writeRuler(); @@ -386,7 +386,7 @@ void GroupDef::writeDocumentation(OutputList &ol) protoMembers.writeDocumentation(ol,name(),this); } - typedefMembers.countDocMembers(); + typedefMembers.countDocMembers(TRUE); if (typedefMembers.totalCount()>0 ) { ol.writeRuler(); @@ -396,7 +396,7 @@ void GroupDef::writeDocumentation(OutputList &ol) typedefMembers.writeDocumentation(ol,name(),this); } - enumMembers.countDocMembers(); + enumMembers.countDocMembers(TRUE); if (enumMembers.totalCount()>0 ) { ol.writeRuler(); @@ -406,17 +406,7 @@ void GroupDef::writeDocumentation(OutputList &ol) enumMembers.writeDocumentation(ol,name(),this); } - //enumValMembers.countDocMembers(); - //if (enumValMembers.totalCount()>0 ) - //{ - // ol.writeRuler(); - // ol.startGroupHeader(); - // parseText(ol,theTranslator->trEnumerationValueDocumentation()); - // ol.endGroupHeader(); - // enumValMembers.writeDocumentation(ol,name()); - //} - - funcMembers.countDocMembers(); + funcMembers.countDocMembers(TRUE); if (funcMembers.totalCount()>0 ) { ol.writeRuler(); @@ -426,7 +416,7 @@ void GroupDef::writeDocumentation(OutputList &ol) funcMembers.writeDocumentation(ol,name(),this); } - varMembers.countDocMembers(); + varMembers.countDocMembers(TRUE); if (varMembers.totalCount()>0 ) { ol.writeRuler(); diff --git a/src/groupdef.h b/src/groupdef.h index e673f7b..385c6e5 100644 --- a/src/groupdef.h +++ b/src/groupdef.h @@ -41,6 +41,7 @@ class GroupDef : public Definition public: GroupDef(const char *fileName,int line,const char *name,const char *title); ~GroupDef(); + DefType definitionType() { return TypeGroup; } QCString getOutputFileBase() const { return fileName; } const char *groupTitle() const { return title; } void addFile(const FileDef *def); diff --git a/src/htmlgen.cpp b/src/htmlgen.cpp index 9703d81..40eed09 100644 --- a/src/htmlgen.cpp +++ b/src/htmlgen.cpp @@ -29,6 +29,7 @@ #include "version.h" #include "dot.h" #include "language.h" +#include "htmlhelp.h" #define GROUP_COLOR "#ff8080" @@ -157,6 +158,11 @@ void HtmlGenerator::startFile(const char *name,const char *title,bool external) lastTitle=title; if (fileName.right(5)!=".html") fileName+=".html"; startPlainFile(fileName); + if (Config::htmlHelpFlag) + { + HtmlHelp::getInstance()->addIndexFile(fileName); + } + lastFile = fileName; if (header.isEmpty()) { diff --git a/src/htmlhelp.cpp b/src/htmlhelp.cpp index 599e39c..064aec2 100644 --- a/src/htmlhelp.cpp +++ b/src/htmlhelp.cpp @@ -287,9 +287,12 @@ void HtmlHelp::initialize() "\n" "\n" "
    \n"; +} +void HtmlHelp::createProjectFile() +{ /* Write the project file */ - fName = Config::htmlOutputDir + "/index.hhp"; + QCString fName = Config::htmlOutputDir + "/index.hhp"; QFile f(fName); if (f.open(IO_WriteOnly)) { @@ -298,12 +301,23 @@ void HtmlHelp::initialize() "Compatibility=1.1\n" "Full-text search=Yes\n" "Contents file=index.hhc\n" - "Default Window=indexHelp\n" + "Default Window=main\n" "Default topic=index.html\n" "Index file=index.hhk\n" - "Title=" << Config::projectName << endl << endl - << "[FILES]\n" - "index.html"; + "Title=" << Config::projectName << endl << endl; + + t << "[WINDOWS]" << endl; + t << "main=\"" << Config::projectName << "\",\"index.hhc\"," + "\"index.hhk\",\"index.html\",\"index.html\",,,,,0x23520,," + "0x3006,,,,,,,,0" << endl << endl; + + t << "[FILES]" << endl; + char *s = indexFiles.first(); + while (s) + { + t << s << endl; + s=indexFiles.next(); + } f.close(); } else @@ -312,6 +326,11 @@ void HtmlHelp::initialize() } } +void HtmlHelp::addIndexFile(const char *s) +{ + indexFiles.append(s); +} + /*! Finalizes the HTML help. This will finish and close the * contents file (index.hhc) and the index file (index.hhk). * \sa initialize() @@ -331,6 +350,8 @@ void HtmlHelp::finalize() kts.unsetDevice(); kf->close(); delete kf; + + createProjectFile(); } /*! Increase the level of the contents hierarchy. diff --git a/src/htmlhelp.h b/src/htmlhelp.h index f054735..e6db9c3 100644 --- a/src/htmlhelp.h +++ b/src/htmlhelp.h @@ -23,6 +23,7 @@ #include "qtbc.h" #include +#include class QFile; class HtmlHelpIndex; @@ -45,12 +46,17 @@ class HtmlHelp const char *anchor = 0); void addIndexItem(const char *level1, const char *level2, const char *ref, const char *anchor); + void addIndexFile(const char *name); + private: + void createProjectFile(); + HtmlHelp(); QFile *cf,*kf; QTextStream cts,kts; HtmlHelpIndex *index; int dc; + QStrList indexFiles; static HtmlHelp *theInstance; }; diff --git a/src/language.cpp b/src/language.cpp index 1c2f997..4fca8c7 100644 --- a/src/language.cpp +++ b/src/language.cpp @@ -34,6 +34,7 @@ #include "translator_hu.h" #include "translator_kr.h" #include "translator_ro.h" +#include "translator_si.h" #endif #define L_EQUAL(a) !stricmp(langName,a) @@ -115,6 +116,10 @@ bool setTranslator(const char *langName) { theTranslator=new TranslatorRomanian; } + else if (L_EQUAL("slovene")) + { + theTranslator=new TranslatorSlovene; + } #endif else // use the default language (i.e. english) { diff --git a/src/memberdef.cpp b/src/memberdef.cpp index c3632ed..f9a8ff9 100644 --- a/src/memberdef.cpp +++ b/src/memberdef.cpp @@ -450,8 +450,15 @@ void MemberDef::writeLink(OutputList &ol,ClassDef *cd,NamespaceDef *nd, { Definition *d=0; if (cd) d=cd; else if (nd) d=nd; else if (fd) d=fd; else if (gd) d=gd; - if (d==0) return; - ol.writeObjectLink(d->getReference(),d->getOutputFileBase(),anchor(),name()); + if (d==0) { err("Member %s without group! Please report this bug!\n",name().data()); return; } + if (group!=0 && gd==0) // forward link to the group + { + ol.writeObjectLink(group->getReference(),group->getOutputFileBase(),anchor(),name()); + } + else // local link + { + ol.writeObjectLink(d->getReference(),d->getOutputFileBase(),anchor(),name()); + } } @@ -689,19 +696,6 @@ void MemberDef::writeDeclaration(OutputList &ol, // write name if (!name().isEmpty() && name().at(0)!='@') { - //if (grpId!=-1) - //{ - // if (annMemb) - // { - // //printf("anchor=%s ann_anchor=%s\n",anchor(),annMemb->anchor()); - // annMemb->writeLink(ol,cd,nd,fd,gd,inGroup ? memberGroup : 0); - // annMemb->annUsed=annUsed=TRUE; - // } - // else - // writeLink(ol,0,0,0,0,memberGroup); - // //ol.writeBoldString(name()); - //} - //else if (isLinkable()) { if (annMemb) @@ -748,7 +742,11 @@ void MemberDef::writeDeclaration(OutputList &ol, ol.docify(excpString()); } - if (!init.isEmpty() && initLines==0 && maxInitLines>0) // add initializer + if (!bitfields.isEmpty()) // add bitfields + { + linkifyText(TextGeneratorOLImpl(ol),cname,name(),bitfields.simplifyWhiteSpace()); + } + else if (!init.isEmpty() && initLines==0 && maxInitLines>0) // add initializer { if (!isDefine()) { @@ -797,9 +795,15 @@ void MemberDef::writeDeclaration(OutputList &ol, * all active output formats. */ void MemberDef::writeDocumentation(MemberList *ml,OutputList &ol, - const char *scopeName,Definition *container) + const char *scopeName, + Definition *container + ) { + // hide global static functions unless extractStaticFlag is enabled if (getClassDef()==0 && isStatic() && !Config::extractStaticFlag) return; + // hide member that are documented in their own group + if (group!=0 && container->definitionType()!=TypeGroup) return; + bool hasDocs = detailsAreVisible(); //printf("MemberDef::writeDocumentation(): type=`%s' def=`%s'\n",type.data(),definition()); if ( @@ -996,7 +1000,7 @@ void MemberDef::writeDocumentation(MemberList *ml,OutputList &ol, if (protection()==Protected) sl.append("protected"); else if (protection()==Private) sl.append("private"); if (lvirt==Virtual) sl.append("virtual"); - else if (lvirt==Pure) sl.append("pure virtual"); + else if (lvirt==Pure) sl.append("pure virtual"); if (isSignal()) sl.append("signal"); if (isSlot()) sl.append("slot"); } diff --git a/src/memberdef.h b/src/memberdef.h index 279d5b3..a0c655e 100644 --- a/src/memberdef.h +++ b/src/memberdef.h @@ -73,6 +73,7 @@ class MemberDef : public Definition bool related,MemberType t,const ArgumentList *tal, const ArgumentList *al); ~MemberDef(); + DefType definitionType() { return TypeMember; } QCString getOutputFileBase() const; const char *declaration() const { return decl; } @@ -80,6 +81,7 @@ class MemberDef : public Definition const char *typeString() const { return type; } const char *argsString() const { return args; } const char *excpString() const { return exception; } + const char *bitfieldString() const { return bitfields; } QCString anchor() const; const QCString &initializer() const { return init; } int initializerLines() const { return initLines; } @@ -133,6 +135,7 @@ class MemberDef : public Definition init=init.stripWhiteSpace(); initLines=init.contains('\n'); } + void setBitfields(const char *s) { bitfields = s; } void setMaxInitLines(int lines) { if (lines!=-1) maxInitLines=lines; } void setMemberClass(ClassDef *cd) { classDef=cd; } void setSectionList(MemberList *sl) { section=sl; } @@ -231,6 +234,7 @@ class MemberDef : public Definition NamespaceDef *nspace; // the namespace this member is in. QCString type; // return type QCString args; // function arguments/variable array specifiers + QCString bitfields; // struct member bitfields QCString exception; // exceptions that can be thrown QCString init; // initializer int initLines; // number of lines in the initializer diff --git a/src/memberlist.cpp b/src/memberlist.cpp index 2ad3061..60a4e90 100644 --- a/src/memberlist.cpp +++ b/src/memberlist.cpp @@ -110,7 +110,7 @@ void MemberList::countDecMembers(bool inGroup,bool countSubGroups,bool sectionPe //printf("MemberList::countDecMembers(%d)=%d\n",inGroup,m_count); } -void MemberList::countDocMembers() +void MemberList::countDocMembers(bool listOfGroup) { /*varCnt=funcCnt=enumCnt=enumValCnt=typeCnt=protoCnt=defCnt=friendCnt=0;*/ m_count=0; @@ -122,7 +122,9 @@ void MemberList::countDocMembers() bool visibleIfStatic = !(md->getClassDef()==0 && md->isStatic() && !Config::extractStaticFlag); - if (visibleIfStatic && + bool inOwnGroup = (md->getGroupDef()!=0 && !listOfGroup); + + if (visibleIfStatic && !inOwnGroup && (Config::extractAllFlag || md->detailsAreVisible()) ) { @@ -298,6 +300,9 @@ void MemberList::writePlainDeclarations(OutputList &ol, typeDecl.writeChar(' '); } + const uint MAX_ENUM_VALUES_FOR_ONE_LINE = 4; + int enumMemCount=0; + typeDecl.docify("{ "); QList *fmdl=md->enumFieldList(); if (fmdl) @@ -305,12 +310,17 @@ void MemberList::writePlainDeclarations(OutputList &ol, MemberDef *fmd=fmdl->first(); while (fmd) { - /* in html we start each enum item on a new line */ - typeDecl.pushGeneratorState(); - typeDecl.disableAllBut(OutputGenerator::Html); - typeDecl.lineBreak(); - typeDecl.writeString("  "); - typeDecl.popGeneratorState(); + /* in html we start a new line after a number of items */ + if (fmdl->count()>MAX_ENUM_VALUES_FOR_ONE_LINE + && (enumMemCount%MAX_ENUM_VALUES_FOR_ONE_LINE)==0 + ) + { + typeDecl.pushGeneratorState(); + typeDecl.disableAllBut(OutputGenerator::Html); + typeDecl.lineBreak(); + typeDecl.writeString("  "); + typeDecl.popGeneratorState(); + } if (fmd->hasDocumentation()) // enum value has docs { @@ -334,12 +344,16 @@ void MemberList::writePlainDeclarations(OutputList &ol, typeDecl.disable(OutputGenerator::Man); typeDecl.writeString("\n"); // to prevent too long lines in LaTeX typeDecl.enable(OutputGenerator::Man); + enumMemCount++; } } - typeDecl.pushGeneratorState(); - typeDecl.disableAllBut(OutputGenerator::Html); - typeDecl.lineBreak(); - typeDecl.popGeneratorState(); + if (fmdl->count()>MAX_ENUM_VALUES_FOR_ONE_LINE) + { + typeDecl.pushGeneratorState(); + typeDecl.disableAllBut(OutputGenerator::Html); + typeDecl.lineBreak(); + typeDecl.popGeneratorState(); + } typeDecl.docify(" }"); md->setEnumDecl(typeDecl); int enumVars=0; diff --git a/src/memberlist.h b/src/memberlist.h index 1967ee3..66efdb3 100644 --- a/src/memberlist.h +++ b/src/memberlist.h @@ -42,7 +42,7 @@ class MemberList : public QList int defineCount() const { return defCnt; } int friendCount() const { return friendCnt; } void countDecMembers(bool inGroup,bool countSubGroups,bool sectionPerType); - void countDocMembers(); + void countDocMembers(bool listOfGroup=FALSE); int totalCount() const { return //varCnt+funcCnt+enumCnt+enumValCnt+typeCnt+ //protoCnt+defCnt+friendCnt; diff --git a/src/namespacedef.h b/src/namespacedef.h index 1156d89..884107e 100644 --- a/src/namespacedef.h +++ b/src/namespacedef.h @@ -39,6 +39,7 @@ class NamespaceDef : public Definition NamespaceDef(const char *defFileName,int defLine, const char *name,const char *ref=0); ~NamespaceDef(); + DefType definitionType() { return TypeNamespace; } QCString getOutputFileBase() const { return fileName; } void insertUsedFile(const char *fname); void writeDocumentation(OutputList &ol); diff --git a/src/page.h b/src/page.h index 11136c9..0d37962 100644 --- a/src/page.h +++ b/src/page.h @@ -49,10 +49,13 @@ class PageSDict : public SDict } }; -class PageSDictIterator : public SDict::Iterator +// typedef is to get around Solaris compile problem +typedef SDict::Iterator _SDictPageInfoIterator; + +class PageSDictIterator : public _SDictPageInfoIterator { public: - PageSDictIterator(const PageSDict &d) : SDict::Iterator(d) {} + PageSDictIterator(const PageSDict &d) : _SDictPageInfoIterator(d) {} ~PageSDictIterator() {} }; diff --git a/src/rtfgen.cpp b/src/rtfgen.cpp index cff0ce4..1cee062 100644 --- a/src/rtfgen.cpp +++ b/src/rtfgen.cpp @@ -488,14 +488,14 @@ bool StyleData::setStyle(const char* s, const char* styleName) if (start < 0) { err("Style sheet '%s' contains no '\\s' clause.\n{%s}\n", styleName, s); - return false; + return FALSE; } s += start; index = (int)atol(s + 2); ASSERT(index > 0); // search for the end of pure formatting codes const char* end = s + len; - bool haveNewDefinition = true; + bool haveNewDefinition = TRUE; for(;;) { if (*end == '{') @@ -518,7 +518,7 @@ bool StyleData::setStyle(const char* s, const char* styleName) } else if (*end == 0) { // no style-definition part, keep default value - haveNewDefinition = false; + haveNewDefinition = FALSE; break; } else // plain name without leading \\snext @@ -534,7 +534,7 @@ bool StyleData::setStyle(const char* s, const char* styleName) definition = new char[size]; memcpy(definition, end, size); } - return true; + return TRUE; } static void loadStylesheet(const char *name, QDict& dict) @@ -591,7 +591,7 @@ void RTFGenerator::init() err("Could not create output directory %s\n",dir.data()); exit(1); } - Rtf_Style.setAutoDelete(true); + Rtf_Style.setAutoDelete(TRUE); // first duplicate strings of Rtf_Style_Default const struct Rtf_Style_Default* def = Rtf_Style_Default; diff --git a/src/scanner.l b/src/scanner.l index 4a74166..c63de52 100644 --- a/src/scanner.l +++ b/src/scanner.l @@ -339,6 +339,7 @@ TITLE [tT][iI][tT][lL][eE] %x Bases %x BasesProt %x NextSemi +%x BitFields %x FindMembers %x FindMemberName %x FindFields @@ -501,7 +502,7 @@ TITLE [tT][iI][tT][lL][eE] --curlyCount ; } else - BEGIN( NextSemi ) ; + BEGIN( NextSemi ); } "'"\\[0-7]{1,3}"'" "'"\\."'" @@ -512,8 +513,12 @@ TITLE [tT][iI][tT][lL][eE] } [;,] { unput(*yytext); - BEGIN( FindMembers ) ; + BEGIN( FindMembers ); } +[;,] { + unput(*yytext); + BEGIN( FindMembers ); + } {B}*"k_dcop"{BN}*":"{BN}* { current->mtype = mtype = DCOP; current->protection = protection = Public ; current->type.resize(0); @@ -779,7 +784,16 @@ TITLE [tT][iI][tT][lL][eE] BEGIN( NSAliasArg ); } ({ID}"::")*{ID} { - namespaceAliasDict.insert(aliasName,new QCString(yytext)); + printf("Inserting namespace alias %s::%s->%s\n",current_root->name.data(),aliasName.data(),yytext); + if (current_root->name.isEmpty()) + { + namespaceAliasDict.insert(aliasName,new QCString(yytext)); + } + else + { + namespaceAliasDict.insert(current_root->name+"::"+aliasName, + new QCString(current_root->name+"::"+yytext)); + } } ";" { BEGIN( FindMembers ); @@ -997,7 +1011,7 @@ TITLE [tT][iI][tT][lL][eE] . [*&]+ { current->name += yytext ; } -";"{BN}*("/**"|"//!"|"/*!"|"///")"<" { +";"{BN}*("/**"|"//!"|"/*!"|"///")"<" { lineCount(); if (current->bodyLine==-1) current->bodyLine=yyLineNr; @@ -1019,7 +1033,7 @@ TITLE [tT][iI][tT][lL][eE] BEGIN(AfterDoc); } } -","{BN}*("/**"|"//!"|"/*!"|"///")"<" { +","{BN}*("/**"|"//!"|"/*!"|"///")"<" { lineCount(); lastAfterDocContext = YY_START; afterDocTerminator = ','; @@ -1043,7 +1057,10 @@ TITLE [tT][iI][tT][lL][eE] lineCount(); lastAfterDocContext = YY_START; if (YY_START==DefineEnd) + { afterDocTerminator = '\n'; + yyLineNr--; + } else afterDocTerminator = 0; if (yytext[yyleng-3]=='/') @@ -1241,59 +1258,54 @@ TITLE [tT][iI][tT][lL][eE] yyLineNr++; *pCopyCurlyString+=*yytext; } - -[:;,] { +":" { + BEGIN(BitFields); + current->bitfields+=":"; + } +. { + current->bitfields+=*yytext; + } +[;,] { QCString oldType = current->type.copy(); QCString oldDocs = current->doc.copy(); - if ( *yytext != ':') + if (current->bodyLine==-1) { - if (current->bodyLine==-1) - { - current->bodyLine = yyLineNr; - } - current->type=current->type.simplifyWhiteSpace(); - current->args=current->args.simplifyWhiteSpace(); - current->name=current->name.stripWhiteSpace(); - if (!current->name.isEmpty() && current->type.left(8)=="typedef ") - { - // add typedef to dictionary - QCString dest = extractName(current->type.right(current->type.length()-8)); - if (typedefDict[current->name]==0 && !dest.isEmpty()) - { - //printf("1>>>>>>>>>> adding %s->%s\n",current->name.data(),dest.data()); - typedefDict.insert(current->name, new QCString(dest)); - } - } - current->section = Entry::VARIABLE_SEC ; - current->fileName = yyFileName; - current->startLine = yyLineNr; - //printf("New variable type=`%s' name=`%s' groupId=%d\n",current->type.data(),current->name.data(),current->mGrpId); - current_root->addSubEntry( current ) ; - current = new Entry ; - // variable found - current->section = Entry::EMPTY_SEC ; - current->protection = protection; - current->mtype = Method; - current->virt = Normal; - current->stat = gstat; - current->mGrpId = memberGroupId; + current->bodyLine = yyLineNr; } - // skip expression or bitfield if needed - if ( *yytext == ':') - { - BEGIN( NextSemi ); + current->type=current->type.simplifyWhiteSpace(); + current->args=current->args.simplifyWhiteSpace(); + current->name=current->name.stripWhiteSpace(); + if (!current->name.isEmpty() && current->type.left(8)=="typedef ") + { + // add typedef to dictionary + QCString dest = extractName(current->type.right(current->type.length()-8)); + if (typedefDict[current->name]==0 && !dest.isEmpty()) + { + //printf("1>>>>>>>>>> adding %s->%s\n",current->name.data(),dest.data()); + typedefDict.insert(current->name, new QCString(dest)); + } } - else + current->section = Entry::VARIABLE_SEC ; + current->fileName = yyFileName; + current->startLine = yyLineNr; + //printf("New variable type=`%s' name=`%s' groupId=%d\n",current->type.data(),current->name.data(),current->mGrpId); + current_root->addSubEntry( current ) ; + current = new Entry ; + // variable found + current->section = Entry::EMPTY_SEC ; + current->protection = protection; + current->mtype = Method; + current->virt = Normal; + current->stat = gstat; + current->mGrpId = memberGroupId; + if ( *yytext == ',' ) { - if ( *yytext == ',' ) - { - int i=oldType.length(); - while (i>0 && (oldType[i-1]=='*' || oldType[i-1]==' ')) i--; - current->type = oldType.left(i); - current->doc = oldDocs; - } - BEGIN( FindMembers ) ; + int i=oldType.length(); + while (i>0 && (oldType[i-1]=='*' || oldType[i-1]==' ')) i--; + current->type = oldType.left(i); + current->doc = oldDocs; } + BEGIN( FindMembers ) ; } "[" { @@ -2661,7 +2673,7 @@ TITLE [tT][iI][tT][lL][eE] lastDocRelContext = YY_START; BEGIN( ClassDocRelates ); } -{ID} { +({ID}"::")*{ID} { current->relates = yytext; BEGIN( lastDocRelContext ); } diff --git a/src/translator_si.h b/src/translator_si.h new file mode 100644 index 0000000..64ea923 --- /dev/null +++ b/src/translator_si.h @@ -0,0 +1,671 @@ +/****************************************************************************** + * + * + * + * Copyright (C) 1997-2000 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 + * for any purpose. It is provided "as is" without express or implied warranty. + * See the GNU General Public License for more details. + * + * Documents produced by Doxygen are derivative works derived from the + * input used in their production; they are not affected by this license. + * + */ + +// translation by Matjaz Ostroversnik + +#ifndef TRANSLATOR_SI_H +#define TRANSLATOR_SI_H + +#include "translator.h" + +class TranslatorSlovene : public Translator +{ + public: + QCString idLanguage() + { return "slovene"; } + /*! Used to get the command(s) for the language support. This method + * was designed for languages which do not prefer babel package. + * If this methods returns empty string, then the latexBabelPackage() + * method is used to generate the command for using the babel package. + */ + QCString latexLanguageSupportCommand() + { + return "\\usepackage[slovene]{babel} \n\\usepackage[latin2]{inputenc} \n\\usepackage[T1]{fontenc}\n"; + } + QCString latexBabelPackage() + { return "slovene"; } + QCString idLanguageCharset() + { +#ifdef _WIN32 + return "windows-1250"; +#else + return "iso-8859-2"; +#endif + } + QCString trRelatedFunctions() + { return "Povezane funkcije"; } + QCString trRelatedSubscript() + { return "(To niso metode.)"; } + QCString trDetailedDescription() + { return "Podroben opis"; } + QCString trMemberTypedefDocumentation() + { return "Opis uporabniško definiranih tipov (typedef) "; } + QCString trMemberEnumerationDocumentation() + { return "Opis naštevnih tipov članova"; } + QCString trEnumerationValueDocumentation() + { return "Opis naštevnih vednosti (enum) "; } + QCString trMemberFunctionDocumentation() + { return "Opis metod"; } + QCString trMemberDataDocumentation() + { return "Opis atributov"; } + QCString trGeneratedFrom(const char *s,bool single) + { + QCString result=(QCString)"Dokumentacija za "+s+ + "je generirana iz "; + if (single) result+="datoteke :"; else result+="naslednih datotek:"; + return result; + } + QCString trMore() + { return "..."; } + QCString trListOfAllMembers() + { return "Seznam vseh metod / atributov."; } + QCString trMemberList() + { return " - Seznam metod in atributov."; } + QCString trThisIsTheListOfAllMembers() + { return "To je seznam metod razreda "; } + QCString trIncludingInheritedMembers() + { return ", vključujoč dedovane metode in atribute."; } + QCString trGeneratedAutomatically(const char *s) + { QCString result="zgenerirano avtomatično z Doxygen-om"; + if (s) result+=(QCString)" za "+s; + result+=" iz programskog koda."; + return result; + } + QCString trEnumName() + { return "enum ime"; } + QCString trEnumValue() + { return "enum vrednost"; } + QCString trDefinedIn() + { return "definirano v"; } + QCString trVerbatimText(const char *f) + { return (QCString)"Ovo je citirani tekst iz include datoteke "+f+"."; } + QCString trModules() + { return "Moduli"; } + QCString trClassHierarchy() + { return "dedovalna hierarhija"; } + QCString trCompoundList() + { return "kratek opis razredov"; } + QCString trFileList() + { return "seznam datotek"; } + QCString trHeaderFiles() + { return "\"Header\" datoteka"; } + QCString trCompoundMembers() + { return "metode in atributi"; } + QCString trFileMembers() + { return "komponente v datotekah"; } + QCString trRelatedPages() + { return "Povezane strani"; } + QCString trExamples() + { return "Primeri"; } + QCString trSearch() + { return "Išči"; } + QCString trClassHierarchyDescription() + { return "Hierarhično drevo je (okvirno) sortirano po abecedi. "; + } + QCString trFileListDescription(bool extractAll) + { + QCString result="Seznam vseh "; + if (!extractAll) result+="dokumentiranih "; + result+="datotek, s kratkim opisom:"; + return result; + } + QCString trCompoundListDescription() + { return "Seznam razredov, množic in struktur " + "s kratkim opisom :"; + } + QCString trCompoundMembersDescription(bool extractAll) + { + QCString result="Seznam vseh "; + if (!extractAll) result+="dokumentiranih "; + result+="metod in atributov s povezavami na "; + if (extractAll) result+="opis posamezne metode in/ali atributa:"; + else result+="opis razreda :"; + return result; + } + QCString trFileMembersDescription(bool extractAll) + { + QCString result="Seznam "; + if (!extractAll) result+="dokumentiranih "; + result+="entite v datotekah "; + if (extractAll) result+="skupaj z opisom datoteke v kateri se nahajajo:"; + else result+="z linki na datoteke v katerih se nahajajo:"; + return result; + } + QCString trHeaderFilesDescription() + { return "Seznam header datotek, ki tvoriju aplikacijski vmesnik (API) :"; } + QCString trExamplesDescription() + { return "Seznam primerov :"; } + QCString trRelatedPagesDescription() + { return "Seznam povezanih strani:"; } + QCString trModulesDescription() + { return "Seznam modulov:"; } + QCString trNoDescriptionAvailable() + { return "Opis ni dostopen"; } + + QCString trDocumentation() + { return "Dokumentacija"; } + QCString trModuleIndex() + { return "seznam modulov"; } + QCString trHierarchicalIndex() + { return "Hierarhični indeks"; } + QCString trCompoundIndex() + { return "abecedni seznam"; } + QCString trFileIndex() + { return "seznam datotek"; } + QCString trModuleDocumentation() + { return "Dokumentacija modulov"; } + QCString trClassDocumentation() + { return "Opis razreda"; } + QCString trFileDocumentation() + { return "Opis datoteke"; } + QCString trExampleDocumentation() + { return "Opis primera"; } + QCString trPageDocumentation() + { return "Dokumentacija povezanih strani"; } + QCString trReferenceManual() + { return "Priročnik"; } + + QCString trDefines() + { return "Makro deklaracije"; } + QCString trFuncProtos() + { return "Prototipi funkcij"; } + QCString trTypedefs() + { return "Uporabniško definirani tipi"; } + QCString trEnumerations() + { return "Naštevni tipi"; } + QCString trFunctions() + { return "Funkcije"; } + QCString trVariables() + { return "Spremenljivke"; } + QCString trEnumerationValues() + { return "Vrednosti naštevnih tipov"; } + QCString trAuthor() + { return "avtor"; } + QCString trDefineDocumentation() + { return "Opis makro definicije"; } + QCString trFunctionPrototypeDocumentation() + { return "Opis prototipa funkcije"; } + QCString trTypedefDocumentation() + { return "Opis uporabniško definiranega tipa"; } + QCString trEnumerationTypeDocumentation() + { return "Opis naštevnega (enum) tipa"; } + QCString trFunctionDocumentation() + { return "Opis funkcije"; } + QCString trVariableDocumentation() + { return "Opis spremenljivke"; } + QCString trCompounds() + { return "Strukture"; } + QCString trFiles() + { return "Datoteke"; } + QCString trGeneratedAt(const char *date,const char *projName) + { + QCString result=(QCString)"Generirano "+date; + if (projName) result+=(QCString)" projekt: "+projName; + result+=(QCString)" generator: "; + return result; + } + QCString trWrittenBy() + { + return "napisal "; + } + QCString trClassDiagram(const char *clName) + { + return (QCString)"Diagram razredov za "+clName; + } + QCString trForInternalUseOnly() + { return "Samo za interno uporabo."; } + QCString trReimplementedForInternalReasons() + { return "Reimplementirano zbog internih razloga; " + "Nema utjecaja na API."; + } + QCString trWarning() + { return "Opozorilo"; } + QCString trBugsAndLimitations() + { return "Napake in omejtive"; } + QCString trVersion() + { return "Verzija"; } + QCString trDate() + { return "Datum"; } + QCString trAuthors() + { return "Avtor(ji)"; } + QCString trReturns() + { return "Rezultat(i)"; } + QCString trSeeAlso() + { return "Glej"; } + QCString trParameters() + { return "Parametri"; } + QCString trExceptions() + { return "Izjeme (Exceptions)"; } + QCString trGeneratedBy() + { return "Izdelano s pomočjo"; } + +////////////////////////////////////////////////////////////////////////// +// new since 0.49-990307 +////////////////////////////////////////////////////////////////////////// + + QCString trNamespaceList() + { return "Seznam imenskih prostorov"; } + QCString trNamespaceListDescription(bool extractAll) + { + QCString result="Seznam "; + if (!extractAll) result+="dokumentiranih "; + result+="imenskih prostorov z opisom:"; + return result; + } + QCString trFriends() + { return "Prijatelji (Friends) "; } + +////////////////////////////////////////////////////////////////////////// +// new since 0.49-990405 +////////////////////////////////////////////////////////////////////////// + + QCString trRelatedFunctionDocumentation() + { return "Podatki o poveznih funkcijah"; } + +////////////////////////////////////////////////////////////////////////// +// new since 0.49-990425 +////////////////////////////////////////////////////////////////////////// + + QCString trCompoundReference(const char *clName, + ClassDef::CompoundType compType, + bool /*isTemplate*/) + // used as the title of the HTML page of a class/struct/union + { + QCString result="Opis "; + switch(compType) + { + case ClassDef::Class: result+=" razreda "; break; + case ClassDef::Struct: result+=" strukture "; break; + case ClassDef::Union: result+=" unije "; break; + case ClassDef::Interface: result+=" vmesnika (interface) "; break; + case ClassDef::Exception: result+=" izjeme (exception) "; break; + } + result += (QCString)clName; + + return result; + } + QCString trFileReference(const char *fileName) + // used as the title of the HTML page of a file + { + QCString result="Vsebina datoteke "; + result+=fileName; + return result; + } + QCString trNamespaceReference(const char *namespaceName) + // used as the title of the HTML page of a namespace + { + QCString result ="Opis imenskega prostora "; + result+=namespaceName; + + return result; + } + + // these are for the member sections of a class, struct or union + QCString trPublicMembers() + { return "Javne metode"; } + QCString trPublicSlots() + { return "Public slotovi"; } + QCString trSignals() + { return "Programske prekinitve"; } + QCString trStaticPublicMembers() + { return "Statične javne metode in atributi"; } + QCString trProtectedMembers() + { return "Zaščitene metode in atributi"; } + QCString trProtectedSlots() + { return "Zaščiteni sloti"; } + QCString trStaticProtectedMembers() + { return "Statične zaščitene metode in atributi"; } + QCString trPrivateMembers() + { return "Skrite metode in atributi"; } + QCString trPrivateSlots() + { return "Skriti slotovi"; } + QCString trStaticPrivateMembers() + { return "Statične skrite metode in atributi"; } + // end of member sections + + QCString trWriteList(int numEntries) + { + // this function is used to produce a comma-separated list of items. + // use generateMarker(i) to indicate where item i should be put. + QCString result; + int i; + // the inherits list contain `numEntries' classes + for (i=0;i