doxygen-users — List for users of doxygen

Re: [Doxygen-users] doxygen failes to generate docu for C++ member function

[Dimitri v. H. <do...@gm...>]

Hi Zack,

> On 03 Mar 2016, at 20:35 , Zack Snyder <za...@gm...> wrote:
> 
> Hi there,
> 
> I have a member function called: "std::vector<type> get_base_classes() 
> const" which will not be generated.
> 
> Documentation can be found online: 
> http://www.rttr.org/doc/master/classrttr_1_1type.html
> Here is the source file of the header: 
> http://www.rttr.org/doc/master/type_8h_source.html
> The function is there, but for unknown reason it will not be documented.


If I run doxygen with a default config file on the sources I see
the method just fine. Do you have a filter or preprocessor running that may
change/remove the get_base_classes() method?

Regards,
  Dimitri

[Doxygen-users] doxygen failes to generate docu for C++ member function

[Zack S. <za...@gm...>]

Hi there,

I have a member function called: "std::vector<type> get_base_classes() 
const" which will not be generated.

Documentation can be found online: 
http://www.rttr.org/doc/master/classrttr_1_1type.html
Here is the source file of the header: 
http://www.rttr.org/doc/master/type_8h_source.html
The function is there, but for unknown reason it will not be documented.

I am using 1.8.11 for windows.

What can I do about it?

Regards.

Re: [Doxygen-users] Bug: Markdown tables missing cell borders in the header LaTex output

[Dimitri v. H. <do...@gm...>]

Hi Luis,

I don't see the problem with your example.
Are you sure it isn't a scaling problem of the document renderer?
(i.e. do the lines reappear if you zoom in?)

Regards,
  Dimitri

> On 29 Feb 2016, at 23:58 , Vega, Luis A <lui...@lm...> wrote:
> 
> When generating documentation in LaTex, any markdown table will be drawn with partially missing (usually left) borders in table header row.  Any markdown table (see simple sample below) can be used to duplicate the error.
>  
> |  Header 1  |  Header 2  |  Header 3  |  Header 4  |
> | ---------: | :--------: | :--------: | :--------- |
> | A1         | A2         | A3         | A4         |
> | B1         | B2         | B3         | B4         |
> | C1         | C2         | C3         | C4         |
> | D1         | D2         | D3         | D4         |
>  
>  
>  
> ------------------------------------------------------------------------------
> Site24x7 APM Insight: Get Deep Visibility into Application Performance
> APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
> Monitor end-to-end web transactions and take corrective actions now
> Troubleshoot faster and improve end-user experience. Signup Now!
> http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140_______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] Bug: Markdown tables missing cell borders in the header LaTex output

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

When generating documentation in LaTex, any markdown table will be drawn with partially missing (usually left) borders in table header row.  Any markdown table (see simple sample below) can be used to duplicate the error.


|  Header 1  |  Header 2  |  Header 3  |  Header 4  |

| ---------: | :--------: | :--------: | :--------- |

| A1         | A2         | A3         | A4         |

| B1         | B2         | B3         | B4         |

| C1         | C2         | C3         | C4         |

| D1         | D2         | D3         | D4         |

Re: [Doxygen-users] Looking for beta testers of a Doxygen GitHub integration

[Allen W. <wi...@kd...>]

On Saturday, February 27, 2016 10:15:50 AM Paul Novotny wrote:
> On Thu, 2016-01-07 at 12:32 -0500, Paul Novotny wrote:
> > On Thu, 2016-01-07 at 11:49 -0500, Allen Winter wrote:
> > > On Wednesday, January 06, 2016 10:59:07 PM Paul Novotny wrote:
> > > > On Wed, Jan 6, 2016, at 06:51 PM, Allen Winter wrote:
> > > > > I have a lot of ideas and thoughts.
> > > > > Here are a few:
> > > > > 1) some of my repos are under my github login I'd like to be able
> > > > > to create codedocs for my other projects that are not under my
> > > > > login.
> > > > > For example: https://github.com/libical/libical
> > > > 
> > > > Currently, you could do this by forking these repositories. But I
> > > > also
> > > > would like some way to have the Doxgyen docs for repos that aren't
> > > > mine.
> > > > Like OpenSceneGraph. I'll think about this a bit.
> > > > 
> > > see travis-ci.org which allows me to choose repos from any
> > > organization I belong to.
> > 
> > Oh, I misunderstood your question. Yes, there is no support for
> > repositories in organizations you belong to, but it is what I am
> > working on now. So stay tuned.
> 
> Hi Allen, I added support for public organizations. You should now be
> able to choose repositories for organizations you belong to. I have been
> testing it for a bit, but would appreciate more testers. Let me know if
> this works for you.
> 
yep, so far so good.
thanks Paul.

Re: [Doxygen-users] Looking for beta testers of a Doxygen GitHub integration

[Paul N. <pa...@pa...>]

On Thu, 2016-01-07 at 12:32 -0500, Paul Novotny wrote:
> On Thu, 2016-01-07 at 11:49 -0500, Allen Winter wrote:
> > On Wednesday, January 06, 2016 10:59:07 PM Paul Novotny wrote:
> > > On Wed, Jan 6, 2016, at 06:51 PM, Allen Winter wrote:
> > > > I have a lot of ideas and thoughts.
> > > > Here are a few:
> > > > 1) some of my repos are under my github login I'd like to be able
> > > > to create codedocs for my other projects that are not under my
> > > > login.
> > > > For example: https://github.com/libical/libical
> > > 
> > > Currently, you could do this by forking these repositories. But I
> > > also
> > > would like some way to have the Doxgyen docs for repos that aren't
> > > mine.
> > > Like OpenSceneGraph. I'll think about this a bit.
> > > 
> > see travis-ci.org which allows me to choose repos from any
> > organization I belong to.
> 
> Oh, I misunderstood your question. Yes, there is no support for
> repositories in organizations you belong to, but it is what I am
> working on now. So stay tuned.

Hi Allen, I added support for public organizations. You should now be
able to choose repositories for organizations you belong to. I have been
testing it for a bit, but would appreciate more testers. Let me know if
this works for you.

Thanks,
-Paul

[Doxygen-users] Bug: Doxygen fails to copy logo image to LaTex output dir

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

When outputting documentation in LaTeX format,  doxygen fails to copy the image set in "PROJECT_LOGO" to the output directory.  Because of this, the use of the $projectlogo command option within a customized LaTeX header will cause a failure to build the final refman.pdf output.

Workaround:

1-      Copy the image into the output directory before calling make.

2-      Use the relative path (from the output dir) to the image (instead of $projectlogo) within the customized LaTeX header

[Doxygen-users] PDF output error when SHOW_NAMESPACES = NO

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

When SHOW_NAMESPACES is set to NO (in the Doxyfile), the final build for the PDF fails.

The build error is because the generated refman.tex still includes links to the LaTeX files related to the namespaces, but doxygen didn't generate them (the correct response to the user configuration).

Workaround is manually removing the following from refman.tex before running make on the directory:
\section{Namespace Index}
\input{namespaces}
\section{Namespace Documentation}
\input{namespace*}     %  where the * is a wildcard (as in anything).

NOTE:
It also looks like the doxygen generated layout xml file now defaults to overriding some of the options selected within the Doxyfile.  Options like SHOW_FILES and SHOW_NAMESPACES are now defaulted to YES in the layout file, instead of pointing to the configuration variable.

[Doxygen-users] Invalid LaTex output when mixing table formats

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

Since Doxygen only support the basic/simple version of markdown tables, the only way to add a caption to a markdown table is by wrapping it around with an HTML table.

This "workaround" works well for HTML output, but fails to output valid LaTeX text.

The following is a simple example that can be used to duplicate the error:

/*!
@page PAGE1   Some Page

@section SEC_1_1   Section 1.1

<table border="0">
<caption>The Table Caption</caption>
<tr><td>

| Document Number        | Document Title                                |
| :--------------------- | :-------------------------------------------- |
| &nbsp;                 | &nbsp;                                        |
| &nbsp;                 | &nbsp;                                        |
| &nbsp;                 | &nbsp;                                        |

</td></tr>
</table>
 */

Re: [Doxygen-users] how to report doxygen bugs ?

[Dimitri v. H. <do...@gm...>]

Hi Monique,

> On 23 Feb 2016, at 2:44 , Monique Semp <mon...@ea...> wrote:
> 
> Hello, Doxygen users,
>  
> Is there a sourceforge or GitLab project where one can report bugs?
>  
> I’m sure I’ve seen it, but can’t seem to find it now. And I’m fairly certain that I’ve identified a couple of bugs that would probably be better managed in the development project than in this email list.

See http://www.doxygen.org/manual/trouble.html#bug_reports for the link. 
Don't forget to include a self-contained example for each bug report that 
allows me to reproduce the problem.

Regards,
  Dimitri

Re: [Doxygen-users] bug - group names starting with numbers cause the number part(s) to appear in output

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

Oh, I’m seeing this in Doxygen 1.8.10 on Windows 7.


From: Monique Semp 
Sent: Tuesday, February 23, 2016 7:24 AM
To: doxygen-users 
Subject: bug - group names starting with numbers cause the number part(s) to appear in output

Hello, Doxygen users,

I’ll report this to Bugzilla when I’ve time, but I thought it good to get this into the doxygen-users forum.

I used the \defgroup command to create a group name that has numbers, such as “3times_functions”. Then in the functions’ Doxygen comment blocks, I used the \ingroup command to place the functions in the group. The grouping works fine, but...

The output for the function contains the numeric part of the group name! That is, for an \ingroup command for group “3times_functions”, the output contains “3” on its own line. And for a group name, “3times3_functions”, the output contains “33”.

The workaround is easy: don’t start a group name with a number. It’s fine to use numbers otherwise (so “times3_functions” works as expected, with nothing about the group name in the function’s page.)

-Monique

[Doxygen-users] bug - group names starting with numbers cause the number part(s) to appear in output

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

Hello, Doxygen users,

I’ll report this to Bugzilla when I’ve time, but I thought it good to get this into the doxygen-users forum.

I used the \defgroup command to create a group name that has numbers, such as “3times_functions”. Then in the functions’ Doxygen comment blocks, I used the \ingroup command to place the functions in the group. The grouping works fine, but...

The output for the function contains the numeric part of the group name! That is, for an \ingroup command for group “3times_functions”, the output contains “3” on its own line. And for a group name, “3times3_functions”, the output contains “33”.

The workaround is easy: don’t start a group name with a number. It’s fine to use numbers otherwise (so “times3_functions” works as expected, with nothing about the group name in the function’s page.)

-Monique

Re: [Doxygen-users] \private - not working for external doc blocks

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

And to complete this thread, in case anyone else stumbles into this issue, here’s my workaround.

Although not ideal because the goal was to not have any Doxygen comments in certain sensitive source files (that are distributed to customers, but we don’t want the detailed documentation in the source code), if I simply surround the unwanted functions by \cond and \endcond, Doxygen of course excludes that part of the file from processing, and so those functions don’t appear in the output.

I still would like to better understand how to use the \private command, and if it has known limitations or whether it should work as I expected. But this workaround is ok.

-Monique


From: Monique Semp 
Sent: Tuesday, February 23, 2016 6:15 AM
To: doxygen-users 
Subject: Re: [Doxygen-users] \private - not working for external doc blocks

More details (which likely I’ll just have to include in a Bugzilla bug report?)...

I can get output without those unwanted functions (the ones with the \private command in the external file, where functions are defined with the \fn command) by omitting all \file commands for the .h file, but still including the .h file in the Doxyfile INPUT option. I’d previously had the \file command for the .h file in the external file, but by removing the \file command, the output ends up with only those functions that I want (the ones without the \private command).

But... a different, worse problem occurs: the functions that I do want are (incorrectly) no longer included in the Files > Globals lists.

So as it stands it seems that I must choose between

* Showing unwanted private (not real private C++, but C \fn functions in external files, with the \private command after the \fn command) functions in the applicable file’s list in the File view.

-OR-

* Not showing the necessary functions in the Globals lists.

All suggestions/corrections/work-arounds will be gratefully received,
-Monique


From: Monique Semp 
Sent: Monday, February 22, 2016 5:34 PM
To: doxygen-users 
Subject: [Doxygen-users] \private - not working for external doc blocks

Hello, Doxygen users,

In Doxygen 1.8.10, the \private command does not seem to work for functions that are documented external from their source file, via the \fn command. I’ve used the \private command extensively in .c files, but it’s not being honored in external (.dxd) files.

This is for C functions, and I have the EXTRACT_PRIVATE setting set to NO. In the .dxd file, I have separate Doxygen blocks for every function in the .h file that I want *omitted* from the Doxygen output, and after the \fn command, I have the \private command.

Doxygen doesn’t generate function details for these functions (and if I doxygen-search for these functions, they’re correctly not found), but they do show up in the Files list, which is very undesirable. I tried simply not including the .h file in the input, but Doxygen seems to require it to match up the functions in the .dxd file. (That is, if I omit the .h file, I get no output for the functions in the .dxd file.)

Does anyone have any ideas what I’m doing wrong?

Thanks,
-Monique


--------------------------------------------------------------------------------
------------------------------------------------------------------------------
Site24x7 APM Insight: Get Deep Visibility into Application Performance
APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
Monitor end-to-end web transactions and take corrective actions now
Troubleshoot faster and improve end-user experience. Signup Now!
http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140 


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



--------------------------------------------------------------------------------
------------------------------------------------------------------------------
Site24x7 APM Insight: Get Deep Visibility into Application Performance
APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
Monitor end-to-end web transactions and take corrective actions now
Troubleshoot faster and improve end-user experience. Signup Now!
http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140 


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

Re: [Doxygen-users] bugs? - section titles - in Mainpage nav tree, and in nav tree for the page

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

(Sorry for not trimming the previous posts, but I think it important to keep all the info together.)

Further debugging info: If I create a new top-level \section in the grouped \page, and then change all the original \section commands to \subsection, the issues are the same as before. That is, the issues seem more related to the page being a grouped page than issues with the \section or \subsection command.

My not-ideal workaround is going to be to abandon the grouping for the pages, which was a nice feature for having a parent group for both function groups and corresponding overview page groups. That is, I’ll just create a top-level (parent) page that has \subpage commands for all the overview pages.

This is still “grouping” of a sort, but by using the \subpage command inside a \page, instead of using \defgroup and \ingroup commands.

When I have time to create a standalone simple set of pages, I’ll file a bug in Bugzilla. But for now this workaround will do.

-Monique


From: Monique Semp 
Sent: Friday, February 19, 2016 5:53 PM
To: doxygen-users 
Subject: Re: [Doxygen-users] bugs? - section titles - in Mainpage nav tree,and in nav tree for the page

Oh, an important point that I just thought to check: None of these bugs occur for pages that are not in a group.

I had non-grouped pages already, but they didn’t have any \section commands. So I just created a new test page with \sections, and it works as expected/correctly: the page appears in the nav tree independent of and after the Mainpage.

And as I alluded to below but didn’t quite state, the Mainpage includes \subpage commands for the non-grouped pages, and therefore when you expand the Mainpage, the nav tree shows those non-grouped pages.

I tried deleting the \subpage commands to see if that made a difference. What happened then is that those non-grouped pages now all appear at the top level of the nav-tree instead of under Mainpage, which is as expected.

But now what happens is that the last page can incorrectly/unexpectedly be expanded. When you expand it, those other pages’ \section titles now all appear (bug 2, below). And bug 1 as described below is still manifesting the same problem/appearance.

I hope this info helps isolate the issue,
-Monique


From: Monique Semp 
Sent: Friday, February 19, 2016 4:32 PM
To: doxygen-users 
Subject: [Doxygen-users] bugs? - section titles - in Mainpage nav tree,and in nav tree for the page

Hello, Doxygen users,

I’m using Doxygen 1.8.10 on Windows 7, and seem to have hit a couple of bugs with how the pages’ \section titles appear in the left nav tree (with GENERATE_TREEVIEW = YES).

I’ve just added a bunch of \section commands to a bunch of \page files, where all the \page files are grouped under various Modules sub-groups (“Pages” and, for example, “Group-1”).

1. In the left nav tree under the Modules (well, under Modules > Pages > Group-1 > Each-Page), each page appears as expected.

But... the last section that’s listed for a page unexpectedly/incorrectly expands to show a repeat of all the section titles in the page. For example:

Pages
+--- Group-1
+--- +--- Page-1
+--- +--- +--- section-first
+--- +--- +--- ...
+--- +--- +--- section-last
+--- +--- +---  +--- section-first        <---- unexpected/incorrect repeat of all the page’s sections
+--- +--- +---  +--- ...
+--- +--- +---  +--- section-last

2. The second bug (?) is that every section name (in groups that are ordered alphabetically by the page name) is *unexpectedly* ALSO appearing in the left nav tree under the Mainpage’s Title, after the last expected (non-grouped) \page.

Before I added the section names, the tree under the Mainpage’s Title correctly showed only the non-grouped pages.

---
These issues both seem to be bugs, but perhaps I’ve misunderstood how the \section command should work? Or perhaps there’s some configuration setting I should be using?

I could replace the \section commands with just bold text, but then I’d lose the ability to use the \section titles as cross-references, which is the whole reason I added the \section commands. So perhaps there’s a better way to do that?

Thanks for your suggestions,
-Monique

Re: [Doxygen-users] \private - not working for external doc blocks

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

More details (which likely I’ll just have to include in a Bugzilla bug report?)...

I can get output without those unwanted functions (the ones with the \private command in the external file, where functions are defined with the \fn command) by omitting all \file commands for the .h file, but still including the .h file in the Doxyfile INPUT option. I’d previously had the \file command for the .h file in the external file, but by removing the \file command, the output ends up with only those functions that I want (the ones without the \private command).

But... a different, worse problem occurs: the functions that I do want are (incorrectly) no longer included in the Files > Globals lists.

So as it stands it seems that I must choose between

* Showing unwanted private (not real private C++, but C \fn functions in external files, with the \private command after the \fn command) functions in the applicable file’s list in the File view.

-OR-

* Not showing the necessary functions in the Globals lists.

All suggestions/corrections/work-arounds will be gratefully received,
-Monique


From: Monique Semp 
Sent: Monday, February 22, 2016 5:34 PM
To: doxygen-users 
Subject: [Doxygen-users] \private - not working for external doc blocks

Hello, Doxygen users,

In Doxygen 1.8.10, the \private command does not seem to work for functions that are documented external from their source file, via the \fn command. I’ve used the \private command extensively in .c files, but it’s not being honored in external (.dxd) files.

This is for C functions, and I have the EXTRACT_PRIVATE setting set to NO. In the .dxd file, I have separate Doxygen blocks for every function in the .h file that I want *omitted* from the Doxygen output, and after the \fn command, I have the \private command.

Doxygen doesn’t generate function details for these functions (and if I doxygen-search for these functions, they’re correctly not found), but they do show up in the Files list, which is very undesirable. I tried simply not including the .h file in the input, but Doxygen seems to require it to match up the functions in the .dxd file. (That is, if I omit the .h file, I get no output for the functions in the .dxd file.)

Does anyone have any ideas what I’m doing wrong?

Thanks,
-Monique


--------------------------------------------------------------------------------
------------------------------------------------------------------------------
Site24x7 APM Insight: Get Deep Visibility into Application Performance
APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
Monitor end-to-end web transactions and take corrective actions now
Troubleshoot faster and improve end-user experience. Signup Now!
http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140 


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

[Doxygen-users] how to report doxygen bugs ?

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

Hello, Doxygen users,

Is there a sourceforge or GitLab project where one can report bugs?

I’m sure I’ve seen it, but can’t seem to find it now. And I’m fairly certain that I’ve identified a couple of bugs that would probably be better managed in the development project than in this email list.

Thanks,
-Monique

[Doxygen-users] \private - not working for external doc blocks

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

Hello, Doxygen users,

In Doxygen 1.8.10, the \private command does not seem to work for functions that are documented external from their source file, via the \fn command. I’ve used the \private command extensively in .c files, but it’s not being honored in external (.dxd) files.

This is for C functions, and I have the EXTRACT_PRIVATE setting set to NO. In the .dxd file, I have separate Doxygen blocks for every function in the .h file that I want *omitted* from the Doxygen output, and after the \fn command, I have the \private command.

Doxygen doesn’t generate function details for these functions (and if I doxygen-search for these functions, they’re correctly not found), but they do show up in the Files list, which is very undesirable. I tried simply not including the .h file in the input, but Doxygen seems to require it to match up the functions in the .dxd file. (That is, if I omit the .h file, I get no output for the functions in the .dxd file.)

Does anyone have any ideas what I’m doing wrong?

Thanks,
-Monique

Re: [Doxygen-users] bugs? - section titles - in Mainpage nav tree, and in nav tree for the page

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

Oh, an important point that I just thought to check: None of these bugs occur for pages that are not in a group.

I had non-grouped pages already, but they didn’t have any \section commands. So I just created a new test page with \sections, and it works as expected/correctly: the page appears in the nav tree independent of and after the Mainpage.

And as I alluded to below but didn’t quite state, the Mainpage includes \subpage commands for the non-grouped pages, and therefore when you expand the Mainpage, the nav tree shows those non-grouped pages.

I tried deleting the \subpage commands to see if that made a difference. What happened then is that those non-grouped pages now all appear at the top level of the nav-tree instead of under Mainpage, which is as expected.

But now what happens is that the last page can incorrectly/unexpectedly be expanded. When you expand it, those other pages’ \section titles now all appear (bug 2, below). And bug 1 as described below is still manifesting the same problem/appearance.

I hope this info helps isolate the issue,
-Monique


From: Monique Semp 
Sent: Friday, February 19, 2016 4:32 PM
To: doxygen-users 
Subject: [Doxygen-users] bugs? - section titles - in Mainpage nav tree,and in nav tree for the page

Hello, Doxygen users,

I’m using Doxygen 1.8.10 on Windows 7, and seem to have hit a couple of bugs with how the pages’ \section titles appear in the left nav tree (with GENERATE_TREEVIEW = YES).

I’ve just added a bunch of \section commands to a bunch of \page files, where all the \page files are grouped under various Modules sub-groups (“Pages” and, for example, “Group-1”).

1. In the left nav tree under the Modules (well, under Modules > Pages > Group-1 > Each-Page), each page appears as expected.

But... the last section that’s listed for a page unexpectedly/incorrectly expands to show a repeat of all the section titles in the page. For example:

Pages
+--- Group-1
+--- +--- Page-1
+--- +--- +--- section-first
+--- +--- +--- ...
+--- +--- +--- section-last
+--- +--- +---  +--- section-first        <---- unexpected/incorrect repeat of all the page’s sections
+--- +--- +---  +--- ...
+--- +--- +---  +--- section-last

2. The second bug (?) is that every section name (in groups that are ordered alphabetically by the page name) is *unexpectedly* ALSO appearing in the left nav tree under the Mainpage’s Title, after the last expected (non-grouped) \page.

Before I added the section names, the tree under the Mainpage’s Title correctly showed only the non-grouped pages.

---
These issues both seem to be bugs, but perhaps I’ve misunderstood how the \section command should work? Or perhaps there’s some configuration setting I should be using?

I could replace the \section commands with just bold text, but then I’d lose the ability to use the \section titles as cross-references, which is the whole reason I added the \section commands. So perhaps there’s a better way to do that?

Thanks for your suggestions,
-Monique

Re: [Doxygen-users] Problems running PlantUML since Doxygen 1.8.10 (Windows)

[Christoph L. <chr...@li...>]

I guess this is actually unrelated to the 1.8.9.1 -> 1.8.10 update, but
rather due to updates in Java and Windows.

Oracle has a habit of thinking they know better than best practices
and/or Microsoft guidelines how to install software on Windows machines.
One of their genius ideas was to install each Java version in a
differently named directory. Obviously this meant that each Java version
update would also require updating the PATH environment variable
accordingly, which can be a messy business in certain cases.

To get around this, a while ago they had another great idea: Instead of
adding the actual Java binary directory to the PATH environment
variable, they would instead add some standard directory, where they
would place symbolic links to the actual Java binaries. Their Java
updater would then no longer have to mess with the PATH environment
variable anymore, and would instead just replace the symbolic links.

However, a few months ago Microsoft identified a security loophole
involving the execution of symbolic links via a certain API, and
therefore blocked the possibility to execute symlinks in this manner.

There is obviously at least one other API that still allows execution of
symlinks, but unfortunately Doxygen invokes java via the API that can't
execute symlinks anymore.

The Windows Explorer is another piece of software that can no longer
execute symlinks.


My workaround for this issue is to run Doxygen from a batch file
invoking the following commands:

-----------------------------------------------------------------------
call :JAVA_SYMLINK_FIX
... (run Doxygen)
goto :EOF

...

:JAVA_SYMLINK_FIX
rem set JAVA_EXE to whatever java.exe is found via the path
call :FIND_IN_PATH JAVA_EXE java.exe
rem set TRUE_JAVA_EXE to the actual file java.exe points to
rem (if it is a symlink), or an empty string otherwise
call :FIND_SYMLINK TRUE_JAVA_EXE "%JAVA_EXE%"
rem if the java.exe found via the path is not a symlink, we're done
if "%TRUE_JAVA_EXE%" == "" goto :EOF
echo "%JAVA_EXE%" is actually a symlink pointing to "%TRUE_JAVA_EXE%"
rem set JAVA_EXE_DIR to the directory in which
rem the actual java.exe resides
call :SET_DIR JAVA_EXE_DIR "%TRUE_JAVA_EXE%"
rem prepend JAVA_EXE_DIR to the path variable
set PATH=%JAVA_EXE_DIR%;%PATH%
goto :EOF

:FIND_IN_PATH
set %1=%~dp$PATH:2%2
goto :EOF

:FIND_SYMLINK
rem Sets the environment variable named by %1
rem to the file pointed to by %2 if that's a symlink.
rem Sets the environment variable to an empty string otherwise.
set %1=
for /F "usebackq tokens=2 delims=[]" %%i in (`dir "%~2" /N`) do set %1=%%i
goto :EOF

:SET_DIR
rem sets the environment variable named by %1
rem to the directory of the file named by %2.
set %1=%~dp2
goto :EOF
-----------------------------------------------------------------------


Am 19.02.2016 um 22:20 schrieb Vega, Luis A:
> Ever since 1.8.10 was release, I'm unable to run doxygen (under Windows)
> on anything with a PlantUML diagram. The same files will build without
> any problems using Doxygen v 1.8.9.1.
> 
> No matter what I do, or how the PATH enviroment variable is adjusted I
> still get:
> error: Problems running PlantUML. Verify that the command 'java -jar
> "<path>\plantuml.jar" -h' works from the command line (where <path> is
> my path to PlantUML, not the actual text).
> 
> As other have notice, the command in itself runs from the command line
> without any problem.
> 
> Something changed between 1.8.9.1 and 1.8.10 that broke execution of
> Java from within doxygen (on Windows 7). The problem is actually worst
> on the Cygwin version of Doxygen (it prefixes the cygwin path of the
> running dir to the plantuml.jar path no matter the format).
> 
> Does anybody have any clue on how to fix this problem?
> Or can I at least get a little clue on where the change happened so that
> I can manually fix the source code?
> 
> Any assistance will be greatly appreciated.
> 
> Note:
> I use an environment variable to configure the location of the PlantUML
> jar-file since hardcoding would require all users to have direct access
> to the path. Here is an example:
> 
> PLANTUML_JAR_PATH = $(PLANTUML_HOME)/plantuml.jar
> 
>  
> 
> 
> 
> ------------------------------------------------------------------------------
> Site24x7 APM Insight: Get Deep Visibility into Application Performance
> APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
> Monitor end-to-end web transactions and take corrective actions now
> Troubleshoot faster and improve end-user experience. Signup Now!
> http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140
> 
> 
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
> 

[Doxygen-users] bugs? - section titles - in Mainpage nav tree, and in nav tree for the page

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

Hello, Doxygen users,

I’m using Doxygen 1.8.10 on Windows 7, and seem to have hit a couple of bugs with how the pages’ \section titles appear in the left nav tree (with GENERATE_TREEVIEW = YES).

I’ve just added a bunch of \section commands to a bunch of \page files, where all the \page files are grouped under various Modules sub-groups (“Pages” and, for example, “Group-1”).

1. In the left nav tree under the Modules (well, under Modules > Pages > Group-1 > Each-Page), each page appears as expected.

But... the last section that’s listed for a page unexpectedly/incorrectly expands to show a repeat of all the section titles in the page. For example:

Pages
+--- Group-1
+--- +--- Page-1
+--- +--- +--- section-first
+--- +--- +--- ...
+--- +--- +--- section-last
+--- +--- +---  +--- section-first        <---- unexpected/incorrect repeat of all the page’s sections
+--- +--- +---  +--- ...
+--- +--- +---  +--- section-last

2. The second bug (?) is that every section name (in groups that are ordered alphabetically by the page name) is *unexpectedly* ALSO appearing in the left nav tree under the Mainpage’s Title, after the last expected (non-grouped) \page.

Before I added the section names, the tree under the Mainpage’s Title correctly showed only the non-grouped pages.

---
These issues both seem to be bugs, but perhaps I’ve misunderstood how the \section command should work? Or perhaps there’s some configuration setting I should be using?

I could replace the \section commands with just bold text, but then I’d lose the ability to use the \section titles as cross-references, which is the whole reason I added the \section commands. So perhaps there’s a better way to do that?

Thanks for your suggestions,
-Monique

[Doxygen-users] Doxygen labels C++ interfaces (pure virtual) as abstract

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

When a C++ class is defined as an interface (ie: pure virtual), Doxygen will title the class documentation as "Interface" but at the same time it will tag the title with an "abstract" label instead of "pure virtual". The methods are correctly tagged as "pure virtual".

While not a big deal, the mislabeling could potentially cause some confusion. Since it could be a bit difficult to correctly guess when a class is pure virtual vs when the user wants it to be abstract, I suggest that when the class is documented with @interface, the label on the tittle should be set to "pure virtual" to avoid confusion.

The following sample code and documentation can used to duplicate the labeling error (using v1.8.11)

/**
* @interface PureVirtualClass PureVirtualClass.hpp "PureVirtualClass.hpp"
* Sample pure virtual (interface) class.
*/
class PureVirtualClass
{
public:
    /**
     * Some function that does something.
     * @return void
     */
    virtual void someFunction() = 0;

    /**
     * Another function that has an input and an output parameter. And when the
     * function its done doing something it returns a status bool.
     * @param [in]  someParam   some input parameter.
     * @param [out] retParam    reference to some output parameter.
     * @return @c true if successful, otherwise @c false.
     */
    virtual bool anotherFunction( int someParam, int& retParam ) = 0;

    /**
     * Class destructor.
     */
    virtual ~PureVirtualClass()
    {}
};

[Doxygen-users] Problems running PlantUML since Doxygen 1.8.10 (Windows)

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

Ever since 1.8.10 was release, I'm unable to run doxygen (under Windows) on anything with a PlantUML diagram. The same files will build without any problems using Doxygen v 1.8.9.1.

No matter what I do, or how the PATH enviroment variable is adjusted I still get:
error: Problems running PlantUML. Verify that the command 'java -jar "<path>\plantuml.jar" -h' works from the command line (where <path> is my path to PlantUML, not the actual text).

As other have notice, the command in itself runs from the command line without any problem.

Something changed between 1.8.9.1 and 1.8.10 that broke execution of Java from within doxygen (on Windows 7). The problem is actually worst on the Cygwin version of Doxygen (it prefixes the cygwin path of the running dir to the plantuml.jar path no matter the format).

Does anybody have any clue on how to fix this problem?
Or can I at least get a little clue on where the change happened so that I can manually fix the source code?

Any assistance will be greatly appreciated.

Note:
I use an environment variable to configure the location of the PlantUML jar-file since hardcoding would require all users to have direct access to the path. Here is an example:

PLANTUML_JAR_PATH = $(PLANTUML_HOME)/plantuml.jar

[Doxygen-users] Error when using !include in @startuml

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

The following snippet will produce a runtime error:
@startuml
    !include diagram.iuml
@enduml

The output error is the following:
Error line 2 in file: <path>\html\diagram.pu
Some diagram description contains errors

The generated file (diagram.pu) looks as follows:
@startuml        !include diagram.pu
      @enduml

As you can see, the problem is that Doxygen failed to insert a return character after @startuml

Workaround: insert an empty line between @startuml and !include
@startuml

    !include diagram. iuml

@enduml

[Doxygen-users] indent \warning, \todo, (etc.) within \param content ?

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

Hello, Doxygen users,

In Doxygen 1.8.10, is there a way to control the indentation of tags such as \todo and \warning when they’re part of a \param description?

If I use a \todo or \warning tag in a \param description, the Todo or Warning item (and its color vertical bar) are outdented/aligned with the “Parameters” heading instead of being aligned with the relevant \param description. And then the “Parameters” heading repeats above the remaining parameter descriptions.

The result is a less-than-optimal user experience because it’s confusing to figure out to what the Todo or Warning applies.

Ideally, the \todo or \warning would be “double-indented” so that it aligns with the parameter description text, not the name of the parameter.

I thought about creating an xrefitem alias and styling it to be indented, but the problem is that the desired alignment is unpredictable because it depends on the length of the parameter name strings, which are output as “paramname” class <td> elements in a “params” table’s <tr> rows.

What’s really needed is for \todo items to be output to the same table cells as the parameters themselves. The output that I’m seeing breaks apart the parameter table, inserting the “todo” class between the resulting two “params” classes/tables.

Thanks for any advice,
-Monique

[Doxygen-users] suppressing or removing - \copydoc page from related page links

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

Hello, Doxygen team,

I’m using the \copydoc command (in Doxygen 1.8.10) to include \page content in multiple places. It works as wished, but has the undesirable side effect of listing the page in the Related Pages list, as well as in the left nav-tree.

1. Is it possible to suppress the \page from the Related Pages lists?

If not, I want to implement a post-processing script to strip it out (as referenced from a long ago post, http://osdir.com/ml/text.doxygen.general/2005-01/msg00067.html), but I’m not certain that I’ve found all the places to manage. I did a search through the output directory for “content-page.html”, and found references to it in the following output\html files:

* navtreedata.js - a one-line entry to delete.
* navtreeindex0.js - a one-line entry to delete.
* todo.html – a <td></td> and <dd></dd> pair of entries to delete. Well, I think I’d likely leave this so that it still appears in the Todo list...
* pages.html - a single <tr> entry to delete.

2. Are these the only files that a post-processing script would need to handle?

3. And of course, there’s the actual content-page.html file; is it ok for a post-processing script to delete it or is it needed by something that I haven’t identified? I think it might be needed as the target of the Todo list entry...

Thanks very much,
-Monique