doxygen-users — List for users of doxygen

Re: [Doxygen-users] Doxygen not showing friend operators of C++ base class

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

ADL tricks do not really make something a member, it gives it preference 
in the lookup but it does NOT make the function a friend or a member 
function of the derived class. I think that Doxygen is currently right 
to not make it such, or to incorrectly falsely list friends as 
'inherited'. Perhaps in this sort of case, the function should be marked 
with something like the @memberof tag to pull this friend in closer to 
the class. This seems a better solution to me. (Don't know if that works 
in Doxygen, but if not, fixing that seems less likely than having 
Doxygen 'lie' without user action.

On 9/1/17 7:43 AM, Maarten de Jong wrote:
> Dear Richard,
>
> It actually corresponds to the so-called Barton–Nackman trick which is 
> conform the C++ standard.
> It is characterized by an in-class friend function definition 
> appearing in the base class template
> component of the curiously recurring template pattern (CRTP).
> This implies that the friend specifier is essential.
>
> Maarten
>
>
> On 01/09/2017 12:56, Richard Damon wrote:
>> On 9/1/17 2:03 AM, Maarten de Jong wrote:
>>> Dear all,
>>>
>>> In some previous versions of Doxygen (e.g. 1.6.1) , the friend 
>>> operators of the base class
>>> in the attached example were displayed as "Friends" under the 
>>> listing of the derived class
>>> but this is no longer so in the latest version of Doxygen (1.8.13).
>>> For information, the parameter INLINE_INHERITED_MEMB = YES.
>>> Would it be possible to recover this information?
>>> Thanks in advance,
>>>
>>> Maarten
>>>
>> One thing to note, friends are NOT inherited in C++, so the friend of 
>> a base class has no special rights to my private/protected members, 
>> just those of my base class that gave it friendship.
>>
>> The out of class operators (which are sometimes given friend access) 
>> are NOT member functions.
>>
>> Doxygen listing them as 'Inherited Members' would have been a bug.
>>
>
>

-- 
Richard Damon

Re: [Doxygen-users] Doxygen not showing friend operators of C++ base class

[Maarten de J. <mj...@ni...>]

Dear Richard,

It actually corresponds to the so-called Barton–Nackman trick which is 
conform the C++ standard.
It is characterized by an in-class friend function definition appearing 
in the base class template
component of the curiously recurring template pattern (CRTP).
This implies that the friend specifier is essential.

Maarten


On 01/09/2017 12:56, Richard Damon wrote:
> On 9/1/17 2:03 AM, Maarten de Jong wrote:
>> Dear all,
>>
>> In some previous versions of Doxygen (e.g. 1.6.1) , the friend 
>> operators of the base class
>> in the attached example were displayed as "Friends" under the listing 
>> of the derived class
>> but this is no longer so in the latest version of Doxygen (1.8.13).
>> For information, the parameter INLINE_INHERITED_MEMB = YES.
>> Would it be possible to recover this information?
>> Thanks in advance,
>>
>> Maarten
>>
> One thing to note, friends are NOT inherited in C++, so the friend of 
> a base class has no special rights to my private/protected members, 
> just those of my base class that gave it friendship.
>
> The out of class operators (which are sometimes given friend access) 
> are NOT member functions.
>
> Doxygen listing them as 'Inherited Members' would have been a bug.
>

Re: [Doxygen-users] Doxygen not showing friend operators of C++ base class

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

On 9/1/17 2:03 AM, Maarten de Jong wrote:
> Dear all,
>
> In some previous versions of Doxygen (e.g. 1.6.1) , the friend 
> operators of the base class
> in the attached example were displayed as "Friends" under the listing 
> of the derived class
> but this is no longer so in the latest version of Doxygen (1.8.13).
> For information, the parameter INLINE_INHERITED_MEMB = YES.
> Would it be possible to recover this information?
> Thanks in advance,
>
> Maarten
>
One thing to note, friends are NOT inherited in C++, so the friend of a 
base class has no special rights to my private/protected members, just 
those of my base class that gave it friendship.

The out of class operators (which are sometimes given friend access) are 
NOT member functions.

Doxygen listing them as 'Inherited Members' would have been a bug.

-- 
Richard Damon

[Doxygen-users] Doxygen not showing friend operators of C++ base class

[Maarten de J. <mj...@ni...>]

Dear all,

In some previous versions of Doxygen (e.g. 1.6.1) , the friend operators 
of the base class
in the attached example were displayed as "Friends" under the listing of 
the derived class
but this is no longer so in the latest version of Doxygen (1.8.13).
For information, the parameter INLINE_INHERITED_MEMB = YES.
Would it be possible to recover this information?
Thanks in advance,

Maarten

Re: [Doxygen-users] Silent installer for doxygen

[Ziegler, M. <Mar...@we...>]

Hello,

doxygen setup is built using Inno Setup.
Silent install is documented here http://www.jrsoftware.org/ishelp/

Mit freundlichen Grüßen  |  Best regards,

i.A. MARK ZIEGLER
Produktbereich Profilieren | Product Unit Profiling
Leitung Softwareentwicklung | Head of Software R&D
Phone +49 (0) 9341 86-1726
Mobil +49 (0) 176 - 186 110 12
Fax +49 (0) 9341 86-31726
mar...@we...<mailto:mar...@we...>

MICHAEL WEINIG AG
Weinigstraße 2/4
97941 Tauberbischofsheim
Deutschland
www.weinig.com<http://www.weinig.com/>

Von: mad...@si... [mailto:mad...@si...]
Gesendet: Donnerstag, 24. August 2017 13:16
An: dox...@li...
Betreff: [Doxygen-users] Silent installer for doxygen

Hi,

I am trying to do a Chef recipe for installing doxygen on windows automatically.

I am wondering if there is a way to install doxygen from the commandline using parameters instead of the GUI wizard. If there is, can someone point me to the documentation of it.

I have tried the most common parameters (/? -help /S /q) without any luck. Any ideas for me?

With best regards,
Mads Baggesen


[http://www.weinig.com/fileadmin/assets/weinig/Signatur_THINK_WEINIG_300.jpg]

Vorsitzender des Aufsichtsrats: Dr. Thomas Bach
Vorstand: Wolfgang Pöschl (Vorsitzender), Gregor Baumbusch, Gerald Schmidt
Sitz Tauberbischofsheim, Amtsgericht Mannheim HRB 560227
UST / ID-Nr. DE 146587898

Re: [Doxygen-users] Silent installer for doxygen

[<mad...@si...>]

Perfect, thank you.

>From the CMake files on github I thought that it was created using NSIS - which have the /S options :)

With best regards,
Mads Baggesen


From: Ziegler, Mark [mailto:Mar...@we...]
Sent: 24. august 2017 13:36
To: Baggesen, Mads ext (WP TE SES TENV); dox...@li...
Subject: AW: Silent installer for doxygen

Hello,

doxygen setup is built using Inno Setup.
Silent install is documented here http://www.jrsoftware.org/ishelp/

Mit freundlichen Grüßen  |  Best regards,

i.A. MARK ZIEGLER
Produktbereich Profilieren | Product Unit Profiling
Leitung Softwareentwicklung | Head of Software R&D
Phone +49 (0) 9341 86-1726
Mobil +49 (0) 176 - 186 110 12
Fax +49 (0) 9341 86-31726
mar...@we...<mailto:mar...@we...>

MICHAEL WEINIG AG
Weinigstraße 2/4
97941 Tauberbischofsheim
Deutschland
www.weinig.com<http://www.weinig.com/>

Von: mad...@si...<mailto:mad...@si...> [mailto:mad...@si...]
Gesendet: Donnerstag, 24. August 2017 13:16
An: dox...@li...<mailto:dox...@li...>
Betreff: [Doxygen-users] Silent installer for doxygen

Hi,

I am trying to do a Chef recipe for installing doxygen on windows automatically.

I am wondering if there is a way to install doxygen from the commandline using parameters instead of the GUI wizard. If there is, can someone point me to the documentation of it.

I have tried the most common parameters (/? -help /S /q) without any luck. Any ideas for me?

With best regards,
Mads Baggesen


[http://www.weinig.com/fileadmin/assets/weinig/Signatur_THINK_WEINIG_300.jpg]

Vorsitzender des Aufsichtsrats: Dr. Thomas Bach
Vorstand: Wolfgang Pöschl (Vorsitzender), Gregor Baumbusch, Gerald Schmidt
Sitz Tauberbischofsheim, Amtsgericht Mannheim HRB 560227
UST / ID-Nr. DE 146587898

[Doxygen-users] Silent installer for doxygen

[<mad...@si...>]

Hi,

I am trying to do a Chef recipe for installing doxygen on windows automatically.

I am wondering if there is a way to install doxygen from the commandline using parameters instead of the GUI wizard. If there is, can someone point me to the documentation of it.

I have tried the most common parameters (/? -help /S /q) without any luck. Any ideas for me?

With best regards,
Mads Baggesen

Re: [Doxygen-users] Doxygen-users Digest, Vol 135, Issue 10

[Ron W <ron...@gm...>]

On Tue, Aug 22, 2017 at 8:23 AM, <
dox...@li...> wrote:
>
> Date: Mon, 21 Aug 2017 16:49:52 +0200
> From: Stefan Ludewig <ste...@ex...>
> Subject: Re: [Doxygen-users] set PROJECT_NUMBER to the value of a
>         #define from a header file
>
> Your solution is exactly what I had in mind as a backup solution if I could
> not find a bulit-in solution, as it involves additional tools ? you run a
> makefile to set the project version, which means, it won?t work in the case
> that one starts doxygen directly without involving that makefile. I was
> looking for a solution that does not have this restriction.
>

Another option would be to maintain the project version in the doxyfile and
have the build procedure read the version from the doxyfile.

Something like:

#!/usr/bin/env perl
while (<>)
{
    if (/PROJECT_NUMBER\s*=\s*(\d+)([.](\d+)([.](\d+)))/)
    {
        print "#define MAJOR_VERSION $1\n";
        print "#define MINOR_VERSION $3\n";
        print "#define TINY_VERSION $5\n";
    }
}

Then in your build/make script:

readversion <doxyfile >version.h

Re: [Doxygen-users] set PROJECT_NUMBER to the value of a #define from a header file

[Stefan L. <ste...@ex...>]

Hi Alessandro.



Your solution is exactly what I had in mind as a backup solution if I could
not find a bulit-in solution, as it involves additional tools – you run a
makefile to set the project version, which means, it won’t work in the case
that one starts doxygen directly without involving that makefile. I was
looking for a solution that does not have this restriction.



Kind regards,

Stefan.



*From:* Alessandro Antonello [mailto:ant...@gm...]
*Sent:* Sonntag, 20. August 2017 21:47
*To:* Stefan Ludewig
*Cc:* dox...@li...
*Subject:* Re: [Doxygen-users] set PROJECT_NUMBER to the value of a #define
from a header file



Hi, Stefan



I faced this problem years ago and the solution I came up was to add a
target in my Makefiles where I also set variables with the the project
version.



MAJOR_VERSION = 1

MINOR_VERSION = 10

BUILD_VERSION = 155

VERSION_NUMBER = $(MAJOR_VERSION).$(MINOR_VERSION).$(BUILD_VERSION)



Then I added a target with the following command line:



docs : $(HTML_DIR)

          ( cat doxyfile; echo "PROJECT_NUMBER=$(VERSION_NUMBER)" ) |
doxygen -



That command generates the documentation with the version number defined in
the Makefile that is also used in the the header variables inside the
project.







2017-08-18 11:51 GMT-03:00 Stefan Ludewig <kai...@ex...>:

Hi.

I would like to centralize the versioning of a project to avoid having to
count up the project version number at multiple places all the time.

I have version.h file, which looks like this:
#define STRINGIFY2(param) #param
#define STRINGIFY(param) EG_PHOTON_STRINGIFY2(param)

#define VERSION_MAJOR 4
#define VERSION_SERVER_MINOR 1
#define VERSION_CLIENT_MINOR 8
#define VERSION_PATCH_RELEASE 2
#define VERSION STRINGIFY(VERSION_MAJOR) "."
STRINGIFY(VERSION_SERVER_MINOR) "." STRINGIFY(VERSION_CLIENT_MINOR) "."
STRINGIFY(VERSION_PATCH_RELEASE)



- the resource-files include this header, so that the Visual Studio
resource compiler can use it for the version number that is shown in the
details page of a generated dll
- the build-scripts parse that file, so that they can include that number
as part of the name of the generated package
- the code itself also includes this header so that it can send the
version to the server when connecting

Now I wonder about the bst way to also have doxygen use this version
number when generating the documentation.
As a fallback option I could just have the buildscript parse in doxygens
configuration file and replace the value to which PROJECT_NUMBER is set
with the value from that header that the build script already has
available anyway, before running doxygen.
However that would mean that only after running a script first, doxygen
would know the correct version number to use.
I would prefer if doxygen would also know the correct version number
without the need to run an external tool first.
Is there any way  how to tell doxygen in its config file to read out the
version number from a #define in a header file?
I know that it's possible to set PROJECT_NUMBER to an environment variable
instead of a hard coded value, but that doesn't help as we still would
have to update the env var every time when version.h gets updated, which
is errorprone.
So is there any way to have doxygen use the value of a #define for the
version number in the generated docs without using any external tools?

Kind regards,
Stefan.

--

--
Exit Games Inc.

We Make Multiplayer Simple
www.photonengine.com

------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
_______________________________________________
Doxygen-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

-- 

--
Exit Games Inc.

We Make Multiplayer Simple
www.photonengine.com

Re: [Doxygen-users] set PROJECT_NUMBER to the value of a #define from a header file

[Alessandro A. <ant...@gm...>]

Hi, Stefan

I faced this problem years ago and the solution I came up was to add a
target in my Makefiles where I also set variables with the the project
version.

MAJOR_VERSION = 1
MINOR_VERSION = 10
BUILD_VERSION = 155
VERSION_NUMBER = $(MAJOR_VERSION).$(MINOR_VERSION).$(BUILD_VERSION)

Then I added a target with the following command line:

docs : $(HTML_DIR)
( cat doxyfile; echo "PROJECT_NUMBER=$(VERSION_NUMBER)" ) | doxygen -

That command generates the documentation with the version number defined in
the Makefile that is also used in the the header variables inside the
project.



2017-08-18 11:51 GMT-03:00 Stefan Ludewig <kai...@ex...>:

> Hi.
>
> I would like to centralize the versioning of a project to avoid having to
> count up the project version number at multiple places all the time.
>
> I have version.h file, which looks like this:
> #define STRINGIFY2(param) #param
> #define STRINGIFY(param) EG_PHOTON_STRINGIFY2(param)
>
> #define VERSION_MAJOR 4
> #define VERSION_SERVER_MINOR 1
> #define VERSION_CLIENT_MINOR 8
> #define VERSION_PATCH_RELEASE 2
> #define VERSION STRINGIFY(VERSION_MAJOR) "."
> STRINGIFY(VERSION_SERVER_MINOR) "." STRINGIFY(VERSION_CLIENT_MINOR) "."
> STRINGIFY(VERSION_PATCH_RELEASE)
>
>
>
> - the resource-files include this header, so that the Visual Studio
> resource compiler can use it for the version number that is shown in the
> details page of a generated dll
> - the build-scripts parse that file, so that they can include that number
> as part of the name of the generated package
> - the code itself also includes this header so that it can send the
> version to the server when connecting
>
> Now I wonder about the bst way to also have doxygen use this version
> number when generating the documentation.
> As a fallback option I could just have the buildscript parse in doxygens
> configuration file and replace the value to which PROJECT_NUMBER is set
> with the value from that header that the build script already has
> available anyway, before running doxygen.
> However that would mean that only after running a script first, doxygen
> would know the correct version number to use.
> I would prefer if doxygen would also know the correct version number
> without the need to run an external tool first.
> Is there any way  how to tell doxygen in its config file to read out the
> version number from a #define in a header file?
> I know that it's possible to set PROJECT_NUMBER to an environment variable
> instead of a hard coded value, but that doesn't help as we still would
> have to update the env var every time when version.h gets updated, which
> is errorprone.
> So is there any way to have doxygen use the value of a #define for the
> version number in the generated docs without using any external tools?
>
> Kind regards,
> Stefan.
>
> --
>
> --
> Exit Games Inc.
>
> We Make Multiplayer Simple
> www.photonengine.com
>
> ------------------------------------------------------------
> ------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

[Doxygen-users] set PROJECT_NUMBER to the value of a #define from a header file

[Stefan L. <kai...@ex...>]

Hi.

I would like to centralize the versioning of a project to avoid having to
count up the project version number at multiple places all the time.

I have version.h file, which looks like this:
#define STRINGIFY2(param) #param
#define STRINGIFY(param) EG_PHOTON_STRINGIFY2(param)

#define VERSION_MAJOR 4
#define VERSION_SERVER_MINOR 1
#define VERSION_CLIENT_MINOR 8
#define VERSION_PATCH_RELEASE 2
#define VERSION STRINGIFY(VERSION_MAJOR) "."
STRINGIFY(VERSION_SERVER_MINOR) "." STRINGIFY(VERSION_CLIENT_MINOR) "."
STRINGIFY(VERSION_PATCH_RELEASE)



- the resource-files include this header, so that the Visual Studio
resource compiler can use it for the version number that is shown in the
details page of a generated dll
- the build-scripts parse that file, so that they can include that number
as part of the name of the generated package
- the code itself also includes this header so that it can send the
version to the server when connecting

Now I wonder about the bst way to also have doxygen use this version
number when generating the documentation.
As a fallback option I could just have the buildscript parse in doxygens
configuration file and replace the value to which PROJECT_NUMBER is set
with the value from that header that the build script already has
available anyway, before running doxygen.
However that would mean that only after running a script first, doxygen
would know the correct version number to use.
I would prefer if doxygen would also know the correct version number
without the need to run an external tool first.
Is there any way  how to tell doxygen in its config file to read out the
version number from a #define in a header file?
I know that it's possible to set PROJECT_NUMBER to an environment variable
instead of a hard coded value, but that doesn't help as we still would
have to update the env var every time when version.h gets updated, which
is errorprone.
So is there any way to have doxygen use the value of a #define for the
version number in the generated docs without using any external tools?

Kind regards,
Stefan.

-- 

--
Exit Games Inc.

We Make Multiplayer Simple
www.photonengine.com

Re: [Doxygen-users] EXTERNAL: Re: Doxygen on Cygwin overwrites user defined paths

[Vega, L. A <lui...@lm...>]

My problem is not related to the RFE.  It is an issue with the Cygwin inserting the current path to pre-defined values.

For example if I set
PLANTUML_JAR_PATH = $(PLANTUML_HOME)   where PLANTUML_HOME is an environment variable with the appropriate location.

Under Linux, OSX and Windows,  PLANTUML_HOME will be kept the same value.   Under Cygwin the value is automatically overwritten to be $(PWD)/$(PLANTUML_HOME)

So if I set the $(PLANTUML_HOME) to C:/COTS/PlantUML,  the Cygwin version will convert it to /cygdrive/c/Development/MyProject/C:/COTS/PlantUML

If I set it to a cygpath (ie:, /cygdrive/c/COTS/PlantUML ), it will still override it to /cygdrive/c/Development/MyProject/cygdrive/c/COTS/PlantUML/plantuml.jar

No matter what value is or format is use, the Cygwin version of doxygen will always prepend $(PWD)/ to it.

Hope this helps.

-  Luis




From: Mark [mailto:dox...@er...]
Sent: Monday, August 7, 2017 5:37 PM
To: Vega, Luis A (US) <lui...@lm...>
Cc: dox...@li...
Subject: EXTERNAL: Re: [Doxygen-users] Doxygen on Cygwin overwrites user defined paths

I filed a bug about relative paths in a doxyfile being relative to where doxygen is executed eons ago. See https://bugzilla.gnome.org/show_bug.cgi?id=756161. There has been no action. However I encountered the problem on macOS and I thought on other platforms too. Not sure why your results are different.

As for the cygwin path issue, either make sure all tools, including doxygen, are cygwin tools or all are windows tools. You might be able to do some mixing by using scripts that use cygpath.

Regards

    -Mark

On Jul 31, 2017, at 14:51, Vega, Luis A <lui...@lm...<mailto:lui...@lm...>> wrote:

When setting up the PLANTUML_JAR_PATH (an others path based config option) within the Doxyfile configuration, the Cygwin version of doxygen will insert the current directory path to the front of the user specified path.   This behavior is very specific to the Cygwin version (not how the Linux, Win or OSX versions of doxygen behave) and is problematic in many ways.

The Cygwin version of doxygen is assuming that all paths are relative to the directory where doxygen is executed.   This is completely opposite to the norm.  Different users have different environments, which is the reason why the Doxyfile includes options to define this paths in the first place.  Also, under Cygwin, we have a problem when doxygen calls external tools that don't support the unix-like cygpath (i.e., anything none-cygwin).  For example, when executing Java to run PlantUML even if the plantuml.jar file is stored a matching relative path, the execution would fail because of the unsupported path format.

Don't know if this is the proper place to submit a bug related to the Cygwin version of doxygen.   If not, please let me know where I should submit a bug report.

Re: [Doxygen-users] Doxygen-users Digest, Vol 135, Issue 5

[Ron W <ron...@gm...>]

On Mon, Aug 14, 2017 at 8:19 AM, <
dox...@li...> wrote:
>
> Date: Mon, 14 Aug 2017 11:38:00 +0200
> From: Andreas Tscharner <an...@vi...>
> Subject: Re: [Doxygen-users] Page with all \since entries
>
> On 10.08.2017 22:54, Ron W wrote:
> > The \xrefitem command can be used. As the documentation suggests, you
> > can define an alias to create a new command to do what you want.
> >
> > See: http://www.stack.nl/~dimitri/doxygen/manual/commands.html#
> cmdxrefitem
>
> Thank you very much. If I define an ALIAS it works and references the
> \page where it is listed. Unfortunately I need not the page, but the
> \subsection (because I have many entries on one page using the
> \tableofcontents for navigation).
> Are there any switches that I can turn on/off to link the subsection?
>

Do you mean you want the \since page divided into subsections?

I've never tried that. It may require post-processing the generated \since
page.

Re: [Doxygen-users] Page with all \since entries

[Andreas T. <an...@vi...>]

On 10.08.2017 22:54, Ron W wrote:
> On Wed, Aug 9, 2017 at 8:17 AM,
> <dox...@li...
> <mailto:dox...@li...>> wrote:
>
>     Date: Wed, 9 Aug 2017 10:48:59 +0200
>     From: Andreas Tscharner <an...@vi... <mailto:an...@vi...>>
>     Subject: [Doxygen-users] Page with all \since entries
>
>     Our product that we are working on, sends MQTT messages. I am writing a
>     documentation for these messages (topic, payload, ...) using doxygen. I
>     am using the \since statement to indicate the version of our product a
>     MQTT message is available.
>     Now I'd like to have a page in the HTML documentation that lists all
>     \since entries similar to the \todo page.
>
>     Is this possible? What do I need to do?
>
>
> The \xrefitem command can be used. As the documentation suggests, you
> can define an alias to create a new command to do what you want.
>
> See: http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdxrefitem

Thank you very much. If I define an ALIAS it works and references the 
\page where it is listed. Unfortunately I need not the page, but the 
\subsection (because I have many entries on one page using the 
\tableofcontents for navigation).
Are there any switches that I can turn on/off to link the subsection?

TIA and best regards
	Andreas
-- 
       ("`-''-/").___..--''"`-._
        `o_ o  )   `-.  (     ).`-.__.`)
        (_Y_.)'  ._   )  `._ `. ``-..-'
      _..`--'_..-_/  /--'_.' .'
     (il).-''  (li).'  ((!.-'

Andreas Tscharner   an...@vi...   ICQ-No. 14356454

Re: [Doxygen-users] Page with all \since entries

[Ron W <ron...@gm...>]

On Wed, Aug 9, 2017 at 8:17 AM, <dox...@li...
> wrote:
>
> Date: Wed, 9 Aug 2017 10:48:59 +0200
> From: Andreas Tscharner <an...@vi...>
> Subject: [Doxygen-users] Page with all \since entries
>
> Our product that we are working on, sends MQTT messages. I am writing a
> documentation for these messages (topic, payload, ...) using doxygen. I
> am using the \since statement to indicate the version of our product a
> MQTT message is available.
> Now I'd like to have a page in the HTML documentation that lists all
> \since entries similar to the \todo page.
>
> Is this possible? What do I need to do?
>

The \xrefitem command can be used. As the documentation suggests, you can
define an alias to create a new command to do what you want.

See: http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdxrefitem

[Doxygen-users] Page with all \since entries

[Andreas T. <an...@vi...>]

Hello World,

Our product that we are working on, sends MQTT messages. I am writing a 
documentation for these messages (topic, payload, ...) using doxygen. I 
am using the \since statement to indicate the version of our product a 
MQTT message is available.
Now I'd like to have a page in the HTML documentation that lists all 
\since entries similar to the \todo page.

Is this possible? What do I need to do?

TIA and best regards
	Andreas
-- 
       ("`-''-/").___..--''"`-._
        `o_ o  )   `-.  (     ).`-.__.`)
        (_Y_.)'  ._   )  `._ `. ``-..-'
      _..`--'_..-_/  /--'_.' .'
     (il).-''  (li).'  ((!.-'

Andreas Tscharner   an...@vi...   ICQ-No. 14356454

Re: [Doxygen-users] Doxygen on Cygwin overwrites user defined paths

[Mark <dox...@er...>]

I filed a bug about relative paths in a doxyfile being relative to where doxygen is executed eons ago. See https://bugzilla.gnome.org/show_bug.cgi?id=756161 <https://bugzilla.gnome.org/show_bug.cgi?id=756161>. There has been no action. However I encountered the problem on macOS and I thought on other platforms too. Not sure why your results are different.

As for the cygwin path issue, either make sure all tools, including doxygen, are cygwin tools or all are windows tools. You might be able to do some mixing by using scripts that use cygpath.

Regards

    -Mark

> On Jul 31, 2017, at 14:51, Vega, Luis A <lui...@lm...> wrote:
> 
> When setting up the PLANTUML_JAR_PATH (an others path based config option) within the Doxyfile configuration, the Cygwin version of doxygen will insert the current directory path to the front of the user specified path.   This behavior is very specific to the Cygwin version (not how the Linux, Win or OSX versions of doxygen behave) and is problematic in many ways.
> 
> The Cygwin version of doxygen is assuming that all paths are relative to the directory where doxygen is executed.   This is completely opposite to the norm.  Different users have different environments, which is the reason why the Doxyfile includes options to define this paths in the first place.  Also, under Cygwin, we have a problem when doxygen calls external tools that don't support the unix-like cygpath (i.e., anything none-cygwin).  For example, when executing Java to run PlantUML even if the plantuml.jar file is stored a matching relative path, the execution would fail because of the unsupported path format.   
> 
> Don't know if this is the proper place to submit a bug related to the Cygwin version of doxygen.   If not, please let me know where I should submit a bug report.

[Doxygen-users] Doxygen on Cygwin overwrites user defined paths

[Vega, L. A <lui...@lm...>]

When setting up the PLANTUML_JAR_PATH (an others path based config option) within the Doxyfile configuration, the Cygwin version of doxygen will insert the current directory path to the front of the user specified path.   This behavior is very specific to the Cygwin version (not how the Linux, Win or OSX versions of doxygen behave) and is problematic in many ways.

The Cygwin version of doxygen is assuming that all paths are relative to the directory where doxygen is executed.   This is completely opposite to the norm.  Different users have different environments, which is the reason why the Doxyfile includes options to define this paths in the first place.  Also, under Cygwin, we have a problem when doxygen calls external tools that don't support the unix-like cygpath (i.e., anything none-cygwin).  For example, when executing Java to run PlantUML even if the plantuml.jar file is stored a matching relative path, the execution would fail because of the unsupported path format.   

Don't know if this is the proper place to submit a bug related to the Cygwin version of doxygen.   If not, please let me know where I should submit a bug report.

Re: [Doxygen-users] Documenting conceptual functions

[Andreas T. <an...@vi...>]

On 20.07.2017 16:19, Zieg, Mark (KSC-ESC-624)[SGT - ESC] wrote:

Hi Mark,

[snip]
> However, I'd also like to use Doxygen to render structured documentation
> for the API which my server exposes, and here I'm a little confused.  I
> don't actually have source code for the API "methods," "parameters" and
> "return values," because client requests are parsed internally by my
> server as text -- there are no compiled signatures for Doxygen to process.

I did not try, so I cannot say if it works or not: Try \fn
http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdfn

Best regards
	Andreas
-- 
      ("`-''-/").___..--''"`-._
       `o_ o  )   `-.  (     ).`-.__.`)
       (_Y_.)'  ._   )  `._ `. ``-..-'
     _..`--'_..-_/  /--'_.' .'
    (il).-''  (li).'  ((!.-'

Andreas Tscharner   an...@vi...   ICQ-No. 14356454

Re: [Doxygen-users] Documenting conceptual functions

[Ron W <ron...@gm...>]

On Fri, Jul 21, 2017 at 8:17 AM, <
dox...@li...> wrote:
>
> Date: Thu, 20 Jul 2017 14:19:29 +0000
> From: "Zieg, Mark (KSC-ESC-624)[SGT - ESC]" <mar...@na...>
> Subject: [Doxygen-users] Documenting conceptual functions
>
> I know Doxygen has keywords like @brief, @param and @return to document
> functions.  Is there something like @function to create a "fake function"
> that those keywords can then decorate?  I tried using @fn, but got
> "Warning: documented function was not declared or defined," and no
> documentation was generated.
>

 That's the only one I've ever found.

@par could be used to created a titled paragraph, but would not generate
any kind of index entry.

@xrefitem will create both a titled paragraph and entries on an index page
with a specified title. I think this is the closest you can get to what you
are asking for.

[Doxygen-users] Documenting conceptual functions

[Zieg, M. (KSC-ESC-624)[S. - ESC] <mar...@na...>]

Hi,

Sorry if this has been documented elsewhere, but it's a hard thing to Google for.

I have a C++ application which exposes a service over an API.  I already use Doxygen to render lovely maintenance documentation for the server application itself.

However, I'd also like to use Doxygen to render structured documentation for the API which my server exposes, and here I'm a little confused.  I don't actually have source code for the API "methods," "parameters" and "return values," because client requests are parsed internally by my server as text -- there are no compiled signatures for Doxygen to process.

I know Doxygen has keywords like @brief, @param and @return to document functions.  Is there something like @function to create a "fake function" that those keywords can then decorate?  I tried using @fn, but got "Warning: documented function was not declared or defined," and no documentation was generated.

(PS, I know I could create a "fake" C++ header file, but I was hoping not to.)

Thanks for your suggestions.

Re: [Doxygen-users] Crash

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

Dear Vinnie,

Please try to get a stack trace (might give a first indication where the
crash occurs and afterwards please  create a small example reproducing the
problem.

Albert

<http://www.avg.com/email-signature?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail>
Virus-free.
www.avg.com
<http://www.avg.com/email-signature?utm_medium=email&utm_source=link&utm_campaign=sig-email&utm_content=webmail>
<#DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2>

On Fri, Jul 14, 2017 at 5:08 PM, Vinnie Falco <vin...@gm...>
wrote:

> Doxygen crashes on my project can someone please fix it, I cannot
> update to the latest verson (the one released December 2016). Here's
> my repo:
>
> <https://github.com/vinniefalco/Beast>
>
> Feel free to contact me for instructions on how to reproduce the
> defect (just run doc/makeqbk.sh)
>
> Thanks
>
> --
> Follow me on GitHub: https://github.com/vinniefalco
>
> ------------------------------------------------------------
> ------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

[Doxygen-users] Crash

[Vinnie F. <vin...@gm...>]

Doxygen crashes on my project can someone please fix it, I cannot
update to the latest verson (the one released December 2016). Here's
my repo:

<https://github.com/vinniefalco/Beast>

Feel free to contact me for instructions on how to reproduce the
defect (just run doc/makeqbk.sh)

Thanks

-- 
Follow me on GitHub: https://github.com/vinniefalco

Re: [Doxygen-users] Images in htmlinclude fines

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

Dear Bob

>From the documentation:
24.124 \htmlinclude <file-name>
This command includes the file <file-name> as is in the HTML documentation.
The command is equivalent to
pasting the file in the documentation and placing \htmlonly and
\endhtmlonly commands around it.
Files or directories that doxygen should look for can be specified using
the EXAMPLE_PATH tag of doxygen's
configuration file.

The HTML documentation is placed verbatim into the output (placed to look
for the files is the EXAMPLE_PATH).
So from your description, the images should land at the same place as where
the HTML documentation will land.

You probably want to use HTML_EXTRA_FILES in the Doxyfile:
The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
other source files which should be copied to the HTML output directory.
Note that these files will be copied to
the base HTML output directory. Use the $relpath^ marker in the HTML_HEADER
and/or HTML_FOO -
TER files to load these files. In the HTML_STYLESHEET file, use the file
name only. Also note that the files
will be copied as-is; there are no commands or markers available.

Albert

On Tue, Jul 11, 2017 at 5:11 PM, Bob+ Biton via Doxygen-users <
dox...@li...> wrote:

> Hi,
>
> I wrote some html files that I want to insert in the documentation using
> the @htmlinclude tag. In the files I wanted to put images like this :<img
> src="name.png/> but I don't know were to put the images... I tried to put
> them in the images_path or in the example_path but it does not work
>
> Did anyone know?
>
> ------------------------------------------------------------
> ------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] Images in htmlinclude fines

[Bob+ B. <dox...@ya...>]

Hi,
I wrote some html files that I want to insert in the documentation using the @htmlinclude tag. In the files I wanted to put images like this :<img src="name.png/> but I don't know were to put the images... I tried to put them in the images_path or in the example_path but it does not work
Did anyone know?