Skip to content

D
doxverilog
Commit 016a22cd authored by dimitri's avatar dimitri
Browse files
Options

Release-1.5.6-20080727

parent f7e90abb
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 1614 additions and 1099 deletions
Doxyfile
View file @ 016a22cd
......@@ -7,7 +7,7 @@ DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = Doxygen
PROJECT_NUMBER =
OUTPUT_DIRECTORY = doxygen_docs
CREATE_SUBDIRS = YES
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
......@@ -144,7 +144,7 @@ HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO
GENERATE_HTMLHELP = YES
GENERATE_DOCSET = YES
DOCSET_FEEDNAME = "Doxygen docs"
DOCSET_BUNDLE_ID = org.doxygen.Doxygen
......@@ -161,7 +161,7 @@ TREEVIEW_WIDTH = 250
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX = YES
GENERATE_LATEX = NO
LATEX_OUTPUT =
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
......
INSTALL
View file @ 016a22cd
DOXYGEN Version 1.5.6-20080626
DOXYGEN Version 1.5.6-20080727
Please read the installation section of the manual
(http://www.doxygen.org/install.html) for instructions.
--------
Dimitri van Heesch (26 June 2008)
Dimitri van Heesch (27 July 2008)
README
View file @ 016a22cd
DOXYGEN Version 1.5.6_20080626
DOXYGEN Version 1.5.6_20080727
Please read INSTALL for compilation instructions.
......@@ -17,4 +17,4 @@ to subscribe to the lists or to visit the archives.
Enjoy,
Dimitri van Heesch (dimitri@stack.nl) (26 June 2008)
Dimitri van Heesch (dimitri@stack.nl) (27 July 2008)
configure
View file @ 016a22cd
......@@ -20,7 +20,7 @@ doxygen_version_minor=5
doxygen_version_revision=6
#NOTE: Setting version_mmn to "NO" will omit mmn info from the package.
doxygen_version_mmn=20080626
doxygen_version_mmn=20080727
bin_dirs=`echo $PATH | sed -e "s/:/ /g"`
......
doc/commands.doc
View file @ 016a22cd
......@@ -83,6 +83,7 @@ documentation:
\refitem cmdenum \\enum
\refitem cmdexample \\example
\refitem cmdexception \\exception
\refitem cmdextends \\extends
\refitem cmdfdollar \\f\$
\refitem cmdfbropen \\f[
\refitem cmdfbrclose \\f]
......@@ -97,6 +98,7 @@ documentation:
\refitem cmdif \\if
\refitem cmdifnot \\ifnot
\refitem cmdimage \\image
\refitem cmdimplements \\implements
\refitem cmdinclude \\include
\refitem cmdincludelineno \\includelineno
\refitem cmdingroup \\ingroup
......@@ -109,6 +111,7 @@ documentation:
\refitem cmdlink \\link
\refitem cmdmainpage \\mainpage
\refitem cmdmanonly \\manonly
\refitem cmdmemberof \\memberof
\refitem cmdmsc \\msc
\refitem cmdn \\n
\refitem cmdname \\name
......@@ -371,6 +374,23 @@ doxygen. Unrecognized commands are treated as normal text.
\sa section \ref cmdinclude "\\include".
<hr>
\section cmdextends \\extends <name>
\addindex \\extends
This command can be used to manually indicate an inheritance relation,
when the programming language does not support this concept natively
(e.g. C).
The file \c manual.c in the example directory shows how to use this command.
\htmlonly
Click <a href="$(DOXYGEN_DOCDIR)/examples/manual/html/index.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
\sa section \ref cmdimplements "\\implements" and section
\ref cmdmemberof "\\memberof"
<hr>
\section cmdfile \\file [<name>]
......@@ -455,6 +475,23 @@ doxygen. Unrecognized commands are treated as normal text.
\sa section \ref cmdshowinitializer "\\showinitializer".
<hr>
\section cmdimplements \\implements <name>
\addindex \\implements
This command can be used to manually indicate an inheritance relation,
when the programming language does not support this concept natively
(e.g. C).
The file \c manual.c in the example directory shows how to use this command.
\htmlonly
Click <a href="$(DOXYGEN_DOCDIR)/examples/manual/html/index.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
\sa section \ref cmdextends "\\extends" and section
\ref cmdmemberof "\\memberof"
<hr>
\section cmdingroup \\ingroup (<groupname> [<groupname> <groupname>])
......@@ -529,16 +566,37 @@ doxygen. Unrecognized commands are treated as normal text.
section \ref cmdsubsection "\\subsection" and
section \ref cmdpage "\\page".
<hr>
\section cmdmemberof \\memberof <name>
\addindex \\memberof
This command make a function a member of a class in a similar way
as \ref cmdrelates "\\relates" does, only with this command the function
is represented as a real member of the class.
This can be useful when the programming language does not support
the concept of member functions natively (e.g. C).
The file \c manual.c in the example directory shows how to use this command.
\htmlonly
Click <a href="$(DOXYGEN_DOCDIR)/examples/manual/html/index.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
\sa section \ref cmdextends "\\extends" and section
\ref cmdmemberof "\\memberof"
<hr>
\section cmdname \\name (header)
This command turns a comment block into a header
definition of a member group. The
comment block should be followed by a
<code>//\@{ ... //\@}</code> block containing the
members of the group.
\addindex \\name
This command turns a comment block into a header
definition of a member group. The
comment block should be followed by a
<code>//\@{ ... //\@}</code> block containing the
members of the group.
See section \ref memgroup for an example.
See section \ref memgroup for an example.
<hr>
\section cmdnamespace \\namespace <name>
......
doc/config.doc
View file @ 016a22cd
......@@ -90,6 +90,7 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_dot_transparent DOT_TRANSPARENT
\refitem cfg_dotfile_dirs DOTFILE_DIRS
\refitem cfg_doxyfile_encoding DOXYFILE_ENCODING
\refitem cfg_doxygen2qthelp_loc DOXYGEN2QTHELP_LOC
\refitem cfg_enable_preprocessing ENABLE_PREPROCESSING
\refitem cfg_enum_values_per_line ENUM_VALUES_PER_LINE
\refitem cfg_enabled_sections ENABLED_SECTIONS
......@@ -192,6 +193,8 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_project_name PROJECT_NAME
\refitem cfg_project_number PROJECT_NUMBER
\refitem cfg_qt_autobrief QT_AUTOBRIEF
\refitem cfg_qthelp_config QTHELP_CONFIG
\refitem cfg_qthelp_file QTHELP_FILE
\refitem cfg_quiet QUIET
\refitem cfg_recursive RECURSIVE
\refitem cfg_referenced_by_relation REFERENCED_BY_RELATION
......@@ -222,6 +225,7 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_strip_from_inc_path STRIP_FROM_INC_PATH
\refitem cfg_strip_from_path STRIP_FROM_PATH
\refitem cfg_subgrouping SUBGROUPING
\refitem cfg_symbol_cache_size SYMBOL_CACHE_SIZE
\refitem cfg_tab_size TAB_SIZE
\refitem cfg_tagfiles TAGFILES
\refitem cfg_template_relations TEMPLATE_RELATIONS
......@@ -569,6 +573,23 @@ sources. Doxygen will then generate output that is tailored for VHDL.
be useful for C code in case the coding convention dictates that all compound
types are typedef'ed and only the typedef is referenced, never the tag name.
\anchor cfg_symbol_cache_size
<dt>\c SYMBOL_CACHE_SIZE <dd>
\addindex SYMBOL_CACHE_SIZE
The \c SYMBOL_CACHE_SIZE determines the size of the internal cache use to
determine which symbols to keep in memory and which to flush to disk.
When the cache is full, less often used symbols will be written to disk.
For small to medium size projects (<1000 input files) the default value is
probably good enough. For larger projects a too small cache size can cause
doxygen to be busy swapping symbols to and from disk most of the time
causing a significant performance penality.
If the system has enough physical memory increasing the cache will improve the
performance by keeping more symbols in memory. Note that the value works on
a logarithmic scale so increasing the size by one will rougly double the
memory usage. The cache size is given by this formula:
\f$2^{(16+\mbox{SYMBOL\_CACHE\_SIZE})}\f$. The valid range is 0..9, the default is 0,
corresponding to a cache size of \f$2^{16} = 65536\f$ symbols.
</dl>
\section config_build Build related options
......@@ -1302,9 +1323,31 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"
\addindex HHC_LOCATION
If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c HHC_LOCATION tag can
be used to specify the location (absolute path including file name) of
the HTML help compiler (hhc.exe). If non empty doxygen will try to run
the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
the HTML help compiler on the generated index.hhp.
\anchor cfg_qthelp_file
<dt>\c QTHELP_FILE <dd>
\addindex QTHELP_FILE
If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c QTHELP_FILE tag can
be used to specify the file name of the resulting .(qch|qhp) file.
You can add a path in front of the file if the result should not be
written to the html output directory.
\anchor cfg_qthelp_config
<dt>\c QTHELP_CONFIG <dd>
\addindex QTHELP_CONFIG
If \c DOXYGEN2QTHELP_LOC is set, \c QTHELP_CONFIG must specify the file name
of a config file to pass to doxygen2qthelp.
\anchor cfg_doxygen2qthelp_loc
<dt>\c DOXYGEN2QTHELP_LOC <dd>
\addindex DOXYGEN2QTHELP_LOC
If the \c GENERATE_HTMLHELP tag is set to \c YES, the \c DOXYGEN2QTHELP_LOC tag
can be used to specify the location (absolute path including file name) of
the doxygen2qthelp tool. If non-empty doxygen will try to run doxygen2qthelp
on the generated index.hhp.
\anchor cfg_generate_chi
<dt>\c GENERATE_CHI <dd>
\addindex GENERATE_CHI
......
doc/docblocks.doc
View file @ 016a22cd
......@@ -166,23 +166,19 @@ for this case.
</ol>
As you can see doxygen is quite flexible. The following however is
not legal
As you can see doxygen is quite flexible. If you have multiple
detailed descriptions, like in the following example:
\verbatim
//! Brief description, which is
//! really a detailed description since it spans multiple lines.
/*! Oops, another detailed description!
/*! Another detailed description!
*/
\endverbatim
because doxygen only allows one brief and one detailed description.
Furthermore, if there is one brief description before a declaration
and one before a definition of a code item, only the one before
the \e declaration will be used. If the same situation occurs for a
detailed description, the one before the \e definition is preferred
and the one before the declaration will be ignored.
They will be joined. Note that this is also the case if the descriptions
are at different places in the code! In this case the order will depend
on the order in which doxygen parses the code.
Here is an example of a documented piece of C++ code using the Qt style:
\include qtstyle.cpp
......
doc/language.doc
View file @ 016a22cd
......@@ -73,7 +73,7 @@ when the translator was updated.
<td>Catalan</td>
<td>Maximiliano Pin<br>Albert Mora</td>
<td>max.pin at bitroit dot com<br>amora at iua dot upf dot es</td>
<td>1.5.4</td>
<td>up-to-date</td>
</tr>
<tr bgcolor="#ffffff">
<td>Chinese</td>
......@@ -235,7 +235,7 @@ when the translator was updated.
<td>Serbian</td>
<td>Dejan Milosavljevic</td>
<td>dmilos at email dot com</td>
<td>1.4.1</td>
<td>up-to-date</td>
</tr>
<tr bgcolor="#ffffff">
<td>SerbianCyrilic</td>
......@@ -294,7 +294,7 @@ when the translator was updated.
\hline
Brazilian Portuguese & Fabio "FJTC" Jun Takada Chino & {\tt\tiny jun-chino@uol.com.br} & up-to-date \\
\hline
Catalan & Maximiliano Pin & {\tt\tiny max.pin@bitroit.com} & 1.5.4 \\
Catalan & Maximiliano Pin & {\tt\tiny max.pin@bitroit.com} & up-to-date \\
~ & Albert Mora & {\tt\tiny amora@iua.upf.es} & ~ \\
\hline
Chinese & Li Daobing & {\tt\tiny lidaobing@gmail.com} & up-to-date \\
......@@ -360,7 +360,7 @@ when the translator was updated.
\hline
Russian & Alexandr Chelpanov & {\tt\tiny cav@cryptopro.ru} & up-to-date \\
\hline
Serbian & Dejan Milosavljevic & {\tt\tiny dmilos@email.com} & 1.4.1 \\
Serbian & Dejan Milosavljevic & {\tt\tiny dmilos@email.com} & up-to-date \\
\hline
SerbianCyrilic & Nedeljko Stefanovic & {\tt\tiny stenedjo@yahoo.com} & up-to-date \\
\hline
......
doc/translator_report.txt
View file @ 016a22cd
......@@ -9,7 +9,7 @@ German, Greek, Hungarian, Indonesian, Italian, Japanese (+En), Korean
Romanian, Russian, Serbian, SerbianCyrilic, Slovak, Slovene, Spanish,
Swedish, and Ukrainian.
Of them, 16 translators are up-to-date, 19 translators are based on
Of them, 18 translators are up-to-date, 17 translators are based on
some adapter class, and 2 are English based.
----------------------------------------------------------------------
......@@ -19,6 +19,7 @@ and they implement all 216 of the required methods. Anyway, there
still may be some details listed even for them:
TranslatorBrazilian
TranslatorCatalan
TranslatorChinesetraditional
TranslatorChinese
TranslatorCroatian
......@@ -33,6 +34,7 @@ still may be some details listed even for them:
TranslatorPersian
TranslatorRussian
TranslatorSerbianCyrilic
TranslatorSerbian
TranslatorSpanish -- Change the base class to Translator.
----------------------------------------------------------------------
......@@ -45,7 +47,6 @@ must be implemented to become up-to-date:
TranslatorGreek 1.5.4 22 methods to implement
TranslatorFrench 1.5.4 22 methods to implement
TranslatorDanish 1.5.4 22 methods to implement
TranslatorCatalan 1.5.4 22 methods to implement
TranslatorSwedish 1.4.6 24 methods to implement
TranslatorSlovene 1.4.6 24 methods to implement
TranslatorPolish 1.4.6 23 methods to implement
......@@ -56,7 +57,6 @@ must be implemented to become up-to-date:
TranslatorArabic 1.4.6 23 methods to implement
TranslatorAfrikaans 1.4.6 24 methods to implement
TranslatorUkrainian 1.4.1 24 methods to implement
TranslatorSerbian 1.4.1 24 methods to implement
TranslatorRomanian 1.4.1 24 methods to implement
TranslatorPortuguese 1.3.3 35 methods to implement
TranslatorSlovak 1.2.18 44 methods to implement
......@@ -152,37 +152,6 @@ TranslatorArabic (TranslatorAdapter_1_4_6) 23 methods to implement
virtual QCString trNoDescriptionAvailable()
TranslatorCatalan (TranslatorAdapter_1_5_4) 22 methods to implement
-----------------
Implements 194 of the required methods.
Missing methods (should be implemented):
virtual QCString trCompoundMembersDescriptionFortran(bool extractAll)
virtual QCString trGeneratedFromFilesFortran(ClassDef::CompoundType compType, bool single)
virtual QCString trSubprograms()
virtual QCString trModulesListDescription(bool extractAll)
virtual QCString trModulesList()
virtual QCString trTypeConstraints()
virtual QCString trMemberFunctionDocumentationFortran()
virtual QCString trCompoundListDescriptionFortran()
virtual QCString trTypeDocumentation()
virtual QCString trModuleReference(const char * namespaceName)
virtual QCString trModulesMemberDescription(bool extractAll)
virtual QCString trModulesMembers()
virtual QCString trModulesIndex()
virtual QCString trCompoundListFortran()
virtual QCString trDataTypes()
virtual QCString trCompoundIndexFortran()
virtual QCString trSubprogram(bool first_capital, bool singular)
virtual QCString trCompoundReferenceFortran(const char * clName, ClassDef::CompoundType compType, bool isTemplate)
virtual QCString trType(bool first_capital, bool singular)
virtual QCString trModule(bool first_capital, bool singular)
virtual QCString trCompoundMembersFortran()
virtual QCString trSubprogramDocumentation()
TranslatorDanish (TranslatorAdapter_1_5_4) 22 methods to implement
----------------
......@@ -658,51 +627,6 @@ TranslatorRomanian (TranslatorAdapter_1_4_1) 24 methods to implement
virtual QCString trNoDescriptionAvailable()
TranslatorSerbian (TranslatorAdapter_1_4_1) 24 methods to implement
-----------------
Implements 192 of the required methods.
Missing methods (should be implemented):
virtual QCString trCompoundMembersDescriptionFortran(bool extractAll)
virtual QCString trOverloadText()
virtual QCString trGeneratedFromFilesFortran(ClassDef::CompoundType compType, bool single)
virtual QCString trSubprograms()
virtual QCString trModulesListDescription(bool extractAll)
virtual QCString trModulesList()
virtual QCString trTypeConstraints()
virtual QCString trMemberFunctionDocumentationFortran()
virtual QCString trCompoundListDescriptionFortran()
virtual QCString trTypeDocumentation()
virtual QCString trModuleReference(const char * namespaceName)
virtual QCString trModulesMemberDescription(bool extractAll)
virtual QCString trModulesMembers()
virtual QCString trModulesIndex()
virtual QCString trCompoundListFortran()
virtual QCString trDataTypes()
virtual QCString trCompoundIndexFortran()
virtual QCString trSubprogram(bool first_capital, bool singular)
virtual QCString trCallerGraph()
virtual QCString trCompoundReferenceFortran(const char * clName, ClassDef::CompoundType compType, bool isTemplate)
virtual QCString trType(bool first_capital, bool singular)
virtual QCString trModule(bool first_capital, bool singular)
virtual QCString trCompoundMembersFortran()
virtual QCString trSubprogramDocumentation()
Obsolete methods (should be removed, never used):
virtual QCString trHeaderFilesDescription()
virtual QCString trField(bool first_capital, bool singular)
virtual QCString trPackageDocumentation()
virtual QCString trSources()
virtual QCString trReimplementedForInternalReasons()
virtual QCString trInterfaces()
virtual QCString trHeaderFiles()
virtual QCString trBugsAndLimitations()
virtual QCString trNoDescriptionAvailable()
TranslatorSlovak (TranslatorAdapter_1_2_18) 44 methods to implement
----------------
......
examples/Makefile.in
View file @ 016a22cd
......@@ -24,13 +24,14 @@ all: class/html/index.html \
memgrp/html/index.html \
docstring/html/index.html \
pyexample/html/index.html \
mux/html/index.html
mux/html/index.html \
manual/html/index.html
clean:
rm -rf class define enum file func page relates author \
par overload example include qtstyle jdstyle structcmd \
autolink tag restypedef afterdoc template tag group diagrams \
memgrp docstring pyexample mux
memgrp docstring pyexample mux manual
class/html/index.html: class.h class.cfg
$(DOXYGEN)/bin/doxygen class.cfg
......@@ -106,6 +107,9 @@ pyexample/html/index.html: pyexample.py pyexample.cfg
mux/html/index.html: mux.vhdl mux.cfg
$(DOXYGEN)/bin/doxygen mux.cfg
manual/html/index.html: manual.c manual.cfg
$(DOXYGEN)/bin/doxygen manual.cfg
docstring/html/index.html: docstring.py docstring.cfg
$(DOXYGEN)/bin/doxygen docstring.cfg
......
examples/Makefile.win.in
View file @ 016a22cd
......@@ -25,13 +25,14 @@ all: class/html/index.html \
memgrp/html/index.html \
docstring/html/index.html \
pyexample/html/index.html \
mux/html/index.html
mux/html/index.html \
manual/html/index.html
clean:
del /s/y class define enum file pyexample docstring
del /s/y func page relates author
del /s/y par overload example include qtstyle
del /s/y jdstyle structcmd autolink resdefine mux
del /s/y jdstyle structcmd autolink resdefine mux manual
del /s/y restypedef afterdoc template tag group diagrams memgrp
class/html/index.html: class.h class.cfg
......@@ -106,6 +107,9 @@ pyexample/html/index.html: pyexample.py pyexample.cfg
mux/html/index.html: mux.vhdl mux.cfg
$(DOXYDIR)\doxygen mux.cfg
manual/html/index.html: manual.c manual.cfg
$(DOXYDIR)\doxygen manual.cfg
docstring/html/index.html: docstring.py docstring.cfg
$(DOXYDIR)\doxygen docstring.cfg
......
examples/manual.c 0 → 100644
View file @ 016a22cd
/**
* \file manual.c
*/
typedef struct Object Object; //!< Object type
typedef struct Vehicle Vehicle; //!< Vehicle type
typedef struct Car Car; //!< Car type
typedef struct Truck Truck; //!< Truck type
/*!
* Base object class.
*/
struct Object
{
int ref; //!< \private Reference count.
};
/*!
* Increments object reference count by one.
* \public \memberof Object
*/
static Object * objRef(Object *obj);
/*!
* Decrements object reference count by one.
* \public \memberof Object
*/
static Object * objUnref(Object *obj);
/*!
* Vehicle class.
* \extends Object
*/
struct Vehicle
{
Object base; //!< \protected Base class.
};
/*!
* Starts the vehicle.
* \public \memberof Vehicle
*/
void vehicleStart(Vehicle *obj);
/*!
* Stops the vehicle.
* \public \memberof Vehicle
*/
void vehicleStop(Vehicle *obj);
/*!
* Car class.
* \extends Vehicle
*/
struct Car
{
Vehicle base; //!< \protected Base class.
};
/*!
* Truck class.
* \extends Vehicle
*/
struct Truck
{
Vehicle base; //!< \protected Base class.
};
/*!
* Main function.
*
* Ref vehicleStart(), objRef(), objUnref().
*/
int main(void)
{
Car c;
vehicleStart((Vehicle*) &c);
}
examples/manual.cfg 0 → 100644
View file @ 016a22cd
PROJECT_NAME = "Manual inheritance and membership"
OUTPUT_DIRECTORY = manual
GENERATE_LATEX = NO
GENERATE_MAN = NO
GENERATE_RTF = NO
CASE_SENSE_NAMES = NO
INPUT = manual.c
QUIET = YES
JAVADOC_AUTOBRIEF = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
TYPEDEF_HIDES_STRUCT = YES
INLINE_SOURCES = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
src/classdef.cpp
View file @ 016a22cd
......@@ -374,40 +374,40 @@ void ClassDef::internalInsertMember(MemberDef *md,
/********************************************/
if (md->isRelated() && (extractPrivate || prot!=Private))
{
addMemberToList(MemberList::related,md);
addMemberToList(MemberList::related,md,true);
}
else if (md->isFriend())
{
addMemberToList(MemberList::friends,md);
addMemberToList(MemberList::friends,md,true);
}
else
{
switch (md->memberType())
{
case MemberDef::Signal: // Qt specific
addMemberToList(MemberList::signals,md);
addMemberToList(MemberList::signals,md,true);
break;
case MemberDef::DCOP: // KDE2 specific
addMemberToList(MemberList::dcopMethods,md);
addMemberToList(MemberList::dcopMethods,md,true);
break;
case MemberDef::Property:
addMemberToList(MemberList::properties,md);
addMemberToList(MemberList::properties,md,true);
break;
case MemberDef::Event:
addMemberToList(MemberList::events,md);
addMemberToList(MemberList::events,md,true);
break;
case MemberDef::Slot: // Qt specific
switch (prot)
{
case Protected:
case Package: // slots in packages are not possible!
addMemberToList(MemberList::proSlots,md);
addMemberToList(MemberList::proSlots,md,true);
break;
case Public:
addMemberToList(MemberList::pubSlots,md);
addMemberToList(MemberList::pubSlots,md,true);
break;
case Private:
addMemberToList(MemberList::priSlots,md);
addMemberToList(MemberList::priSlots,md,true);
break;
}
break;
......@@ -419,16 +419,16 @@ void ClassDef::internalInsertMember(MemberDef *md,
switch (prot)
{
case Protected:
addMemberToList(MemberList::proStaticAttribs,md);
addMemberToList(MemberList::proStaticAttribs,md,true);
break;
case Package:
addMemberToList(MemberList::pacStaticAttribs,md);
addMemberToList(MemberList::pacStaticAttribs,md,true);
break;
case Public:
addMemberToList(MemberList::pubStaticAttribs,md);
addMemberToList(MemberList::pubStaticAttribs,md,true);
break;
case Private:
addMemberToList(MemberList::priStaticAttribs,md);
addMemberToList(MemberList::priStaticAttribs,md,true);
break;
}
}
......@@ -437,16 +437,16 @@ void ClassDef::internalInsertMember(MemberDef *md,
switch (prot)
{
case Protected:
addMemberToList(MemberList::proStaticMethods,md);
addMemberToList(MemberList::proStaticMethods,md,true);
break;
case Package:
addMemberToList(MemberList::pacStaticMethods,md);
addMemberToList(MemberList::pacStaticMethods,md,true);
break;
case Public:
addMemberToList(MemberList::pubStaticMethods,md);
addMemberToList(MemberList::pubStaticMethods,md,true);
break;
case Private:
addMemberToList(MemberList::priStaticMethods,md);
addMemberToList(MemberList::priStaticMethods,md,true);
break;
}
}
......@@ -458,16 +458,16 @@ void ClassDef::internalInsertMember(MemberDef *md,
switch (prot)
{
case Protected:
addMemberToList(MemberList::proAttribs,md);
addMemberToList(MemberList::proAttribs,md,true);
break;
case Package:
addMemberToList(MemberList::pacAttribs,md);
addMemberToList(MemberList::pacAttribs,md,true);
break;
case Public:
addMemberToList(MemberList::pubAttribs,md);
addMemberToList(MemberList::pubAttribs,md,true);
break;
case Private:
addMemberToList(MemberList::priAttribs,md);
addMemberToList(MemberList::priAttribs,md,true);
break;
}
}
......@@ -476,16 +476,16 @@ void ClassDef::internalInsertMember(MemberDef *md,
switch (prot)
{
case Protected:
addMemberToList(MemberList::proTypes,md);
addMemberToList(MemberList::proTypes,md,true);
break;
case Package:
addMemberToList(MemberList::pacTypes,md);
addMemberToList(MemberList::pacTypes,md,true);
break;
case Public:
addMemberToList(MemberList::pubTypes,md);
addMemberToList(MemberList::pubTypes,md,true);
break;
case Private:
addMemberToList(MemberList::priTypes,md);
addMemberToList(MemberList::priTypes,md,true);
break;
}
}
......@@ -494,16 +494,16 @@ void ClassDef::internalInsertMember(MemberDef *md,
switch (prot)
{
case Protected:
addMemberToList(MemberList::proMethods,md);
addMemberToList(MemberList::proMethods,md,true);
break;
case Package:
addMemberToList(MemberList::pacMethods,md);
addMemberToList(MemberList::pacMethods,md,true);
break;
case Public:
addMemberToList(MemberList::pubMethods,md);
addMemberToList(MemberList::pubMethods,md,true);
break;
case Private:
addMemberToList(MemberList::priMethods,md);
addMemberToList(MemberList::priMethods,md,true);
break;
}
}
......@@ -517,21 +517,21 @@ void ClassDef::internalInsertMember(MemberDef *md,
/*******************************************************/
if ((md->isRelated() && (extractPrivate || prot!=Private)) || md->isFriend())
{
addMemberToList(MemberList::relatedMembers,md);
addMemberToList(MemberList::relatedMembers,md,false);
}
else
{
switch (md->memberType())
{
case MemberDef::Property:
addMemberToList(MemberList::propertyMembers,md);
addMemberToList(MemberList::propertyMembers,md,false);
break;
case MemberDef::Event:
addMemberToList(MemberList::eventMembers,md);
addMemberToList(MemberList::eventMembers,md,false);
break;
case MemberDef::Signal: // fall through
case MemberDef::DCOP:
addMemberToList(MemberList::functionMembers,md);
addMemberToList(MemberList::functionMembers,md,false);
break;
case MemberDef::Slot:
switch (prot)
......@@ -539,12 +539,12 @@ void ClassDef::internalInsertMember(MemberDef *md,
case Protected:
case Package:
case Public:
addMemberToList(MemberList::functionMembers,md);
addMemberToList(MemberList::functionMembers,md,false);
break;
case Private:
if (extractPrivate)
{
addMemberToList(MemberList::functionMembers,md);
addMemberToList(MemberList::functionMembers,md,false);
}
break;
}
......@@ -555,13 +555,13 @@ void ClassDef::internalInsertMember(MemberDef *md,
switch (md->memberType())
{
case MemberDef::Typedef:
addMemberToList(MemberList::typedefMembers,md);
addMemberToList(MemberList::typedefMembers,md,false);
break;
case MemberDef::Enumeration:
addMemberToList(MemberList::enumMembers,md);
addMemberToList(MemberList::enumMembers,md,false);
break;
case MemberDef::EnumValue:
addMemberToList(MemberList::enumValMembers,md);
addMemberToList(MemberList::enumValMembers,md,false);
break;
case MemberDef::Function:
if (md->isConstructor() || md->isDestructor())
......@@ -571,11 +571,11 @@ void ClassDef::internalInsertMember(MemberDef *md,
}
else
{
addMemberToList(MemberList::functionMembers,md);
addMemberToList(MemberList::functionMembers,md,false);
}
break;
case MemberDef::Variable:
addMemberToList(MemberList::variableMembers,md);
addMemberToList(MemberList::variableMembers,md,false);
break;
default:
err("Unexpected member type %d found!\n",md->memberType());
......@@ -3168,11 +3168,14 @@ MemberList *ClassDef::getMemberList(MemberList::ListType lt)
return 0;
}
void ClassDef::addMemberToList(MemberList::ListType lt,MemberDef *md)
void ClassDef::addMemberToList(MemberList::ListType lt,MemberDef *md,bool isBrief)
{
static bool sortBriefDocs = Config_getBool("SORT_BRIEF_DOCS");
static bool sortMemberDocs = Config_getBool("SORT_MEMBER_DOCS");
MemberList *ml = createMemberList(lt);
if (sortBriefDocs)
if (( isBrief && sortBriefDocs ) ||
(!isBrief && sortMemberDocs)
)
ml->inSort(md);
else
ml->append(md);
......
src/classdef.h
View file @ 016a22cd
......@@ -327,7 +327,7 @@ class ClassDef : public Definition
private:
void internalInsertMember(MemberDef *md,Protection prot,bool addToAllList);
QCString getMemberListFileName() const;
void addMemberToList(MemberList::ListType lt,MemberDef *md);
void addMemberToList(MemberList::ListType lt,MemberDef *md,bool isBrief);
MemberList *createMemberList(MemberList::ListType lt);
void writeMemberDeclarations(OutputList &ol,MemberList::ListType lt,const QCString &title,
const char *subTitle=0);
......
src/commentscan.l
View file @ 016a22cd
......@@ -79,6 +79,7 @@ static bool handleDeprecated(const QCString &);
static bool handleXRefItem(const QCString &);
static bool handleRelated(const QCString &);
static bool handleRelatedAlso(const QCString &);
static bool handleMemberOf(const QCString &);
static bool handleRefItem(const QCString &);
static bool handleSection(const QCString &);
static bool handleAnchor(const QCString &);
......@@ -106,6 +107,7 @@ static bool handleProtectedSection(const QCString &);
static bool handlePublic(const QCString &s);
static bool handlePublicSection(const QCString &s);
static bool handleInherit(const QCString &);
static bool handleExtends(const QCString &);
typedef bool (*DocCmdFunc)(const QCString &name);
......@@ -197,6 +199,9 @@ static DocCmdMap docCmdMap[] =
{ "public", &handlePublic, FALSE },
{ "publicsection", &handlePublicSection, FALSE },
{ "inherit", &handleInherit, TRUE },
{ "extends", &handleExtends, TRUE },
{ "implements", &handleExtends, TRUE },
{ "memberof", &handleMemberOf, TRUE },
{ "arg", 0, TRUE },
{ "attention", 0, TRUE },
{ "author", 0, TRUE },
......@@ -840,6 +845,7 @@ RCSTAG "$"{ID}":"[^\n$]+"$"
%x FnParam
%x OverloadParam
%x InheritParam
%x ExtendsParam
%x ReadFormulaShort
%x ReadFormulaLong
%x AnchorLabel
......@@ -920,7 +926,7 @@ RCSTAG "$"{ID}":"[^\n$]+"$"
{
if (cmdPtr->endsBrief)
{
briefEndsAtDot=FALSE;
briefEndsAtDot=FALSE;
// this command forces the end of brief description
setOutput(OutputDoc);
}
......@@ -1366,7 +1372,7 @@ RCSTAG "$"{ID}":"[^\n$]+"$"
}
/* --------- handle arguments of the relates(also) command ------------ */
/* ----- handle arguments of the relates(also)/memberof command ------- */
<RelatesParam1>({ID}("::"|"."))*{ID} { // argument
current->relates = yytext;
......@@ -1382,7 +1388,7 @@ RCSTAG "$"{ID}":"[^\n$]+"$"
}
<RelatesParam1>{DOCNL} { // missing argument
warn(yyFileName,yyLineNr,
"Warning: Missing argument of \\relates command"
"Warning: Missing argument of \\relates or \\memberof command"
);
if (*yytext=='\n') yyLineNr++;
addOutput('\n');
......@@ -1800,6 +1806,25 @@ RCSTAG "$"{ID}":"[^\n$]+"$"
BEGIN(Comment);
}
/* ----- handle argument of extends and implements commands ------- */
<ExtendsParam>({ID}("::"|"."))*{ID} { // found argument
current->extends->append(
new BaseInfo(removeRedundantWhiteSpace(yytext),Public,Normal)
);
BEGIN( Comment );
}
<ExtendsParam>{DOCNL} { // missing argument
warn(yyFileName,yyLineNr,
"Warning: \\extends or \\implements command has no argument"
);
if (*yytext=='\n') yyLineNr++;
addOutput('\n');
BEGIN( Comment );
}
<ExtendsParam>. { // ignore other stuff
}
/* ----- handle language specific sections ------- */
<SkipLang>[\\@]"~"[a-zA-Z]* { /* language switch */
......@@ -2060,7 +2085,14 @@ static bool handleRelated(const QCString &)
static bool handleRelatedAlso(const QCString &)
{
current->relatesDup = TRUE;
current->relatesType = Duplicate;
BEGIN(RelatesParam1);
return FALSE;
}
static bool handleMemberOf(const QCString &)
{
current->relatesType = MemberOf;
BEGIN(RelatesParam1);
return FALSE;
}
......@@ -2257,53 +2289,52 @@ static bool handlePure(const QCString &)
static bool handlePrivate(const QCString &)
{
endBrief();
current->protection = Private;
current->protection = Private;
return FALSE;
}
static bool handlePrivateSection(const QCString &)
{
endBrief();
current->protection = protection = Private;
current->protection = protection = Private;
return FALSE;
}
static bool handleProtected(const QCString &)
{
endBrief();
current->protection = Protected;
current->protection = Protected;
return FALSE;
}
static bool handleProtectedSection(const QCString &)
{
endBrief();
current->protection = protection = Protected ;
return FALSE;
}
static bool handlePublic(const QCString &)
{
endBrief();
current->protection = Public;
return FALSE;
}
static bool handlePublicSection(const QCString &)
{
endBrief();
current->protection = protection = Public;
current->protection = protection = Public;
return FALSE;
}
static bool handleInherit(const QCString &)
{
endBrief();
BEGIN(InheritParam);
return FALSE;
}
static bool handleExtends(const QCString &)
{
BEGIN(ExtendsParam);
return FALSE;
}
//----------------------------------------------------------------------------
static void checkFormula()
......
src/config.l
View file @ 016a22cd
......@@ -1779,6 +1779,24 @@ void Config::create()
"types are typedef'ed and only the typedef is referenced, never the tag name.\n",
FALSE
);
ci = addInt(
"SYMBOL_CACHE_SIZE",
"The SYMBOL_CACHE_SIZE determines the size of the internal cache use to \n"
"determine which symbols to keep in memory and which to flush to disk.\n"
"When the cache is full, less often used symbols will be written to disk.\n"
"For small to medium size projects (<1000 input files) the default value is \n"
"probably good enough. For larger projects a too small cache size can cause \n"
"doxygen to be busy swapping symbols to and from disk most of the time \n"
"causing a significant performance penality. \n"
"If the system has enough physical memory increasing the cache will improve the \n"
"performance by keeping more symbols in memory. Note that the value works on \n"
"a logarithmic scale so increasing the size by one will rougly double the \n"
"memory usage. The cache size is given by this formula: \n"
"2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, \n"
"corresponding to a cache size of 2^16 = 65536 symbols\n",
0,9,0
);
//-----------------------------------------------------------------------------------------------
addInfo("Build","Build related configuration options");
//-----------------------------------------------------------------------------------------------
......@@ -2410,6 +2428,31 @@ void Config::create()
);
cs->setWidgetType(ConfigString::File);
cs->addDependency("GENERATE_HTML");
cs = addString(
"QTHELP_FILE",
"If the GENERATE_HTMLHELP tag is set to YES, the QTHELP_FILE tag can \n"
"be used to specify the file name of the resulting .(qch|qhp) file. \n"
"You can add a path in front of the file if the result should not be \n"
"written to the html output directory. \n"
);
cs->setWidgetType(ConfigString::File);
cs->addDependency("GENERATE_HTML");
cs = addString(
"QTHELP_CONFIG",
"If DOXYGEN2QTHELP_LOC is set, QTHELP_CONFIG must specify the file name \n"
"of a config file to pass to doxygen2qthelp. \n"
);
cs->setWidgetType(ConfigString::File);
cs->addDependency("GENERATE_HTML");
cs = addString(
"DOXYGEN2QTHELP_LOC",
"If the GENERATE_HTMLHELP tag is set to YES, the DOXYGEN2QTHELP_LOC tag \n"
"can be used to specify the location (absolute path including file name) of \n"
"the doxygen2qthelp tool. If non-empty doxygen will try to run doxygen2qthelp \n"
"on the generated index.hhp.\n"
);
cs->setWidgetType(ConfigString::File);
cs->addDependency("GENERATE_HTML");
cb = addBool(
"GENERATE_CHI",
"If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag \n"
......
src/doxygen.cpp
View file @ 016a22cd
This diff is collapsed.
src/doxygen.css
View file @ 016a22cd
This diff is collapsed.
src/doxygen_css.h
View file @ 016a22cd
This diff is collapsed.
src/entry.cpp
View file @ 016a22cd
......@@ -69,7 +69,7 @@ Entry::Entry()
mGrpId = -1;
tagInfo = 0;
sli = 0;
relatesDup = FALSE;
relatesType = Simple;
hidden = FALSE;
groupDocType = GROUPDOC_NORMAL;
reset();
......@@ -98,7 +98,7 @@ Entry::Entry(const Entry &e)
docLine = e.docLine;
docFile = e.docFile.copy();
relates = e.relates.copy();
relatesDup = e.relatesDup;
relatesType = e.relatesType;
read = e.read.copy();
write = e.write.copy();
brief = e.brief.copy();
......@@ -255,7 +255,7 @@ void Entry::reset()
docFile.resize(0);
docLine=-1;
relates.resize(0);
relatesDup=FALSE;
relatesType=Simple;
brief.resize(0);
briefFile.resize(0);
briefLine=-1;
......
src/entry.h
View file @ 016a22cd
......@@ -33,6 +33,8 @@ class StorageIntf;
enum Protection { Public, Protected, Private, Package } ;
enum Specifier { Normal, Virtual, Pure } ;
enum MethodTypes { Method, Signal, Slot, DCOP, Property, Event };
enum RelatesType { Simple, Duplicate, MemberOf };
enum Relationship { Member, Related, Foreign };
struct ListItemInfo
{
......@@ -350,7 +352,7 @@ class Entry
int inbodyLine; //!< line number at which the body doc was found
QCString inbodyFile; //!< file in which the body doc was found
QCString relates; //!< related class (doc block)
bool relatesDup; //!< keep duplicate doc in original file also
RelatesType relatesType; //!< how relates is handled
QCString read; //!< property read accessor
QCString write; //!< property write accessor
QCString inside; //!< name of the class in which documents are found
......
src/groupdef.cpp
View file @ 016a22cd
......@@ -1162,8 +1162,16 @@ MemberList *GroupDef::getMemberList(MemberList::ListType lt) const
void GroupDef::writeMemberDeclarations(OutputList &ol,MemberList::ListType lt,const QCString &title)
{
static bool optimizeVhdl = Config_getBool("OPTIMIZE_OUTPUT_VHDL");
MemberList * ml = getMemberList(lt);
if (ml) ml->writeDeclarations(ol,0,0,0,this,title,0);
if (optimizeVhdl && ml)
{
VhdlDocGen::writeVhdlDeclarations(ml,ol,this,0);
return;
}
if (ml)
ml->writeDeclarations(ol,0,0,0,this,title,0);
}
void GroupDef::writeMemberDocumentation(OutputList &ol,MemberList::ListType lt,const QCString &title)
......
src/increasebuffer.pl
View file @ 016a22cd
......@@ -4,5 +4,6 @@
while (<>)
{
s/YY_BUF_SIZE 16384/YY_BUF_SIZE 262144/g;
s/YY_READ_BUF_SIZE 8192/YY_READ_BUF_SIZE 262144/g;
print $_;
}
src/index.cpp
View file @ 016a22cd
......@@ -1577,7 +1577,8 @@ void addClassMemberNameToIndex(MemberDef *md)
g_memberIndexLetterUsed[CMHL_Events][letter].append(md);
documentedClassMembers[CMHL_Events]++;
}
else if (md->isRelated() || (md->isFriend() && !isFriendToHide))
else if (md->isRelated() || md->isForeign() ||
(md->isFriend() && !isFriendToHide))
{
g_memberIndexLetterUsed[CMHL_Related][letter].append(md);
documentedClassMembers[CMHL_Related]++;
......@@ -2954,7 +2955,8 @@ void writeIndex(OutputList &ol)
for (pdi.toFirst();(pd=pdi.current());++pdi)
{
if (!pd->getGroupDef() && !pd->isReference() &&
!pd->hasParentPage()
(!pd->hasParentPage() || // not inside other page
(Doxygen::mainPage==pd->getOuterScope())) // or inside main page
)
{
QCString title = pd->title();
......
src/language.cpp
View file @ 016a22cd
......@@ -340,7 +340,7 @@ bool setTranslator(const char *langName)
#ifdef LANG_CA
else if (L_EQUAL("catalan"))
{
theTranslator=new TranslatorDecoder(new TranslatorCatalan);
theTranslator=new TranslatorCatalan;
}
#endif
#ifdef LANG_LT
......
src/marshal.cpp
View file @ 016a22cd
......@@ -395,7 +395,7 @@ void marshalEntry(StorageIntf *s,Entry *e)
marshalInt(s,e->inbodyLine);
marshalQCString(s,e->inbodyFile);
marshalQCString(s,e->relates);
marshalBool(s,e->relatesDup);
marshalInt(s,e->relatesType);
marshalQCString(s,e->read);
marshalQCString(s,e->write);
marshalQCString(s,e->inside);
......@@ -788,7 +788,7 @@ Entry * unmarshalEntry(StorageIntf *s)
e->inbodyLine = unmarshalInt(s);
e->inbodyFile = unmarshalQCString(s);
e->relates = unmarshalQCString(s);
e->relatesDup = unmarshalBool(s);
e->relatesType = (RelatesType)unmarshalInt(s);
e->read = unmarshalQCString(s);
e->write = unmarshalQCString(s);
e->inside = unmarshalQCString(s);
......
src/memberdef.cpp
View file @ 016a22cd
......@@ -306,8 +306,9 @@ class MemberDefImpl
MemberDefImpl();
~MemberDefImpl();
void init(Definition *def,const char *t,const char *a,const char *e,
Protection p,Specifier v,bool s,bool r,MemberDef::MemberType mt,
const ArgumentList *tal,const ArgumentList *al
Protection p,Specifier v,bool s,Relationship r,
MemberDef::MemberType mt,const ArgumentList *tal,
const ArgumentList *al
);
ClassDef *classDef; // member of or related to
......@@ -395,7 +396,7 @@ class MemberDefImpl
bool hasDocumentedParams;
bool hasDocumentedReturnType;
bool isDMember;
bool related; // is this a member that is only related to a class
Relationship related; // relationship of this to the class
bool stat; // is it a static function?
bool proto; // is it a prototype;
bool docEnumValues; // is an enum with documented enum values.
......@@ -439,8 +440,9 @@ MemberDefImpl::~MemberDefImpl()
void MemberDefImpl::init(Definition *def,
const char *t,const char *a,const char *e,
Protection p,Specifier v,bool s,bool r,MemberDef::MemberType mt,
const ArgumentList *tal,const ArgumentList *al
Protection p,Specifier v,bool s,Relationship r,
MemberDef::MemberType mt,const ArgumentList *tal,
const ArgumentList *al
)
{
classDef=0;
......@@ -572,7 +574,7 @@ void MemberDefImpl::init(Definition *def,
* \param v The degree of `virtualness' of the member, possible values are:
* \c Normal, \c Virtual, \c Pure.
* \param s A boolean that is true iff the member is static.
* \param r A boolean that is true iff the member is only related.
* \param r The relationship between the class and the member.
* \param mt The kind of member. See #MemberDef::MemberType for a list of
* all types.
* \param tal The template arguments of this member.
......@@ -582,7 +584,7 @@ void MemberDefImpl::init(Definition *def,
MemberDef::MemberDef(const char *df,int dl,
const char *t,const char *na,const char *a,const char *e,
Protection p,Specifier v,bool s,bool r,MemberType mt,
Protection p,Specifier v,bool s,Relationship r,MemberType mt,
const ArgumentList *tal,const ArgumentList *al
) : Definition(df,dl,removeRedundantWhiteSpace(na))
{
......@@ -3201,7 +3203,13 @@ bool MemberDef::isEvent() const
bool MemberDef::isRelated() const
{
makeResident();
return m_impl->related;
return m_impl->related == Related;
}
bool MemberDef::isForeign() const
{
makeResident();
return m_impl->related == Foreign;
}
bool MemberDef::isStatic() const
......@@ -3638,7 +3646,13 @@ void MemberDef::setTemplateSpecialization(bool b)
void MemberDef::makeRelated()
{
makeResident();
m_impl->related=TRUE;
m_impl->related = Related;
}
void MemberDef::makeForeign()
{
makeResident();
m_impl->related = Foreign;
}
void MemberDef::setHasDocumentedParams(bool b)
......@@ -3838,7 +3852,7 @@ void MemberDef::flushToDisk() const
marshalBool (Doxygen::symbolStorage,m_impl->hasDocumentedParams);
marshalBool (Doxygen::symbolStorage,m_impl->hasDocumentedReturnType);
marshalBool (Doxygen::symbolStorage,m_impl->isDMember);
marshalBool (Doxygen::symbolStorage,m_impl->related);
marshalInt (Doxygen::symbolStorage,(int)m_impl->related);
marshalBool (Doxygen::symbolStorage,m_impl->stat);
marshalBool (Doxygen::symbolStorage,m_impl->proto);
marshalBool (Doxygen::symbolStorage,m_impl->docEnumValues);
......@@ -3938,7 +3952,7 @@ void MemberDef::loadFromDisk() const
m_impl->hasDocumentedParams = unmarshalBool (Doxygen::symbolStorage);
m_impl->hasDocumentedReturnType = unmarshalBool (Doxygen::symbolStorage);
m_impl->isDMember = unmarshalBool (Doxygen::symbolStorage);
m_impl->related = unmarshalBool (Doxygen::symbolStorage);
m_impl->related = (Relationship)unmarshalInt(Doxygen::symbolStorage);
m_impl->stat = unmarshalBool (Doxygen::symbolStorage);
m_impl->proto = unmarshalBool (Doxygen::symbolStorage);
m_impl->docEnumValues = unmarshalBool (Doxygen::symbolStorage);
......
src/memberdef.h
View file @ 016a22cd
......@@ -69,7 +69,7 @@ class MemberDef : public Definition
MemberDef(const char *defFileName,int defLine,
const char *type,const char *name,const char *args,
const char *excp,Protection prot,Specifier virt,bool stat,
bool related,MemberType t,const ArgumentList *tal,
Relationship related,MemberType t,const ArgumentList *tal,
const ArgumentList *al);
~MemberDef();
DefType definitionType() const { return TypeMember; }
......@@ -133,6 +133,7 @@ class MemberDef : public Definition
bool isProperty() const;
bool isEvent() const;
bool isRelated() const;
bool isForeign() const;
bool isStatic() const;
bool isInline() const;
bool isExplicit() const;
......@@ -257,6 +258,7 @@ class MemberDef : public Definition
void setTemplateSpecialization(bool b);
void makeRelated();
void makeForeign();
void setHasDocumentedParams(bool b);
void setHasDocumentedReturnType(bool b);
void setInheritsDocsFrom(MemberDef *md);
......
src/pagedef.cpp
View file @ 016a22cd
......@@ -49,7 +49,14 @@ void PageDef::addInnerCompound(Definition *def)
PageDef *pd = (PageDef*)def;
m_subPageDict->append(pd->name(),pd);
def->setOuterScope(this);
pd->setNestingLevel(m_nestingLevel+1);
if (this==Doxygen::mainPage)
{
pd->setNestingLevel(m_nestingLevel);
}
else
{
pd->setNestingLevel(m_nestingLevel+1);
}
}
}
......@@ -71,8 +78,12 @@ void PageDef::writeDocumentation(OutputList &ol)
startFile(ol,pageName,pageName,title(),HLI_None,TRUE);
ol.pushGeneratorState();
//1.{
if (m_nestingLevel>0) // a sub page
if (m_nestingLevel>0
//&& // a sub page
//(Doxygen::mainPage==0 || getOuterScope()!=Doxygen::mainPage) // and not a subpage of the mainpage
)
{
// do not generate sub page output for RTF and LaTeX, as these are
// part of their parent page
......@@ -91,13 +102,16 @@ void PageDef::writeDocumentation(OutputList &ol)
// save old generator state and write title only to Man generator
ol.pushGeneratorState();
//2.{
ol.disableAllBut(OutputGenerator::Man);
ol.startTitleHead(pageName);
ol.endTitleHead(pageName, pageName);
ol.popGeneratorState();
//2.}
// for Latex the section is already generated as a chapter in the index!
ol.pushGeneratorState();
//2.{
ol.disable(OutputGenerator::Latex);
ol.disable(OutputGenerator::RTF);
SectionInfo *si=0;
......@@ -112,10 +126,12 @@ void PageDef::writeDocumentation(OutputList &ol)
ol.endSection(si->label,si->type);
}
ol.popGeneratorState();
//2.}
writePageDocumentation(ol);
ol.popGeneratorState();
//1.}
endFile(ol);
......
src/pre.l
View file @ 016a22cd
......@@ -1040,7 +1040,7 @@ void addDefine()
MemberDef *md=new MemberDef(
g_yyFileName,g_yyLineNr,
"#define",g_defName,g_defArgsStr,0,
Public,Normal,FALSE,FALSE,MemberDef::Define,0,0);
Public,Normal,FALSE,Member,MemberDef::Define,0,0);
if (!g_defArgsStr.isEmpty())
{
ArgumentList *argList = new ArgumentList;
......
src/scanner.l
View file @ 016a22cd
......@@ -1594,7 +1594,7 @@ TYPEDEFPREFIX (("typedef"{BN}+)?)((("volatile"|"const"){BN}+)?)
current->tArgLists->append(al);
currentArgumentList = al;
templateStr="<";
fullArgString = templateStr.copy();
fullArgString = templateStr;
copyArgString = &templateStr;
currentArgumentContext = FindMembers;
BEGIN( ReadTempArgs );
......@@ -4326,9 +4326,10 @@ TYPEDEFPREFIX (("typedef"{BN}+)?)((("volatile"|"const"){BN}+)?)
current->spec |= Entry::Template;
current->tArgLists->append(al);
currentArgumentList = al;
current->name+="<";
templateStr="<";
fullArgString = templateStr;
copyArgString = &templateStr;
copyArgString = &current->name;
currentArgumentContext = CompoundName;
BEGIN( ReadTempArgs );
}
......
src/translator_br.h
View file @ 016a22cd
......@@ -15,6 +15,8 @@
* Thanks to Jorge Ramos and others for their contributions.
*
* History:
* 20080709:
* - References to MAX_DOT_GRAPH_HEIGHT removed from trLegendDocs().
* 20080206:
* - Method trTypeContraints() renamed to trTypeConstraints().
* 20071216:
......@@ -1028,9 +1030,7 @@ class TranslatorBrazilian : public Translator
" Used *m_usedClass;\n"
"};\n"
"\\endcode\n"
"Se a tag \\c MAX_DOT_GRAPH_HEIGHT no arquivo de configuração tem o valor"
"200, o seguinte gráfo será gerado:"
"Isto irá gerar o seguinte gráfo:"
"<p><center><img src=\"graph_legend."+Config_getEnum("DOT_IMAGE_FORMAT")+"\"></center>\n"
"<p>\n"
"As caixas no grafo acima tem as seguintes interpretações:\n"
......
src/translator_ca.h
View file @ 016a22cd
This diff is collapsed.
src/util.cpp
View file @ 016a22cd
......@@ -3715,7 +3715,8 @@ bool getDefs(const QCString &scName,const QCString &memberName,
for (mmli.toFirst(); (mmd = mmli.current()); ++mmli)
{
if (!mmd->isLinkable() || !mmd->isRelated() || !mmd->getClassDef())
if (!mmd->isLinkable() || (!mmd->isRelated() && !mmd->isForeign()) ||
!mmd->getClassDef())
continue;
if (!args) break;
......
src/vhdlcode.l
View file @ 016a22cd
......@@ -974,7 +974,7 @@ MAPPORT {BN}*("port"|"generic"){BN}*("map"){BN}*("("){1}
}
}
<ParseType>[_a-zA_Z"]["_a-zA-Z0-9]* {
<ParseType>["_a-zA-Z0-9]* {
QCString val(yytext);
g_FuncProto.append(yytext);
appStringLower(g_PrevString,yytext);
......
src/vhdldocgen.cpp
View file @ 016a22cd
......@@ -160,24 +160,6 @@ QCString* VhdlDocGen::findKeyWord(const QCString& word)
* returns the parsed entry at line xxx
*/
Entry* VhdlDocGen::getEntryAtLine(const Entry* ce,int line)
{
EntryListIterator eli(*ce->children());
Entry *found=0;
Entry *rt;
for (;(rt=eli.current());++eli)
{
if (rt->bodyLine==line)
{
found=rt;
} // if
if (!found)
{
found=getEntryAtLine(rt,line);
}
}
return found;
}// getEntryAtLine
void VhdlDocGen::debugClassName(ClassSDict* mDict)
{
......@@ -1360,7 +1342,7 @@ void VhdlDocGen::formatString(QCString & qcs, OutputList& ol,const MemberDef* md
{
temp+=" ";
}
temp+=QCString(&c,1);
temp+=c;
temp+=" ";
}
else if (c=='=')
......@@ -1373,13 +1355,13 @@ void VhdlDocGen::formatString(QCString & qcs, OutputList& ol,const MemberDef* md
else // = operator
{
temp+=" ";
temp+=QCString(&c,1);
temp+=c;
temp+=" ";
}
}
else
{
temp+=QCString(&c,1);
temp+=c;
}
index=temp.length();
......@@ -1670,19 +1652,20 @@ void VhdlDocGen::writeVhdlDeclarations(MemberList* ml,
OutputList& ol,GroupDef* gd,ClassDef* cd)
{
static ClassDef *cdef;
static GroupDef* gdef;
//static GroupDef* gdef;
if (cd && cdef!=cd)
{ // only one inline link
VhdlDocGen::writeInlineClassLink(cd,ol);
cdef=cd;
}
/*
if (gd && gdef==gd) return;
if (gd && gdef!=gd)
{
gdef=gd;
}
*/
VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,0,0,gd,theTranslator_vhdlType(VhdlDocGen::LIBRARY,FALSE),0,FALSE,VhdlDocGen::LIBRARY);
VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,0,0,gd,theTranslator_vhdlType(VhdlDocGen::USE,FALSE),0,FALSE,VhdlDocGen::USE);
VhdlDocGen::writeVHDLDeclarations(ml,ol,cd,0,0,gd,theTranslator_vhdlType(VhdlDocGen::FUNCTION,FALSE),0,FALSE,VhdlDocGen::FUNCTION);
......
src/vhdldocgen.h
View file @ 016a22cd
......@@ -80,7 +80,6 @@ class VhdlDocGen
static void init();
// --- used by vhdlscanner.l -----------
static Entry* getEntryAtLine(const Entry* e,int line);
static QCString getIndexWord(const char* ,int index);
static bool foundInsertedComponent(const QCString& name,Entry* root);
static bool deleteCharRev(QCString &s,char c);
......
src/vhdlscanner.l
View file @ 016a22cd
This diff is collapsed.
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