doxygen-users — List for users of doxygen

Re: [Doxygen-users] \warning - customize the "Warning" text ?

[Clemens F. <c....@os...>]

Monique Semp wrote on 22.09.2016 at 01:02:
> Hello, Doxygen users,
>
> (Doxygen 1.8.10, Windows 7)
>
> Is there a way to create in essence an alias for the \warning command?
> I’m looking to create a “Memory Usage” style for flagging memory issues,
> and it’d be ideal if I could simply change the “Warning” label/text to
> say, “Memory Usage”. (And bonus if I could change the red color to some
> other color.)
>
> One method is to use the \xrefitem and alias to customize the output
> text and styling, but I haven’t found a way to omit the consolidated
> page (the one that lists all the \xrefitem instances) from the output.
> And I don’t want a consolidated page of all “memory usage” notes.
>
> Thanks,
> -Monique

Hello Monique


If you like to omit the auto-generated consolidated page (created by 
\xrefitem), then all you want seems to be a simple paragraph with 
headline "Memory Usage", do you?

Then just make your own \memory (or @memory) command, as explained in 
the comments inside the configuration file:

ALIAS = "memory=@par Memory Usage:\n"


Clemens

[Doxygen-users] \warning - customize the "Warning" text ?

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

Hello, Doxygen users,

(Doxygen 1.8.10, Windows 7)

Is there a way to create in essence an alias for the \warning command? I’m looking to create a “Memory Usage” style for flagging memory issues, and it’d be ideal if I could simply change the “Warning” label/text to say, “Memory Usage”. (And bonus if I could change the red color to some other color.)

One method is to use the \xrefitem and alias to customize the output text and styling, but I haven’t found a way to omit the consolidated page (the one that lists all the \xrefitem instances) from the output. And I don’t want a consolidated page of all “memory usage” notes.

Thanks,
-Monique

[Doxygen-users] Marking docs as inherited?

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

When setting INHERIT_DOCS=YES, Doxygen will automatically fill in
missing class member documentation from the parent class, if available.

Is there a way to have Doxygen somehow mark docs inherited in such a
manner, e.g. by inserting the text "(from MyBaseClass documentation)" at
the top or end of the section?


Regards
Christoph

Re: [Doxygen-users] Broken Links to C++ Source Files

[Pilhofer, F. <Fra...@zu...>]

Albert,
I tried posting an example, but SF does not like attachments. After more research, I’ve narrowed the issue down to the SHOW_FILES=NO setting in our set-up, and it looks like a bug in Doxygen. I’ve created bug 770747 in Bugzilla:
https://bugzilla.gnome.org/show_bug.cgi?id=770747
Cheers,
Frank


From: Albert [mailto:alb...@gm...] 
Sent: Freitag, 2. September 2016 11:12
To: Pilhofer, Frank <Fra...@zu...>
Cc: dox...@li...
Subject: Re: [Doxygen-users] Broken Links to C++ Source Files

Frank,
Please post a small example including the used Doxyfile (to make it a bit smaller use the -s option, so the comment is not present) or list the differences between the standard Doxyfile and the one you used so it is possible to reproduce the problem.
Albert

On Fri, Sep 2, 2016 at 10:08 AM, Pilhofer, Frank <mailto:Fra...@zu...> wrote:
Hi,

I am using Doxygen 1.8.11 on our C++ code base. It works fine, except that some
Links to source files are broken. When I click on "Modules" on the main page and
Click on any module, the links to all the files in the "File" section are broken. The
Links are to, e.g., "<file>_8cpp.html" while the generated HTML files use the
"<file>_8cpp_source.html" convention (with an added "_source").

File links in the "Detailed Description" section, e.g., for functions, ("Definition at line
<n> of file <file>"), correctly link to the "_source" files.

What can I do to fix the links?

Thank you,
Frank


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

Re: [Doxygen-users] Broken Links to C++ Source Files

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

Frank,

Please post a small example including the used Doxyfile (to make it a bit
smaller use the -s option, so the comment is not present) or list the
differences between the standard Doxyfile and the one you used so it is
possible to reproduce the problem.

Albert

On Fri, Sep 2, 2016 at 10:08 AM, Pilhofer, Frank <Fra...@zu...
> wrote:

> Hi,
>
> I am using Doxygen 1.8.11 on our C++ code base. It works fine, except that
> some
> Links to source files are broken. When I click on "Modules" on the main
> page and
> Click on any module, the links to all the files in the "File" section are
> broken. The
> Links are to, e.g., "<file>_8cpp.html" while the generated HTML files use
> the
> "<file>_8cpp_source.html" convention (with an added "_source").
>
> File links in the "Detailed Description" section, e.g., for functions,
> ("Definition at line
> <n> of file <file>"), correctly link to the "_source" files.
>
> What can I do to fix the links?
>
> Thank you,
> Frank
>
>
> ------------------------------------------------------------
> ------------------
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

[Doxygen-users] Broken Links to C++ Source Files

[Pilhofer, F. <Fra...@zu...>]

Hi,

I am using Doxygen 1.8.11 on our C++ code base. It works fine, except that some
Links to source files are broken. When I click on "Modules" on the main page and
Click on any module, the links to all the files in the "File" section are broken. The
Links are to, e.g., "<file>_8cpp.html" while the generated HTML files use the
"<file>_8cpp_source.html" convention (with an added "_source").

File links in the "Detailed Description" section, e.g., for functions, ("Definition at line
<n> of file <file>"), correctly link to the "_source" files.

What can I do to fix the links?

Thank you,
Frank

Re: [Doxygen-users] EXTERNAL: Re: \include inserts line numbers for LaTeX/PDF output

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

Luis,

Better option is  to use @verbinclude instead of @include.

In the mean time I found the problem and pushed a proposed patch to github
(pull request 505)

Albert

On Wed, Aug 24, 2016 at 11:45 AM, Albert <alb...@gm...> wrote:

> Luis,
>
> I was able to reproduce the problem.
> The example makefile is in your case the 'userbuild.mk', looks like in
> one way or another a wrong printing routine is called.
> A quick workaround is:EXTENSION_MAPPING = mk=C
>
> Best Regards,
>
> Albert
>
> On Wed, Aug 24, 2016 at 12:14 AM, Vega, Luis A <lui...@lm...>
> wrote:
>
>> Enclose are the example files.  Problem will show up when including a
>> non-source text file (in my case a sample makefile).
>>
>>
>>
>> *From:* Albert [mailto:alb...@gm...]
>> *Sent:* Thursday, August 18, 2016 7:52 AM
>> *Cc:* dox...@li...
>> *Subject:* EXTERNAL: Re: [Doxygen-users] \include inserts line numbers
>> for LaTeX/PDF output
>>
>>
>>
>> Luis,
>>
>> Which version of doxygen are you using? I did a quick test on Windows
>> with 1.8.11 and didn't see the behavior you described.
>>
>> In case the problem persist: Can you please attach a self-contained
>> example (source+config file in a tar or zip) that allows us to reproduce
>> the problem or file a bug report (see: http://www.stack.nl/~dimitri/d
>> oxygen/manual/trouble.html#bug_reports) with the relevant informatin?
>>
>> Albert
>>
>>
>>
>
>

Re: [Doxygen-users] EXTERNAL: Re: \include inserts line numbers for LaTeX/PDF output

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

Luis,

I was able to reproduce the problem.
The example makefile is in your case the 'userbuild.mk', looks like in one
way or another a wrong printing routine is called.
A quick workaround is:EXTENSION_MAPPING = mk=C

Best Regards,

Albert

On Wed, Aug 24, 2016 at 12:14 AM, Vega, Luis A <lui...@lm...> wrote:

> Enclose are the example files.  Problem will show up when including a
> non-source text file (in my case a sample makefile).
>
>
>
> *From:* Albert [mailto:alb...@gm...]
> *Sent:* Thursday, August 18, 2016 7:52 AM
> *Cc:* dox...@li...
> *Subject:* EXTERNAL: Re: [Doxygen-users] \include inserts line numbers
> for LaTeX/PDF output
>
>
>
> Luis,
>
> Which version of doxygen are you using? I did a quick test on Windows with
> 1.8.11 and didn't see the behavior you described.
>
> In case the problem persist: Can you please attach a self-contained
> example (source+config file in a tar or zip) that allows us to reproduce
> the problem or file a bug report (see: http://www.stack.nl/~dimitri/
> doxygen/manual/trouble.html#bug_reports) with the relevant informatin?
>
> Albert
>
>
>

[Doxygen-users] BUG with \struct in IDL (was: Re: How to avoid double entries of structs? --> Workaround found)

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

On 18.08.2016 08:37, Fabian Cenedese wrote:
> At 08:41 10.08.2016, you wrote:
>> Hello World,
>>
>> I am documenting a couple of IDL files. Now I've noticed that all
>> the structs are listed twice in the classes list (see the attached
>> small screenshot), once with and once without a documentation (both
>> links point to the same documentation page). How do I avoid the
>> undocumented structs entries (because they are documented ones)
>> WITHOUT setting the HIDE_UNDOC_CLASSES option? (I want
>> HIDE_UNDOC_CLASSES to be set to NO so undocumented classes lead to
>> a warning.)
>
> I also reported a similar problem already in 2014 but didn't get a
> response.
>
> http://doxygen.10944.n7.nabble.com/Double-entries-of-C-variable-td6951.html

I have found a workaround for my problem and I think that problem is a 
bug in Doxygen. I had my structs documented as follows:

/** \struct MyStruct
   * \brief Brief description
   *
   * Longer description
   */
<struct begins here>

This led to the double entry. Removing the first line, e.g. the struct 
entry fixed the problem:

/** \brief Brief description
   *
   * Longer description
   */
<struct begins here>

As I understand Doxygen, however, I think the first variant should be 
valid as well and thus I think it is a bug in Doxygen.

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

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

Re: [Doxygen-users] EXTERNAL: Re: \include inserts line numbers for LaTeX/PDF output

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

Enclose are the example files.  Problem will show up when including a non-source text file (in my case a sample makefile).


From: Albert [mailto:alb...@gm...]
Sent: Thursday, August 18, 2016 7:52 AM
Cc: dox...@li...
Subject: EXTERNAL: Re: [Doxygen-users] \include inserts line numbers for LaTeX/PDF output

Luis,
Which version of doxygen are you using? I did a quick test on Windows with 1.8.11 and didn't see the behavior you described.
In case the problem persist: Can you please attach a self-contained example (source+config file in a tar or zip) that allows us to reproduce the problem or file a bug report (see: http://www.stack.nl/~dimitri/doxygen/manual/trouble.html#bug_reports) with the relevant informatin?
Albert

Re: [Doxygen-users] include/exclude comment content - based on html vs.latex ?

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

>> As well, there are places where I'd like to simply refer people to a named section in the PDF, but in the HTML include an actual image.

> 

> You would just use \ref.  For either HTML or LaTeX.



No; what I meant was to use the equivalent of \ref to a .page file for the LaTeX output (which I've figured out how to do, with the nameref package), but in the HTML output, have the result of using the \image command to include the image.



<snip>



>> I do know about the \htmlonly and \latexonly commands, but then I really have to know how to deal with low-level LaTeX coding, which I'd prefer Doxygen took care of.

> 

> Doxygen will *still* take of it.  You don't really have to deal with 

> low-level LaTeX (or even HTML) coding, although there really isn't anything there

> anyway.   The \htmlonly and \latexonly don't mean those sections contain 

> either HTML or LaTeX, only that those sections should only be 

> processed for those specific output formats.  You would still use normal Doxygen commands.

> For the most part, you don't actually use any low-level LaTeX coding 

> -- in a sense, there isn't any such thing as "low-level LaTeX coding", 

> since *LaTeX* is pretty much a high level thing.



It would be lovely if things worked this way. But my quick trial didn't work at all. When I surrounded Doxygen comments (in a .page file, so perhaps it is different in a regular .c file's comments; I didn't try that) with \htmlonly and \endhtmlonly, all the Doxygen commands were simply output as text. And given the Doxygen documentation's description of this command (https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdhtmlonly), "Starts a block of text that will be verbatim included in the generated HTML documentation only", I'm not surprised.



Another off-list reply said that they used sed scripting to manage multiple Doxyfile configuration files and then a preprocessing mechanism similar to what I'd described (using the ENABLED_SECTIONS for things such as __INCLUDE_PDF-ONLY__).



So I guess that's what I'll be doing.



Thanks for the help,

-Monique

Re: [Doxygen-users] include/exclude comment content - based on html vs. latex ?

[Robert H. <he...@de...>]

At Mon, 22 Aug 2016 14:57:32 -0700 Monique Semp <mon...@ea...> wrote:

> 
> 
> 
> Hello, Doxygen-users,
> 
> In Doxygen 1.8.10 (on Windows), is there any way to have different portions
> of the Doxygen comment block appear depending on which output is generated?

> 
> I was producing only HTML, and so I had nice tables of thumbnail images that
> the user can click to open a full-size page of the image. But now that
> I've added PDF (well, Doxygen->LaTeX->PDF), verbiage such as "click the
> thumbnail" doesn't make sense. I'm using the full-size image for the
> "\image latex" instead of what I use for the html output (an <href> on
> the thumbnail that resolves to the full-size image).
> 
> As well, there are places where I'd like to simply refer people to a named
> section in the PDF, but in the HTML include an actual image.

You would just use \ref.  For either HTML or LaTeX.

> 
> I know that I could use separate Doxyfile config files and the
> ENABLED_SECTIONS to selectively enable parts of the comments based on their
> output (for example; __INCLUDE_PDF-ONLY_CONTENT__ and
> __INCLUDE_HTML-ONLY_CONTENT__), but then that's yet another configuration
> file to keep in sync. So I'm hoping for some smarter way to get Doxygen
> comments into only one output format.
> 
> I do know about the \htmlonly and \latexonly commands, but then I really
> have to know how to deal with low-level LaTeX coding, which I'd prefer
> Doxygen took care of.

Doxygen will *still* take of it.  You don't really have to deal with low-level 
LaTeX (or even HTML) coding, although there really isn't anything there 
anyway.   The \htmlonly and \latexonly don't mean those sections contain 
either HTML or LaTeX, only that those sections should only be processed for 
those specific output formats.  You would still use normal Doxygen commands.  
For the most part, you don't actually use any low-level LaTeX coding -- in a 
sense, there isn't any such thing as "low-level LaTeX coding", since *LaTeX* 
is pretty much a high level thing.

> 
> Thanks for any suggestions,
> -Monique
> MIME-Version: 1.0
> 
> ------------------------------------------------------------------------------
> 
> MIME-Version: 1.0
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
> 
>                                                                                         

-- 
Robert Heller             -- 978-544-6933
Deepwoods Software        -- Custom Software Services
http://www.deepsoft.com/  -- Linux Administration Services
he...@de...       -- Webhosting Services
                                 

[Doxygen-users] include/exclude comment content - based on html vs. latex ?

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

Hello, Doxygen-users,

In Doxygen 1.8.10 (on Windows), is there any way to have different portions of the Doxygen comment block appear depending on which output is generated?

I was producing only HTML, and so I had nice tables of thumbnail images that the user can click to open a full-size page of the image. But now that I’ve added PDF (well, Doxygen->LaTeX->PDF), verbiage such as “click the thumbnail” doesn’t make sense. I’m using the full-size image for the “\image latex” instead of what I use for the html output (an <href> on the thumbnail that resolves to the full-size image).

As well, there are places where I’d like to simply refer people to a named section in the PDF, but in the HTML include an actual image.

I know that I could use separate Doxyfile config files and the ENABLED_SECTIONS to selectively enable parts of the comments based on their output (for example; __INCLUDE_PDF-ONLY_CONTENT__ and __INCLUDE_HTML-ONLY_CONTENT__), but then that’s yet another configuration file to keep in sync. So I’m hoping for some smarter way to get Doxygen comments into only one output format.

I do know about the \htmlonly and \latexonly commands, but then I really have to know how to deal with low-level LaTeX coding, which I’d prefer Doxygen took care of.

Thanks for any suggestions,
-Monique

[Doxygen-users] Official Doxygen docker image

[bassam.khouri <bas...@gm...>]

Hello,

The doxygen  download page
<http://www.stack.nl/~dimitri/doxygen/download.html>   does not offer a
Docker image. Does anyone know if there is an official docker image of
doxygen?

Bassam



--
View this message in context: http://doxygen.10944.n7.nabble.com/Official-Doxygen-docker-image-tp7690.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] \include inserts line numbers for LaTeX/PDF output

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

Luis,

Which version of doxygen are you using? I did a quick test on Windows with
1.8.11 and didn't see the behavior you described.
In case the problem persist: Can you please attach a self-contained example
(source+config file in a tar or zip) that allows us to reproduce the
problem or file a bug report (see:
http://www.stack.nl/~dimitri/doxygen/manual/trouble.html#bug_reports) with
the relevant informatin?

Albert

On Wed, Aug 10, 2016 at 11:50 PM, Vega, Luis A <lui...@lm...> wrote:

> Doxygen offers two options when including examples.  One for just the text
> (i.e., \include), and the other with line numbers (i.e., \includeline).
>
> The options work as advertised on the HTML output, but for the LaTeX/PDF
> output the \include outputs with line numbers.  While not a big deal, the
> inconsistency can prevent the insertion of examples meant to be copy &
> paste (kind-off … most editors don’t support delete by column) when a
> document is generated in LaTeX/PDF format.
>
>
>
> Is this a bug or is there a different way to prevent insertion of line
> numbers when including sample code in LaTeX/PDF output?
>
>
>
> Thanks
>
> Luis Vega
>
> ------------------------------------------------------------
> ------------------
> 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. http://sdm.link/zohodev2dev
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

Re: [Doxygen-users] How to avoid double entries of structs?

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

At 08:41 10.08.2016, you wrote:
>Content-Transfer-Encoding: 7bit
>
>Hello World,
>
>I am documenting a couple of IDL files. Now I've noticed that all the structs are listed twice in the classes list (see the attached small screenshot), once with and once without a documentation (both links point to the same documentation page).
>How do I avoid the undocumented structs entries (because they are documented ones) WITHOUT setting the HIDE_UNDOC_CLASSES option? (I want HIDE_UNDOC_CLASSES to be set to NO so undocumented classes lead to a warning.)

I also reported a similar problem already in 2014 but didn't get a response.

http://doxygen.10944.n7.nabble.com/Double-entries-of-C-variable-td6951.html

Maybe this can be a solution for you:

http://stackoverflow.com/questions/27845542/c-and-doxygen-removing-duplicates-of-variable-documentation

bye  Fabi

Re: [Doxygen-users] missing brief class descriptions

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

Rob,

No bell ringing.
Have a look at the new settings in the Doxyfiole between 1.7.5.1 and 1.7.6
A small example would help i.e. source that shows up in 1.7.5.1 and doesn't
in 1.7.6 including Doxyfile.

Albert

On Wed, Aug 17, 2016 at 5:38 PM, Rob Boehne <ro...@da...> wrote:

> All,
>
> I recently attempted to upgrade a build to use Doxygen 1.8.11 where it had
> been using 1.5.2 (on multiple platforms), and found some missing output.
> It’s a bit of a complicated build, where C++ sources are SWIGged into C# &
> Java, and the documentation is for C# and Java.  Some Java and C# classes
> aren’t generated by SWIG, and the brief descriptions for these are not
> affected.
> Digging a bit more, the class descriptions are there when I use Doxygen
> 1.7.5.1, but when I change to Doxygen 1.7.6 or later, they disappear.
>
> Does this ring any bells?
>
> Thanks,
>
> Robert Boehne
> Sr. Software Architect  - APDFL Team @ Datalogics Inc
>
>
>
> ------------------------------------------------------------
> ------------------
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] missing brief class descriptions

[Rob B. <ro...@da...>]

All,

I recently attempted to upgrade a build to use Doxygen 1.8.11 where it had been using 1.5.2 (on multiple platforms), and found some missing output.
It's a bit of a complicated build, where C++ sources are SWIGged into C# & Java, and the documentation is for C# and Java.  Some Java and C# classes aren't generated by SWIG, and the brief descriptions for these are not affected.
Digging a bit more, the class descriptions are there when I use Doxygen 1.7.5.1, but when I change to Doxygen 1.7.6 or later, they disappear.

Does this ring any bells?

Thanks,

Robert Boehne
Sr. Software Architect  - APDFL Team @ Datalogics Inc

[Doxygen-users] unsubscribe

[Jeung, M. V. <Mic...@gd...>]

[Doxygen-users] Documentation inside preprocessor macro definition

[Matthias M. <mmo...@gm...>]

Dear all,

I run into the following problem documenting my code with doxygen.
Large parts of the code are created using preprocessor macros like this

/// Helper macro for generating selectors for specialialized
/// implementations of element-wise binary operations; generic
/// implementation follows below
#define FDBB_GENERATE_BINARY_ELEMENTOPERATION_OVERLOADS(OPNAME)         \
    /** @brief                                                          \
        Selector for (specialized) implementation of                    \
        fdbb::internal::elem_##OPNAME##<A,B>(A&& a, B&& b) function     \
    */                                                                  \
    template<typename A, typename B, typename = void>                   \
    struct elem_##OPNAME##_spec : public std::integral_constant<EnumETL, EnumETL::GENERIC>{};

FDBB_GENERATE_BINARY_ELEMENTOPERATION_OVERLOADS(mul)
FDBB_GENERATE_BINARY_ELEMENTOPERATION_OVERLOADS(div)
FDBB_GENERATE_BINARY_ELEMENTOPERATION_OVERLOADS(pow)

#undef FDBB_GENERATE_BINARY_ELEMENTOPERATION_OVERLOADS


Running doxygen (v1.8.11) with the following configuration of the preprocessor

ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = NO
SEARCH_INCLUDES        = YES
INCLUDE_PATH           =
INCLUDE_FILE_PATTERNS  =
PREDEFINED             =
EXPAND_AS_DEFINED      =
SKIP_FUNCTION_MACROS   = YES

produces the following output (html):

struct  	elem_mul_spec <file:///Users/mmoller/codes/FDBB/build.gcc5/doc/html/structfdbb_1_1internal_1_1elem__mul__spec.html>
 	\ Selector for (specialized) implementation of \ fdbb::internal::elem_mul<A,B>(A&& a, B&& b) function \  More... <file:///Users/mmoller/codes/FDBB/build.gcc5/doc/html/structfdbb_1_1internal_1_1elem__mul__spec.html#details>

Obviously, the backslash that is needed for multiline macros is included in the documentation.
Any help on how to configure doxygen and/or modify the documentation is appreciated.

Best regards,
Matthias

[Doxygen-users] \include inserts line numbers for LaTeX/PDF output

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

Doxygen offers two options when including examples.  One for just the text (i.e., \include), and the other with line numbers (i.e., \includeline).

The options work as advertised on the HTML output, but for the LaTeX/PDF output the \include outputs with line numbers.  While not a big deal, the inconsistency can prevent the insertion of examples meant to be copy & paste (kind-off ... most editors don't support delete by column) when a document is generated in LaTeX/PDF format.

Is this a bug or is there a different way to prevent insertion of line numbers when including sample code in LaTeX/PDF output?

Thanks
Luis Vega

[Doxygen-users] How to avoid double entries of structs?

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

Hello World,

I am documenting a couple of IDL files. Now I've noticed that all the 
structs are listed twice in the classes list (see the attached small 
screenshot), once with and once without a documentation (both links 
point to the same documentation page).
How do I avoid the undocumented structs entries (because they are 
documented ones) WITHOUT setting the HIDE_UNDOC_CLASSES option? (I want 
HIDE_UNDOC_CLASSES to be set to NO so undocumented classes lead to a 
warning.)

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

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

Re: [Doxygen-users] C++ Anonymous Structure Identification (XML Output)

[Adrian M N. <gr...@gm...>]

Hi,

Doxygen's xmlgen ignores anonymous scopes/compounds/members purposefully.


br

On Sat, Jul 16, 2016 at 4:35 AM, Richard Damon <Ri...@da...> wrote:
> On 7/15/16 7:27 PM, CareyG wrote:
>> I have created a simple union as follows:
>>
>> #ifndef _ANONUNION_H
>> #define _ANONUNION_H
>>
>> #ifdef __cplusplus
>> ///@brief Anonymous Union example.
>> namespace AnonUnion
>> {
>> #endif
>>
>>       ///@brief Create a typename for our union.
>>       typedef union {
>>               ///@brief A short followed by two characters.
>>               struct {
>>                       short s;        ///<A short.
>>                       char ch1;       ///&lt;A single character.
>>                       char ch2;       ///&lt;Another character.
>>               };
>>
>>               ///@brief Structure as an unsigned long.
>>               unsigned long ul;
>>       } Example;
>> #ifdef __cplusplus
>> }
>> #endif
>>
>> #endif
>>
>> When I process this file, called AnonUnion.h I get the usual output files.
>> In particular, the index file looks like:
> <snipped>
>> What I would like to know is how to identify that s, ch1 and ch2 are part of
>> the anonymous structure and that ul1 and the anonymous structure are part of
>> the union.
>>
>> I need to know this information to reconstruct the parsed input as part of a
>> documentation package I am creating using an automated tool.
>>
>> I noticed that several other people have had similar questions over the
>> years but none of them had a satisfactory answer that enables me to solve
>> this problem.
>>
>> Thank you.
>>
>> Carey
> I don't see any mention of the anonymous struct in the xml, which might
> not be that surprising as doxygen doesn't have anything to say about
> this struct since it is totally anonymous.
>
> You probably don't want to give it a member name, as that would require
> a lot of changes in the code, but perhaps if you gave it a struct tag,
> you might get doxygen to note its existence, and that shouldn't change
> how you use it.
>
> --
> Richard Damon
>
>
> ------------------------------------------------------------------------------
> 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.http://sdm.link/zohodev2dev
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users



-- 
Regards!
http://groleo.wordpress.com

[Doxygen-users] Image Size Specification Syntax

[CareyG <car...@ou...>]

The \image tag permits a size specification.  The documentation says that a
size specification may be composed of either (or both) of a height or width. 
Yet, if I enter both the second is inserted into the <para></para> XML
element.

For example, if enter

@image rtf myimage.png width=509px height=125px I get:

image type="rtf" name="myimage.png" height="125px,">Starry Night -- As
moving as the original!</image>
width=509px</para>

What is the syntax for entering both the height and width?

Thanks,

Carey



--
View this message in context: http://doxygen.10944.n7.nabble.com/Image-Size-Specification-Syntax-tp7680.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] suppress private functions from treeview expansion of the file ?

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

Hello, Doxygen users,

I’m using Doxygen 1.8.10 on Win 7, 64-bit.

When I user the \private in the comment block for a function, the function is correctly omitted from the documentation. However, the function is *incorrectly* appearing when you expand the file in the treeview, “Files > File List > file-name.c”. I’m looking for the best way to omit such functions from the treeview display. (I have two workarounds that are not entirely satisfactory.)

Details:

I have “GENERATE_TREEVIEW=YES” in my Doxyfile. In the treeview, if you click the name of a function that should not be appearing, the right pane changes to the file’s File Reference page, which *correctly* does not show the function. The function remains incorrectly shown in the treeview.

One workaround is to set “HIDE_UNDOC_MEMBERS = YES” in the Doxyfile, which results in the correct treeview, without the function. But I don’t want to use this setting because I want inadvertently undocumented members to appear in the doc. Plus, I have many structures where I likely won’t ever add documentation for fields because the field names really are so obvious that adding documentation looks ridiculous. But I certainly want these fields to appear in the Doxygen output.

Another workaround is to use the \cond and \endcond Doxygen commands around the function so that Doxygen doesn’t even read it, and so it’s correctly omitted from the output. But this seems rather a blunt-force method, and not as useful for source code readers as an explanatory \private or \internal command.

So, for functions that include either or both the \private and/or \internal commands in the Doxygen comment blocks, is there a way to make them NOT appear when you expand the function’s file in the treeview, without resorting to setting HIDE_UNDOC_MEMBERS=YES or using \cond and \endcond tags?

Thanks,
-Monique