doxygen-users — List for users of doxygen

Re: [Doxygen-users] FILE_PATTERNS: one custom plus all defaults

[Clayton <cla...@gm...>]

Thanks to both of you. I think to achieve this another configuration
parameter may be required, since no other suggestions are falling out.

Clayton

On Mon, 17 Aug 2015 18:33:04 +0200
Albert <alb...@gm...> wrote:

> The += won't work as it will add the *.js to an empty list resulting
> in a non empty list and as a consequence doxygen thinks non empty
> list so I don't have to apply the defaults.
> 
> Albert
> 
> On Sun, Aug 16, 2015 at 8:07 PM, Richard Damon
> <Ri...@da...> wrote:
> 
> > On 8/16/15 7:45 AM, Clayton wrote:
> > > Hi doxygen,
> > >
> > > I am looking at the config file and writing to ask if I am missing
> > > something.
> > >
> > > I am using
> > >
> > >       FILE_PATTERNS = *.js
> > >       FILTER_PATTERNS = *.js=plugins/js2doxy/js2doxy.pl
> > >
> > > to successfully (more or less) process javascript files. However,
> > > I would *also*, at least in principle, like FILE_PATTERNS to
> > > automatically include all the default patterns that would
> > > normally be processed if the FILE_PATTERNS parameter was left
> > > blank, without having to explicitly list them (noting that the
> > > list in the code is not the same as the list in the config file
> > > comment, for starters).
> > >
> > > I am not seeing any combination of configuration parameters that
> > > will achieve that. Is that true?
> > >
> > > Thanks,
> > > Clayton
> > >
> > Have you tried += to add the items to the lists? I haven't done
> > this to keep defaults, but it might work.
> >
> > --
> > Richard Damon
> >
> >
> >
> > ------------------------------------------------------------------------------
> > _______________________________________________
> > Doxygen-users mailing list
> > Dox...@li...
> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
> >

Re: [Doxygen-users] fenced code block bug

[Albert <alb...@gm...>]

Which LaTeX version are you using on your system. There are problems with
some a bit older LaTeX versions. Might be good to have a look at the recent
texlive version (solved a lot of problems for me on Linux).

I used your code, incorporated as follows in a file aa.h:
/** \file
~~~
'THIS IS A COMMENT
'NOTE! COMMENTS ARE IGNORED BY THE PROGRAM
~~~
*/

I used a default Doxyfile, but don't see the line numbers (I've seen
remarks about this before, but I don't remember under which circumstances).
Maybe you can attach a small complete example (source and Doxyfile, with
the Doxyfile when generating it use the -s option and try to pack it in a
zip file as attachments are limited in size).


Regarding the \- \+ I think they will be there for a good reason (The
change from \- to \+ was commented as follows: Use hook arrow for hyphens
in symbol names in the LaTeX output.).

Albert

On Mon, Aug 17, 2015 at 9:22 AM, Paul Anton Letnes <pa...@le...> wrote:

> Hi!
>
> Okay, so I've dug further into the matter. doxygen 1.8.5 (centos 7) and
> 1.8.6 (ubuntu 14.04) creates this LaTeX code:
>   0  \begin{DoxyCode}
>   1 \textcolor{stringliteral}{'THIS IS A COMMENT}
>   2 \textcolor{stringliteral}{'}NOTE! COMMENTS ARE IGNORED BY THE PROGRAM
>   3 \end{DoxyCode}
> whereas 1.8.9.1 (cygwin, not sure when it was updated last) creates this
> LaTeX code:
>   0  \begin{DoxyCode}
>   1 1 'THIS IS A COMMENT
>   2 2 'NOTE! COMMENTS ARE IGNORED BY THE PROGRAM
>   3 \end{DoxyCode}
>
> Notably, line numbering is suddenly enabled. I've got my markdown sources
> in git, btw, so they should be identical. The 1.8.[56] LaTeX code compiles
> on the LaTeX versions on their respective OS-es, but gives the screenshot
> attached: The \textcolor{...} stuff is included in the output, which it
> should not be.
>
> On cygwin LaTeX and doxygen 1.8.9.1, the LaTeX does not compile due to
> another change in the generated LaTeX - there's a lot of \+ commands in
> CAPITALIZED words (can this be disabled?). On 1.8.[56], there are \-
> commands. For example:
>
> Markdown:
> CAPITALIZED
> LaTeX from 1.8.[56]:
> C\-A\-P\-I\-T\-A\-L\-I\-Z\-E\-D
> LaTeX from 1.8.9.1:
> C\+A\+P\+I\+T\+A\+L\+I\+Z\+E\+D
>
> Is it possible to disable the backslash plusminus behavior? And why do we
> see the differences in generated DoxyCode blocks? The version change 1.8.5
> to 1.8.9 is a fairly minor one, so I'm a bit surprised. Any advice greatly
> appreciated.
>
> -----------
> Paul Anton
>
>
> Den 14. august 2015 skrev woody <kn...@re...>:
>
> Given that curly braces enclose items, it is
> Pretty clear that the {'}  is a stand alone quote, and the remainder of
> the line NOTE!.... is just a line of text, and passed through directly to
> the output.
> However, if the code was
> {'NOTE!.......}
> then I assume it will behave correctly.  perhaps reformatting it so the
> braces line up properly will reveal this.
>
> ~~~
>
> 'THIS IS A COMMENT
>
> 'NOTE! COMMENTS ARE IGNORED BY THE PROGRAM ~~~ the resulting LaTeX code
> has errors in it (the HTML looks fine): \begin
>
>
>                 {
>                 DoxyCode
>                 }
>
> \textcolor         {           stringliteral         }
>
> {'THIS IS A COMMENT}
>
> \textcolor        {        stringliteral         }
>
>       {'}         NOTE! COMMENTS ARE IGNORED BY THE PROGRAM \end{DoxyCode}
>
> This leads to the \textcolor command passing through to the PDF document.
> Also, the curly brace looks off in the second line.
>
> Are there any fixes in more recent versions of doxygen? Or is there a
> workaround that's not too bad? Sometimes it helps to give the .m suffix,
> e.g. ~~~{.m}, to the code block - but weirdly, not always.
>
> ----------- Paul Anton
>
>
>
> ------------------------------------------------------------------------------
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

Re: [Doxygen-users] FILE_PATTERNS: one custom plus all defaults

[Albert <alb...@gm...>]

Bug report is not really needed.

I don't think the other places are in conflict.
There is no separate javascript parser but it is more or less integrated in
the c parser. The g_lang2extMap tells that javascript type of files have to
be parsed by the c parser and that the type of language is SrcLangExt_JS.
With the later it is possible to ask in the code which language a file has
and do special things for this language.

The initDefaultExtensionMapping maps the files extension to the language
type of files.

Albert




On Mon, Aug 17, 2015 at 10:09 AM, Clayton <cla...@gm...> wrote:

> Thanks for the quick work, Albert. Does this mean a bug report is now
> no longer needed? (That's quite the list of bugs in Bugzilla....)
>
> It looks to me like your patch leaves js in. And I am in fact seeing at
> least two different references in util.cpp, which also might be in
> conflict:
>
> g_lang2extMap[] =
> {
> //  language       parser           parser option
>   { "javascript",  "c",             SrcLangExt_JS       },
>
>
> void initDefaultExtensionMapping()
> {
>   g_extLookup.setAutoDelete(TRUE);
>   //                  extension      parser id
>   updateLanguageMapping(".as",       "javascript");
>   updateLanguageMapping(".js",       "javascript");
>
> The second reference above gives the impression that there is an
> internal doxygen parser for javascript? Really??
>
> Clayton
>
>
>
>
> On Sun, 16 Aug 2015 18:21:46 +0200
> Albert <alb...@gm...> wrote:
>
> > I've just pushed a proposed patch to github (pull request 383)
> >
> > Albert
> >
> > On Sun, Aug 16, 2015 at 4:06 PM, Albert <alb...@gm...>
> > wrote:
> >
> > > The following does not yet solve your problem, but points in the
> > > direction where we have to look to solve the problem:
> > > There is in util.cpp another list which does contain .js, looks
> > > like a small inconsistency between config.xml, util.cpp and
> > > config.l. Please file a bug report to signal this discrepancy.
> > >
> > > Albert
> > >
> > >
> > > On Sun, Aug 16, 2015 at 3:09 PM, Clayton <cla...@gm...> wrote:
> > >
> > >> On Sun, 16 Aug 2015 14:05:56 +0200
> > >> Stefan Pendl <ste...@gm...> wrote:
> > >>
> > >> > Am 16.08.2015 um 13:45 schrieb Clayton:
> > >> > > Hi doxygen,
> > >> > >
> > >> > > I am looking at the config file and writing to ask if I am
> > >> > > missing something.
> > >> > >
> > >> > > I am using
> > >> > >
> > >> > >     FILE_PATTERNS = *.js
> > >> > >     FILTER_PATTERNS = *.js=plugins/js2doxy/js2doxy.pl
> > >> >
> > >> > From the help file topic "Configuration => Configuration options
> > >> > related to the input files => FILE_PATTERNS" it seems that *.js
> > >> > is included in the default already.
> > >> >
> > >> > Is your doxygen version less than v1.8.10?
> > >>
> > >> Hi Stefan, the help is not the same as the code, from src/config.l
> > >> in a very recent clone of the source, I believe this to be the
> > >> ACTUAL default list of file patterns:
> > >>
> > >>   QStrList &filePatternList = Config_getList("FILE_PATTERNS");
> > >>   if (filePatternList.isEmpty())
> > >>   {
> > >>     filePatternList.append("*.c");
> > >>     filePatternList.append("*.cc");
> > >>     filePatternList.append("*.cxx");
> > >>     filePatternList.append("*.cpp");
> > >>     filePatternList.append("*.c++");
> > >>     filePatternList.append("*.java");
> > >>     filePatternList.append("*.ii");
> > >>     filePatternList.append("*.ixx");
> > >>     filePatternList.append("*.ipp");
> > >>     filePatternList.append("*.i++");
> > >>     filePatternList.append("*.inl");
> > >>     filePatternList.append("*.h");
> > >>     filePatternList.append("*.hh");
> > >>     filePatternList.append("*.hxx");
> > >>     filePatternList.append("*.hpp");
> > >>     filePatternList.append("*.h++");
> > >>     filePatternList.append("*.idl");
> > >>     filePatternList.append("*.odl");
> > >>     filePatternList.append("*.cs");
> > >>     filePatternList.append("*.php");
> > >>     filePatternList.append("*.php3");
> > >>     filePatternList.append("*.inc");
> > >>     filePatternList.append("*.m");
> > >>     filePatternList.append("*.mm");
> > >>     filePatternList.append("*.dox");
> > >>     filePatternList.append("*.py");
> > >>     filePatternList.append("*.f90");
> > >>     filePatternList.append("*.f");
> > >>     filePatternList.append("*.for");
> > >>     filePatternList.append("*.vhd");
> > >>     filePatternList.append("*.vhdl");
> > >>     filePatternList.append("*.tcl");
> > >>     filePatternList.append("*.md");
> > >>     filePatternList.append("*.markdown");
> > >>
> > >> *.js is not in there. The plugin is necessary, the point is, how
> > >> to get the plugin to integrate with the default list
> > >> automatically, without explicitly adding the default list to
> > >> FILE_PATTERNS.
> > >>
> > >> Thanks,
> > >> Clayton
> > >>
> > >>
> > >>
> ------------------------------------------------------------------------------
> > >> _______________________________________________
> > >> Doxygen-users mailing list
> > >> Dox...@li...
> > >> https://lists.sourceforge.net/lists/listinfo/doxygen-users
> > >>
> > >
> > >
>
>
> ------------------------------------------------------------------------------
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

Re: [Doxygen-users] FILE_PATTERNS: one custom plus all defaults

[Albert <alb...@gm...>]

The += won't work as it will add the *.js to an empty list resulting in a
non empty list and as a consequence doxygen thinks non empty list so I
don't have to apply the defaults.

Albert

On Sun, Aug 16, 2015 at 8:07 PM, Richard Damon <Ri...@da...>
wrote:

> On 8/16/15 7:45 AM, Clayton wrote:
> > Hi doxygen,
> >
> > I am looking at the config file and writing to ask if I am missing
> > something.
> >
> > I am using
> >
> >       FILE_PATTERNS = *.js
> >       FILTER_PATTERNS = *.js=plugins/js2doxy/js2doxy.pl
> >
> > to successfully (more or less) process javascript files. However, I
> > would *also*, at least in principle, like FILE_PATTERNS to
> > automatically include all the default patterns that would normally be
> > processed if the FILE_PATTERNS parameter was left blank, without having
> > to explicitly list them (noting that the list in the code is not the
> > same as the list in the config file comment, for starters).
> >
> > I am not seeing any combination of configuration parameters that will
> > achieve that. Is that true?
> >
> > Thanks,
> > Clayton
> >
> Have you tried += to add the items to the lists? I haven't done this to
> keep defaults, but it might work.
>
> --
> Richard Damon
>
>
>
> ------------------------------------------------------------------------------
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

Re: [Doxygen-users] overloaded template functions with structural commands

[Albert <alb...@gm...>]

With the 1.8.6 version one gets the mentioned messages. With the 1.8.10
version (all Windows, but this should not make any difference) the messages
are gone.
So if would be nice when the package maintainers supplied the newer version
of doxygen

Albert

On Mon, Aug 17, 2015 at 3:09 PM, Donjan Rodic <br...@fr...> wrote:

> I'm using Doxygen 1.8.6 (default repository version of the current
> Ubuntu LTS release) and encounter two issues while trying to move
> documentation to structural commands (mainly \fn for member functions).
>
> The first problem occurs when a class method with different signatures
> is declared const:
>
> /**
>   * \file test.hpp
>   */
> /**
>   * \fn template <T, U> void Foo::bar(T a, U b) const
>   * \brief two args
>   *
>   * \fn template <T> void Foo::bar(T a) const
>   * \brief one arg
>   */
> /**
>   * \brief Foobar
>   */
> class Foo {
>      public:
>      template <typename T, typename U> void bar(T a, U b) const {}
>      template <typename T> void bar(T a) const {}
>
> };
>
> which fails to document with two warnings, one of which is (abbreviated):
>
>    no matching class member found for
>      template< T > void Foo::bar(T a) const
>    Possible candidates:
>      'template < T >
>      void Foo::bar(T a) const
>
> Removing the four occurences of const in the source file "fixes" the
> warning, as does removing one of the signatures, neither of which I can
> do. Using \overload in any combination doesn't help, same with switching
> "T" for "typename T" and similar in pretty much any combination. Not
> sure what the apostrophe in the warning is about.
>
> The other example is about mixing overloading and default parameters:
>
> /**
>   * \file test.hpp
>   */
> /**
>   * \fn template <T, U> void Foo::bar(T a, U b, int c=1)
>   * \brief three args
>   *
>   * \fn template <T> void Foo::bar(T a)
>   * \brief one arg
>   */
> /**
>   * \brief Foobar
>   */
> class Foo {
>      public:
>      template <typename T, typename U> void bar(T a, U b, int c=1) {}
>      template <typename T> void bar(T a) {}
> };
>
> which fails to document with one warning (again abbreviated to the most
> confusing part):
>
>    no matching class member found for
>      template< T, U > void Foo::bar(T a, U b, int c=1)
>    Possible candidates:
>    'template < T, U >
>      void Foo::bar(T a, U b, int c=1)
>
> The one-argument member function gets documented, the three-argument one
> doesn't.
> Removing the default parameter for the third argument "fixes" the
> problem again, and interestingly so does removing the one-argument
> member function (then in the resulting HTML, both \fn commands are
> attached to the three-argument version). Also no success fiddling with
> \overload and template keywords here.
>
> So... any way to make this work properly, or should I go bother the
> package maintainers to start building with clang parsing support?
>
> cheers
> Donjan Rodic
>
>
> ------------------------------------------------------------------------------
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

[Doxygen-users] overloaded template functions with structural commands

[Donjan R. <br...@fr...>]

I'm using Doxygen 1.8.6 (default repository version of the current 
Ubuntu LTS release) and encounter two issues while trying to move 
documentation to structural commands (mainly \fn for member functions).

The first problem occurs when a class method with different signatures 
is declared const:

/**
  * \file test.hpp
  */
/**
  * \fn template <T, U> void Foo::bar(T a, U b) const
  * \brief two args
  *
  * \fn template <T> void Foo::bar(T a) const
  * \brief one arg
  */
/**
  * \brief Foobar
  */
class Foo {
     public:
     template <typename T, typename U> void bar(T a, U b) const {}
     template <typename T> void bar(T a) const {}

};

which fails to document with two warnings, one of which is (abbreviated):

   no matching class member found for
     template< T > void Foo::bar(T a) const
   Possible candidates:
     'template < T >
     void Foo::bar(T a) const

Removing the four occurences of const in the source file "fixes" the 
warning, as does removing one of the signatures, neither of which I can 
do. Using \overload in any combination doesn't help, same with switching 
"T" for "typename T" and similar in pretty much any combination. Not 
sure what the apostrophe in the warning is about.

The other example is about mixing overloading and default parameters:

/**
  * \file test.hpp
  */
/**
  * \fn template <T, U> void Foo::bar(T a, U b, int c=1)
  * \brief three args
  *
  * \fn template <T> void Foo::bar(T a)
  * \brief one arg
  */
/**
  * \brief Foobar
  */
class Foo {
     public:
     template <typename T, typename U> void bar(T a, U b, int c=1) {}
     template <typename T> void bar(T a) {}
};

which fails to document with one warning (again abbreviated to the most 
confusing part):

   no matching class member found for
     template< T, U > void Foo::bar(T a, U b, int c=1)
   Possible candidates:
   'template < T, U >
     void Foo::bar(T a, U b, int c=1)

The one-argument member function gets documented, the three-argument one 
doesn't.
Removing the default parameter for the third argument "fixes" the 
problem again, and interestingly so does removing the one-argument 
member function (then in the resulting HTML, both \fn commands are 
attached to the three-argument version). Also no success fiddling with 
\overload and template keywords here.

So... any way to make this work properly, or should I go bother the 
package maintainers to start building with clang parsing support?

cheers
Donjan Rodic

Re: [Doxygen-users] FILE_PATTERNS: one custom plus all defaults

[Clayton <cla...@gm...>]

Thanks for the quick work, Albert. Does this mean a bug report is now
no longer needed? (That's quite the list of bugs in Bugzilla....)

It looks to me like your patch leaves js in. And I am in fact seeing at
least two different references in util.cpp, which also might be in
conflict:

g_lang2extMap[] =
{
//  language       parser           parser option
  { "javascript",  "c",             SrcLangExt_JS       },


void initDefaultExtensionMapping()
{
  g_extLookup.setAutoDelete(TRUE);
  //                  extension      parser id
  updateLanguageMapping(".as",       "javascript");
  updateLanguageMapping(".js",       "javascript");

The second reference above gives the impression that there is an
internal doxygen parser for javascript? Really??

Clayton




On Sun, 16 Aug 2015 18:21:46 +0200
Albert <alb...@gm...> wrote:

> I've just pushed a proposed patch to github (pull request 383)
> 
> Albert
> 
> On Sun, Aug 16, 2015 at 4:06 PM, Albert <alb...@gm...>
> wrote:
> 
> > The following does not yet solve your problem, but points in the
> > direction where we have to look to solve the problem:
> > There is in util.cpp another list which does contain .js, looks
> > like a small inconsistency between config.xml, util.cpp and
> > config.l. Please file a bug report to signal this discrepancy.
> >
> > Albert
> >
> >
> > On Sun, Aug 16, 2015 at 3:09 PM, Clayton <cla...@gm...> wrote:
> >
> >> On Sun, 16 Aug 2015 14:05:56 +0200
> >> Stefan Pendl <ste...@gm...> wrote:
> >>
> >> > Am 16.08.2015 um 13:45 schrieb Clayton:
> >> > > Hi doxygen,
> >> > >
> >> > > I am looking at the config file and writing to ask if I am
> >> > > missing something.
> >> > >
> >> > > I am using
> >> > >
> >> > >     FILE_PATTERNS = *.js
> >> > >     FILTER_PATTERNS = *.js=plugins/js2doxy/js2doxy.pl
> >> >
> >> > From the help file topic "Configuration => Configuration options
> >> > related to the input files => FILE_PATTERNS" it seems that *.js
> >> > is included in the default already.
> >> >
> >> > Is your doxygen version less than v1.8.10?
> >>
> >> Hi Stefan, the help is not the same as the code, from src/config.l
> >> in a very recent clone of the source, I believe this to be the
> >> ACTUAL default list of file patterns:
> >>
> >>   QStrList &filePatternList = Config_getList("FILE_PATTERNS");
> >>   if (filePatternList.isEmpty())
> >>   {
> >>     filePatternList.append("*.c");
> >>     filePatternList.append("*.cc");
> >>     filePatternList.append("*.cxx");
> >>     filePatternList.append("*.cpp");
> >>     filePatternList.append("*.c++");
> >>     filePatternList.append("*.java");
> >>     filePatternList.append("*.ii");
> >>     filePatternList.append("*.ixx");
> >>     filePatternList.append("*.ipp");
> >>     filePatternList.append("*.i++");
> >>     filePatternList.append("*.inl");
> >>     filePatternList.append("*.h");
> >>     filePatternList.append("*.hh");
> >>     filePatternList.append("*.hxx");
> >>     filePatternList.append("*.hpp");
> >>     filePatternList.append("*.h++");
> >>     filePatternList.append("*.idl");
> >>     filePatternList.append("*.odl");
> >>     filePatternList.append("*.cs");
> >>     filePatternList.append("*.php");
> >>     filePatternList.append("*.php3");
> >>     filePatternList.append("*.inc");
> >>     filePatternList.append("*.m");
> >>     filePatternList.append("*.mm");
> >>     filePatternList.append("*.dox");
> >>     filePatternList.append("*.py");
> >>     filePatternList.append("*.f90");
> >>     filePatternList.append("*.f");
> >>     filePatternList.append("*.for");
> >>     filePatternList.append("*.vhd");
> >>     filePatternList.append("*.vhdl");
> >>     filePatternList.append("*.tcl");
> >>     filePatternList.append("*.md");
> >>     filePatternList.append("*.markdown");
> >>
> >> *.js is not in there. The plugin is necessary, the point is, how
> >> to get the plugin to integrate with the default list
> >> automatically, without explicitly adding the default list to
> >> FILE_PATTERNS.
> >>
> >> Thanks,
> >> Clayton
> >>
> >>
> >> ------------------------------------------------------------------------------
> >> _______________________________________________
> >> Doxygen-users mailing list
> >> Dox...@li...
> >> https://lists.sourceforge.net/lists/listinfo/doxygen-users
> >>
> >
> >

Re: [Doxygen-users] fenced code block bug

[Paul A. L. <pa...@le...>]

Hi!


Okay, so I've dug further into the matter. doxygen 1.8.5 (centos 7) and 1.8.6 (ubuntu 14.04) creates this LaTeX code:
0 \begin{DoxyCode}
1 \textcolor{stringliteral}{'THIS IS A COMMENT}
2 \textcolor{stringliteral}{'}NOTE! COMMENTS ARE IGNORED BY THE PROGRAM
3 \end{DoxyCode}
whereas 1.8.9.1 (cygwin, not sure when it was updated last) creates this LaTeX code:
0 \begin{DoxyCode}
1 1 'THIS IS A COMMENT
2 2 'NOTE! COMMENTS ARE IGNORED BY THE PROGRAM
3 \end{DoxyCode}

Notably, line numbering is suddenly enabled. I've got my markdown sources in git, btw, so they should be identical. The 1.8.[56] LaTeX code compiles on the LaTeX versions on their respective OS-es, but gives the screenshot attached: The \textcolor{...} stuff is included in the output, which it should not be.

On cygwin LaTeX and doxygen 1.8.9.1, the LaTeX does not compile due to another change in the generated LaTeX - there's a lot of \+ commands in CAPITALIZED words (can this be disabled?). On 1.8.[56], there are \- commands. For example:

Markdown:
CAPITALIZED
LaTeX from 1.8.[56]:
C\-A\-P\-I\-T\-A\-L\-I\-Z\-E\-D
LaTeX from 1.8.9.1:
C\+A\+P\+I\+T\+A\+L\+I\+Z\+E\+D

Is it possible to disable the backslash plusminus behavior? And why do we see the differences in generated DoxyCode blocks? The version change 1.8.5 to 1.8.9 is a fairly minor one, so I'm a bit surprised. Any advice greatly appreciated.

-----------
Paul Anton



Den 14. august 2015 skrev woody <kn...@re...>:
> Given that curly braces enclose items, it is
> Pretty clear that the {'} is a stand alone quote, and the remainder of the line NOTE!.... is just a line of text, and passed through directly to the output.
> However, if the code was
> {'NOTE!.......}
> then I assume it will behave correctly. perhaps reformatting it so the braces line up properly will reveal this.
> 
> 
> > ~~~ 'THIS IS A COMMENT 'NOTE! COMMENTS ARE IGNORED BY THE PROGRAM~~~the resulting LaTeX code has errors in it (the HTML looks fine):\begin
> {
> DoxyCode
> }
> > \textcolor{stringliteral}
> > {'THIS IS A COMMENT}
> > \textcolor{stringliteral}
> > {'}NOTE! COMMENTS ARE IGNORED BY THE PROGRAM\end{DoxyCode} This leads to the \textcolor command passing through to the PDF document. Also, the curly brace looks off in the second line. Are there any fixes in more recent versions of doxygen? Or is there a workaround that's not too bad? Sometimes it helps to give the .m suffix, e.g. ~~~{.m}, to the code block - but weirdly, not always. ----------- Paul Anton

Re: [Doxygen-users] FILE_PATTERNS: one custom plus all defaults

[Richard D. <Ri...@Da...>]

On 8/16/15 7:45 AM, Clayton wrote:
> Hi doxygen,
>
> I am looking at the config file and writing to ask if I am missing
> something.
>
> I am using
>
> 	FILE_PATTERNS = *.js
> 	FILTER_PATTERNS = *.js=plugins/js2doxy/js2doxy.pl
>
> to successfully (more or less) process javascript files. However, I
> would *also*, at least in principle, like FILE_PATTERNS to
> automatically include all the default patterns that would normally be
> processed if the FILE_PATTERNS parameter was left blank, without having
> to explicitly list them (noting that the list in the code is not the
> same as the list in the config file comment, for starters).
>
> I am not seeing any combination of configuration parameters that will
> achieve that. Is that true?
>
> Thanks,
> Clayton
>
Have you tried += to add the items to the lists? I haven't done this to 
keep defaults, but it might work.

-- 
Richard Damon

Re: [Doxygen-users] FILE_PATTERNS: one custom plus all defaults

[Albert <alb...@gm...>]

I've just pushed a proposed patch to github (pull request 383)

Albert

On Sun, Aug 16, 2015 at 4:06 PM, Albert <alb...@gm...> wrote:

> The following does not yet solve your problem, but points in the direction
> where we have to look to solve the problem:
> There is in util.cpp another list which does contain .js, looks like a
> small inconsistency between config.xml, util.cpp and config.l.
> Please file a bug report to signal this discrepancy.
>
> Albert
>
>
> On Sun, Aug 16, 2015 at 3:09 PM, Clayton <cla...@gm...> wrote:
>
>> On Sun, 16 Aug 2015 14:05:56 +0200
>> Stefan Pendl <ste...@gm...> wrote:
>>
>> > Am 16.08.2015 um 13:45 schrieb Clayton:
>> > > Hi doxygen,
>> > >
>> > > I am looking at the config file and writing to ask if I am missing
>> > > something.
>> > >
>> > > I am using
>> > >
>> > >     FILE_PATTERNS = *.js
>> > >     FILTER_PATTERNS = *.js=plugins/js2doxy/js2doxy.pl
>> >
>> > From the help file topic "Configuration => Configuration options
>> > related to the input files => FILE_PATTERNS" it seems that *.js is
>> > included in the default already.
>> >
>> > Is your doxygen version less than v1.8.10?
>>
>> Hi Stefan, the help is not the same as the code, from src/config.l in
>> a very recent clone of the source, I believe this to be the ACTUAL
>> default list of file patterns:
>>
>>   QStrList &filePatternList = Config_getList("FILE_PATTERNS");
>>   if (filePatternList.isEmpty())
>>   {
>>     filePatternList.append("*.c");
>>     filePatternList.append("*.cc");
>>     filePatternList.append("*.cxx");
>>     filePatternList.append("*.cpp");
>>     filePatternList.append("*.c++");
>>     filePatternList.append("*.java");
>>     filePatternList.append("*.ii");
>>     filePatternList.append("*.ixx");
>>     filePatternList.append("*.ipp");
>>     filePatternList.append("*.i++");
>>     filePatternList.append("*.inl");
>>     filePatternList.append("*.h");
>>     filePatternList.append("*.hh");
>>     filePatternList.append("*.hxx");
>>     filePatternList.append("*.hpp");
>>     filePatternList.append("*.h++");
>>     filePatternList.append("*.idl");
>>     filePatternList.append("*.odl");
>>     filePatternList.append("*.cs");
>>     filePatternList.append("*.php");
>>     filePatternList.append("*.php3");
>>     filePatternList.append("*.inc");
>>     filePatternList.append("*.m");
>>     filePatternList.append("*.mm");
>>     filePatternList.append("*.dox");
>>     filePatternList.append("*.py");
>>     filePatternList.append("*.f90");
>>     filePatternList.append("*.f");
>>     filePatternList.append("*.for");
>>     filePatternList.append("*.vhd");
>>     filePatternList.append("*.vhdl");
>>     filePatternList.append("*.tcl");
>>     filePatternList.append("*.md");
>>     filePatternList.append("*.markdown");
>>
>> *.js is not in there. The plugin is necessary, the point is, how to get
>> the plugin to integrate with the default list automatically, without
>> explicitly adding the default list to FILE_PATTERNS.
>>
>> Thanks,
>> Clayton
>>
>>
>> ------------------------------------------------------------------------------
>> _______________________________________________
>> Doxygen-users mailing list
>> Dox...@li...
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
>
>

Re: [Doxygen-users] FILE_PATTERNS: one custom plus all defaults

[Albert <alb...@gm...>]

The following does not yet solve your problem, but points in the direction
where we have to look to solve the problem:
There is in util.cpp another list which does contain .js, looks like a
small inconsistency between config.xml, util.cpp and config.l.
Please file a bug report to signal this discrepancy.

Albert


On Sun, Aug 16, 2015 at 3:09 PM, Clayton <cla...@gm...> wrote:

> On Sun, 16 Aug 2015 14:05:56 +0200
> Stefan Pendl <ste...@gm...> wrote:
>
> > Am 16.08.2015 um 13:45 schrieb Clayton:
> > > Hi doxygen,
> > >
> > > I am looking at the config file and writing to ask if I am missing
> > > something.
> > >
> > > I am using
> > >
> > >     FILE_PATTERNS = *.js
> > >     FILTER_PATTERNS = *.js=plugins/js2doxy/js2doxy.pl
> >
> > From the help file topic "Configuration => Configuration options
> > related to the input files => FILE_PATTERNS" it seems that *.js is
> > included in the default already.
> >
> > Is your doxygen version less than v1.8.10?
>
> Hi Stefan, the help is not the same as the code, from src/config.l in
> a very recent clone of the source, I believe this to be the ACTUAL
> default list of file patterns:
>
>   QStrList &filePatternList = Config_getList("FILE_PATTERNS");
>   if (filePatternList.isEmpty())
>   {
>     filePatternList.append("*.c");
>     filePatternList.append("*.cc");
>     filePatternList.append("*.cxx");
>     filePatternList.append("*.cpp");
>     filePatternList.append("*.c++");
>     filePatternList.append("*.java");
>     filePatternList.append("*.ii");
>     filePatternList.append("*.ixx");
>     filePatternList.append("*.ipp");
>     filePatternList.append("*.i++");
>     filePatternList.append("*.inl");
>     filePatternList.append("*.h");
>     filePatternList.append("*.hh");
>     filePatternList.append("*.hxx");
>     filePatternList.append("*.hpp");
>     filePatternList.append("*.h++");
>     filePatternList.append("*.idl");
>     filePatternList.append("*.odl");
>     filePatternList.append("*.cs");
>     filePatternList.append("*.php");
>     filePatternList.append("*.php3");
>     filePatternList.append("*.inc");
>     filePatternList.append("*.m");
>     filePatternList.append("*.mm");
>     filePatternList.append("*.dox");
>     filePatternList.append("*.py");
>     filePatternList.append("*.f90");
>     filePatternList.append("*.f");
>     filePatternList.append("*.for");
>     filePatternList.append("*.vhd");
>     filePatternList.append("*.vhdl");
>     filePatternList.append("*.tcl");
>     filePatternList.append("*.md");
>     filePatternList.append("*.markdown");
>
> *.js is not in there. The plugin is necessary, the point is, how to get
> the plugin to integrate with the default list automatically, without
> explicitly adding the default list to FILE_PATTERNS.
>
> Thanks,
> Clayton
>
>
> ------------------------------------------------------------------------------
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

Re: [Doxygen-users] FILE_PATTERNS: one custom plus all defaults

[Clayton <cla...@gm...>]

On Sun, 16 Aug 2015 14:05:56 +0200
Stefan Pendl <ste...@gm...> wrote:

> Am 16.08.2015 um 13:45 schrieb Clayton:
> > Hi doxygen,
> >
> > I am looking at the config file and writing to ask if I am missing
> > something.
> >
> > I am using
> >
> > 	FILE_PATTERNS = *.js
> > 	FILTER_PATTERNS = *.js=plugins/js2doxy/js2doxy.pl
> 
> From the help file topic "Configuration => Configuration options 
> related to the input files => FILE_PATTERNS" it seems that *.js is 
> included in the default already.
> 
> Is your doxygen version less than v1.8.10?

Hi Stefan, the help is not the same as the code, from src/config.l in
a very recent clone of the source, I believe this to be the ACTUAL
default list of file patterns:

  QStrList &filePatternList = Config_getList("FILE_PATTERNS");
  if (filePatternList.isEmpty())
  {
    filePatternList.append("*.c");
    filePatternList.append("*.cc"); 
    filePatternList.append("*.cxx");
    filePatternList.append("*.cpp");
    filePatternList.append("*.c++");
    filePatternList.append("*.java");
    filePatternList.append("*.ii");
    filePatternList.append("*.ixx");
    filePatternList.append("*.ipp");
    filePatternList.append("*.i++");
    filePatternList.append("*.inl");
    filePatternList.append("*.h");
    filePatternList.append("*.hh");
    filePatternList.append("*.hxx");
    filePatternList.append("*.hpp");
    filePatternList.append("*.h++");
    filePatternList.append("*.idl");
    filePatternList.append("*.odl");
    filePatternList.append("*.cs");
    filePatternList.append("*.php");
    filePatternList.append("*.php3");
    filePatternList.append("*.inc");
    filePatternList.append("*.m");
    filePatternList.append("*.mm");
    filePatternList.append("*.dox");
    filePatternList.append("*.py");
    filePatternList.append("*.f90");
    filePatternList.append("*.f");
    filePatternList.append("*.for");
    filePatternList.append("*.vhd");
    filePatternList.append("*.vhdl");
    filePatternList.append("*.tcl");
    filePatternList.append("*.md");
    filePatternList.append("*.markdown");

*.js is not in there. The plugin is necessary, the point is, how to get
the plugin to integrate with the default list automatically, without
explicitly adding the default list to FILE_PATTERNS.

Thanks,
Clayton

Re: [Doxygen-users] FILE_PATTERNS: one custom plus all defaults

[Stefan P. <ste...@gm...>]

Am 16.08.2015 um 13:45 schrieb Clayton:
> Hi doxygen,
>
> I am looking at the config file and writing to ask if I am missing
> something.
>
> I am using
>
> 	FILE_PATTERNS = *.js
> 	FILTER_PATTERNS = *.js=plugins/js2doxy/js2doxy.pl
>

 From the help file topic "Configuration => Configuration options 
related to the input files => FILE_PATTERNS" it seems that *.js is 
included in the default already.

Is your doxygen version less than v1.8.10?


-- 
*Stefan P.*

Top-posting:
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
A: Top-posting.
Q: What is the most annoying thing in e-mail?

[Doxygen-users] FILE_PATTERNS: one custom plus all defaults

[Clayton <cla...@gm...>]

Hi doxygen,

I am looking at the config file and writing to ask if I am missing
something.

I am using

	FILE_PATTERNS = *.js
	FILTER_PATTERNS = *.js=plugins/js2doxy/js2doxy.pl

to successfully (more or less) process javascript files. However, I
would *also*, at least in principle, like FILE_PATTERNS to
automatically include all the default patterns that would normally be
processed if the FILE_PATTERNS parameter was left blank, without having
to explicitly list them (noting that the list in the code is not the
same as the list in the config file comment, for starters).

I am not seeing any combination of configuration parameters that will
achieve that. Is that true?

Thanks,
Clayton

Re: [Doxygen-users] fenced code block bug

[woody <kn...@re...>]

Given that curly braces enclose items, it is
Pretty clear that the {'}  is a stand alone quote, and the remainder of the 
line NOTE!.... is just a line of text, and passed through directly to the 
output.
However, if the code was
{'NOTE!.......}
then I assume it will behave correctly.  perhaps reformatting it so the 
braces line up properly will reveal this.

>~~~
>
>'THIS IS A COMMENT
>
>'NOTE! COMMENTS ARE IGNORED BY THE PROGRAM
>~~~
>the resulting LaTeX code has errors in it (the HTML looks fine):
>\begin

                 {
                 DoxyCode
                 }
>\textcolor
>         {
>           stringliteral
>         }
>{'THIS IS A COMMENT}
>\textcolor
>        {
>        stringliteral
>         }
>       {'}
>         NOTE! COMMENTS ARE IGNORED BY THE PROGRAM
>\end{DoxyCode}
>
>This leads to the \textcolor command passing through to the PDF document. 
>Also, the curly brace looks off in the second line.
>
>Are there any fixes in more recent versions of doxygen? Or is there a 
>workaround that's not too bad? Sometimes it helps to give the .m suffix, 
>e.g. ~~~{.m}, to the code block - but weirdly, not always.
>
>-----------
>Paul Anton
>
>------------------------------------------------------------------------------
>
>_______________________________________________
>Doxygen-users mailing list
><mailto:Dox...@li...>Dox...@li... 
>
>https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>------------------------------------------------------------------------------
>_______________________________________________
>Doxygen-users mailing list
>Dox...@li...
>https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: [Doxygen-users] fenced code block bug

[Albert <alb...@gm...>]

What kind of investigations did you test regarding the newer versions?

What errors are there in the Latex code, code looks fine to me (and
compiles correctly). The part the second {'} is the closing quote of the
first one, in the HTML you see that the first line has a different color
than the second line (except for the second '. This is mimicked in the
Latex output by the 2 statements. In newer versions behavior is the similar.

Albert

On Fri, Aug 14, 2015 at 2:12 PM, Paul Anton Letnes <pa...@le...> wrote:

> Hi,
>
> I've found something that looks like a bug in doxygen --version: 1.8.6
> (and the same goes for 1.8.5)
>
> If I put this in a fenced code block:
>
> ~~~
>
> 'THIS IS A COMMENT
>
> 'NOTE! COMMENTS ARE IGNORED BY THE PROGRAM
> ~~~
> the resulting LaTeX code has errors in it (the HTML looks fine):
> \begin{DoxyCode}
> \textcolor{stringliteral}{'THIS IS A COMMENT}
> \textcolor{stringliteral}{'}NOTE! COMMENTS ARE IGNORED BY THE PROGRAM
> \end{DoxyCode}
>
> This leads to the \textcolor command passing through to the PDF document.
> Also, the curly brace looks off in the second line.
>
> Are there any fixes in more recent versions of doxygen? Or is there a
> workaround that's not too bad? Sometimes it helps to give the .m suffix,
> e.g. ~~~{.m}, to the code block - but weirdly, not always.
>
> -----------
> Paul Anton
>
>
> ------------------------------------------------------------------------------
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] fenced code block bug

[Paul A. L. <pa...@le...>]

Hi,

I've found something that looks like a bug in doxygen --version: 1.8.6 (and the same goes for 1.8.5)
If I put this in a fenced code block:

~~~
'THIS IS A COMMENT
'NOTE! COMMENTS ARE IGNORED BY THE PROGRAM~~~
the resulting LaTeX code has errors in it (the HTML looks fine):
\begin{DoxyCode}
\textcolor{stringliteral}{'THIS IS A COMMENT}
\textcolor{stringliteral}{'}NOTE! COMMENTS ARE IGNORED BY THE PROGRAM
\end{DoxyCode}

This leads to the \textcolor command passing through to the PDF document. Also, the curly brace looks off in the second line.

Are there any fixes in more recent versions of doxygen? Or is there a workaround that's not too bad? Sometimes it helps to give the .m suffix, e.g. ~~~{.m}, to the code block - but weirdly, not always.

-----------
Paul Anton

[Doxygen-users] Trouble with captions for tables

[arnab <arn...@ya...>]

As far as I can tell, it is not possible to generate auto-numbered captions
for tables using markdown. Please correct me if I'm wrong. A pointer to a
minimal example would be great. I am using doxygen version 1.8.9.1.

I'm trying to convert my tables to HTML. With this table:

///  &lttable&gt
///  &ltcaption align=top&gt Foo Functions &lt/caption&gt
///  &lttr&gt
///  &ltth&gt API Call &lt/th&gt &ltth&gt Description &lt/th&gt
///  &lt/tr&gt
///  &lttr&gt
///  &lttd&gt get_foo() &lt/td&gt
///  &lttd&gt Get current value of foo. &lt/td&gt
///  &lt/tr&gt
///  &lttr&gt
///  &lttd&gt set_foo() &lt/td&gt
///  &lttd&gt Set new value of foo. &lt/td&gt
///  &lt/tr&gt
///  &lttr&gt
///  &lt/table&gt

I get an error running pdflatex. The cause of the error appears to be
mismatched TabularC/TabularNC in the generated output:

\begin{table}[h]\begin{TabularC}{2}
\hline
\rowcolor{lightgray}{\bf A\+P\+I Call  }&{\bf Description   }\\\cline{1-2}
get\+\_\+foo()  &Get current value of foo.   \\\cline{1-2}
set\+\_\+foo()  &Set new value of foo.   \\\cline{1-2}
\end{TabularNC}        <<==== Right here
\centering
\caption{Foo Functions }
\end{table}

Why would this happen ? If I change the TabularNC to TabularC by hand and
then run pdflatex it produces a table, although the the caption is at the
bottom.

Thanks in advance for any help.
Arnab




--
View this message in context: http://doxygen.10944.n7.nabble.com/Trouble-with-captions-for-tables-tp7303.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] C++ bug with final classes ?

[Barthelemy V. H. <Bar...@ce...>]

Hello,

I have a class defined as :
class ExampleTask final : public TaskInterface
{
  public:
    ExampleTask(std::string name, Publisher *publisher);
    void initialize() override;
};

Implementation being :
ExampleTask::ExampleTask(std::string name, Publisher *publisher)
  : TaskInterface(name, publisher)
{
}
void ExampleTask::initialize()
{
  // nothing
}

When I run doxygen, I get :
ExampleTask.cxx:22: Warning: no matching class member found for
  ExampleTask::ExampleTask(std::string name, Publisher *publisher)
ExampleTask.cxx:30: Warning: no uniquely matching class member found for
  void ExampleTask::initialize()

I don't think that the error is correct. After some tests, I realized that removing the "final" from the class definitio solved the issue.

Is it a bug or is it me who do something illegal in C++ ?

Thank you in advance for your help,
Barth

[Doxygen-users] browser support - for HTML output ?

[Monique S. <mon...@ea...>]

Hello, Doxygen users,

Is there a list anywhere that says what the browser support is for Doxygen’s HTML output (from Doxygen 1.8.10)?

Or barring that, is there an explanation of which version of HTML is output?

It’s always good to tell users how to achieve the best viewing experience...

Thanks,
-Monique

[Doxygen-users] Documenting a Python module that's split into multiple files

[Peter E. <pea...@st...>]

Hi,

I posted this question on StackOverflow, but I haven't gotten any answer there, so I'm trying here in the hope that someone can help me.
I'm using Doxygen to document some Python code. It includes a module that is split into multiple files. I needed to do that for maintainability. Some of the classes in the module are very large with complex implementations. If I had to combine them all into one file, that file would become unmanageably large, well over 10,000 lines. So I split them into many files, then have __init__.py import all the files into the parent module. This works nicely: the code is maintainable, and users can import everything with a single import statement.

But Doxygen doesn't know about this. It shows the classes as being split into many modules. Users shouldn't need to even know all those modules exist. They're just an implementation detail to keep the code simpler. How can I make it produce documentation that matches the intended API, with all the classes shown as being in a single module?

Thanks!

Peter

Re: [Doxygen-users] overloaded C++ functions - any way to consolidate ?

[Monique S. <mon...@ea...>]

> Doxygen automatically generates documentation for each signature. What we do is put all the documentation in the first of these, then use auto-cross-references from each of the others to the one with the documentation:
/** See Function() */

Well, after lots more research, I’ve learned that lots of people wish for this (overloaded method output to match the general style of the cplusplus references). There are numerous threads in StackOverflow, and numerous experiments and talk, but it seems that it’s simply not possible at the moment.
I did try the @overload command in Doxygen (http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdoverload), but I’m either using it incorrectly or assuming that it will do the opposite of what I expected. (I’m using Doxygen 1.8.10.)
DETAILS:
Here’s what I’m trying to do, for the following sort of code (albeit very simplified):
void foo(int a);                           <—function to be referenced
void foo(int a, int b);         <—overload 1
void foo(int a, char* b);    <—overload 2
I put the “function to be referenced” at the top of my class declaration, per Note 1 in the Doxygen manual.
Then for both the “overload 1” and “overload 2” functions, I included the “@overload void foo(int a)” command.
For both “overload 1” and “overload 2”, I expected to get the generated message, “This is an overloaded member function, provided for convenience...” to be used as the @brief description, or to at least get the @brief description to appear in the class summary pages; and then in the details, I’d expect to see the both the “overloaded member” generated message and the full contents of the Doxygen comment.
But instead, it’s reversed in logic, and missing output. The output for the function to be referenced (foo(int a)) has the “overloaded member” generated message. And the other functions do not have any Doxygen comment output.
THE QUESTION:
I can understand the reverse logic that is putting the “overloaded” generated message in the function to be referenced – after all, that is the function that is overloaded. But why is all output from the “overload 1” and “overload 2” functions missing?
Thanks for any ideas and suggestions,
-Monique

Re: [Doxygen-users] overloaded C++ functions - any way to consolidate ?

[<dam...@xc...>]

Hello Monica

Doxygen automatically generates documentation for each signature. What we
do is put all the documentation in the first of these, then use
auto-cross-references from each of the others to the one with the
documentation:
/** See Function() */

- Damon



                                                                                                                       
  From:       "Monique Semp" <mon...@ea...>                                                              
                                                                                                                       
  To:         "doxygen-users" <dox...@li...>,                                                   
                                                                                                                       
  Date:       08/03/2015 02:42 PM                                                                                      
                                                                                                                       
  Subject:    [Doxygen-users] overloaded C++ functions - any way to consolidate ?                                      
                                                                                                                       





Hello, Doxygen users,

I’m using Doxygen 1.8.10, and would like to explore consolidating the
documentation for overloaded functions. What I’m after is output that would
be similar to how the cplusplus.com site documents things; for example,
http://www.cplusplus.com/reference/string/string/assign/.

I know how to use groups, but that would still create separate output for
every overload instance, and I’d like to streamline the documentation by
consolidating the overloaded functions.

This seems like a common use-case for documentation, so I’m hoping that
this is something that Doxygen supports. I’ve typically used Doxygen for C
code (and set the configuration options to best support C), not C++, so my
apologies if this is easy and I’ve just missed the applicable config file
options.

Thanks for your help,
-Monique
------------------------------------------------------------------------------

_______________________________________________
Doxygen-users mailing list
Dox...@li...
http://cp.mcafee.com/d/5fHCMUedEIcLe9zCm1NKVJ6W8VZB5NWVJ6X3wVcsqen7zqdQhPXabzO9J6XZTNPPbZPq6GRxRJzfUwEfJYoXOVIfJYoXOVJd5MwWgvvW_6zBBNwsqerZuVt4QsFzKhud7b5TS4umKzp55mXyfaxVZicHs3jq9J4TvAm4TDNOb2pEVdTdAVPmEBC7OFeDkGT6TKw0vU6UvaAWovaAVgtHy5gYIh-1tKDNErgG7ByfMbJQ-d2V2Hsbvg57OFeDkGT6TKw0vU6CT3hOOOrdbotkfb4vwnrFYq6BQQglc_4-KEuwq818080jh0WT2QVlxgQg5Ph1I2NEwcqmd44WCy2RokGv93p-q82hJMsrZdksRD5K5lCN

Re: [Doxygen-users] overloaded C++ functions - any way to consolidate ?

[Monique S. <mon...@ea...>]

Oh, I should have included the details that I have played a bit with the @name and @overload commands, but they’re not doing quite what I’d expect. So if you have a publically-viewable site that does this sort of thing and can share the Doxygen technique that you used, that’d be excellent!

Thanks,
-Monique

From: Monique Semp 
Sent: Monday, August 03, 2015 11:39 AM
To: doxygen-users 
Subject: [Doxygen-users] overloaded C++ functions - any way to consolidate ?

Hello, Doxygen users,

I’m using Doxygen 1.8.10, and would like to explore consolidating the documentation for overloaded functions. What I’m after is output that would be similar to how the cplusplus.com site documents things; for example, http://www.cplusplus.com/reference/string/string/assign/. 

I know how to use groups, but that would still create separate output for every overload instance, and I’d like to streamline the documentation by consolidating the overloaded functions.

This seems like a common use-case for documentation, so I’m hoping that this is something that Doxygen supports. I’ve typically used Doxygen for C code (and set the configuration options to best support C), not C++, so my apologies if this is easy and I’ve just missed the applicable config file options.

Thanks for your help,
-Monique


--------------------------------------------------------------------------------
------------------------------------------------------------------------------



--------------------------------------------------------------------------------
_______________________________________________
Doxygen-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] overloaded C++ functions - any way to consolidate ?

[Monique S. <mon...@ea...>]

Hello, Doxygen users,

I’m using Doxygen 1.8.10, and would like to explore consolidating the documentation for overloaded functions. What I’m after is output that would be similar to how the cplusplus.com site documents things; for example, http://www.cplusplus.com/reference/string/string/assign/. 

I know how to use groups, but that would still create separate output for every overload instance, and I’d like to streamline the documentation by consolidating the overloaded functions.

This seems like a common use-case for documentation, so I’m hoping that this is something that Doxygen supports. I’ve typically used Doxygen for C code (and set the configuration options to best support C), not C++, so my apologies if this is easy and I’ve just missed the applicable config file options.

Thanks for your help,
-Monique