Skip to content

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

Release-1.7.2-20101118

parent be602ee7
Show whitespace changes
Inline Side-by-side
Showing with 1037 additions and 690 deletions
INSTALL
View file @ dd7602fd
DOXYGEN Version 1.7.2-20101106
DOXYGEN Version 1.7.2-20101118
Please read the installation section of the manual
(http://www.doxygen.org/install.html) for instructions.
--------
Dimitri van Heesch (06 November 2010)
Dimitri van Heesch (18 November 2010)
README
View file @ dd7602fd
DOXYGEN Version 1.7.2_20101106
DOXYGEN Version 1.7.2_20101118
Please read INSTALL for compilation instructions.
......@@ -26,4 +26,4 @@ forum.
Enjoy,
Dimitri van Heesch (dimitri@stack.nl) (06 November 2010)
Dimitri van Heesch (dimitri@stack.nl) (18 November 2010)
configure
View file @ dd7602fd
......@@ -20,7 +20,7 @@ doxygen_version_minor=7
doxygen_version_revision=2
#NOTE: Setting version_mmn to "NO" will omit mmn info from the package.
doxygen_version_mmn=20101106
doxygen_version_mmn=20101118
bin_dirs=`echo $PATH | sed -e "s/:/ /g"`
......
doc/commands.doc
View file @ dd7602fd
......@@ -31,7 +31,7 @@ Each argument has a certain range:
<li>If {curly} braces are used the argument extends until the next paragraph.
Paragraphs are delimited by a blank line or by a section indicator.
</ul>
If [square] brackets are used the argument is optional.
If in addition to the aboveargument specifiers [square] brackets are used the argument is optional.
Here is an alphabetically sorted list of all commands with references to their
documentation:
......@@ -66,7 +66,6 @@ documentation:
\refitem cmddontinclude \\dontinclude
\refitem cmddot \\dot
\refitem cmddotfile \\dotfile
\refitem cmdmscfile \\mscfile
\refitem cmde \\e
\refitem cmdelse \\else
\refitem cmdelseif \\elseif
......@@ -117,6 +116,7 @@ documentation:
\refitem cmdmanonly \\manonly
\refitem cmdmemberof \\memberof
\refitem cmdmsc \\msc
\refitem cmdmscfile \\mscfile
\refitem cmdn \\n
\refitem cmdname \\name
\refitem cmdnamespace \\namespace
......@@ -146,6 +146,7 @@ documentation:
\refitem cmdrelatesalso \\relatesalso
\refitem cmdremark \\remark
\refitem cmdremarks \\remarks
\refitem cmdresult \\result
\refitem cmdreturn \\return
\refitem cmdreturns \\returns
\refitem cmdretval \\retval
......@@ -233,7 +234,7 @@ Structural indicators
/*! @} */
\endverbatim
\sa page \ref grouping "Grouping", sections \ref cmddefgroup "\\defgroup", \ref cmdingroup "\\ingroup" and
\sa page \ref grouping "Grouping", sections \ref cmddefgroup "\\defgroup", \ref cmdingroup "\\ingroup", and
\ref cmdweakgroup "\\weakgroup".
<hr>
......@@ -243,11 +244,13 @@ Structural indicators
When this command is put in a comment block of a function or method
and \ref cfg_have_dot "HAVE_DOT" is set to YES, then doxygen will
generate a call graph for that function (provided the implementation of the
function or method calls other documented functions). The call graph will
function or method calls other documented functions). The call graph will be
generated regardless of the value of \ref cfg_call_graph "CALL_GRAPH".
\note The completeness (and correctness) of the call graph depends on the
doxygen code parser which is not perfect.
\sa section \ref cmdcallergraph "\\callergraph".
<hr>
\section cmdcallergraph \\callergraph
......@@ -255,11 +258,13 @@ Structural indicators
When this command is put in a comment block of a function or method
and \ref cfg_have_dot "HAVE_DOT" is set to YES, then doxygen will
generate a caller graph for that function (provided the implementation of the
function or method calls other documented functions). The caller graph will
function or method calls other documented functions). The caller graph will be
generated regardless of the value of \ref cfg_caller_graph "CALLER_GRAPH".
\note The completeness (and correctness) of the caller graph depends on the
doxygen code parser which is not perfect.
\sa section \ref cmdcallgraph "\\callgraph".
<hr>
\section cmdcategory \\category <name> [<header-file>] [<header-name>]
......@@ -285,7 +290,7 @@ Structural indicators
argument you can also specify how the include statement should look like,
by adding either quotes or sharp brackets around the name.
Sharp brackets are used if just the name is given. Note that the
last two arguments can also specified using
last two arguments can also be specified using
the \ref cmdheaderfile "\\headerfile" command.
\par Example:
......@@ -321,7 +326,7 @@ Structural indicators
The \<name\> argument should be a single-word identifier.
\sa page \ref grouping "Grouping", sections \ref cmdingroup "\\ingroup", \ref cmdaddtogroup "\\addtogroup",
\sa page \ref grouping "Grouping", sections \ref cmdingroup "\\ingroup", \ref cmdaddtogroup "\\addtogroup", and
\ref cmdweakgroup "\\weakgroup".
<hr>
......@@ -460,6 +465,8 @@ Structural indicators
\\fn command on a \e single line, since the argument ends at the end
of the line!
This command is equivalent to \\var, \\typedef, and \\property.
\warning Do not use this command
if it is not absolutely needed, since it will lead to duplication of
information and thus to errors.
......@@ -472,7 +479,8 @@ Structural indicators
\endhtmlonly
\sa section \ref cmdvar "\\var" and \ref cmdtypedef "\\typedef".
\sa sections \ref cmdvar "\\var", \ref cmdproperty "\\property", and
\ref cmdtypedef "\\typedef".
<hr>
\section cmdheaderfile \\headerfile <header-file> [<header-name>]
......@@ -481,8 +489,8 @@ Structural indicators
Intended to be used for class, struct, or union documentation, where
the documentation is in front of the definition. The arguments of
this command are the same as the second and third argument of
\ref cmdclass "\\cmdclass".
The header-file name refers to the file that should by included by the
\ref cmdclass "\\class".
The \<header-file\> name refers to the file that should by included by the
application to obtain the definition of the class, struct, or union.
The \<header-name\> argument can be used to overwrite the
name of the link that is used in the class documentation to something other
......@@ -494,8 +502,8 @@ Structural indicators
by adding either double quotes or sharp brackets around the name.
By default sharp brackets are used if just the name is given.
If a pair of double quotes is given for either the header-file or
header-name argument, the current file (in which the command was found)
If a pair of double quotes is given for either the \<header-file\> or
\<header-name\> argument, the current file (in which the command was found)
will be used but with quotes. So for a comment block with a \\headerfile
command inside a file test.h, the following three commands are equivalent:
\verbatim
......@@ -523,7 +531,10 @@ Structural indicators
By default the value of a define and the initializer of a variable
are displayed unless they are longer than 30 lines. By putting
this command in a comment block of a define or variable, the
initializer is always hidden.
initializer is always hidden. The maximum number of initalization linens
can be changed by means of the configuration parameter
\ref cfg_max_initializer_lines "MAX_INITIALIZER_LINES", the default value is
30.
\sa section \ref cmdshowinitializer "\\showinitializer".
......@@ -554,14 +565,14 @@ Structural indicators
groups identified by \<groupname\>.
\sa page \ref grouping "Grouping", sections \ref cmddefgroup "\\defgroup",
\ref cmdaddtogroup "\\addtogroup" and \ref cmdweakgroup "\\weakgroup"
\ref cmdaddtogroup "\\addtogroup", and \ref cmdweakgroup "\\weakgroup"
<hr>
\section cmdinterface \\interface <name> [<header-file>] [<header-name>]
\addindex \\interface
Indicates that a comment block contains documentation for an
interface with name \<name\>. The arguments are equal to the \\class
interface with name \<name\>. The arguments are equal to the arguments of the \\class
command.
\sa section \ref cmdclass "\\class".
......@@ -572,7 +583,7 @@ Structural indicators
\addindex \\internal
This command starts a documentation fragment that is meant for internal
use only. The fragment naturally ends at the end of the comment block.
You can also force the internal section to end earlier using the
You can also force the internal section to end earlier by using the
\ref cmdendinternal "\\endinternal" command.
If the \\internal command is put inside a section
......@@ -583,6 +594,8 @@ Structural indicators
You can use \ref cfg_internal_docs "INTERNAL_DOCS" in the config file
to show (\c YES) or hide (\c NO) the internal documentation.
\sa section \ref cmdendinternal "\\endinternal".
<hr>
\section cmdmainpage \\mainpage [(title)]
......@@ -616,14 +629,14 @@ Structural indicators
is disabled, otherwise you should use \\ref main).
\sa section \ref cmdsection "\\section",
section \ref cmdsubsection "\\subsection" and
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
This command makes 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
......@@ -673,6 +686,9 @@ Structural indicators
to avoid that doxygen puts a member group as a subgroup of a
Public/Protected/Private/... section.
\sa sections \ref cmdpublicsection "\\publicsection",
\ref cmdprotectedsection "\\protectedsection" and
\ref cmdprivatesection "\\privatesection".
<hr>
\section cmdoverload \\overload [(function declaration)]
......@@ -745,7 +761,6 @@ Structural indicators
\section cmdprivate \\private
\addindex \\private
\addindex \\privatesection
Indicates that the member documented in the comment block is private,
i.e., should only be accessed by other members in the same class.
......@@ -758,7 +773,19 @@ Structural indicators
"private:" class marker in C++, use \\privatesection.
\sa sections \ref cmdmemberof "\\memberof", \ref cmdpublic "\\public",
and \ref cmdprotected "\\protected".
\ref cmdprotected "\\protected" and \ref cmdprivatesection "\\privatesection".
<hr>
\section cmdprivatesection \\privatesection
\addindex \\privatesection
Starting a section of private members, in a way similar to the
"private:" class marker in C++.
Indicates that the member documented in the comment block is private,
i.e., should only be accessed by other members in the same class.
\sa sections \ref cmdmemberof "\\memberof", \ref cmdpublic "\\public",
\ref cmdprotected "\\protected" and \ref cmdprivate "\\private".
<hr>
\section cmdproperty \\property (qualified property name)
......@@ -766,15 +793,15 @@ Structural indicators
\addindex \\property
Indicates that a comment block contains documentation for a
property (either global or as a member of a class).
This command is equivalent to \\var and \\fn.
This command is equivalent to \\var, \\typedef, and \\fn.
\sa section \ref cmdfn "\\fn" and \ref cmdvar "\\var".
\sa sections \ref cmdfn "\\fn", \ref cmdtypedef "\\typedef", and
\ref cmdvar "\\var".
<hr>
\section cmdprotected \\protected
\addindex \\protected
\addindex \\protectedsection
Indicates that the member documented in the comment block is protected,
i.e., should only be accessed by other members in the same or derived
classes.
......@@ -788,7 +815,20 @@ Structural indicators
"protected:" class marker in C++, use \\protectedsection.
\sa sections \ref cmdmemberof "\\memberof", \ref cmdpublic "\\public",
and \ref cmdprivate "\\private".
\ref cmdprivate "\\private" and \ref cmdprotectedsection "\\protectedsection".
<hr>
\section cmdprotectedsection \\protectedsection
\addindex \\protectedsection
Starting a section of protected members, in a way similar to the
"protected:" class marker in C++.
Indicates that the member documented in the comment block is protected,
i.e., should only be accessed by other members in the same or derived
classes.
\sa sections \ref cmdmemberof "\\memberof", \ref cmdpublic "\\public",
\ref cmdprivate "\\private" and \ref cmdprotected "\\protected".
<hr>
\section cmdprotocol \\protocol <name> [<header-file>] [<header-name>]
......@@ -804,7 +844,6 @@ Structural indicators
\section cmdpublic \\public
\addindex \\public
\addindex \\publicsection
Indicates that the member documented in the comment block is public,
i.e., can be accessed by any other class or function.
......@@ -816,8 +855,20 @@ Structural indicators
For starting a section of public members, in a way similar to the
"public:" class marker in C++, use \\publicsection.
\sa sections \ref cmdmemberof "\\memberof", \ref cmdprotected "\\protected"
and \ref cmdprivate "\\private".
\sa sections \ref cmdmemberof "\\memberof", \ref cmdprotected "\\protected",
\ref cmdprivate "\\private" and \ref cmdpublicsection "\\publicsection".
<hr>
\section cmdpublicsection \\publicsection
\addindex \\publicsection
Starting a section of public members, in a way similar to the
"public:" class marker in C++.
Indicates that the member documented in the comment block is public,
i.e., can be accessed by any other class or function.
\sa sections \ref cmdmemberof "\\memberof", \ref cmdprotected "\\protected",
\ref cmdprivate "\\private" and \ref cmdpublic "\\public".
<hr>
\section cmdrelates \\relates <name>
......@@ -849,7 +900,7 @@ Structural indicators
\addindex \\relatesalso
This command can be used in the documentation of a non-member function
\<name\>. It puts the function both inside the `related function' section
of the class documentation as well as leaving its normal file documentation
of the class documentation as well as leaving it at its normal file documentation
location. This command is useful for documenting
non-friend functions that are nevertheless strongly coupled to a certain
class. It only works for functions.
......@@ -868,6 +919,10 @@ Structural indicators
are only displayed if they are less than 30 lines long. By putting
this command in a comment block of a define or variable, the
initializer is shown unconditionally.
The maximum number of initalization linens
can be changed by means of the configuration parameter
\ref cfg_max_initializer_lines "MAX_INITIALIZER_LINES", the default value is
30.
\sa section \ref cmdhideinitializer "\\hideinitializer".
......@@ -876,7 +931,7 @@ Structural indicators
\addindex \\struct
Indicates that a comment block contains documentation for a
struct with name \<name\>. The arguments are equal to the \\class
struct with name \<name\>. The arguments are equal to the arguments of the \\class
command.
\sa section \ref cmdclass "\\class".
......@@ -887,16 +942,17 @@ Structural indicators
\addindex \\typedef
Indicates that a comment block contains documentation for a
typedef (either global or as a member of a class).
This command is equivalent to \\var and \\fn.
This command is equivalent to \\var, \\propery, and \\fn.
\sa section \ref cmdfn "\\fn" and \ref cmdvar "\\var".
\sa section \ref cmdfn "\\fn", \ref cmdproperty "\\property", and
\ref cmdvar "\\var".
<hr>
\section cmdunion \\union <name> [<header-file>] [<header-name>]
\addindex \\union
Indicates that a comment block contains documentation for a
union with name \<name\>. The arguments are equal to the \\class
union with name \<name\>. The arguments are equal to the arguments of the \\class
command.
\sa section \ref cmdclass "\\class".
......@@ -907,9 +963,9 @@ Structural indicators
\addindex \\var
Indicates that a comment block contains documentation for a variable or
enum value (either global or as a member of a class).
This command is equivalent to \\typedef and \\fn.
This command is equivalent to \\typedef, \\propery, and \\fn.
\sa section \ref cmdfn "\\fn" and \ref cmdtypedef "\\typedef".
\sa section \ref cmdfn "\\fn", \ref cmdproperty "\\property", and \ref cmdtypedef "\\typedef".
<hr>
\section cmdweakgroup \\weakgroup <name> [(title)]
......@@ -918,7 +974,7 @@ Structural indicators
a lower priority when it comes to resolving conflicting grouping
definitions.
\sa page \ref grouping "Grouping" and \ref cmdaddtogroup "\\addtogroup".
\sa page \ref grouping "Grouping" and section \ref cmdaddtogroup "\\addtogroup".
<hr>
......@@ -968,7 +1024,7 @@ Section indicators
Equivalent to \ref cmdauthor "\\author".
<hr>
\section cmdbrief \\brief {brief description}
\section cmdbrief \\brief { brief description }
\addindex \\brief
Starts a paragraph that serves as a brief description. For classes and files
......@@ -1064,6 +1120,8 @@ class Implementation : public Intf
The output will be different depending on whether or not \c ENABLED_SECTIONS
contains \c TEST, or \c DEV
\sa section \ref cmdendcond "\\endcond".
<hr>
\section cmddate \\date { date description }
......@@ -1088,7 +1146,7 @@ contains \c TEST, or \c DEV
expected life span, etc.
<hr>
\section cmddetails \\details {detailed decription}
\section cmddetails \\details { detailed decription }
\addindex \\details
Just like \ref cmdbrief "\\brief" starts a brief description, \\details
......@@ -1127,7 +1185,7 @@ contains \c TEST, or \c DEV
\addindex \\endcond
Ends a conditional section that was started by \ref cmdcond "\\cond".
\sa \ref cmdcond "\\cond".
\sa section \ref cmdcond "\\cond".
<hr>
\section cmdendif \\endif
......@@ -1136,7 +1194,7 @@ contains \c TEST, or \c DEV
Ends a conditional section that was started by \c \\if or \c \\ifnot
For each \c \\if or \c \\ifnot one and only one matching \c \\endif must follow.
\sa \ref cmdif "\\if", and \ref cmdifnot "\\ifnot".
\sa sections \ref cmdif "\\if" and \ref cmdifnot "\\ifnot".
<hr>
\section cmdexception \\exception <exception-object> { exception description }
......@@ -1148,14 +1206,11 @@ contains \c TEST, or \c DEV
The text of the paragraph has no special internal structure. All visual
enhancement commands may be used inside the paragraph.
Multiple adjacent \\exception commands will be joined into a single paragraph.
Each parameter description will start on a new line.
Each exception description will start on a new line.
The \\exception description ends when a blank line or some other
sectioning command is encountered. See section \ref cmdfn "\\fn" for an
example.
\par Note:
the tag \\exceptions is a synonym for this tag.
<hr>
\section cmdif \\if <section-label>
......@@ -1268,7 +1323,7 @@ ALIASES = "english=\if english" \
If no paragraph title is given this command will start a new paragraph.
This will also work inside other paragraph commands
(like \\param or \\warning) without ending the that command.
(like \\param or \\warning) without ending that command.
The text of the paragraph has no special internal structure. All visual
enhancement commands may be used inside the paragraph.
......@@ -1283,7 +1338,7 @@ ALIASES = "english=\if english" \
\endhtmlonly
<hr>
\section cmdparam \\param <parameter-name> { parameter description }
\section cmdparam \\param [(dir)] <parameter-name> { parameter description }
\addindex \\param
Starts a parameter description for a function parameter with name
......@@ -1292,9 +1347,11 @@ ALIASES = "english=\if english" \
the documentation of this (or any other) parameter is missing or not
present in the function declaration or definition.
The \\param command has an optional attribute specifying the direction
of the attribute. Possible values are "in" and "out". Here is an example
for the function memcpy:
The \\param command has an optional attribute, (dir), specifying the direction
of the parameter. Possible values are "[in]", "[in,out]", and "[out]",
note the [square] brackets in this description.
When a parameter is both input and output, [in,out] is used as attribute.
Here is an example for the function memcpy:
\code
/*!
* Copies bytes from a source memory area to a destination memory area,
......@@ -1305,7 +1362,6 @@ ALIASES = "english=\if english" \
*/
void memcpy(void *dest, const void *src, size_t n);
\endcode
If a parameter is both input and output, use [in,out] as an attribute.
The parameter description is a paragraph with no special internal structure.
All visual enhancement commands may be used inside the paragraph.
......@@ -1328,11 +1384,11 @@ void memcpy(void *dest, const void *src, size_t n);
\section cmdtparam \\tparam <template-parameter-name> { description }
\addindex \\tparam
Starts a template parameters for a class or function template parameter
Starts a template parameter for a class or function template parameter
with name \<template-parameter-name\>, followed by a description of the
template parameter.
Otherwise similar to \ref cmdparam "\\cmdparam".
Otherwise similar to \ref cmdparam "\\param".
<hr>
\section cmdpost \\post { description of the postcondition }
......@@ -1382,6 +1438,12 @@ void memcpy(void *dest, const void *src, size_t n);
\addindex \\remarks
Equivalent to \ref cmdremark "\\remark".
<hr>
\section cmdresult \\result { description of the result value }
\addindex \\result
Equivalent to \ref cmdreturn "\\return".
<hr>
\section cmdreturn \\return { description of the return value }
......@@ -1405,7 +1467,7 @@ void memcpy(void *dest, const void *src, size_t n);
\addindex \\retval
Starts a description for a function's return value with name
\<return value\>. Followed by a description of the return value.
\<return value\>, followed by a description of the return value.
The text of the paragraph that forms the description has no special
internal structure. All visual enhancement commands may be used inside the
paragraph.
......@@ -1438,10 +1500,10 @@ void memcpy(void *dest, const void *src, size_t n);
Equivalent to \ref cmdsa "\\sa". Introduced for compatibility with Javadoc.
<hr>
\section cmdshort \\short {short description}
\section cmdshort \\short { short description }
\addindex \\short
Equivalent to \\ref cmdbrief "\\brief".
Equivalent to \ref cmdbrief "\\brief".
<hr>
\section cmdsince \\since { text }
......@@ -1472,11 +1534,13 @@ void memcpy(void *dest, const void *src, size_t n);
\par Note:
the tag \\throws is a synonym for this tag.
\sa section \ref cmdexception "\\exception"
<hr>
\section cmdthrows \\throws <exception-object> { exception description }
\addindex \\throws
Equivalent to \ref cmdthrows "\\throws".
Equivalent to \ref cmdthrow "\\throw".
<hr>
\section cmdtodo \\todo { paragraph describing what is to be done }
......@@ -1520,7 +1584,7 @@ void memcpy(void *dest, const void *src, size_t n);
for an example.
<hr>
\section cmdxrefitem \\xrefitem <key> "(heading)" "(list title)" {text}
\section cmdxrefitem \\xrefitem <key> "(heading)" "(list title)" { text }
\addindex \\xrefitem
This command is a generalization of commands such as \ref cmdtodo "\\todo"
......@@ -1530,12 +1594,12 @@ void memcpy(void *dest, const void *src, size_t n);
which will be generated. On the related page all sections of
the same type will be collected.
The first argument \<key\> is a
The first argument \<key\> is an
identifier uniquely representing the type of the section. The second argument
is a quoted string representing the heading of the section under which
text passed as the forth argument is put. The third argument (list title)
text passed as the fourth argument is put. The third argument (list title)
is used as the title for the related page containing all items with the
same key. The keys "todo", "test", "bug", and "deprecated" are predefined.
same key. The keys "todo", "test", "bug" and "deprecated" are predefined.
To get an idea on how to use the \\xrefitem command and what its effect
is, consider the todo list, which (for English output) can be seen an
......@@ -1611,8 +1675,8 @@ Commands to create links
\addindex \\ref
Creates a reference to a named section, subsection, page or anchor.
For HTML documentation the reference command will generate a link to
the section. For a sections or subsections the title of the section will be
used as the text of the link. For anchor the optional text between quotes
the section. For a section or subsection the title of the section will be
used as the text of the link. For an anchor the optional text between quotes
will be used or \<name\> if no text is specified.
For \f$\mbox{\LaTeX}\f$ documentation the reference command will
generate a section number for sections or the text followed by a
......@@ -1684,6 +1748,10 @@ Make sure you have first read \ref intro "the introduction".
\warning This command only works inside related page documentation and
\e not in other documentation blocks!
\sa
Section \ref cmdpage "\\page" for an example of the
\ref cmdsection "\\section" command.
<hr>
\section cmdsubsection \\subsection <subsection-name> (subsection title)
......@@ -1714,7 +1782,8 @@ Make sure you have first read \ref intro "the introduction".
\sa
Section \ref cmdpage "\\page" for an example of the
\ref cmdsubsubsection "\\subsubsection" command.
\ref cmdsection "\\section" command and
\ref cmdsubsection "\\subsection" command.
<hr>
\section cmdparagraph \\paragraph <paragraph-name> (paragraph title)
......@@ -1728,10 +1797,6 @@ Make sure you have first read \ref intro "the introduction".
related page documentation block and
\e not in other documentation blocks!
\sa
Section \ref cmdpage "\\page" for an example of the
\ref cmdparagraph "\\paragraph" command.
<hr>
\htmlonly <center> \endhtmlonly
......@@ -1773,7 +1838,8 @@ Commands for displaying examples
\endhtmlonly
\sa sections \ref cmdline "\\line", \ref cmdskip "\\skip",
\ref cmdskipline "\\skipline", and \ref cmduntil "\\until".
\ref cmdskipline "\\skipline", \ref cmduntil "\\until", and
\ref cmdinclude "\\include".
<hr>
\section cmdinclude \\include <file-name>
......@@ -1806,8 +1872,8 @@ Commands for displaying examples
\note Doxygen's special commands do not work inside blocks of code.
It is allowed to nest C-style comments inside a code block though.
\sa section \ref cmdexample "\\example", \ref cmddontinclude "\\dontinclude", and
section \ref cmdverbatim "\\verbatim".
\sa sections \ref cmdexample "\\example", \ref cmddontinclude "\\dontinclude", and
\ref cmdverbatim "\\verbatim".
<hr>
\section cmdincludelineno \\includelineno <file-name>
......@@ -1920,7 +1986,8 @@ Commands for visual enhancements
\section cmda \\a <word>
\addindex \\a
Displays the argument \<word\> using a special font.
Displays the argument \<word\> in italics.
Use this command to emphasize words.
Use this command to refer to member arguments in the running text.
\par Example:
......@@ -1930,6 +1997,9 @@ Commands for visual enhancements
This will result in the following text:<br><br>
... the \a x and \a y coordinates are used to ...
Equivalent to \ref cmda "\\e" and \ref cmdem "\\em".
To emphasize multiple words use \<em\>multiple words\</em\>.
<hr>
\section cmdarg \\arg { item-description }
......@@ -1999,7 +2069,7 @@ Commands for visual enhancements
classes and members that are documented are automatically replaced by
links to the documentation.
\sa section \ref cmdendcode "\\endcode", section \ref cmdverbatim "\\verbatim".
\sa section \ref cmdendcode "\\endcode" and section \ref cmdverbatim "\\verbatim".
<hr>
\section cmdcopydoc \\copydoc <link-object>
......@@ -2036,14 +2106,16 @@ Commands for visual enhancements
Qualified names are only needed if the context in which the documentation
block is found requires them.
The copydoc command can be used recursively, but cycles in the copydoc
The \\copydoc command can be used recursively, but cycles in the \\copydoc
relation will be broken and flagged as an error.
Note that both the brief description and the detailed documentation
will be copied. See \ref cmdcopybrief "\\cmdcopybrief" and
\ref cmdcopydetails "\\cmdcopydetails" for copying only the brief or
will be copied. See \ref cmdcopybrief "\\copybrief" and
\ref cmdcopydetails "\\copydetails" for copying only the brief or
detailed part of the comment block.
\sa sections \ref cmdcopybrief "\\copybrief" and \ref cmdcopydetails "\\copydetails"
<hr>
\section cmdcopybrief \\copybrief <link-object>
......@@ -2137,6 +2209,8 @@ class Receiver
\endcode
\sa section \ref cmdmscfile "\\mscfile".
<hr>
\section cmddotfile \\dotfile <file> ["caption"]
......@@ -2160,19 +2234,22 @@ class Receiver
\addindex \\mscfile
Inserts an image generated by mscgen from \<file\> into the documentation.
See http://www.mcternan.me.uk/mscgen/ for examples.
The first argument specifies the file name of the image.
doxygen will look for files in the paths (or files) that you specified
after the \ref cfg_mscfile_dirs "MSCFILE_DIRS" tag.
If the msc file is found it will be used as an input file to the mscgen tool.
The resulting image will be put into the correct output directory.
If the dot file name contains spaces you'll have to put quotes ("...") around it.
If the msc file name contains spaces you'll have to put quotes ("...") around it.
The second argument is optional and can be used to specify the caption
that is displayed below the image. This argument has to be specified
between quotes even if it does not contain any spaces. The quotes are
stripped before the caption is displayed.
\sa section \ref cmdmsc "\\msc".
<hr>
\section cmde \\e <word>
......@@ -2188,8 +2265,8 @@ class Receiver
will result in the following text:<br><br>
... this is a \e really good example ...
Equivalent to \ref cmdem "\\em".
To emphasis multiple words use \<em\>multiple words\</em\>.
Equivalent to \ref cmda "\\a" and \ref cmdem "\\em".
To emphasize multiple words use \<em\>multiple words\</em\>.
<hr>
\section cmdem \\em <word>
......@@ -2206,7 +2283,8 @@ class Receiver
will result in the following text:<br><br>
... this is a \em really good example ...
Equivalent to \ref cmde "\\e"
Equivalent to \ref cmda "\\a" and \ref cmde "\\e".
To emphasize multiple words use \<em\>multiple words\</em\>.
<hr>
\section cmdendcode \\endcode
......@@ -2306,7 +2384,7 @@ class Receiver
\section cmdfcurlyopen \\f{environment}{
Marks the start of a formula that is in a specific environment.
\note The second \{ is optional and is only to help editors (such as Vim) to
\note The second { is optional and is only to help editors (such as Vim) to
do proper syntax highlighting by making the number of opening and closing braces
the same.
......@@ -2328,8 +2406,7 @@ class Receiver
require attributes). You can use the \\latexonly and \\endlatexonly
pair to provide a proper \f$\mbox{\LaTeX}\f$ alternative.
\b Note:
environment variables (like \$(HOME) ) are resolved inside a
\note environment variables (like \$(HOME) ) are resolved inside a
HTML-only block.
\sa section \ref cmdmanonly "\\manonly", section
......@@ -2345,7 +2422,7 @@ class Receiver
format you'll have to repeat this command for each format.
The first argument specifies the output format. Currently, the
following values are supported: \c html and \c latex.
following values are supported: \c html, \c latex and \c rtf.
The second argument specifies the file name of the image.
doxygen will look for files in the paths (or files) that you specified
......@@ -2409,6 +2486,7 @@ class Receiver
\f$\mbox{\LaTeX}\f$-only block.
\sa section \ref cmdrtfonly "\\rtfonly",
section \ref cmdxmlonly "\\xmlonly",
section \ref cmdmanonly "\\manonly", and
section \ref cmdhtmlonly "\\htmlonly".
......@@ -2426,6 +2504,7 @@ class Receiver
HTML and \f$\mbox{\LaTeX}\f$ alternatives.
\sa section \ref cmdhtmlonly "\\htmlonly",
section \ref cmdxmlonly "\\xmlonly",
section \ref cmdrtfonly "\\rtfonly", and
section \ref cmdlatexonly "\\latexonly".
......@@ -2484,6 +2563,7 @@ class Receiver
... the \p x and \p y coordinates are used to ...
Equivalent to \ref cmdc "\\c"
To have multiple words in typewriter font use \<tt\>multiple words\</tt\>.
<hr>
\section cmdrtfonly \\rtfonly
......@@ -2501,6 +2581,7 @@ class Receiver
RTF-only block.
\sa section \ref cmdmanonly "\\manonly", section
\ref cmdxmlonly "\\xmlonly", section
\ref cmdlatexonly "\\latexonly", and section
\ref cmdhtmlonly "\\htmlonly".
......@@ -2529,8 +2610,10 @@ class Receiver
This command can be used to include custom XML tags.
\sa section \ref cmdhtmlonly "\\htmlonly" and section
\ref cmdlatexonly "\\latexonly".
\sa section \ref cmdmanonly "\\manonly", section
\ref cmdrtfonly "\\rtfonly", section
\ref cmdlatexonly "\\latexonly", and section
\ref cmdhtmlonly "\\htmlonly".
<hr>
\section cmdbackslash \\\\
......
doc/config.doc
View file @ dd7602fd
......@@ -122,6 +122,7 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_file_version_filter FILE_VERSION_FILTER
\refitem cfg_filter_patterns FILTER_PATTERNS
\refitem cfg_filter_source_files FILTER_SOURCE_FILES
\refitem cfg_filter_source_patterns FILTER_SOURCE_PATTERNS
\refitem cfg_force_local_includes FORCE_LOCAL_INCLUDES
\refitem cfg_formula_fontsize FORMULA_FONTSIZE
\refitem cfg_formula_transparent FORMULA_TRANSPARENT
......@@ -215,6 +216,7 @@ followed by the descriptions of the tags grouped by category.
\refitem cfg_predefined PREDEFINED
\refitem cfg_project_name PROJECT_NAME
\refitem cfg_project_number PROJECT_NUMBER
\refitem cfg_qch_file QCH_FILE
\refitem cfg_qhg_location QHG_LOCATION
\refitem cfg_qhp_cust_filter_attrs QHP_CUST_FILTER_ATTRS
\refitem cfg_qhp_cust_filter_name QHP_CUST_FILTER_NAME
......@@ -1101,8 +1103,8 @@ AClass::ANamespace, ANamespace::*Test
basis. Doxygen will compare the file name with each pattern and apply the
filter if there is a match. The filters are a list of the form:
pattern=filter (like <code>*.cpp=my_cpp_filter</code>). See \c INPUT_FILTER for further
info on how filters are used. If \c FILTER_PATTERNS is empty, \c INPUT_FILTER
is applied to all files.
info on how filters are used. If \c FILTER_PATTERNS is empty or if
non of the patterns match the file name, \c INPUT_FILTER is applied.
\anchor cfg_filter_source_files
<dt>\c FILTER_SOURCE_FILES <dd>
......@@ -1112,6 +1114,15 @@ AClass::ANamespace, ANamespace::*Test
files that are used for producing the source files to browse
(i.e. when SOURCE_BROWSER is set to YES).
\anchor cfg_filter_source_patterns
<dt>\c FILTER_SOURCE_PATTERNS <dd>
\addindex FILTER_SOURCE_PATTERNS
The \c FILTER_SOURCE_PATTERNS tag can be used to specify source filters per
file pattern. A pattern will override the setting for \c FILTER_PATTERN (if any)
and it is also possible to disable source filtering for a specific pattern
using *.ext= (so without naming a filter). This option only has effect when
\c FILTER_SOURCE_FILES is enabled.
</dl>
\section sourcebrowser_index Source browsing related options
......@@ -1481,6 +1492,13 @@ The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
to generate a Qt Compressed Help (.qch) of the generated HTML
documentation.
\anchor cfg_qch_file
<dt>\c QCH_FILE <dd>
\addindex QCH_FILE
If the QHG_LOCATION tag is specified, the QCH_FILE tag can
be used to specify the file name of the resulting .qch file.
The path specified is relative to the HTML output folder.
\anchor cfg_qhp_namespace
<dt>\c QHP_NAMESPACE <dd>
\addindex QHP_NAMESPACE
......@@ -2374,7 +2392,7 @@ PROJECT_NAME = Example
INPUT = example.cc example.h
WARNINGS = YES
TAGFILES = qt.tag
PERL_PATH = /usr/bin/perl
PERL_PATH = /usr/local/bin/perl
SEARCHENGINE = NO
\endverbatim
......
doc/htmlcmds.doc
View file @ dd7602fd
......@@ -18,7 +18,7 @@
Here is a list of all HTML commands that may be used inside the
documentation. Note that although these HTML tags are translated to the
proper commands for outer formats other than HTML, all attributes
proper commands for output formats other than HTML, all attributes
of a HTML tag are passed on to the HTML output only
(the HREF and NAME attributes for the A tag are the only exception).
......@@ -38,7 +38,7 @@ of a HTML tag are passed on to the HTML output only
<li><tt>\<CODE\></tt> Starts a piece of text displayed in a typewriter font.
Note that for C# code, this command is equivalent to
\ref cmdcode "\\code".
<li><tt>\</CODE\></tt> End a <tt>\<CODE\></tt> section.
<li><tt>\</CODE\></tt> Ends a <tt>\<CODE\></tt> section.
Note that for C# code, this command is equivalent to
\ref cmdendcode "\\endcode".
<li><tt>\<DD\></tt> Starts an item description.
......@@ -101,7 +101,7 @@ of a HTML tag are passed on to the HTML output only
<li><tt>\<UL\></tt> Starts an unnumbered item list.
<li><tt>\</UL\></tt> Ends an unnumbered item list.
<li><tt>\<VAR\></tt> Starts a piece of text displayed in an italic font.
<li><tt>\</VAR\></tt> Ends a <tt>\</VAR\></tt> section.
<li><tt>\</VAR\></tt> Ends a <tt>\<VAR\></tt> section.
</ul>
The special HTML character entities that are recognized by Doxygen:
......
doc/install.doc
View file @ dd7602fd
......@@ -63,11 +63,11 @@ tools should be installed.
This is needed to build the GUI front-end doxywizard.
<li>A \f$\mbox{\LaTeX}\f$ distribution: for instance
<a href="http://www.tug.org/interest.html#free">teTeX 1.0</a>
\latexonly \\par (see {\tt http://www.tug.org/interest.html\#free})\endlatexonly.
\latexonly (see {\tt http://www.tug.org/interest.html\#free})\endlatexonly.
This is needed for generating LaTeX, Postscript, and PDF output.
<li><a href="http://www.graphviz.org/">
the Graph visualization toolkit version 1.8.10 or higher</a>
\latexonly \\par (see {\tt http://www.graphviz.org/})\endlatexonly.
\latexonly (see {\tt http://www.graphviz.org/})\endlatexonly.
Needed for the include dependency graphs,
the graphical inheritance graphs, and the collaboration graphs.
If you compile graphviz yourself, make sure you do include
......
doc/language.doc
View file @ dd7602fd
......@@ -23,7 +23,7 @@ text fragments, generated by doxygen, can be produced in languages other
than English (the default). The output language is chosen through the
configuration file (with default name and known as Doxyfile).
Currently (version 1.7.1), 38 languages
Currently (version 1.7.2), 38 languages
are supported (sorted alphabetically):
Afrikaans, Arabic, Brazilian Portuguese, Catalan, Chinese, Chinese
Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto,
......
doc/translator_report.txt
View file @ dd7602fd
(1.7.1)
(1.7.2)
Doxygen supports the following 38 languages (sorted alphabetically):
......
src/classdef.cpp
View file @ dd7602fd
......@@ -1315,6 +1315,7 @@ void ClassDef::writeMemberGroups(OutputList &ol)
// write user defined member groups
if (m_impl->memberGroupSDict)
{
m_impl->memberGroupSDict->sort();
MemberGroupSDict::Iterator mgli(*m_impl->memberGroupSDict);
MemberGroup *mg;
for (;(mg=mgli.current());++mgli)
......
src/cmdmapper.cpp
View file @ dd7602fd
......@@ -102,6 +102,7 @@ CommandMap cmdMap[] =
{ "$", CMD_DOLLAR },
{ "#", CMD_HASH },
{ "%", CMD_PERCENT },
{ "::", CMD_DCOLON },
{ "\"", CMD_QUOTE },
{ "_internalref", CMD_INTERNALREF },
{ "dot", CMD_DOT },
......
src/cmdmapper.h
View file @ dd7602fd
......@@ -114,7 +114,8 @@ enum CommandType
CMD_COPYBRIEF = 80,
CMD_COPYDETAILS = 81,
CMD_QUOTE = 82,
CMD_MSCFILE = 83
CMD_MSCFILE = 83,
CMD_DCOLON = 84
};
enum HtmlTagType
......
src/code.l
View file @ dd7602fd
......@@ -621,7 +621,7 @@ static void addParmType()
static void addUsingDirective(const char *name)
{
if (g_exampleBlock && g_sourceFileDef && name)
if (g_sourceFileDef && name)
{
NamespaceDef *nd = Doxygen::namespaceSDict->find(name);
if (nd)
......@@ -3394,10 +3394,12 @@ void parseCCode(CodeOutputInterface &od,const char *className,const QCString &s,
g_exampleName = exName;
g_sourceFileDef = fd;
g_lineNumbers = fd!=0 && showLineNumbers;
if (exBlock && fd==0)
bool cleanupSourceDef = FALSE;
if (/* exBlock */ fd==0)
{
// create a dummy filedef for the example
g_sourceFileDef = new FileDef("",exName);
g_sourceFileDef = new FileDef("",(exName?exName:"generated"));
cleanupSourceDef = TRUE;
}
if (g_sourceFileDef)
{
......@@ -3433,7 +3435,7 @@ void parseCCode(CodeOutputInterface &od,const char *className,const QCString &s,
endFontClass();
g_code->endCodeLine();
}
if (exBlock && fd==0)
if (cleanupSourceDef)
{
// delete the temporary file definition used for this example
delete g_sourceFileDef;
......
src/commentcnv.l
View file @ dd7602fd
......@@ -25,6 +25,7 @@
#include <qstack.h>
#include <qregexp.h>
#include <qtextstream.h>
#include <qglobal.h>
#include "bufstr.h"
#include "debug.h"
......@@ -33,6 +34,7 @@
#include "doxygen.h"
#include "util.h"
#include <assert.h>
#define ADDCHAR(c) g_outBuf->addChar(c)
#define ADDARRAY(a,s) g_outBuf->addArray(a,s)
......@@ -134,7 +136,7 @@ static inline void copyToOutput(const char *s,int len)
}
}
}
else
else if (len>0)
{
ADDARRAY(s,len);
static int tabSize=Config_getInt("TAB_SIZE");
......@@ -318,7 +320,12 @@ void replaceComment(int offset);
copyToOutput(yytext,yyleng);
}
<Scan>("//!"|"///").*/\n[ \t]*"//"[\/!][^\/] { /* start C++ style special comment block */
if (g_mlBrief) REJECT; // bail out if we do not need to convert
if (g_mlBrief)
{
REJECT; // bail out if we do not need to convert
}
else
{
int i=3;
if (yytext[2]=='/')
{
......@@ -330,6 +337,7 @@ void replaceComment(int offset);
g_inSpecialComment=TRUE;
BEGIN(SComment);
}
}
<Scan>"//##Documentation".*/\n { /* Start of Rational Rose ANSI C++ comment block */
if (g_mlBrief) REJECT;
int i=17; //=strlen("//##Documentation");
......@@ -770,6 +778,7 @@ void replaceComment(int offset)
{
copyToOutput(" */",3);
int i;for (i=yyleng-1;i>=0;i--) unput(yytext[i]);
g_inSpecialComment=FALSE;
BEGIN(Scan);
}
}
......
src/commentscan.l
View file @ dd7602fd
......@@ -2661,7 +2661,7 @@ void openGroup(Entry *e,const char *,int)
}
else // start of a member group
{
//printf(" membergroup id=%d\n",g_memberGroupId);
//printf(" membergroup id=%d %s\n",g_memberGroupId,g_memberGroupHeader.data());
if (g_memberGroupId==DOX_NOGROUP) // no group started yet
{
static int curGroupId=0;
......
src/compound.xsd
View file @ dd7602fd
......@@ -582,12 +582,6 @@
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="docParamName" mixed="true">
<xsd:sequence>
<xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="1" />
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="docParamName" mixed="true">
<xsd:sequence>
<xsd:element name="ref" type="refTextType" minOccurs="0" maxOccurs="1" />
......
src/compound_xsd.h
View file @ dd7602fd
......@@ -586,12 +586,6 @@
" <xsd:sequence>\n"
" <xsd:element name=\"ref\" type=\"refTextType\" minOccurs=\"0\" maxOccurs=\"1\" />\n"
" </xsd:sequence>\n"
" </xsd:complexType>\n"
"\n"
" <xsd:complexType name=\"docParamName\" mixed=\"true\">\n"
" <xsd:sequence>\n"
" <xsd:element name=\"ref\" type=\"refTextType\" minOccurs=\"0\" maxOccurs=\"1\" />\n"
" </xsd:sequence>\n"
" <xsd:attribute name=\"direction\" type=\"DoxParamDir\" use=\"optional\" />\n"
" </xsd:complexType>\n"
"\n"
......
src/config.xml
View file @ dd7602fd
......@@ -419,6 +419,14 @@ not including the namespace part.
Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
Note: This option applies only to the class list, not to the
alphabetical list.
' defval='0'/>
<option type='bool' id='STRICT_PROTO_MATCHING' docs='
If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
do proper type resolution of all parameters of a function it will reject a
match between the prototype and the implementation of a member function even
if there is only one candidate or it is obvious which candidate to choose
by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
will still accept a match between prototype and implementation in such cases.
' defval='0'/>
<option type='bool' id='GENERATE_TODOLIST' docs='
The GENERATE_TODOLIST tag can be used to enable (YES) or
......@@ -663,8 +671,8 @@ The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
basis. Doxygen will compare the file name with each pattern and apply the
filter if there is a match. The filters are a list of the form:
pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
is applied to all files.
info on how filters are used. If FILTER_PATTERNS is empty or if
non of the patterns match the file name, INPUT_FILTER is applied.
'>
</option>
<option type='bool' id='FILTER_SOURCE_FILES' docs='
......@@ -672,6 +680,13 @@ If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
INPUT_FILTER) will be used to filter the input files when producing source
files to browse (i.e. when SOURCE_BROWSER is set to YES).
' defval='0'/>
<option type='list' id='FILTER_SOURCE_PATTERNS' format='file' docs='
The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
pattern. A pattern will override the setting for FILTER_PATTERN (if any)
and it is also possible to disable source filtering for a specific pattern
using *.ext= (so without naming a filter). This option only has effect when
FILTER_SOURCE_FILES is enabled.
' depends='FILTER_SOURCE_FILES'/>
</group>
<group name='Source Browser' docs='configuration options related to source browsing'>
<option type='bool' id='SOURCE_BROWSER' docs='
......
src/configoptions.cpp
View file @ dd7602fd
......@@ -600,6 +600,14 @@ void addConfigOptions(Config *cfg)
FALSE
);
//----
cb = cfg->addBool(
"STRICT_PROTO_MATCHING",
"If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper type resolution of all parameters of a function it will reject a\n"
"match between the prototype and the implementation of a member function even if there is only one candidate or it is obvious which candidate to choose by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen\n"
"will still accept a match between prototype and implementation in such cases.",
FALSE
);
//----
cb = cfg->addBool(
"GENERATE_TODOLIST",
"The GENERATE_TODOLIST tag can be used to enable (YES) or\n"
......@@ -934,8 +942,8 @@ void addConfigOptions(Config *cfg)
"filter if there is a match.\n"
"The filters are a list of the form:\n"
"pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further\n"
"info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER\n"
"is applied to all files."
"info on how filters are used. If FILTER_PATTERNS is empty or if\n"
"non of the patterns match the file name, INPUT_FILTER is applied."
);
cl->setWidgetType(ConfigList::File);
//----
......@@ -946,6 +954,17 @@ void addConfigOptions(Config *cfg)
"files to browse (i.e. when SOURCE_BROWSER is set to YES).",
FALSE
);
//----
cl = cfg->addList(
"FILTER_SOURCE_PATTERNS",
"The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file\n"
"pattern. A pattern will override the setting for FILTER_PATTERN (if any)\n"
"and it is also possible to disable source filtering for a specific pattern\n"
"using *.ext= (so without naming a filter). This option only has effect when\n"
"FILTER_SOURCE_FILES is enabled."
);
cl->addDependency("FILTER_SOURCE_FILES");
cl->setWidgetType(ConfigList::File);
//---------------------------------------------------------------------------
cfg->addInfo("Source Browser","configuration options related to source browsing");
//---------------------------------------------------------------------------
......
src/declinfo.l
View file @ dd7602fd
......@@ -128,9 +128,11 @@ ID "$"?([a-z_A-Z\x80-\xFF][a-z_A-Z0-9\x80-\xFF]*)|(@[0-9]+)
name += yytext;
}
}
<Start>(~{B}*)?{ID}/({B}*"["{B}*"]")* { // the []'s are for Java,
<Start>([~!]{B}*)?{ID}/({B}*"["{B}*"]")* { // the []'s are for Java,
// the / was add to deal with multi-
// dimensional C++ arrays like A[][15]
// the leading ~ is for a destructor
// the leading ! is for a C++/CLI finalizer (see bug 456475 and 635198)
addTypeName();
name += yytext;
}
......
src/definition.cpp
View file @ dd7602fd
......@@ -544,7 +544,7 @@ static bool readCodeFragment(const char *fileName,
static bool filterSourceFiles = Config_getBool("FILTER_SOURCE_FILES");
//printf("readCodeFragment(%s,%d,%d)\n",fileName,startLine,endLine);
if (fileName==0 || fileName[0]==0) return FALSE; // not a valid file name
QCString filter = getFileFilter(fileName);
QCString filter = getFileFilter(fileName,TRUE);
FILE *f=0;
bool usePipe = !filter.isEmpty() && filterSourceFiles;
if (!usePipe) // no filter given or wanted
......
src/docparser.cpp
View file @ dd7602fd
......@@ -540,6 +540,7 @@ static void detectNoDocumentedParams()
g_memberDef->hasDocumentedReturnType() ||
returnType.isEmpty() || // empty return type
returnType.find("void")!=-1 || // void return type
returnType.find("subroutine")!=-1 || // fortran subroutine
g_memberDef->isConstructor() || // a constructor
g_memberDef->isDestructor() // or destructor
)
......@@ -1107,9 +1108,13 @@ static void handleLinkedWord(DocNode *parent,QList<DocNode> &children)
if (g_token->name.left(1)=="#" || g_token->name.left(2)=="::")
{
warn_doc_error(g_fileName,doctokenizerYYlineno,"warning: explicit link request to '%s' could not be resolved",qPrint(name));
children.append(new DocWord(parent,g_token->name));
}
else
{
children.append(new DocWord(parent,name));
}
}
}
static void handleParameterType(DocNode *parent,QList<DocNode> &children,const QCString &paramTypes)
......@@ -1179,6 +1184,9 @@ reparsetoken:
case CMD_HASH:
children.append(new DocSymbol(parent,DocSymbol::Hash));
break;
case CMD_DCOLON:
children.append(new DocSymbol(parent,DocSymbol::DoubleColon));
break;
case CMD_PERCENT:
children.append(new DocSymbol(parent,DocSymbol::Percent));
break;
......@@ -3018,6 +3026,7 @@ int DocIndexEntry::parse()
case CMD_AMP: m_entry+='&'; break;
case CMD_DOLLAR: m_entry+='$'; break;
case CMD_HASH: m_entry+='#'; break;
case CMD_DCOLON: m_entry+="::"; break;
case CMD_PERCENT: m_entry+='%'; break;
case CMD_QUOTE: m_entry+='"'; break;
default:
......@@ -4772,6 +4781,9 @@ int DocPara::handleCommand(const QCString &cmdName)
case CMD_HASH:
m_children.append(new DocSymbol(this,DocSymbol::Hash));
break;
case CMD_DCOLON:
m_children.append(new DocSymbol(this,DocSymbol::DoubleColon));
break;
case CMD_PERCENT:
m_children.append(new DocSymbol(this,DocSymbol::Percent));
break;
......@@ -6197,6 +6209,9 @@ void DocText::parse()
case CMD_HASH:
m_children.append(new DocSymbol(this,DocSymbol::Hash));
break;
case CMD_DCOLON:
m_children.append(new DocSymbol(this,DocSymbol::DoubleColon));
break;
case CMD_PERCENT:
m_children.append(new DocSymbol(this,DocSymbol::Percent));
break;
......
src/docparser.h
View file @ dd7602fd
......@@ -313,7 +313,7 @@ class DocSymbol : public DocNode
{
public:
enum SymType { Unknown=0, BSlash, At, Less, Greater, Amp, Dollar, Hash,
Percent, Copy, Tm, Reg, Apos, Quot, Uml, Acute,
DoubleColon, Percent, Copy, Tm, Reg, Apos, Quot, Uml, Acute,
Grave, Circ, Tilde, Szlig, Cedil, Ring, Nbsp, Slash,
Lsquo, Rsquo, Ldquo, Rdquo, Ndash, Mdash, Aelig, AElig
};
......
src/docsets.cpp
View file @ dd7602fd
......@@ -343,6 +343,16 @@ void DocSets::addIndexItem(Definition *context,MemberDef *md,const char *)
case MemberDef::Event:
type="event"; break;
}
cd = md->getClassDef();
nd = md->getNamespaceDef();
if (cd)
{
scope = cd->qualifiedName();
}
else if (nd)
{
scope = nd->name();
}
writeToken(m_tts,md,type,lang,scope,md->anchor());
}
else if (context && context->isLinkable())
......@@ -404,7 +414,7 @@ void DocSets::addIndexItem(Definition *context,MemberDef *md,const char *)
}
if (m_scopes.find(context->getOutputFileBase())==0)
{
writeToken(m_tts,context,type,lang,0,0,decl);
writeToken(m_tts,context,type,lang,scope,0,decl);
m_scopes.append(context->getOutputFileBase(),(void*)0x8);
}
}
......
src/doctokenizer.l
View file @ dd7602fd
......@@ -310,6 +310,7 @@ VERBATIM "verbatim"{BLANK}*
SPCMD1 {CMD}([a-z_A-Z][a-z_A-Z0-9]*|{VERBATIM})
SPCMD2 {CMD}[\\@<>&$#%~"]
SPCMD3 {CMD}form#[0-9]+
SPCMD4 {CMD}"::"
INOUT "in"|"out"|("in"{BLANK}*","{BLANK}*"out")|("out"{BLANK}*","{BLANK}*"in")
PARAMIO {CMD}param{BLANK}*"["{BLANK}*{INOUT}{BLANK}*"]"
TEMPCHAR [a-z_A-Z0-9,: \t\*\&]
......@@ -429,7 +430,8 @@ REFWORD {LABELID}|{REFWORD2}
return TK_COMMAND;
}
<St_Para>{SPCMD1} |
<St_Para>{SPCMD2} { /* special command */
<St_Para>{SPCMD2} |
<St_Para>{SPCMD4} { /* special command */
g_token->name = yytext+1;
g_token->name = g_token->name.stripWhiteSpace();
g_token->paramDir=TokenInfo::Unspecified;
......
src/dot.cpp
View file @ dd7602fd
......@@ -997,9 +997,9 @@ bool DotManager::run()
{
uint numDotRuns = m_dotRuns.count();
uint numDotMaps = m_dotMaps.count();
if (numDotRuns+numDotMaps>0)
if (numDotRuns+numDotMaps>1)
{
msg("Generating dot graphs using %d parallel threads...\n",m_workers.count());
msg("Generating dot graphs using %d parallel threads...\n",QMIN(numDotRuns+numDotMaps,m_workers.count()));
}
int i=1;
QListIterator<DotRunner> li(m_dotRuns);
......
src/doxygen.cpp
View file @ dd7602fd
......@@ -3921,7 +3921,7 @@ static bool findTemplateInstanceRelation(Entry *root,
// int *tempArgIndex;
// for (;(tempArgIndex=qdi.current());++qdi)
// {
// printf("(%s->%d) ",qdi.currentKey().data(),*tempArgIndex);
// printf("(%s->%d) ",qdi.currentKey(),*tempArgIndex);
// }
//}
//printf("\n");
......@@ -5651,26 +5651,53 @@ static void findMember(EntryNav *rootNav,
if (count==0 && !(isFriend && funcType=="class"))
{
int candidates=0;
ClassDef *ccd = 0, *ecd = 0;
MemberDef *cmd = 0, *emd = 0;
if (mn->count()>0)
{
//printf("Assume template class\n");
for (mni.toFirst();(md=mni.current());++mni)
{
ClassDef *cd=md->getClassDef();
//printf("cd->name()==%s className=%s\n",cd->name().data(),className.data());
if (cd!=0 && rightScopeMatch(cd->name(),className))
ccd=md->getClassDef();
cmd=md;
//printf("ccd->name()==%s className=%s\n",ccd->name().data(),className.data());
if (ccd!=0 && rightScopeMatch(ccd->name(),className))
{
LockingPtr<ArgumentList> templAl = md->templateArguments();
if (root->tArgLists && templAl!=0 &&
root->tArgLists->getLast()->count()<=templAl->count())
{
addMethodToClass(rootNav,cd,md->name(),isFriend);
addMethodToClass(rootNav,ccd,md->name(),isFriend);
return;
}
if (md->argsString()==argListToString(root->argList,TRUE,FALSE))
{ // exact argument list match -> remember
ecd = ccd;
emd = cmd;
}
candidates++;
}
}
}
static bool strictProtoMatching = Config_getBool("STRICT_PROTO_MATCHING");
if (!strictProtoMatching)
{
if (candidates==1 && ccd && cmd)
{
// we didn't find an actual match on argument lists, but there is only 1 member with this
// name in the same scope, so that has to be the one.
addMemberDocs(rootNav,cmd,funcDecl,0,overloaded,0);
return;
}
else if (candidates>1 && ecd && emd)
{
// we didn't find a unique match using type resolution,
// but one of the matches has the exact same signature so
// we take that one.
addMemberDocs(rootNav,emd,funcDecl,0,overloaded,0);
return;
}
}
QCString warnMsg = "warning: no ";
if (noMatchCount>1) warnMsg+="uniquely ";
......
src/filedef.cpp
View file @ dd7602fd
......@@ -61,7 +61,7 @@ class DevNullCodeDocInterface : public CodeOutputInterface
//---------------------------------------------------------------------------
/*! create a new file definition, where \a p is the file path,
\a nm the file name, and \a ref is an HTML anchor name if the
\a nm the file name, and \a lref is an HTML anchor name if the
file was read from a tag file or 0 otherwise
*/
FileDef::FileDef(const char *p,const char *nm,
......@@ -431,6 +431,7 @@ void FileDef::writeMemberGroups(OutputList &ol)
/* write user defined member groups */
if (memberGroupSDict)
{
memberGroupSDict->sort();
MemberGroupSDict::Iterator mgli(*memberGroupSDict);
MemberGroup *mg;
for (;(mg=mgli.current());++mgli)
......@@ -789,7 +790,7 @@ void FileDef::writeSource(OutputList &ol)
pIntf->resetCodeParserState();
ol.startCodeFragment();
pIntf->parseCode(ol,0,
fileToString(absFilePath(),filterSourceFiles),
fileToString(absFilePath(),filterSourceFiles,TRUE),
FALSE,0,this
);
ol.endCodeFragment();
......@@ -806,7 +807,7 @@ void FileDef::parseSource()
pIntf->resetCodeParserState();
pIntf->parseCode(
devNullIntf,0,
fileToString(absFilePath(),filterSourceFiles),
fileToString(absFilePath(),filterSourceFiles,TRUE),
FALSE,0,this
);
}
......
src/fortranscanner.l
View file @ dd7602fd
......@@ -527,7 +527,7 @@ PREFIX (RECURSIVE{BS_}|PURE{BS_}|ELEMENTAL{BS_}){0,2}(RECURSIVE|PURE|ELEMENTA
/*------- module/global/typedef variable ---------------------------------------------------*/
<SubprogBody,SubprogBodyContains>^{BS}"end"({BS}{SUBPROG}({BS_}{ID})?)?{BS}/(\n|!) {
<SubprogBody,SubprogBodyContains>^{BS}[0-9]*{BS}"end"({BS}{SUBPROG}({BS_}{ID})?)?{BS}/(\n|!) {
//fprintf(stderr,"1e=========> got end subprog: %s\n", yytext);
/* args is used for parameters in list of functions, argList for
......@@ -696,7 +696,7 @@ PREFIX (RECURSIVE{BS_}|PURE{BS_}|ELEMENTAL{BS_}){0,2}(RECURSIVE|PURE|ELEMENTA
// TYPE_SPEC is for old function style function result
result= yytext;
result= result.stripWhiteSpace();
extractPrefix(result);
//extractPrefix(result);
//fprintf(stderr, "===%s\n", (const char*)result);
current->type = result;
yy_push_state(SubprogPrefix);
......@@ -712,7 +712,7 @@ PREFIX (RECURSIVE{BS_}|PURE{BS_}|ELEMENTAL{BS_}){0,2}(RECURSIVE|PURE|ELEMENTA
// Fortran subroutine or function found
result= yytext;
result= result.stripWhiteSpace();
extractPrefix(result);
//extractPrefix(result);
addSubprogram(result);
yy_push_state(Subprog);
}
......@@ -841,7 +841,9 @@ PREFIX (RECURSIVE{BS_}|PURE{BS_}|ELEMENTAL{BS_}){0,2}(RECURSIVE|PURE|ELEMENTA
%%
//----------------------------------------------------------------------------
static void extractPrefix(QCString &text) {
#if 0
static void extractPrefix(QCString &text)
{
int prefixIndex = 0;
int curIndex = 0;
bool cont = TRUE;
......@@ -860,6 +862,7 @@ static void extractPrefix(QCString &text) {
}
}
}
#endif
static int getAmpersandAtTheStart(const char *buf, int length)
{
......
src/groupdef.cpp
View file @ dd7602fd
......@@ -753,6 +753,7 @@ void GroupDef::writeMemberGroups(OutputList &ol)
/* write user defined member groups */
if (memberGroupSDict)
{
memberGroupSDict->sort();
/* write user defined member groups */
MemberGroupSDict::Iterator mgli(*memberGroupSDict);
MemberGroup *mg;
......
src/htmldocvisitor.cpp
View file @ dd7602fd
......@@ -179,6 +179,7 @@ void HtmlDocVisitor::visit(DocSymbol *s)
case DocSymbol::Amp: m_t << "&amp;"; break;
case DocSymbol::Dollar: m_t << "$"; break;
case DocSymbol::Hash: m_t << "#"; break;
case DocSymbol::DoubleColon: m_t << "::"; break;
case DocSymbol::Percent: m_t << "%"; break;
case DocSymbol::Copy: m_t << "&copy;"; break;
case DocSymbol::Tm: m_t << "&trade;"; break;
......@@ -304,7 +305,7 @@ void HtmlDocVisitor::visit(DocVerbatim *s)
if (m_hide) return;
switch(s->type())
{
case DocVerbatim::Code: // fall though
case DocVerbatim::Code:
forceEndParagraph(s);
m_t << PREFRAG_START;
Doxygen::parserManager->getParser(m_langExt)
......
src/index.cpp
View file @ dd7602fd
......@@ -42,6 +42,7 @@
#include "pagedef.h"
#include "dirdef.h"
#include "vhdldocgen.h"
#include "layout.h"
#define MAX_ITEMS_BEFORE_MULTIPAGE_INDEX 200
#define MAX_ITEMS_BEFORE_QUICK_INDEX 30
......@@ -1879,6 +1880,35 @@ void writeQuickMemberIndex(OutputList &ol,
//----------------------------------------------------------------------------
struct CmhlInfo
{
CmhlInfo(const char *fn,const char *t) : fname(fn), title(t) {}
const char *fname;
QCString title;
};
static const CmhlInfo *getCmhlInfo(int hl)
{
static bool fortranOpt = Config_getBool("OPTIMIZE_FOR_FORTRAN");
static bool vhdlOpt = Config_getBool("OPTIMIZE_OUTPUT_VHDL");
static CmhlInfo cmhlInfo[] =
{
CmhlInfo("functions", theTranslator->trAll()),
CmhlInfo("functions_func",
fortranOpt ? theTranslator->trSubprograms() :
vhdlOpt ? VhdlDocGen::trFunctionAndProc() :
theTranslator->trFunctions()),
CmhlInfo("functions_vars",theTranslator->trVariables()),
CmhlInfo("functions_type",theTranslator->trTypedefs()),
CmhlInfo("functions_enum",theTranslator->trEnumerations()),
CmhlInfo("functions_eval",theTranslator->trEnumerationValues()),
CmhlInfo("functions_prop",theTranslator->trProperties()),
CmhlInfo("functions_evnt",theTranslator->trEvents()),
CmhlInfo("functions_rela",theTranslator->trRelatedFunctions())
};
return &cmhlInfo[hl];
}
static void writeClassMemberIndexFiltered(OutputList &ol, ClassMemberHighlight hl)
{
if (documentedClassMembers[hl]==0) return;
......@@ -1894,6 +1924,7 @@ static void writeClassMemberIndexFiltered(OutputList &ol, ClassMemberHighlight h
numPages=127;
}
#if 0
struct CmhlInfo
{
CmhlInfo(const char *fn,const char *t) : fname(fn), title(t) {}
......@@ -1914,6 +1945,7 @@ static void writeClassMemberIndexFiltered(OutputList &ol, ClassMemberHighlight h
CmhlInfo("functions_evnt",theTranslator->trEvents()),
CmhlInfo("functions_rela",theTranslator->trRelatedFunctions())
};
#endif
ol.pushGeneratorState();
ol.disableAllBut(OutputGenerator::Html);
......@@ -1922,7 +1954,7 @@ static void writeClassMemberIndexFiltered(OutputList &ol, ClassMemberHighlight h
QCString title = fortranOpt ? theTranslator->trCompoundMembersFortran() :
vhdlOpt ? VhdlDocGen::trDesignUnitMembers() :
theTranslator->trCompoundMembers() ;
if (hl!=CMHL_All) title+=(QCString)" - "+cmhlInfo[hl].title;
if (hl!=CMHL_All) title+=(QCString)" - "+getCmhlInfo(hl)->title;
int page;
bool first=TRUE;
......@@ -1930,7 +1962,7 @@ static void writeClassMemberIndexFiltered(OutputList &ol, ClassMemberHighlight h
{
if (!multiPageIndex || g_memberIndexLetterUsed[hl][page].count()>0)
{
QCString fileName = cmhlInfo[hl].fname;
QCString fileName = getCmhlInfo(hl)->fname;
if (multiPageIndex && !first)
{
fileName+=QCString().sprintf("_0x%02x",page);
......@@ -1942,8 +1974,8 @@ static void writeClassMemberIndexFiltered(OutputList &ol, ClassMemberHighlight h
// index item for global member list
startQuickIndexItem(ol,
cmhlInfo[0].fname+Doxygen::htmlFileExtension,hl==CMHL_All,TRUE,first);
ol.writeString(fixSpaces(cmhlInfo[0].title));
getCmhlInfo(0)->fname+Doxygen::htmlFileExtension,hl==CMHL_All,TRUE,first);
ol.writeString(fixSpaces(getCmhlInfo(0)->title));
endQuickIndexItem(ol);
// index items per category member lists
......@@ -1952,10 +1984,10 @@ static void writeClassMemberIndexFiltered(OutputList &ol, ClassMemberHighlight h
{
if (documentedClassMembers[i]>0)
{
startQuickIndexItem(ol,cmhlInfo[i].fname+Doxygen::htmlFileExtension,hl==i,TRUE,first);
ol.writeString(fixSpaces(cmhlInfo[i].title));
startQuickIndexItem(ol,getCmhlInfo(i)->fname+Doxygen::htmlFileExtension,hl==i,TRUE,first);
ol.writeString(fixSpaces(getCmhlInfo(i)->title));
//printf("multiPageIndex=%d first=%d fileName=%s file=%s title=%s\n",
// multiPageIndex,first,fileName.data(),cmhlInfo[i].fname,cmhlInfo[i].title.data());
// multiPageIndex,first,fileName.data(),getCmhlInfo(i)->fname,getCmhlInfo(i)->title.data());
endQuickIndexItem(ol);
}
}
......@@ -1967,7 +1999,7 @@ static void writeClassMemberIndexFiltered(OutputList &ol, ClassMemberHighlight h
if (quickIndex)
{
writeQuickMemberIndex(ol,g_memberIndexLetterUsed[hl],page,
cmhlInfo[hl].fname,multiPageIndex);
getCmhlInfo(hl)->fname,multiPageIndex);
}
ol.endQuickIndices();
......@@ -2978,6 +3010,57 @@ void writeExampleIndex(OutputList &ol)
ol.popGeneratorState();
}
//----------------------------------------------------------------------------
void writeFullNavIndex(QTextStream &t, LayoutNavEntry *root,int indent)
{
QCString indentStr;
indentStr.fill(' ',indent*2);
if (root->children().count()>0)
{
t << indentStr << "<ul>" << endl;
QListIterator<LayoutNavEntry> li(root->children());
LayoutNavEntry *entry;
for (li.toFirst();(entry=li.current());++li)
{
t << indentStr << "<li>";
t << "<a href=\"" << entry->baseFile() << Doxygen::htmlFileExtension << "\">";
t << fixSpaces(entry->title());
t << "</a>";
t << "</li>" << endl;
writeFullNavIndex(t,entry,indent+1);
if (entry->kind()==LayoutNavEntry::ClassMembers)
{
t << indentStr << " <ul>" << endl;
// index items per category member lists
int i;
for (i=0;i<CMHL_Total;i++)
{
if (documentedClassMembers[i]>0)
{
t << indentStr << " <li>";
t << "<a href=\"" << getCmhlInfo(i)->fname << Doxygen::htmlFileExtension << "\">";
t << fixSpaces(getCmhlInfo(i)->title);
t << "</a>";
t << "</li>" << endl;
}
}
t << indentStr << " </ul>" << endl;
}
else if (entry->kind()==LayoutNavEntry::NamespaceMembers)
{
t << indentStr << " <namespacemembers>" << endl;
}
else if (entry->kind()==LayoutNavEntry::FileGlobals)
{
t << indentStr << " <fileglobals>" << endl;
}
}
t << indentStr << "</ul>" << endl;
}
}
//----------------------------------------------------------------------------
void countRelatedPages(int &docPages,int &indexPages)
......@@ -3619,6 +3702,18 @@ void writeIndex(OutputList &ol)
projPrefix=Config_getString("PROJECT_NAME")+" ";
}
#if 0
{
QFile f("navindex.html");
if (f.open(IO_WriteOnly))
{
QTextStream t(&f);
LayoutNavEntry *layout = LayoutDocManager::instance().rootNavEntry();
writeFullNavIndex(t,layout,0);
}
}
#endif
//--------------------------------------------------------------------
// write HTML index
//--------------------------------------------------------------------
......
src/latexdocvisitor.cpp
View file @ dd7602fd
......@@ -148,6 +148,7 @@ void LatexDocVisitor::visit(DocSymbol *s)
case DocSymbol::Amp: m_t << "\\&"; break;
case DocSymbol::Dollar: m_t << "\\$"; break;
case DocSymbol::Hash: m_t << "\\#"; break;
case DocSymbol::DoubleColon: m_t << "::"; break;
case DocSymbol::Percent: m_t << "\\%"; break;
case DocSymbol::Copy: m_t << "\\copyright"; break;
case DocSymbol::Tm: m_t << "\\texttrademark"; break;
......
src/mandocvisitor.cpp
View file @ dd7602fd
......@@ -82,6 +82,7 @@ void ManDocVisitor::visit(DocSymbol *s)
case DocSymbol::Amp: m_t << "&"; break;
case DocSymbol::Dollar: m_t << "$"; break;
case DocSymbol::Hash: m_t << "#"; break;
case DocSymbol::DoubleColon: m_t << "::"; break;
case DocSymbol::Percent: m_t << "%"; break;
case DocSymbol::Copy: m_t << "(C)"; break;
case DocSymbol::Tm: m_t << "(TM)"; break;
......
src/membergroup.cpp
View file @ dd7602fd
......@@ -107,7 +107,7 @@ void MemberGroup::setAnchors(ClassDef *context)
void MemberGroup::writeDeclarations(OutputList &ol,
ClassDef *cd,NamespaceDef *nd,FileDef *fd,GroupDef *gd)
{
//printf("MemberGroup::writeDeclarations() memberList->count()=%d\n",memberList->count());
printf("MemberGroup::writeDeclarations() %s\n",grpHeader.data());
QCString ldoc = doc;
if (!ldoc.isEmpty()) ldoc.prepend("<a name=\""+anchor()+"\"></a>");
memberList->writeDeclarations(ol,cd,nd,fd,gd,grpHeader,ldoc/*,TRUE,TRUE*/);
......
src/membergroup.h
View file @ dd7602fd
......@@ -115,6 +115,10 @@ class MemberGroupSDict : public SIntDict<MemberGroup>
public:
MemberGroupSDict(int size=17) : SIntDict<MemberGroup>(size) {}
~MemberGroupSDict() {}
int compareItems(GCI item1,GCI item2)
{
return ((MemberGroup *)item1)->groupId() - ((MemberGroup*)item2)->groupId();
}
};
......
src/namespacedef.cpp
View file @ dd7602fd
......@@ -348,6 +348,7 @@ void NamespaceDef::writeMemberGroups(OutputList &ol)
/* write user defined member groups */
if (memberGroupSDict)
{
memberGroupSDict->sort();
MemberGroupSDict::Iterator mgli(*memberGroupSDict);
MemberGroup *mg;
for (;(mg=mgli.current());++mgli)
......
src/perlmodgen.cpp
View file @ dd7602fd
......@@ -532,6 +532,7 @@ void PerlModDocVisitor::visit(DocSymbol *sy)
case DocSymbol::Amp: c = '&'; break;
case DocSymbol::Dollar: c = '$'; break;
case DocSymbol::Hash: c = '#'; break;
case DocSymbol::DoubleColon: s = "::"; break;
case DocSymbol::Percent: c = '%'; break;
case DocSymbol::Quot: c = '"'; break;
case DocSymbol::Lsquo: s = "\\\'"; break;
......
src/pre.l
View file @ dd7602fd
......@@ -1300,10 +1300,10 @@ static void readIncludeFile(const QCString &inc)
QCString absPath = incFileName;
if (QDir::isRelativePath(incFileName))
{
QString absPath = QDir::cleanDirPath(oldFileDef->getPath()+"/"+incFileName);
absPath = QDir::cleanDirPath(oldFileDef->getPath()+"/"+incFileName);
//printf("%s + %s -> resolved path %s\n",oldFileDef->getPath().data(),incFileName.data(),absPath.data());
}
FileDef *fd = findFileDef(Doxygen::inputNameDict,incFileName,ambig);
FileDef *fd = findFileDef(Doxygen::inputNameDict,absPath,ambig);
//printf("%s::findFileDef(%s)=%p\n",oldFileDef->name().data(),incFileName.data(),fd);
// add include dependency to the file in which the #include was found
oldFileDef->addIncludeDependency(fd,incFileName,localInclude,g_isImported);
......@@ -2130,8 +2130,7 @@ CHARLIT (("'"\\[0-7]{1,3}"'")|("'"\\."'")|("'"[^'\\\n]{1,4}"'"))
}
<SkipCComment,SkipCPPComment>[\\@]"cond"[ \t\r]*\n |
<CondLine>. {
outputArray(yytext,yyleng);
g_yyLineNr+=QCString(yytext).contains('\n');
unput(*yytext);
startCondSection(" ");
if (YY_START==CondLine) BEGIN(g_condCtx);
}
......
src/rtfdocvisitor.cpp
View file @ dd7602fd
......@@ -110,6 +110,7 @@ void RTFDocVisitor::visit(DocSymbol *s)
case DocSymbol::Amp: m_t << "&"; break;
case DocSymbol::Dollar: m_t << "$"; break;
case DocSymbol::Hash: m_t << "#"; break;
case DocSymbol::DoubleColon: m_t << "::"; break;
case DocSymbol::Percent: m_t << "%"; break;
case DocSymbol::Copy: m_t << "(C)"; break;
case DocSymbol::Tm: m_t << "(TM)"; break;
......
src/scanner.l
View file @ dd7602fd
......@@ -2099,7 +2099,12 @@ TYPEDEFPREFIX (("typedef"{BN}+)?)((("volatile"|"const"){BN}+)?)
yyLineNr = atoi(&yytext[1]);
//printf("setting line number to %d\n",yyLineNr);
lastPreLineCtrlContext = YY_START;
if (YY_START==ReadBody ||
YY_START==ReadNSBody ||
YY_START==ReadBodyIntf)
{
current->program+=yytext;
}
BEGIN( PreLineCtrl );
}
<PreLineCtrl>"\""[^\n\"]*"\"" {
......@@ -5553,6 +5558,15 @@ static void handleCommentBlock(const QCString &doc,bool brief)
if (docBlockInBody && hideInBodyDocs) return;
//printf("parseCommentBlock [%s] brief=%d\n",doc.data(),brief);
int lineNr = brief ? current->briefLine : current->docLine; // line of block start
// fill in inbodyFile && inbodyLine the first time, see bug 633891
Entry *docEntry = docBlockInBody && previous ? previous : current;
if (docBlockInBody && docEntry && docEntry->inbodyLine==-1)
{
docEntry->inbodyFile = yyFileName;
docEntry->inbodyLine = lineNr;
}
while (parseCommentBlock(
g_thisParser,
docBlockInBody && previous ? previous : current,
......
src/textdocvisitor.cpp
View file @ dd7602fd
......@@ -33,6 +33,7 @@ void TextDocVisitor::visit(DocSymbol *s)
case DocSymbol::Amp: m_t << "&amp;"; break;
case DocSymbol::Dollar: m_t << "$"; break;
case DocSymbol::Hash: m_t << "#"; break;
case DocSymbol::DoubleColon: m_t << "::"; break;
case DocSymbol::Percent: m_t << "%"; break;
case DocSymbol::Copy: m_t << "&copy;"; break;
case DocSymbol::Tm: m_t << "&tm;"; break;
......
src/util.cpp
View file @ dd7602fd
......@@ -1959,7 +1959,7 @@ void writeExample(OutputList &ol,ExampleSDict *ed)
}
QCString argListToString(ArgumentList *al,bool useCanonicalType)
QCString argListToString(ArgumentList *al,bool useCanonicalType,bool showDefVals)
{
QCString result;
if (al==0) return result;
......@@ -1988,7 +1988,7 @@ QCString argListToString(ArgumentList *al,bool useCanonicalType)
{
result+= type1+type2;
}
if (!a->defval.isEmpty())
if (!a->defval.isEmpty() && showDefVals)
{
result+="="+a->defval;
}
......@@ -2089,24 +2089,9 @@ int filterCRLF(char *buf,int len)
return dest; // length of the valid part of the buf
}
/*! looks for a filter for the file \a name. Returns the name of the filter
* if there is a match for the file name, otherwise an empty string.
*/
QCString getFileFilter(const char* name)
static QCString getFilterFromList(const char *name,const QStrList &filterList,bool &found)
{
// sanity check
if (name==0) return "";
// first look for filter pattern list
QStrList& filterList = Config_getList("FILTER_PATTERNS");
if (filterList.isEmpty())
{
// use INPUT_FILTER instead (For all files)
return Config_getString("INPUT_FILTER");
}
found=FALSE;
// compare the file name to the filter pattern list
QStrListIterator sli(filterList);
char* filterStr;
......@@ -2127,6 +2112,7 @@ QCString getFileFilter(const char* name)
{ // add quotes if the name has spaces
filterName="\""+filterName+"\"";
}
found=TRUE;
return filterName;
}
}
......@@ -2136,6 +2122,39 @@ QCString getFileFilter(const char* name)
return "";
}
/*! looks for a filter for the file \a name. Returns the name of the filter
* if there is a match for the file name, otherwise an empty string.
* In case \a inSourceCode is TRUE then first the source filter list is
* considered.
*/
QCString getFileFilter(const char* name,bool isSourceCode)
{
// sanity check
if (name==0) return "";
QStrList& filterSrcList = Config_getList("FILTER_SOURCE_PATTERNS");
QStrList& filterList = Config_getList("FILTER_PATTERNS");
QCString filterName;
bool found=FALSE;
if (isSourceCode && !filterSrcList.isEmpty())
{ // first look for source filter pattern list
filterName = getFilterFromList(name,filterSrcList,found);
}
if (!found && !filterName.isEmpty())
{ // then look for filter pattern list
filterName = getFilterFromList(name,filterList,found);
}
if (!found)
{ // then use the generic input filter
return Config_getString("INPUT_FILTER");
}
else
{
return filterName;
}
}
#if 0
QCString recodeString(const QCString &str,const char *fromEncoding,const char *toEncoding)
{
......@@ -2220,7 +2239,7 @@ QCString transcodeCharacterStringToUTF8(const QCString &input)
* is TRUE the file will be filtered by any user specified input filter.
* If \a name is "-" the string will be read from standard input.
*/
QCString fileToString(const char *name,bool filter)
QCString fileToString(const char *name,bool filter,bool isSourceCode)
{
if (name==0 || name[0]==0) return 0;
QFile f;
......@@ -2255,7 +2274,7 @@ QCString fileToString(const char *name,bool filter)
err("error: file `%s' not found\n",name);
return "";
}
QCString filterName = getFileFilter(name);
QCString filterName = getFileFilter(name,isSourceCode);
if (filterName.isEmpty() || !filter)
{
f.setName(name);
......@@ -3162,8 +3181,10 @@ QCString getCanonicalTemplateSpec(Definition *d,FileDef *fs,const QCString& spec
static QCString getCanonicalTypeForIdentifier(
Definition *d,FileDef *fs,const QCString &word,
QCString *tSpec)
QCString *tSpec,int count=0)
{
if (count>10) return word; // oops recursion
QCString symName,scope,result,templSpec,tmpName;
//DefinitionList *defList=0;
if (tSpec && !tSpec->isEmpty()) templSpec = stripDeclKeywords(getCanonicalTemplateSpec(d,fs,*tSpec));
......@@ -3266,8 +3287,16 @@ static QCString getCanonicalTypeForIdentifier(
else if (mType && mType->isTypedef()) // a typedef
{
//result = mType->qualifiedName(); // changed after 1.7.2
//result = mType->typeString();
if (word!=mType->typeString())
{
result = getCanonicalTypeForIdentifier(d,fs,mType->typeString(),tSpec,count++);
}
else
{
result = mType->typeString();
}
}
else // fallback
{
resolvedType = resolveTypeDef(d,word);
......@@ -6927,7 +6956,7 @@ bool readInputFile(const char *fileName,BufStr &inBuf)
QFileInfo fi(fileName);
if (!fi.exists()) return FALSE;
QCString filterName = getFileFilter(fileName);
QCString filterName = getFileFilter(fileName,FALSE);
if (filterName.isEmpty())
{
QFile f(fileName);
......
src/util.h
View file @ dd7602fd
......@@ -118,7 +118,7 @@ void linkifyText(const TextGeneratorIntf &ol,
void setAnchors(ClassDef *cd,char id,MemberList *ml,int groupId=-1);
QCString fileToString(const char *name,bool filter=FALSE);
QCString fileToString(const char *name,bool filter=FALSE,bool isSourceCode=FALSE);
QCString dateToString(bool);
......@@ -135,7 +135,7 @@ bool getDefs(const QCString &scopeName,
bool checkCV=FALSE
);
QCString getFileFilter(const char* name);
QCString getFileFilter(const char* name,bool isSourceCode);
bool resolveRef(/* in */ const char *scName,
/* in */ const char *name,
......@@ -207,7 +207,7 @@ inline bool isId(int c)
QCString removeRedundantWhiteSpace(const QCString &s);
QCString argListToString(ArgumentList *al,bool useCanonicalType=FALSE);
QCString argListToString(ArgumentList *al,bool useCanonicalType=FALSE,bool showDefVals=TRUE);
QCString tempArgListToString(ArgumentList *al);
......
src/xmldocvisitor.cpp
View file @ dd7602fd
......@@ -76,6 +76,7 @@ void XmlDocVisitor::visit(DocSymbol *s)
case DocSymbol::Amp: m_t << "&amp;"; break;
case DocSymbol::Dollar: m_t << "$"; break;
case DocSymbol::Hash: m_t << "#"; break;
case DocSymbol::DoubleColon: m_t << "::"; break;
case DocSymbol::Percent: m_t << "%"; break;
case DocSymbol::Copy: m_t << "<copy/>"; break;
case DocSymbol::Tm: m_t << "<trademark/>"; break;
......
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