doxygen-users — List for users of doxygen

[Doxygen-users] How to create man-page style options listing?

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

I am trying to create a man-page style options list, e.g.,

The options are:

-a      option a does something useful
-f      a really long option explanation that needs a second
         line

[Hope the above survives e-mail.]

I can’t find anything for indented paragraphs or definition lists or anything like that. named paragraphs put the title above the paragraph. \verbatim looks like it might be an option but is unattractive since you can’t include any commands in it. I’m pretty sure I’ll need at least things like \b and \e.

I sure hope the answer isn’t to use \manonly and my own groff, and therefore also \htmlonly and my own html.

Regards

    -Mark

Re: [Doxygen-users] How can I stop Doxygen creating a _path_to_my_proj_lib_.3 man page?

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

> On May 1, 2017, at 6:24, Ken Kazinski <kjk...@ya... <mailto:kjk...@ya...>> wrote:
> 
> Can you not use exclude from the input section of the doxywizard?  This would allow you to exclude the directories.  "
> The EXCLUDE tag can be used to specify files and/or directories that should be excluded from the INPUT source files".
> 

Thanks for the suggestion. It does not work. I had INPUT = tools and RECURSIVE = YES. Adding tools & tools/toktx to EXCLUDE resulted in no output.

I tried setting input to tools/toktx/toktx.cpp and leaving EXCLUDE blank. In this case I still get these pesky path files for the 2 directories in the path.

Regards

    -Mark

P.S. to Ken, sorry for the duplicate message. I failed to notice that my mail client had not set the proper from address.

Re: [Doxygen-users] How can I stop Doxygen creating a _path_to_my_proj_lib_.3 man page?

[Ken K. <kjk...@ya...>]

Can you not use exclude from the input section of the doxywizard?  This would allow you to exclude the directories.  "
The EXCLUDE tag can be used to specify files and/or directories that should be excluded from the INPUT source files".   

Re: [Doxygen-users] How can I generate a man page for a command?

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

> On Apr 29, 2017, at 12:43, Mark <dox...@er...> wrote:
> 
> I have found an answer.


Now I’m trying to think of a way to share text between the usage message printed by the app and this man page. Anyone got any bright ideas?

Regards

    -Mark

Re: [Doxygen-users] How can I generate a man page for a command?

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

> On Apr 29, 2017, at 11:48, Mark <dox...@er...> wrote:
> 
> How can I get the man page to have this content?

I have found an answer. If I change @mainpage to @page then a toktx.1 file is created.

I still need to get rid of those 2 useless files named after the full paths to source files.

Regards

    -Mark

[Doxygen-users] How can I generate a man page for a command?

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

I tried putting the following in the .cpp file of the command.

//! @~English
//! @mainpage toktx
//!
//! @section name NAME
//!
//! toktx - create a KTX file from netpbm  (.pam, .pgm, .ppm) format files.
//!
//! @section synopsis SYNOPSIS
//!
//! @section description DESCRIPTION
//!
//! @section exitstatus EXIT STATUS
//!
//! @section history HISTORY
//!
//! @section author AUTHOR
//!
//! @version 1.1
//! $Date: Sun Dec 25 07:02:41 2016 -0200 $

Nothing was created in the man output directory except 2 more of those useless files I mentioned in a previous mail

_path_to_my_tools_.1 and _path_to_my_tools_toktx.1

If I put

//! @file

at the beginning of the above comment block then a file called toktx.cpp.1 is generated. It’s content is:

tools/toktx/toktx.cpp(1)                                                                                                         tools/toktx/toktx.cpp(1)

NAME
       tools/toktx/toktx.cpp

SYNOPSIS
       #include 'stdafx.h'
       #include 'GL/glcorearb.h'
       #include 'ktx.h'
       #include 'image.h'
       #include <cstdlib>

Author
       Generated automatically by Doxygen for Khronos Texture Tools from the source code.

Khronos Texture Tools                                                Sat Apr 29 2017                                             tools/toktx/toktx.cpp(1)


The generated HTML has a page called toktx with the desired sections. How can I get the man page to have this content?

I am sure I can’t be the first person trying to generated end-user documentation with Doxygen. What am I missing?

Regards

    -Mark

[Doxygen-users] How can I stop Doxygen creating a _path_to_my_proj_lib_.3 man page?

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

I am documenting a library with Doxygen and want to generate man pages that could ship with it. Doxygen is generating 2 very odd, and empty except for some man page boilerplate, man pages

_path_to_my_project_include_.3
_path_to_my_project_lib_.3
The files correspond to the Doxygen's INPUT

/path/to/my/project/include
/path/to/my/project/lib
include is given in INPUT. lib is the parent of some .c source files given in INPUT. include & lib are in the directory containing the doxyConfig file which is also the current directory when I run Doxygen.

With Doxygen 1.8.9 the files contained lists respectively of the .h files in the include directory and the .c files in the lib directory.

How can I stop Doxygen from generating these useless files? Even if they had any content, the man page names being specific to my environment make them useless.

Also asked on stackoverflow <http://stackoverflow.com/questions/43677909/how-can-i-stop-doxygen-creating-a-path-to-my-proj-lib-3-man-page>.

Regards

    -Mark

Re: [Doxygen-users] VHDL Hierarchy

[Larry <la...@co...>]

Thanks Luc.  We use Sigasi (its great).  But we are trying to fully automate
the process.  Check in the code, elaborate the templates, run the unit
tests, synthesize, place & route, run the system tests, generate the
documentation and post it to Confluence.  Since Doxygen seems 99% of the way
there (it already knows the hierarchy and outputs fantastic call and called
graphs), it seems it would be easy to get that last 1% . either by
specifying the top level and trim what's not in the hierarchy, or adding
something like a "libraries path" to find entities/architectures referenced
by the entities in the normal source path, but ignore all the other entities
(the same way the synthesizer works).  Our libraries are quite substantial,
so documenting all the unused entities triples the size of the documentation
(600 meg) and the extra clutter makes the resulting documentation more
difficult to follow.   

 

Gary

 

 

From: Luc Braeckman [mailto:luc...@lo...] 
Sent: Thursday, April 27, 2017 10:20 AM
To: Larry <la...@co...>; 'Richard Damon'
<Ri...@Da...>; dox...@li...
Subject: Re: [Doxygen-users] VHDL Hierarchy

 

I understood doxygen is mainly used for documentation. If one would like to
find the hierarchy of a set of VHDL entities, I'd rather use other tools. I
mainly use Sigasi as VHDL editor/validation tool. 

But of course there are others on the market.

Obviously I don't want to start a discussion in a doxygen thread of which
one is better - I just want to share my findings.

Luc

  _____  

Van: Larry <la...@co... <mailto:la...@co...> >
Verzonden: donderdag 27 april 2017 3:36:28
Aan: 'Richard Damon'; dox...@li...
<mailto:dox...@li...> 
Onderwerp: Re: [Doxygen-users] VHDL Hierarchy 

 

Thank you Richard.  Unfortunately, there are many entities per file, so even
if there was some way of knowing which files contained the entities used in
the active tree, it would be difficult to filter out the unused entities in
that file.  

There is no overloading in VHDL, so determining the hierarchy without a full
compile is feasible (doxygen in fact already does that for VHDL). I could
write a program to read the code, determine the hierarchy, search the files
to find the entities used in the hierarchy, then copy those into another
file to include in doxygen ... but since doxygen is already parsing the
file, it seem like a short stretch to have doxygen do this.  The challenge
for me is to understand the doxygen source code well enough to know how to
add that feature. 

Gary


-----Original Message-----
From: Richard Damon [mailto:Ri...@Da...] 
Sent: Wednesday, April 26, 2017 2:35 PM
To: dox...@li...
<mailto:dox...@li...> 
Subject: Re: [Doxygen-users] VHDL Hierarchy

On 4/26/17 6:32 AM, Larry wrote:
>
> Hello.  I'm new to Doxygen and have spent many hours trying to find 
> this answer on my own.  I will apologize ahead of time if I should 
> have been able to find this without bothering the mailing list .
>
> Is there any way to specify the "Top-Level" entity of set of VHDL 
> code, and have Doxygen ignore any entities which it finds in the 
> doxygen search path which are **not** in the hierarchy below the 
> top-level entity?
>
> The reason I ask is because I have VHDL designs which instantiate 
> entities from a pool of VHDL utilities.  If I put the utilities 
> libraries in the Doxygen search path, the resulting Doxygen 
> documentation accurately describes the complete hierarchy, but also 
> includes a ton of confusing extraneous stuff that is not relevant to
> the design being documented.   If I don't include the libraries, the 
> documentation of the relevant hierarchy is not complete.
>
> If this feature is not currently supported, can anyone give me advice 
> on how one might go about adding it?  I have the all the doxygen 
> sourcecode downloaded and running in Eclipse.  I have also been able 
> to successfully rebuild the VHDL parser using javacc.  I'm having a 
> little trouble getting up to speed on all the code and determining 
> which features are supported and/or how to add features.  Or, is there 
> anyone out there willing to add features for hire? (I hope that ok to 
> ask on the mailing list.)
>
> ...
>
> Gary
>
My understanding of Doxygen is the it doesn't have any from of pruning the
source file list to only what is "needed". That actually would be a somewhat
tricky problem, as it would be language dependent (C++ with its overloads,
especially operator xxx()s would require basically a FULL: 
parsing of the code).

One option would be to not include the whole library directory as an input,
but only the specific files that you need from the library.

--
Richard Damon


----------------------------------------------------------------------------
--
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...
<mailto:Dox...@li...> 
https://lists.sourceforge.net/lists/listinfo/doxygen-users


----------------------------------------------------------------------------
--
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...
<mailto:Dox...@li...> 
https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] Even though it is reading the tag file Doxygen isn't adding any external links

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

I have a library documented with Doxygen. It's doxyFile contains

GENERATE_TAGFILE       = build/doc/mylib/mylib.tag
Doxygen generates the documentation and tagfile without complaint.

I have a package also documented with Doxygen. I want the package documentation to refer to the library documentation. The package doxyFile contains

TAGFILES               = build/doc/mylib/mylib.tag=../../mylib/html
Doxygen reports

Reading and parsing tag files
Reading tag file `build/doc/mylib/mylib.tag', location `../../mylib/html'...
Apart from some warnings about duplicate anchors

/Users/mark/Projects/github/Foo/build/doc-x/mylib/mylib.tag:800: warning: Duplicate anchor vdiparam found
Doxgen completes without a problem. However the generated package doc does not include any references to the external library documentation.

What am I doing wrong? Do I have to put explicit links in the package documentation? If so, how?

What I want is to have an entry in the first level of the left-pane treeview of the package docs that links to the library doc's main page.


I asked this on stackoverflow <http://stackoverflow.com/questions/43629076/why-isnt-doxygen-putting-any-external-doc-links-in-the-generated-doc-it-is-rea> too, but no answers yet so I thought I'd try here.

Regards

    -Mark

Re: [Doxygen-users] VHDL Hierarchy

[Luc B. <luc...@lo...>]

I understood doxygen is mainly used for documentation. If one would like to find the hierarchy of a set of VHDL entities, I'd rather use other tools. I mainly use Sigasi as VHDL editor/validation tool.

But of course there are others on the market.

Obviously I don't want to start a discussion in a doxygen thread of which one is better - I just want to share my findings.

Luc

________________________________
Van: Larry <la...@co...>
Verzonden: donderdag 27 april 2017 3:36:28
Aan: 'Richard Damon'; dox...@li...
Onderwerp: Re: [Doxygen-users] VHDL Hierarchy

Thank you Richard.  Unfortunately, there are many entities per file, so even
if there was some way of knowing which files contained the entities used in
the active tree, it would be difficult to filter out the unused entities in
that file.

There is no overloading in VHDL, so determining the hierarchy without a full
compile is feasible (doxygen in fact already does that for VHDL). I could
write a program to read the code, determine the hierarchy, search the files
to find the entities used in the hierarchy, then copy those into another
file to include in doxygen ... but since doxygen is already parsing the
file, it seem like a short stretch to have doxygen do this.  The challenge
for me is to understand the doxygen source code well enough to know how to
add that feature.

Gary


-----Original Message-----
From: Richard Damon [mailto:Ri...@Da...]
Sent: Wednesday, April 26, 2017 2:35 PM
To: dox...@li...
Subject: Re: [Doxygen-users] VHDL Hierarchy

On 4/26/17 6:32 AM, Larry wrote:
>
> Hello.  I'm new to Doxygen and have spent many hours trying to find
> this answer on my own.  I will apologize ahead of time if I should
> have been able to find this without bothering the mailing list .
>
> Is there any way to specify the "Top-Level" entity of set of VHDL
> code, and have Doxygen ignore any entities which it finds in the
> doxygen search path which are **not** in the hierarchy below the
> top-level entity?
>
> The reason I ask is because I have VHDL designs which instantiate
> entities from a pool of VHDL utilities.  If I put the utilities
> libraries in the Doxygen search path, the resulting Doxygen
> documentation accurately describes the complete hierarchy, but also
> includes a ton of confusing extraneous stuff that is not relevant to
> the design being documented.   If I don't include the libraries, the
> documentation of the relevant hierarchy is not complete.
>
> If this feature is not currently supported, can anyone give me advice
> on how one might go about adding it?  I have the all the doxygen
> sourcecode downloaded and running in Eclipse.  I have also been able
> to successfully rebuild the VHDL parser using javacc.  I'm having a
> little trouble getting up to speed on all the code and determining
> which features are supported and/or how to add features.  Or, is there
> anyone out there willing to add features for hire? (I hope that ok to
> ask on the mailing list.)
>
> ...
>
> Gary
>
My understanding of Doxygen is the it doesn't have any from of pruning the
source file list to only what is "needed". That actually would be a somewhat
tricky problem, as it would be language dependent (C++ with its overloads,
especially operator xxx()s would require basically a FULL:
parsing of the code).

One option would be to not include the whole library directory as an input,
but only the specific files that you need from the library.

--
Richard Damon


----------------------------------------------------------------------------
--
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


------------------------------------------------------------------------------
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

Re: [Doxygen-users] VHDL Hierarchy

[Larry <la...@co...>]

Thank you Richard.  Unfortunately, there are many entities per file, so even
if there was some way of knowing which files contained the entities used in
the active tree, it would be difficult to filter out the unused entities in
that file.  

There is no overloading in VHDL, so determining the hierarchy without a full
compile is feasible (doxygen in fact already does that for VHDL). I could
write a program to read the code, determine the hierarchy, search the files
to find the entities used in the hierarchy, then copy those into another
file to include in doxygen ... but since doxygen is already parsing the
file, it seem like a short stretch to have doxygen do this.  The challenge
for me is to understand the doxygen source code well enough to know how to
add that feature. 

Gary


-----Original Message-----
From: Richard Damon [mailto:Ri...@Da...] 
Sent: Wednesday, April 26, 2017 2:35 PM
To: dox...@li...
Subject: Re: [Doxygen-users] VHDL Hierarchy

On 4/26/17 6:32 AM, Larry wrote:
>
> Hello.  I'm new to Doxygen and have spent many hours trying to find 
> this answer on my own.  I will apologize ahead of time if I should 
> have been able to find this without bothering the mailing list .
>
> Is there any way to specify the "Top-Level" entity of set of VHDL 
> code, and have Doxygen ignore any entities which it finds in the 
> doxygen search path which are **not** in the hierarchy below the 
> top-level entity?
>
> The reason I ask is because I have VHDL designs which instantiate 
> entities from a pool of VHDL utilities.  If I put the utilities 
> libraries in the Doxygen search path, the resulting Doxygen 
> documentation accurately describes the complete hierarchy, but also 
> includes a ton of confusing extraneous stuff that is not relevant to
> the design being documented.   If I don't include the libraries, the 
> documentation of the relevant hierarchy is not complete.
>
> If this feature is not currently supported, can anyone give me advice 
> on how one might go about adding it?  I have the all the doxygen 
> sourcecode downloaded and running in Eclipse.  I have also been able 
> to successfully rebuild the VHDL parser using javacc.  I'm having a 
> little trouble getting up to speed on all the code and determining 
> which features are supported and/or how to add features.  Or, is there 
> anyone out there willing to add features for hire? (I hope that ok to 
> ask on the mailing list.)
>
> ...
>
> Gary
>
My understanding of Doxygen is the it doesn't have any from of pruning the
source file list to only what is "needed". That actually would be a somewhat
tricky problem, as it would be language dependent (C++ with its overloads,
especially operator xxx()s would require basically a FULL: 
parsing of the code).

One option would be to not include the whole library directory as an input,
but only the specific files that you need from the library.

--
Richard Damon


----------------------------------------------------------------------------
--
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

Re: [Doxygen-users] VHDL Hierarchy

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

On 4/26/17 6:32 AM, Larry wrote:
>
> Hello.  I’m new to Doxygen and have spent many hours trying to find 
> this answer on my own.  I will apologize ahead of time if I should 
> have been able to find this without bothering the mailing list …
>
> Is there any way to specify the “Top-Level” entity of set of VHDL 
> code, and have Doxygen ignore any entities which it finds in the 
> doxygen search path which are **not** in the hierarchy below the 
> top-level entity?
>
> The reason I ask is because I have VHDL designs which instantiate 
> entities from a pool of VHDL utilities.  If I put the utilities 
> libraries in the Doxygen search path, the resulting Doxygen 
> documentation accurately describes the complete hierarchy, but also 
> includes a ton of confusing extraneous stuff that is not relevant to 
> the design being documented.   If I don’t include the libraries, the 
> documentation of the relevant hierarchy is not complete.
>
> If this feature is not currently supported, can anyone give me advice 
> on how one might go about adding it?  I have the all the doxygen 
> sourcecode downloaded and running in Eclipse.  I have also been able 
> to successfully rebuild the VHDL parser using javacc.  I’m having a 
> little trouble getting up to speed on all the code and determining 
> which features are supported and/or how to add features.  Or, is there 
> anyone out there willing to add features for hire? (I hope that ok to 
> ask on the mailing list.)
>
> ...
>
> Gary
>
My understanding of Doxygen is the it doesn't have any from of pruning 
the source file list to only what is "needed". That actually would be a 
somewhat tricky problem, as it would be language dependent (C++ with its 
overloads, especially operator xxx()s would require basically a FULL: 
parsing of the code).

One option would be to not include the whole library directory as an 
input, but only the specific files that you need from the library.

-- 
Richard Damon

[Doxygen-users] VHDL Hierarchy

[Larry <la...@co...>]

Hello.  I'm new to Doxygen and have spent many hours trying to find this
answer on my own.  I will apologize ahead of time if I should have been able
to find this without bothering the mailing list .

 

Is there any way to specify the "Top-Level" entity of set of VHDL code, and
have Doxygen ignore any entities which it finds in the doxygen search path
which are *not* in the hierarchy below the top-level entity?  

 

The reason I ask is because I have VHDL designs which instantiate entities
from a pool of VHDL utilities.  If I put the utilities libraries in the
Doxygen search path, the resulting Doxygen documentation accurately
describes the complete hierarchy, but also includes a ton of confusing
extraneous stuff that is not relevant to the design being documented.   If I
don't include the libraries, the documentation of the relevant hierarchy is
not complete.  

 

If this feature is not currently supported, can anyone give me advice on how
one might go about adding it?  I have the all the doxygen sourcecode
downloaded and running in Eclipse.  I have also been able to successfully
rebuild the VHDL parser using javacc.  I'm having a little trouble getting
up to speed on all the code and determining which features are supported
and/or how to add features.  Or, is there anyone out there willing to add
features for hire? (I hope that ok to ask on the mailing list.)

 

Btw, I did enhance the VHDL parser to accept underscores inside hex literals
by modifying this line in the jj file:

<BASED_LITERAL: <INTEGER>["#"]<BASED_INTEGER> ((["_"])? <BASED_INTEGER>)*
(["."] <BASED_INTEGER>)? ["#"] (<EXPONENT>)? >  /*Gary Pratt added ((["_"])?
<BASED_INTEGER>)* */

 

I can provide the modified vhdlparser.jj file.  

 

Thanks in advance.  And, thanks to Dimitri and everyone who has helped build
a fantastic tool.

 

Gary

 

Gary L. Pratt, P.E.

President

ControlSphere Engineering

 

 

 

Re: [Doxygen-users] Crash using Doxygen 1.8.13

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

On Tue, Apr 25, 2017 at 12:49 AM, L A Walsh <do...@tl...> wrote:
> Dimitri van Heesch wrote:
>> Hi Vinnie,
>>
>> Looks like the issue is already fixed in the latest version from Github.

Is there a Windows installer for what's at the tip of the main GitHub
repository branch?

Re: [Doxygen-users] Crash using Doxygen 1.8.13

[L A W. <do...@tl...>]

Vinnie Falco wrote:
> On Tue, Apr 25, 2017 at 11:57 AM, L A Walsh <do...@tl...> wrote:
>   
>> ?? Beast? ??
>> For me it was a different project.
>>
>> From what I understand, different files are included in the
>> git-version than come in the tarball.  might
>> that not change things?
>>     
>
> Yes, building from the version in the Git repository would produce
> different results, if the sources in the repository do not correspond
> to the binary that is distributed in the Windows installer that I used
> to install Doxygen 1.8.13.
>
> To know if the repository fixes the issue, it is necessary to try
> reproducing the issue described in my original post. I will repeat
> those instructions here:...
>   


    Perhaps you will understand, but I'm more interested
in how the project in  bugzilla bug 781306 is affected.

1) if it was the same bug, and
2) if the fix works for for the project that that
the bugzilla bug was filed against. 


>   

Re: [Doxygen-users] Crash using Doxygen 1.8.13

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

On Tue, Apr 25, 2017 at 11:57 AM, L A Walsh <do...@tl...> wrote:
> ?? Beast? ??
> For me it was a different project.
>
> From what I understand, different files are included in the
> git-version than come in the tarball.  might
> that not change things?

Yes, building from the version in the Git repository would produce
different results, if the sources in the repository do not correspond
to the binary that is distributed in the Windows installer that I used
to install Doxygen 1.8.13.

To know if the repository fixes the issue, it is necessary to try
reproducing the issue described in my original post. I will repeat
those instructions here:

To reproduce the crash in Doxygen 1.8.13, clone this repository:
https://github.com/vinniefalco/Beast

Then issue these commands from the root of the local directory:

    cd doc
    ./makeqbk.sh

Can you please try this, to see if the defect has been resolved? I
don't have the right environment set up to build Doxygen from sources.

Re: [Doxygen-users] Crash using Doxygen 1.8.13

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

On Tue, Apr 25, 2017 at 12:49 AM, L A Walsh <do...@tl...> wrote:
> Dimitri van Heesch wrote:
>> Looks like the issue is already fixed in the latest version from Github.

It should be easy to verify, just clone my repository and execute the
2 steps I provided. Did the Beast documentation build for you?

Re: [Doxygen-users] Crash using Doxygen 1.8.13

[L A W. <do...@tl...>]

Dimitri van Heesch wrote:
> Hi Vinnie,
>
> Looks like the issue is already fixed in the latest version from Github.
>
> Regards,
>   Dimitri
>   
----
    Is it?  Is it the same as this bug reported against 1.8.13
here:

https://bugzilla.gnome.org/show_bug.cgi?id=781306

No one ever responded to it after I uploaded the requested information

(and no way to change status from 'NEEDINFO' to 'OPEN'...)...

Re: [Doxygen-users] Crash using Doxygen 1.8.13

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

Hi Vinnie,

Looks like the issue is already fixed in the latest version from Github.

Regards,
  Dimitri

> On 23 Apr 2017, at 20:11 , Vinnie Falco <vin...@gm...> wrote:
> 
> My documentation builds correctly with 1.8.12 but when I try 1.8.13 I
> get a segmentation fault.
> 
> The project is located here:
> https://github.com/vinniefalco/Beast
> 
> To reproduce the steps, issue these commands from the root of the
> local repository:
> 
> cd doc
> ./makeqbk.sh
> 
> Result: When Doxygen 1.8.13 is invoked, it will do some processing and
> then terminate with a segmentation fault.
> 
> Please advise
> 
> ------------------------------------------------------------------------------
> 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 using Doxygen 1.8.13

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

My documentation builds correctly with 1.8.12 but when I try 1.8.13 I
get a segmentation fault.

The project is located here:
https://github.com/vinniefalco/Beast

To reproduce the steps, issue these commands from the root of the
local repository:

cd doc
./makeqbk.sh

Result: When Doxygen 1.8.13 is invoked, it will do some processing and
then terminate with a segmentation fault.

Please advise

Re: [Doxygen-users] Namespace members behaviour in 1.8.13

[didje <dia...@pd...>]

Updating this with some more detailed information after further
investigation:

I am using Doxygen 1.8.13. 

Previously I was using Doxygen 1.8.10 

With Doxygen 1.8.10, when I generated documentation for a library using a
file from another library, a "Namespace Members" page was generated in the
first library, with an alphabetically ordered list of the namespace members
from the other libraries and from any other library containing additional
namespace members for such namespaces, if those other libraries tag files
had been included by the second library.
However, in Doxygen 1.8.13, a Namespace Members page is generated for the
first library containing only the namespace members found in the second
library and not in any other libraries with tag files included in the second
library.

I realise the above sentence is a brain-twister, so I will give a concrete
example below:

I am generating documentation for three libraries, TestLibB, TestLibC and
TestLibD.

Using Doxygen 1.8.13, I do as follows:

TestLibD library contains one file named FileD.h, with the following
contents:

    /*!
     * \file FileD.h
     * \brief Describes FileA stuff
     */

    /*! \brief
     * Contains ABC stuff
     */
    namespace ABC {
    /*! \enum YEnumA
     * \brief YEnumA stuff
     */
    enum YEnumA {
    eABORT,
    eIGNORE
    };

    }

I generate the documentation using the default generated Doxyfile
properties, apart from the following tags:
    
    @PROJECT_NAME="TestLibD"
    @INPUT=FileD.h
    @GENERATE_TAGFILE  = $(DOXY_OUTPUT)/TestLibD.tag

TestLibB library contains one file named FileB.h, with the following
contents:

    /*!
     * \file FileB.h
     * \brief Describes FileB stuff
     */

    /*! \brief
     * Contains ABC stuff
     */
    namespace ABC {
	
    /*! \enum XEnumA
    * \brief XEnumA stuff
    */
    enum XEnumA {
    eABORT,
    eIGNORE
    };

    }

I generate the documentation using the default generated Doxyfile
properties, apart from the following tags:
the following:

    @PROJECT_NAME="TestLibD"
    @INPUT=FileD.h
    @GENERATE_TAGFILE=$(DOXY_OUTPUT)/TestLibD.tag
    @TAGFILES=$(DOXY_OUTPUT)/../TestLibD/TestLibD.tag=../TestLibD

TestLabC library does not contain any of its own files.
It uses the default generated Doxyfile properties, apart from the following
tags:

    @PROJECT_NAME="TestLibC"
    @INPUT=Overview.html ../TestLibB/FileB.h
    @TAGFILES=$(DOXY_OUTPUT)/../TestLibD/TestLibD.tag=../TestLibD

I generate the documentation for TestLibC. On its namespacemembers page, is
the following:

    XEnumA : ABC

Now, using Doxygen 1.8.10, I repeat the above steps:

In the namespacemembers page for TestLibC, I see the following:
    
    XEnumA : ABC
    YEnumA : ABC

What is the reason for the difference in the namespacemember between 1.8.10
and 1.8.13 ?





--
View this message in context: http://doxygen.10944.n7.nabble.com/Namespace-members-behaviour-in-1-8-13-tp7828p7832.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] What is the reason for no alphabetical organisation of namespace members in certain libraries

[didje <dia...@pd...>]

To reply to my own question...

This is caused by the number of namespace members. When there are not many,
the list of members are not organised under the alphabetical letter with
which the namespace member begins, however, when there are a lot of
namespace members, these are organised under the alphabetical letter with
which they begin.



--
View this message in context: http://doxygen.10944.n7.nabble.com/What-is-the-reason-for-no-alphabetical-organisation-of-namespace-members-in-certain-libraries-tp7829p7831.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] Where are the tests in the source tree?

[Brier, Frederick(GE O. & Gas) <Fre...@ge...>]

I checked out the doxygen code, followed the instructions, installing the necessary tools, and successfully built the project using Visual Studio 2015 under Windows 10 Enterprise.  Looking through the source tree, I do not see any tests of the various supported language grammars.  My immediate goal is to validate that there is, or is not a problem with Doxygen understanding some C# syntax<http://doxygen.10944.n7.nabble.com/C-using-with-results-in-quot-was-not-declared-or-defined-quot-td7774.html>.  So I would like to create a test.  Make sure there is a problem, and if necessary modify the grammar or code to fix it.  Thank you for any help.

Fred

[Doxygen-users] What is the reason for no alphabetical organisation of namespace members in certain libraries

[didje <dia...@pd...>]

In the namespace members page, why do some libraries generate lists of
members organised alphabetically (i.e. when you click on "Namespaces", then
"Namespace Members", then "All", there is a list of namespace members
beginning with "a" under the title "a", then those with "b" under the title
"b" etc....), whereas for some other libraries, there are list of members,
but not organised under the letter of the alphabet they begin with (though
they do appear in alphabetical order).

Is this connected to the number of members of the namespace in the library
in question - i.e. if there are more than X number of namespace members, the
members are grouped under the letter they belong to ?





--
View this message in context: http://doxygen.10944.n7.nabble.com/What-is-the-reason-for-no-alphabetical-organisation-of-namespace-members-in-certain-libraries-tp7829.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] Namespace members behaviour in 1.8.13

[didje <dia...@pd...>]

I am using Doxygen 1.8.13.

Previously I was using Doxygen 1.8.10

I am generating the documentation for a library libA, which, in has as its
@INPUT tag only the following:

@INPUT = ../libB/AFile.h \
         docs/Overview.html

AFile.h contains lots of includes of header files from other libraries.

With Doxygen 1.8.10, a "Namespace Members" page was generated, with an
alphabetically ordered list of the namespace members (from various different
libraries).
However, with Doxygen 1.8.13, no "Namespace Members" page was generated at
all.

Why is this ?



--
View this message in context: http://doxygen.10944.n7.nabble.com/Namespace-members-behaviour-in-1-8-13-tp7828.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.