doxygen-users — List for users of doxygen

[Doxygen-users] hard to search - the archives on sourceforge...

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

> This question has popped up multiple times on e.g. this forum and on stackexchange.

Yes, but... I find it very (very) hard to use the archives on sourceforge. Unlike the archives of many other lists I’ve subscribed to, I haven’t found a way to search for a topic and then display all a given message’s replies in a typical threaded view. Clicking on individual messages often result in a display with the message repeated at least twice, but no links to the previous or next messages in a thread.
It’s been a long time since the list moved to sourceforge, but I believe that the archives were much easier to search before that.
But occasionally when I click a message, I do see several responses. I just have no idea when it’ll “work” and when I have to keep going to the search page and searching for ever-more specific things to try to get the display to show me all a thread’s messages.
Perhaps I’m doing something wrong, or there’s a setting I haven’t found?
-Monique
 

Re: [Doxygen-users] Q: possible to create custom special pages?

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

Albrecht,

Please look in the manual at \xrefitem or search the internet for some
examples.
This question has popped up multiple times on e.g. this forum and on
stackexchange.

Albert

On Fri, Jun 24, 2016 at 7:15 PM, Albrecht Dreß <alb...@ar...>
wrote:

> Hi all,
>
> Is it possible in doxygen to create a custom "todo"-like list from other
> commands?  E.g. something like the "side effects" custom command documented
> here [1], with the addition, that all these "side effects" paragraphs are
> collected somewhere?
>
> For a practical use case, consider a software where changes are added by
> many people which must be reviewed.  Everyone should add a special comment
> (e.g. "@review", as custom command) briefly documenting the changes.  If
> those changes are all collected on a special page, and cross-referenced to
> the description, this would greatly simplify a review process.
>
> Thanks in advance,
> Albrecht.
>
>
> [1] <
> http://www.stack.nl/~dimitri/doxygen/manual/custcmd.html#custcmd_simple>
>
> ------------------------------------------------------------------------------
> Attend Shape: An AT&T Tech Expo July 15-16. Meet us at AT&T Park in San
> Francisco, CA to explore cutting-edge tech and listen to tech luminaries
> present their vision of the future. This family event has something for
> everyone, including kids. Get more information and register today.
> http://sdm.link/attshape
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

Re: [Doxygen-users] Q: possible to create custom special pages?

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

Oh, I forgot to say that I'm using Doxygen 1.8.10, but I think this is 
pretty standard across many Doxygen versions. 

Re: [Doxygen-users] Q: possible to create custom special pages?

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

> Is it possible in doxygen to create a custom "todo"-like list from other 
> commands? ... Everyone should add a special comment (e.g. "@review", as 
> custom command) briefly documenting the changes.  If those changes are all 
> collected on a special page, and cross-referenced to the description, this 
> would greatly simplify a review process.

Yes, it's possible, and it's easier than the documentation makes it seem.

I have several of these lists that I use for things as varied as 
@todo_techpubs, @todo_eng_review (for things I want to highlight as needing 
review), @todo_add_ask (for public entities that I'm unsure about 
documenting, because there are public entities that are nevertheless not for 
end user use, but are needed by internal modules.

I'll use the @todo_eng_review example since it corresponds most closely to 
your use case.

In the Doxyfile, I have the following alias (the ending "\" chars are so 
that I can have linefeeds in the Doxyfile for easier readability, but you 
could put the entire command on a single line):

ALIASES               += todo_eng_review="@xrefitem key_todo_eng_review \
                           \"Eng Review\" \"Eng Review Requested List\" \
                           Eng-review requested."

And you need to set the GENERATE_TODOLIST = YES.

Then when  you use the @todo_eng_review command in the Doxygen comment 
blocks, you'll get a page for the Eng Review Requested List.

I generally have two versions of my Doxyfile config files: one for a 
review/non-release/internal version that sets "GENERATE_TODOLIST = YES", and 
one that's for the actual production version where we don't want to expose 
these internal things to the end user, with "GENERATE_TODOLIST = NO". This 
way I don't have to strip out all these comments from the code, and can 
carry things over to the next version.

If you go this route, then in addition to having "GENERATE_TODOLIST = NO", 
you need to change the ALIAS, which I do as follows:

ALIASES               += todo_eng_review="@todo Eng-review requested."

I found this necessary because the GENERATE_TODOLIST applies only to the 
@todo comments, not the @todo_eng_review. So if I don't redefine the 
@todo_eng_review back to @todo, I end up with that separate @xrefitem page 
appearing in the output.

A bonus bit of info: I wanted these special @todo things to stand out in the 
output, with a magenta vertical bar instead of the regular color. I created 
a customdoxygen.css stylesheet, set "HTML_EXTRA_STYLESHEET = 
customdoxygen.css", and in in the stylesheet, after the dl.todo entry, I 
added an entry for dl.todo_eng_review. I kept everything the same as the 
regular dl.todo, except for the color:

dl.key_todo_eng_review
{
        margin-left:-7px;
        padding-left: 3px;
        border-left:4px solid;
        border-color: #FF00FF;    /* magenta */
}

HTH,
-Monique

[Doxygen-users] Q: possible to create custom special pages?

[Albrecht D. <alb...@ar...>]

Hi all,

Is it possible in doxygen to create a custom "todo"-like list from other commands?  E.g. something like the "side effects" custom command documented here [1], with the addition, that all these "side effects" paragraphs are collected somewhere?

For a practical use case, consider a software where changes are added by many people which must be reviewed.  Everyone should add a special comment (e.g. "@review", as custom command) briefly documenting the changes.  If those changes are all collected on a special page, and cross-referenced to the description, this would greatly simplify a review process.

Thanks in advance,
Albrecht.


[1] <http://www.stack.nl/~dimitri/doxygen/manual/custcmd.html#custcmd_simple>

[Doxygen-users] how to get global variables linked in tcl

[Hartmut M. <po...@ha...>]

Experts,

I wonder how I can document my tcl code such that variables appear as links
inside my procs. Example:


## \file
# File documentation.

## my global variable
variable glob_var
set glob_var "hallo"

## my top proc
proc test {arg1} {
    variable glob_var
    puts [uc $glob_var $arg1]
    return
}

## my upper casing proc
proc uc {args} {
    return [string toupper $args]
}

Global variable "glob_var" appears in the Variable section, but the variable
statement inside proc test is not a clickable link. What could be the reason
for that?

[Doxygen-users] \relates for partial specialization

[Andreas F. <and...@ge...>]

Hello,

Is it possible to use \relates for a partial specialization.
I tried it, but the related free function ends up with the
most generic class template, but maybe I simply do something wrong.

Best,

Andreas

-- 
Andreas Fabri, PhD
Chief Officer, GeometryFactory
Editor, The CGAL Project

phone: +33.492.954.912    skype: andreas.fabri

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

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

This is due to CodeDocs not supporting all the doxygen configuration
options. This restriction should be lifted shortly, as I am working on
it now.

In the mean time, you can see the currently supported options in the
example config file:

  https://codedocs.xyz/static/codedocs_example.txt

Hope this helps.
-Paul



On Mon, 2016-06-13 at 17:07 -0400, Allen Winter wrote:
> Hi Paul,
> 
> I noticed that images (under a top-level folder called 'images') are
> not being found.
> 
> My .codedocs file has:
> DOXYFILE = Doxyfile
> 
> and my Doxyfile has:
> IMAGE_PATH = images
> 
> similar with examples, I think (and EXAMPLE_PATH)
> 
> any idea what I'm doing wrong?
> 
> -Allen
> 
> 
> On Tuesday, January 05, 2016 08:56:26 PM Paul Novotny wrote:
> > Hello,
> > 
> > I put together a GitHub integration for generating and hosting
> > Doxygen
> > docs for your public GitHub repositories. Consider this an early
> > prototype, but I would like to get some testers and feedback. Just
> > go
> > to:
> > 
> >   https://codedocs.xyz/
> > 
> > You should see a list of your public repositories. Then enable the
> > repositories you want Doxygen generated for. A GitHub hook is
> > added, so
> > the documentation is rebuilt every time you push changes to GitHub.
> > You
> > can add badges to your README.md (like Coverity, Travis-CI, etc)
> > that
> > point to the documentation that is hosted on codedocs.xyz. For
> > example,
> > look at my OpenSceneGraph and Doxygen forks:
> > 
> >   https://github.com/paulnovo/osg
> >   https://github.com/paulnovo/doxygen
> > 
> > I added the "code: documented" badges to the README.md that point
> > to the
> > latest Doxgyen documentation:
> > 
> >   https://codedocs.xyz/paulnovo/osg/
> >   https://codedocs.xyz/paulnovo/doxygen/
> > 
> > Let me know what you think. Hopefully this will be useful for
> > Doxygen
> > users.
> > 
> > -Paul
> > 
> > -----------------------------------------------------------------
> > -------------
> > _______________________________________________
> > Doxygen-users mailing list
> > Dox...@li...
> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
> 

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

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

Hi Paul,

I noticed that images (under a top-level folder called 'images') are not being found.

My .codedocs file has:
DOXYFILE = Doxyfile

and my Doxyfile has:
IMAGE_PATH = images

similar with examples, I think (and EXAMPLE_PATH)

any idea what I'm doing wrong?

-Allen


On Tuesday, January 05, 2016 08:56:26 PM Paul Novotny wrote:
> Hello,
> 
> I put together a GitHub integration for generating and hosting Doxygen
> docs for your public GitHub repositories. Consider this an early
> prototype, but I would like to get some testers and feedback. Just go
> to:
> 
>   https://codedocs.xyz/
> 
> You should see a list of your public repositories. Then enable the
> repositories you want Doxygen generated for. A GitHub hook is added, so
> the documentation is rebuilt every time you push changes to GitHub. You
> can add badges to your README.md (like Coverity, Travis-CI, etc) that
> point to the documentation that is hosted on codedocs.xyz. For example,
> look at my OpenSceneGraph and Doxygen forks:
> 
>   https://github.com/paulnovo/osg
>   https://github.com/paulnovo/doxygen
> 
> I added the "code: documented" badges to the README.md that point to the
> latest Doxgyen documentation:
> 
>   https://codedocs.xyz/paulnovo/osg/
>   https://codedocs.xyz/paulnovo/doxygen/
> 
> Let me know what you think. Hopefully this will be useful for Doxygen
> users.
> 
> -Paul
> 
> ------------------------------------------------------------------------------
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: [Doxygen-users] Newbie Question (Be Nice!): Hits and misses

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

Paul,

This message has nothing to do with the selected type of output.
Please have a look in the documentation of the LOOKUP_CACHE_SIZE setting in
the configuration part of the manual.
So no omissions as you suspected.

Albert


On Wed, Jun 8, 2016 at 3:59 PM, Flores, Paul A. <PAU...@sa...>
wrote:

> Rather new to doxygen.
>
>
>
> I am generating XML to be used to reverse engineer in an attempt at
> setting a UML baseline for an existing project.  Concern is that there will
> be some significant delta between what he code has and what the resulting
> UML represents.
>
>
>
> So after an initial run we are seeing the following in the log file and it
> has raised some questions.  Notably what does this mean? -> "lookup cache
> used 65536/65536 hits=1215374 misses=144799"
>
>
>
> What constitutes a "miss"?  Does this imply that there are 144799
> "omissions" in the resulting XML?
>
>
>
> Any insights, guidance, clarification or advice is appreciated!
>
>
>
> Paul
>
>
> ------------------------------
>
> This communication (including any attachments) may contain information
> that is proprietary, confidential or exempt from disclosure. If you are not
> the intended recipient, please note that further dissemination,
> distribution, use or copying of this communication is strictly prohibited.
> Anyone who received this message in error should notify the sender
> immediately by telephone or by return email and delete it from his or her
> computer.
>
>
>
> ------------------------------------------------------------------------------
> What NetFlow Analyzer can do for you? Monitors network bandwidth and
> traffic
> patterns at an interface-level. Reveals which users, apps, and protocols
> are
> consuming the most bandwidth. Provides multi-vendor support for NetFlow,
> J-Flow, sFlow and other flows. Make informed decisions using capacity
> planning reports. https://ad.doubleclick.net/ddm/clk/305295220;132659582;e
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] Newbie Question (Be Nice!): Hits and misses

[Flores, P. A. <PAU...@SA...>]

Rather new to doxygen.



I am generating XML to be used to reverse engineer in an attempt at setting a UML baseline for an existing project.  Concern is that there will be some significant delta between what he code has and what the resulting UML represents.



So after an initial run we are seeing the following in the log file and it has raised some questions.  Notably what does this mean? -> "lookup cache used 65536/65536 hits=1215374 misses=144799"



What constitutes a "miss"?  Does this imply that there are 144799 "omissions" in the resulting XML?



Any insights, guidance, clarification or advice is appreciated!



Paul


________________________________

This communication (including any attachments) may contain information that is proprietary, confidential or exempt from disclosure. If you are not the intended recipient, please note that further dissemination, distribution, use or copying of this communication is strictly prohibited. Anyone who received this message in error should notify the sender immediately by telephone or by return email and delete it from his or her computer.

[Doxygen-users] New snapshot Moritz 2.0.90 to generate nassi shneiderman and UML like activity diagrams is available

[Eckard K. <eck...@t-...>]

Hello everybody.

Since some years I'm providing  Moritz a tool to generate source 
diagrams.  Moritz is able to generate html-based nassi shneiderman 
diagrams as well as dot-based UML like activity diagrams.

After more or less one and a half year of work I posted this weekend not 
only 1 but 2 new snapshots to prepare the next Release Moritz 2.1.0.


The snapshot Moritz 2.0.90 is the real new thing and can be downloaded here:
https://sourceforge.net/projects/moritz/files/Moritz_2.x/DevelopmentFor_2_1_0/Snapshot_2_0_90/
With this snapshot I start a deeper refactoring of Moritz. Instead of 
the boost library Spirit Moritz will now come with its own parser module 
completely new developed.

With an own parser module it will be easier to maintain the sources and 
to implement new features which expect special parser functionalities.

Furthermore I hope that the parsing process becomes a little bit faster 
since the new parser module is able to store temporary results to reuse 
them later instead of parsing again.


The snapshot Moritz 2.0.3 is just a small update of the snapshot Moritz 
2.0.2 and can be downloaded here:
https://sourceforge.net/projects/moritz/files/Moritz_2.x/DevelopmentFor_2_1_0/Snapshot_2_0_3/
Note my reason to post this package is to provide just a kind of 
benchmark for the release 2.0.90 and a fall-back in the case you will 
have some trouble with 2.0.90.


Please allow me to ask all of you to test Moritz 2.0.90 to give me some 
feedback in the forum of Moritz.

Best regards,
                        Eckard Klotz

Re: [Doxygen-users] VHDL Hierachy

[Stefan D. <st...@sd...>]

True, now that you mention it I remember that I also had two entities
that didn't show up in the graph at first, because I also used
direct-instantiation for the two missing entities. I usually never do
that, only for these two missing entities I was too lazy. (What I
usually do is I add the component declarations to a package, which I
include at the top of my file. That gives a better overview what is
used in the entity, but also keeps the architecture declarative part
clean.)

I just added the component declarations of my two missing entities to
the package that I include, and changed the instantiation and that
solved it for me. But if "a_module" is auto-generated I guess thats
not an option for you.

On the other hand: If a_module is auto-generated, you cannot add
doxygen comments to it. And since its generated, the inner structure
of a_module shouldn't be of concern anyway, in my opinion. Instead
maybe the settings/options of the generating script/program should be
documented.

But yeah, I know what you mean. I try to avoid generated code as much
as possible. But there is not always a way around it.

And it definitely is a bug in the doxygen parser. (Sadly Doxygen for
VHDL is not very good anyway (e.g. the UML class diagrams are almost
useless). Unfortunately there are no real alternative I guess.

2016-06-03 18:51 GMT+02:00  <ma...@di...>:
> Hey Stefan,
>
>
>
> I have uploaded some sample code to
> http://github.com/martynp/doxygen_vhdl_test/. I tried your settings file and
> it did not work still…
>
>
>
> With doxygen 1.8.5 (CentOS 7 default version):
>
>
>
> https://github.com/martynp/doxygen_vhdl_test/blob/master/1.8.5.png
>
>
>
> With doxygen 1.8.12:
>
>
>
> https://github.com/martynp/doxygen_vhdl_test/blob/master/1.8.12.png
>
>
>
> I had a play with most of the settings I could find – but doxygen is not
> figuring out the entity relationships. It works if I use components, but I
> would rather not (there are auto-generated parts of the code which will not
> work without major changes).
>
>
>
> Thanks!
>
>
>
> -          Martyn
>
>
>
> From: ste...@gm... [mailto:ste...@gm...] On Behalf Of Stefan
> Dröge
> Sent: 03 June 2016 10:17
> To: Martyn Pittuck <ma...@di...>
> Cc: dox...@li...
> Subject: Re: [Doxygen-users] VHDL Hierachy
>
>
>
> With hierarchy you mean something like that the diagram below? That was
> generated for my VHDL code with doxygen Version 1.8.11 and the attached
> Doxyfile.
>
>
>
> (In case attachements do not work on the mailinglist here is a link:
> https://www.dropbox.com/s/pdpybkpstxx73uq/Screenshot%202016-06-03%2011.08.24.png?dl=0
> )
>
>
>
> 2016-06-03 9:55 GMT+02:00 Martyn Pittuck <ma...@di...>:
>
> Hello,
>
>  - Martyn
>
>
>
>
> ------------------------------------------------------------------------------
> What NetFlow Analyzer can do for you? Monitors network bandwidth and traffic
> patterns at an interface-level. Reveals which users, apps, and protocols are
> consuming the most bandwidth. Provides multi-vendor support for NetFlow,
> J-Flow, sFlow and other flows. Make informed decisions using capacity
> planning reports. https://ad.doubleclick.net/ddm/clk/305295220;132659582;e
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

Re: [Doxygen-users] VHDL Hierachy

[<ma...@di...>]

Hey Stefan,

 

I have uploaded some sample code to http://github.com/martynp/doxygen_vhdl_test/. I tried your settings file and it did not work still…

 

With doxygen 1.8.5 (CentOS 7 default version):

 

https://github.com/martynp/doxygen_vhdl_test/blob/master/1.8.5.png

 

With doxygen 1.8.12:

 

https://github.com/martynp/doxygen_vhdl_test/blob/master/1.8.12.png

 

I had a play with most of the settings I could find – but doxygen is not figuring out the entity relationships. It works if I use components, but I would rather not (there are auto-generated parts of the code which will not work without major changes).

 

Thanks!

 

-          Martyn

 

From: ste...@gm... [mailto:ste...@gm...] On Behalf Of Stefan Dröge
Sent: 03 June 2016 10:17
To: Martyn Pittuck <ma...@di...>
Cc: dox...@li...
Subject: Re: [Doxygen-users] VHDL Hierachy

 

With hierarchy you mean something like that the diagram below? That was generated for my VHDL code with doxygen Version 1.8.11 and the attached Doxyfile.

 

(In case attachements do not work on the mailinglist here is a link: https://www.dropbox.com/s/pdpybkpstxx73uq/Screenshot%202016-06-03%2011.08.24.png?dl=0 )

 

2016-06-03 9:55 GMT+02:00 Martyn Pittuck <ma...@di...>:

Hello, 

 - Martyn

 


------------------------------------------------------------------------------
What NetFlow Analyzer can do for you? Monitors network bandwidth and traffic
patterns at an interface-level. Reveals which users, apps, and protocols are
consuming the most bandwidth. Provides multi-vendor support for NetFlow,
J-Flow, sFlow and other flows. Make informed decisions using capacity
planning reports. https://ad.doubleclick.net/ddm/clk/305295220;132659582;e
_______________________________________________
Doxygen-users mailing list
Dox...@li... <mailto:Dox...@li...> 
https://lists.sourceforge.net/lists/listinfo/doxygen-users

 

[Doxygen-users] VHDL Hierachy

[Martyn P. <ma...@di...>]

Hello,

 

I recently had upgraded a doxygen install to the current release and instantly lost all the hierarchy information within the documentation. Trying different versions of doxygen the problem seems to have started after Release 1.8.7 when the parser was changed, all releases after that tag result in the same issue:

 

Some code:

 

library IEEE; use IEEE.std_logic_1164.all; use ieee.numeric_std.all;

library lib;

 

entity a_module is

            port ( a_in : in std_logic; a_out : out std_logic);

end a_module;

 

architecture behavioral of a_module is

            signal b_in                  : std_logic;

            signal b_out    : std_logic;

            signal c_in                   : std_logic;

            signal c_out     : std_logic;

begin

 

            b_i : entity work.b_module

            port map (b_in => b_in, b_out => b_out);

 

            c_i : entity lib.c_module

            port map (c_in => c_in, c_out => c_out);

 

end behavioral;

 

library IEEE; use IEEE.std_logic_1164.all; use ieee.numeric_std.all;

 

entity b_module is

            port ( b_in : in std_logic; b_out : out std_logic);

end b_module;

 

architecture behavioral of b_module is

            signal b_in : std_logic;

            signal b_out : std_logic;

begin

            b_out <= b_in;

end behavioral;

 

[c_module is the same code as b_module, just located in a different place]

 

Older version of doxygen identify a_module as using b_module and c_module, newer versions do not. The entities a_module and b_module are in the 'work' scope, c_module is partially compiled elsewhere. 

 

Is there any way to fix this or is there a way to force the class hierarchy. My only option at the moment is to require my user nothing new than 1.8.7 which is not ideal...

 

Many thanks,

 

 - Martyn

 

Re: [Doxygen-users] display log message of TortoiseSVN

[Fabian C. <Cen...@in...>]

> * $HeadURL: https://cobsvsvn/svn/Projects/FC_CPU/FC_CPU/source/main/bus.c $
> * $Date: 2016-06-02 11:48:33 +0200 (Do, 02 Jun 2016) $
> * $Author: cobbrj0 $
> * $Revision: 3022 $
>
>As you can see, I have inserted some svn::keywords like $Date$, $Revision$,
>$Author$, ... Here TortoiseSVN inserts the required information when I check
>in (commit) the file.
>
>Now, I also want to show in this file the last log message of my last check
>in of this file. But I don't know if there is a keyword for this or
>something else in TortoiseSVN.

No, there is no svn keyword for the commit message, see here:
http://svnbook.red-bean.com/en/1.8/svn.advanced.props.special.keywords.html

You'd need to do something like

svn log -r HEAD your_file > your_file.commitmessage

and then link to this from the original file or do some other processing
before running doxygen.

bye  Fabi

Re: [Doxygen-users] display log message of TortoiseSVN

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

Juergen,

I'm not sure if it is what you meant, but did you have a look at:
FILE_VERSION_FILTER in the manual (paragraoh "Build related configuration
options" of the chapter "Configuration")

Best Regards,

Albert

On Thu, Jun 2, 2016 at 7:09 AM, juergen1769 <jue...@li...>
wrote:

> Hello,
>
> I want to display the last committed log message of TortoiseSVN of a file
> maybe with a keyword like $Date$, $Revision$, $Author$, ... or something
> else.
>
> Do you know a posibility to do this?
>
> Best regards,
>
> Juergen
>
>
>
>
>
> --
> View this message in context:
> http://doxygen.10944.n7.nabble.com/display-log-message-of-TortoiseSVN-tp7627.html
> Sent from the Doxygen - Users mailing list archive at Nabble.com.
>
>
> ------------------------------------------------------------------------------
> What NetFlow Analyzer can do for you? Monitors network bandwidth and
> traffic
> patterns at an interface-level. Reveals which users, apps, and protocols
> are
> consuming the most bandwidth. Provides multi-vendor support for NetFlow,
> J-Flow, sFlow and other flows. Make informed decisions using capacity
> planning reports. https://ad.doubleclick.net/ddm/clk/305295220;132659582;e
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

[Doxygen-users] Preprocessing : #if #endif conditions inside functions

[walid e. <wal...@gm...>]

Hi all,

I have the case of a code base with multiple #if #endif conditions outside
and inside the functions.

When generating the dot files with Doxygen, the conditions outside the
functions are treated correctly (parts of code in a false condition are
deleted).

But for the #if #endif conditions inside the functions, the code is always
considered, even when conditions are false.

I checked the result of the preprocessing and it seems to be correct, but
when generating the dot files and the call graph, functions which normally
are deleted during preprocessing are there.

Is there a configuration in Doxygen to parameter a complete conditional
compilation ?


Thank you,

Best regards,
Walid

[Doxygen-users] Doxygen creates unnecessary (unwanted) paragraphs.

[Julian <jul...@we...>]

Oh, I didn't know it places the brief description always in a separate 
paragraph... This explains a lot. Thanks for pointing this out!
Javadoc doesn't do this, or am I wrong there either?

Am 02.06.2016 um 11:27 schrieb Christoph Lipka:
> Hi Julian,
>
> you probably have set JAVADOC_AUTOBRIEF=YES; to quote from the manual:
>
> "If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret
> the first line (until the first dot) of a Javadoc-style comment as the
> brief description. If set to NO, the Javadoc-style will behave just like
> regular Qt-style comments (thus requiring an explicit @brief command for
> a brief description.)"
>
> The brief description is always placed in a separate paragraph.

Re: [Doxygen-users] Doxygen creates unnecessary (unwanted) paragraphs.

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

Hi Julian,

you probably have set JAVADOC_AUTOBRIEF=YES; to quote from the manual:

"If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret
the first line (until the first dot) of a Javadoc-style comment as the
brief description. If set to NO, the Javadoc-style will behave just like
regular Qt-style comments (thus requiring an explicit @brief command for
a brief description.)"

The brief description is always placed in a separate paragraph.


Am 02.06.2016 um 09:43 schrieb Julian:
> Hello everyone!
> 
> I recently started with doxygen and immediately ran into a problem.
> I wanted to document a method with a small paragraph of text, but for 
> some reason, Doxygen keeps splitting the paragraph into two.
> 
> This is the documentation in code:
> 
>      /**
>       * Returns the next character in the file without actually 
> consuming it.
>       * Once the end of the file is reached, this method returns the char
>       * equivalent of -1.
>       */
>      char look();
> 
> I expect Doxygen to create a documentation in a single paragraph, which 
> would look like this:
> 
> Returns the next character in the file without actually consuming it. 
> Once the end of the file is reached, this method returns the char 
> equivalent of -1.
> 
> However, I get this instead:
> 
> Returns the next character in the file without actually consuming it.
> 
> Once the end of the file is reached, this method returns the char 
> equivalent of -1.
> 
> This also persists if I put the in-code documentation in one single line.
> Could you maybe point me in the right direction what I am doing wrong or 
> what option I may have set wrongly in the configuration file?
> 
> Thanks in advance!
> 
> ------------------------------------------------------------------------------
> What NetFlow Analyzer can do for you? Monitors network bandwidth and traffic
> patterns at an interface-level. Reveals which users, apps, and protocols are 
> consuming the most bandwidth. Provides multi-vendor support for NetFlow, 
> J-Flow, sFlow and other flows. Make informed decisions using capacity 
> planning reports. https://ad.doubleclick.net/ddm/clk/305295220;132659582;e
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
> 

[Doxygen-users] Doxygen creates unnecessary (unwanted) paragraphs.

[Julian <jul...@we...>]

Hello everyone!

I recently started with doxygen and immediately ran into a problem.
I wanted to document a method with a small paragraph of text, but for 
some reason, Doxygen keeps splitting the paragraph into two.

This is the documentation in code:

     /**
      * Returns the next character in the file without actually 
consuming it.
      * Once the end of the file is reached, this method returns the char
      * equivalent of -1.
      */
     char look();

I expect Doxygen to create a documentation in a single paragraph, which 
would look like this:

Returns the next character in the file without actually consuming it. 
Once the end of the file is reached, this method returns the char 
equivalent of -1.

However, I get this instead:

Returns the next character in the file without actually consuming it.

Once the end of the file is reached, this method returns the char 
equivalent of -1.

This also persists if I put the in-code documentation in one single line.
Could you maybe point me in the right direction what I am doing wrong or 
what option I may have set wrongly in the configuration file?

Thanks in advance!

[Doxygen-users] Solution (?) to Warning from <unknown>:1 on inheritance from template instantiations

[Marcin K. <Mar...@me...>]

I faced and found workaround (which I'd like to share) for the problem
previously discussed some time ago:
   https://sourceforge.net/p/doxygen/mailman/message/31040993/
In short, code like
    /** … **/
    class SomeClass : public SomeTemplate<Arg>
    {
        …
    };
where SomeTemplate is template class defined in separate library
(accessible via TAGFILES)
generates various warnings like
   <unknown>:1: warning: Member ……… of class SomeTemplate<Arg> is not documented
(for various methods of SomeTemplate)

Apart from warnings it causes undocumented methods showing up.


Looks like the following workaround works fairly nicely:

   // workaround for doxygen problems on inheritance from templates
   /**
       @class SomeTemplate<Arg>
       @extends SomeTemplate
   **/

    /** … **/
    class SomeClass : public SomeTemplate<Arg>
    {
        …
    }

Warnings are gone, inherited methods show up, inheritance chain shows
SomeClass <- SomeTemplate<Arg> <- SomeTemplate
what is in fact logical

(I tested on doxygen 1.8.6)

[Doxygen-users] Escape '*/' in \code blocks

[Barnes, P. D. <bar...@ll...>]

Hello Folks,

I need to escape the sequence `*/‘ inside a code block.

For example, consider a shell command with wildcards:
\code $ ls foo*/ \endcode

The problem, of course, is this is in a C/C++ file, so the delimiter for the Doxygen comment block is `/** … */‘.  The compiler sees the `*/‘ in the code block as the end of the comment block as a whole, and tries to parse the rest of the Doxygen block as code, resulting in lots of parse errors.

While Doxygen has many escapes for special characters, `\/' and `\*' aren’t among them.

I’ve looked at the suggestions in these prior threads, but none of them address this case:

https://sourceforge.net/p/doxygen/mailman/message/12235697/
- Dimitri: use /// instead
	But this doesn’t work with multi-line \code blocks, which
	would all have `///‘ at the left margin of the generated
	docs.


http://stackoverflow.com/questions/24978463/doxygen-escape-nested-comments-in-c
- Use `*//*’ to reopen the comment immediately
	But the extra characters still appear in the documentation.
- Use `‍'
	But these are not removed in parsing \code blocks.

http://doxygen.10944.n7.nabble.com/How-can-I-escape-in-a-comment-td5528.html
- Use `\htmlonly\endhtmlonly’ (or shorter: `<b></b>’)
	As for `&sqj;’, these are not removed in \code blocks.

In fact, experimenting with the other character escapes with `\’, it seems that none of them work in \code blocks.

So, my questions:

0.  Is there some other way to handle `*/‘ in (multi-line) \code blocks?

1.  How hard is it to add `\*’ and/or `\/‘ to the escape list?

2.  How hard is it to add escaping to \code blocks?

Thanks,
Peter


P.S.  There appears to be an error in the Special Commands index:
http://www.doxygen.nl/manual/commands.html

The index lists
	• \&ndash;
	• \&mdash;
But the documentation (and feature) is really \-- and \---

_______________________________________________________________________
Dr. Peter D. Barnes, Jr.                NACS Division
Lawrence Livermore National Laboratory  Physical and Life Sciences
7000 East Avenue, L-50                  email:  pdb...@ll...
P. O. Box 808                           Voice:  (925) 422-3384
Livermore, California 94550             Fax:    (925) 423-3371

[Doxygen-users] @ingroup for entire file with modules and subroutines

[Fabian N. <fab...@sc...>]

Hi,

I have an entire FORTRAN file which I want to add to a group.
So what I did was

!> @ingroup G
!! @{

    !> subroutine doc
    module x
       !> subroutine doc
       subroutine xx
       end subroutine xx
       !> subroutine doc
       subroutine xy
       end subroutine xy
    end module x

    !> subroutine doc
    subroutine y
    end subroutine y

    !> subroutine doc
    subroutine z
    end subroutine z
!> @}

The group G is defined in another file.
However when I generate the doxygen pages, only the module x and its
subroutines end up being in the group G. Subroutines y and z are missing.
Most routines have an @internal tag by the way but my config file is set
up so that it also generates the documentation of those routines.

What am I doing wrong?

Regards,
Fabian.

[Doxygen-users] Show inherited

[couet <oli...@ce...>]

Hi,

Right now you can show all inherited methods of a class or hide them with some setting in DOXYFILE.
If you hide them then you have one shutter per mother class… and to show all inherited you need to click on all shutters...
Is there a way to show/hide all inherited methods with just one click ?

Cheers,