doxygen-users — List for users of doxygen

Re: [Doxygen-users] Preprocessing

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

Mouadh,

I think it is correct, when myconst the first #if evaluates to true and the
second to false (test is myconst == 20, and myconst has a value of 10).

Albert


On Mon, May 16, 2016 at 7:52 PM, Mouadh Balti <mou...@gm...>
wrote:

> Dear All;
>
> i'am using doxygen to document a source code in C language, i have some
> preprossing derictives which not working correctly this is my code source :
>
>
> #define myconst = (1U)
>
> #if (myconst == 1U)
> void myfunction()
> {
>     #if (myconst == 2U)
>      call_function();
>    #endif
> }
> #endif
>
> the first prepossessing is working correctly but the second one does not
> work..
>
> I checked the file after preprocessing it contain this:
>
> void myfunction()
> {
>
> }
>
> but in call graph diagram it is wrong myfunction is calling call_function
> which is not correct..
>
> is there any solution for that problem?
>
> thank you all.
> --
>
> Cordialement \ Best Regards,
> ________________________________
>
> *Mouadh BALTI*
>
>
>
> ------------------------------------------------------------------------------
> Mobile security can be enabling, not merely restricting. Employees who
> bring their own devices (BYOD) to work are irked by the imposition of MDM
> restrictions. Mobile Device Manager Plus allows you to control only the
> apps on BYO-devices by containerizing them, leaving personal data
> untouched!
> https://ad.doubleclick.net/ddm/clk/304595813;131938128;j
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] Preprocessing

[Mouadh B. <mou...@gm...>]

Dear All;

i'am using doxygen to document a source code in C language, i have some
preprossing derictives which not working correctly this is my code source :


#define myconst = (1U)

#if (myconst == 1U)
void myfunction()
{
    #if (myconst == 2U)
     call_function();
   #endif
}
#endif

the first prepossessing is working correctly but the second one does not
work..

I checked the file after preprocessing it contain this:

void myfunction()
{

}

but in call graph diagram it is wrong myfunction is calling call_function
which is not correct..

is there any solution for that problem?

thank you all.
-- 

Cordialement \ Best Regards,
________________________________

*Mouadh BALTI*

Re: [Doxygen-users] A hash character inside a markdown table

[Brian H. <bhe...@pi...>]

Aha!  I don’t know why I didn’t think to try that.  That works correctly.

Thanks!

From: Albert [mailto:alb...@gm...]
Sent: Tuesday, May 10, 2016 1:42 PM
To: Brian Henning <bhe...@pi...>
Cc: dox...@li...
Subject: Re: [Doxygen-users] A hash character inside a markdown table

Brian,
Did you try to do the escaping by means of a backslash ?
Albert

On Tue, May 10, 2016 at 6:48 PM, Brian Henning <bhe...@pi...<mailto:bhe...@pi...>> wrote:
Hi,

I’m trying to display a hash inside a string inside a markdown table.  Here is the source:

-0.5   | P#B2      | -2<sup>-1</sup>

This results in the following HTML for the center column:
<td>P::B2 </td>

If I try HTML entity such as this:

-0.5   | P&#35;B2      | -2<sup>-1</sup>  <!-- Markdown gobbles the # character, so use HTML entity; actual format string is P#B2 -->

Then the entity ends up escaped in the HTML:
<td>P&amp;#35;B2 </td>

I tried removing the inline HTML comment to make sure it wasn’t causing the problem, and it made no difference.

Why is the ampersand getting escaped?  How do I prevent it, or otherwise stop markdown from parsing the # character?

Thanks,
-B

------------------------------------------------------------------------------
Mobile security can be enabling, not merely restricting. Employees who
bring their own devices (BYOD) to work are irked by the imposition of MDM
restrictions. Mobile Device Manager Plus allows you to control only the
apps on BYO-devices by containerizing them, leaving personal data untouched!
https://ad.doubleclick.net/ddm/clk/304595813;131938128;j
_______________________________________________
Doxygen-users mailing list
Dox...@li...<mailto:Dox...@li...>
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: [Doxygen-users] A hash character inside a markdown table

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

Brian,

Did you try to do the escaping by means of a backslash ?

Albert

On Tue, May 10, 2016 at 6:48 PM, Brian Henning <bhe...@pi...>
wrote:

> Hi,
>
>
>
> I’m trying to display a hash inside a string inside a markdown table.
> Here is the source:
>
>
>
> -0.5   | P#B2      | -2<sup>-1</sup>
>
>
>
> This results in the following HTML for the center column:
>
> <td>P::B2 </td>
>
>
>
> If I try HTML entity such as this:
>
>
>
> -0.5   | P&#35;B2      | -2<sup>-1</sup>  <!-- Markdown gobbles the #
> character, so use HTML entity; actual format string is P#B2 -->
>
>
>
> Then the entity ends up escaped in the HTML:
>
> <td>P&amp;#35;B2 </td>
>
>
>
> I tried removing the inline HTML comment to make sure it wasn’t causing
> the problem, and it made no difference.
>
>
>
> Why is the ampersand getting escaped?  How do I prevent it, or otherwise
> stop markdown from parsing the # character?
>
>
>
> Thanks,
>
> -B
>
>
> ------------------------------------------------------------------------------
> Mobile security can be enabling, not merely restricting. Employees who
> bring their own devices (BYOD) to work are irked by the imposition of MDM
> restrictions. Mobile Device Manager Plus allows you to control only the
> apps on BYO-devices by containerizing them, leaving personal data
> untouched!
> https://ad.doubleclick.net/ddm/clk/304595813;131938128;j
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] A hash character inside a markdown table

[Brian H. <bhe...@pi...>]

Hi,

I'm trying to display a hash inside a string inside a markdown table.  Here is the source:

-0.5   | P#B2      | -2<sup>-1</sup>

This results in the following HTML for the center column:
<td>P::B2 </td>

If I try HTML entity such as this:

-0.5   | P&#35;B2      | -2<sup>-1</sup>  <!-- Markdown gobbles the # character, so use HTML entity; actual format string is P#B2 -->

Then the entity ends up escaped in the HTML:
<td>P&amp;#35;B2 </td>

I tried removing the inline HTML comment to make sure it wasn't causing the problem, and it made no difference.

Why is the ampersand getting escaped?  How do I prevent it, or otherwise stop markdown from parsing the # character?

Thanks,
-B

Re: [Doxygen-users] Multiple indents inside paragraphs?

[Brian H. <bhe...@pi...>]

Sorry, meant to send this to the list.

Hi Albert,

I hadn’t tried DL (I wasn’t aware of that one), and now that I read up on it, it sounds like it may be the right answer both effectively and semantically (my application is indeed items / descriptions) and they are allowed to be nested.

Regarding emphasis markdown:  …okay, it does work; I just have a specific case that breaks it apparently:

Source:
    - _<angle_bracketed_italics>_ _represent_ fields in the format string

Resultant HTML:
<li>_&lt;angle_bracketed_italics&gt;_ <em>represent</em> fields in the format string</li>

“Represent” is properly emphasized (as a control example), but “&lt;angle_bracketed_italics&gt;” is not.

The same happens whether I use underscores or asterisks:
    - *&lt;angle_bracketed_italics&gt;* represent fields in the format string
becomes
<li>*&lt;angle_bracketed_italics&gt;* <em>represent</em> fields in the format string</li>

It seems to be connected to the interior underscores.

I can work around it of course by using <em>…</em>

Cheers,
-Brian

From: Albert [mailto:alb...@gm...]
Sent: Wednesday, May 04, 2016 5:36 AM
To: Brian Henning <bhe...@pi...>
Cc: dox...@li...
Subject: Re: [Doxygen-users] Multiple indents inside paragraphs?

Brian,
Spaced in texts are always quite cumbersome.
Maybe the HTML tages <DL> etc. (see manual Chapter 25 HTML commands) or the special spacing commands like &nbsp; (The special HTML4 character entities., same chapter) might help you here.
Regarding the "PS" please give an example where it is not working.
Albert

On Tue, May 3, 2016 at 10:06 PM, Brian Henning <bhe...@pi...<mailto:bhe...@pi...>> wrote:
Hello,

I’m hoping to create some documentation that looks like this:

Blah blah blah
    Blah blah blah
        Blah blah blah
    Blah blah blah
        Blah blah blah
…

I don’t want blank lines between, and I want multiple layers of indenting.

I tried using HTML <p> tags with inline style attribute, but doxygen apparently strips attributes from HTML tags.

I tried doing an HTML table but that creates borders.

I could forgive blank lines in between if I could get the multiple indents.

It’s like a nested list, but without decorations (another thing Doxygen apparently doesn’t do?)

Is this possible at all?
Thanks,
-Brian

PS: Also noticed emphasis markdown (** and __) doesn’t work; I have to use HTML <em> and <strong> tags.  Is there a config switch for this?

------------------------------------------------------------------------------
Find and fix application performance issues faster with Applications Manager
Applications Manager provides deep performance insights into multiple tiers of
your business applications. It resolves application problems quickly and
reduces your MTTR. Get your free trial!
https://ad.doubleclick.net/ddm/clk/302982198;130105516;z
_______________________________________________
Doxygen-users mailing list
Dox...@li...<mailto:Dox...@li...>
https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] markdown's ** and __ emphasis

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

Regarding the “PS” and reply: That is surprising. I’m using Doxygen 1.8.10, and the markdown emphasis, “__” is definitely working. I had to escape it in many places where I list compiler flags that begin (and end, although that didn’t need escaping) with a double-underscore. These appear in regular comment blocks. But where it doesn’t seem to need escaping is in the \cond and ENABLED_SECTIONS. Those seem fine with leading underscores for the enabled sections flags, without any escaping. But they’re not intended to appear as output with emphasis. I do have MARKDOWN_SUPPORT = YES in my Doxyfile, so perhaps check for that?

-Monique


From: Albert 
Sent: Wednesday, May 04, 2016 2:36 AM
To: Brian Henning 
Cc: dox...@li... 
Subject: Re: [Doxygen-users] Multiple indents inside paragraphs?

Brian,


Spaced in texts are always quite cumbersome. 

Maybe the HTML tages <DL> etc. (see manual Chapter 25 HTML commands) or the special spacing commands like &nbsp; (The special HTML4 character entities., same chapter) might help you here.


Regarding the "PS" please give an example where it is not working.


Albert


On Tue, May 3, 2016 at 10:06 PM, Brian Henning <bhe...@pi...> wrote:

  Hello,



  I’m hoping to create some documentation that looks like this:



  Blah blah blah

      Blah blah blah

          Blah blah blah

      Blah blah blah 

          Blah blah blah 

  …



  I don’t want blank lines between, and I want multiple layers of indenting.



  I tried using HTML <p> tags with inline style attribute, but doxygen apparently strips attributes from HTML tags.



  I tried doing an HTML table but that creates borders.



  I could forgive blank lines in between if I could get the multiple indents.



  It’s like a nested list, but without decorations (another thing Doxygen apparently doesn’t do?)



  Is this possible at all?

  Thanks,

  -Brian



  PS: Also noticed emphasis markdown (** and __) doesn’t work; I have to use HTML <em> and <strong> tags.  Is there a config switch for this?


  ------------------------------------------------------------------------------
  Find and fix application performance issues faster with Applications Manager
  Applications Manager provides deep performance insights into multiple tiers of
  your business applications. It resolves application problems quickly and
  reduces your MTTR. Get your free trial!
  https://ad.doubleclick.net/ddm/clk/302982198;130105516;z
  _______________________________________________
  Doxygen-users mailing list
  Dox...@li...
  https://lists.sourceforge.net/lists/listinfo/doxygen-users





--------------------------------------------------------------------------------
------------------------------------------------------------------------------
Find and fix application performance issues faster with Applications Manager
Applications Manager provides deep performance insights into multiple tiers of
your business applications. It resolves application problems quickly and
reduces your MTTR. Get your free trial!
https://ad.doubleclick.net/ddm/clk/302982198;130105516;z 


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

Re: [Doxygen-users] "Reimplemented in"

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

Hi Olivier,

I looked a bit in source code and it doesn't seem to have any config
knob to disable
the "Reimplemented in" part  (MemberDef::_writeReimplementedBy)

One way of doing it is to modify the html templates (see
templates/html/htmlmemdef.tpl:185)
and just take out the {# reimplementedBy #} section.


br

On Wed, May 4, 2016 at 12:05 PM, Olivier Couet <Oli...@ce...> wrote:
> Hi,
>
> I would like to remove the ""Reimplemented in” lists in the documentation  of my C++ methods.
> How can I do that ?
>
> Thanks,
> Olivier
> ------------------------------------------------------------------------------
> Find and fix application performance issues faster with Applications Manager
> Applications Manager provides deep performance insights into multiple tiers of
> your business applications. It resolves application problems quickly and
> reduces your MTTR. Get your free trial!
> https://ad.doubleclick.net/ddm/clk/302982198;130105516;z
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users



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

Re: [Doxygen-users] Multiple indents inside paragraphs?

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

Brian,

Spaced in texts are always quite cumbersome.
Maybe the HTML tages <DL> etc. (see manual Chapter 25 HTML commands) or the
special spacing commands like &nbsp; (The special HTML4 character
entities., same chapter) might help you here.

Regarding the "PS" please give an example where it is not working.

Albert

On Tue, May 3, 2016 at 10:06 PM, Brian Henning <bhe...@pi...>
wrote:

> Hello,
>
>
>
> I’m hoping to create some documentation that looks like this:
>
>
>
> Blah blah blah
>
>     Blah blah blah
>
>         Blah blah blah
>
>     Blah blah blah
>
>         Blah blah blah
>
> …
>
>
>
> I don’t want blank lines between, and I want multiple layers of indenting.
>
>
>
> I tried using HTML <p> tags with inline style attribute, but doxygen
> apparently strips attributes from HTML tags.
>
>
>
> I tried doing an HTML table but that creates borders.
>
>
>
> I could forgive blank lines in between if I could get the multiple indents.
>
>
>
> It’s like a nested list, but without decorations (another thing Doxygen
> apparently doesn’t do?)
>
>
>
> Is this possible at all?
>
> Thanks,
>
> -Brian
>
>
>
> PS: Also noticed emphasis markdown (** and __) doesn’t work; I have to use
> HTML <em> and <strong> tags.  Is there a config switch for this?
>
>
> ------------------------------------------------------------------------------
> Find and fix application performance issues faster with Applications
> Manager
> Applications Manager provides deep performance insights into multiple
> tiers of
> your business applications. It resolves application problems quickly and
> reduces your MTTR. Get your free trial!
> https://ad.doubleclick.net/ddm/clk/302982198;130105516;z
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] "Reimplemented in"

[Olivier C. <Oli...@ce...>]

Hi,

I would like to remove the ""Reimplemented in” lists in the documentation  of my C++ methods.
How can I do that ?

Thanks,
Olivier 

[Doxygen-users] Multiple indents inside paragraphs?

[Brian H. <bhe...@pi...>]

Hello,

I'm hoping to create some documentation that looks like this:

Blah blah blah
    Blah blah blah
        Blah blah blah
    Blah blah blah
        Blah blah blah
...

I don't want blank lines between, and I want multiple layers of indenting.

I tried using HTML <p> tags with inline style attribute, but doxygen apparently strips attributes from HTML tags.

I tried doing an HTML table but that creates borders.

I could forgive blank lines in between if I could get the multiple indents.

It's like a nested list, but without decorations (another thing Doxygen apparently doesn't do?)

Is this possible at all?
Thanks,
-Brian

PS: Also noticed emphasis markdown (** and __) doesn't work; I have to use HTML <em> and <strong> tags.  Is there a config switch for this?

Re: [Doxygen-users] Link to README.md

[Christian <0x...@po...>]

Hi Adrian, 

Maybe I should have mentioned that I try to link from mainpage.dox (my mainpage
in dox format) to this README file. But using a markdown file for this purpose is
maybe the better idea. Especially as I can link other markdown files without a
hassle :)

thanks for your time and help!

Regards
Christian 

Am Freitag, den 29.04.2016, 10:30 +0300 schrieb Adrian M Negreanu:
> Hi Christian,
> 
> I've tested with the setup below and "it works for me". I've attached
> a screenshot too.
> 
> 
> $   cat -> main.md
> My Main Page                         {#mainpage}
> ============
> 
> Documentation that will appear on the main page
> 
> See [Link to README](README.md) for more info.
> 
> 
> -------8<-----------
> 
> 
> $   cat -> README.md
> Other
> ============
> 
> Documentation that will appear on the other page.
> 
> 
> On Thu, Apr 28, 2016 at 3:15 PM, Christian <0x...@po...> wrote:
> > Hi,
> > 
> > I am using doxygen 1.8.11 and I try to link my README markdown file.
> > 
> > I was reading
> > https://www.stack.nl/~dimitri/doxygen/manual/markdown.html#md_page_header
> > 
> > and it seems a simple [Link to README](README.md) should be enough, but the
> > link
> > is not created. The README file does appear though under the Related Pages
> > Tab
> > and it has a Level 1 Header if this important. If I use a header label
> > {#myheader}, then I can do [Link to README](@ref myheader) but this header
> > label
> > is also rendered by github and that doesn't look very nice.
> > 
> > So how do I get doxygen to create a link to my README.md file?
> > 
> > Regards
> > Christian
> > 
> > ---------------------------------------------------------------------------
> > ---
> > Find and fix application performance issues faster with Applications Manager
> > Applications Manager provides deep performance insights into multiple tiers
> > of
> > your business applications. It resolves application problems quickly and
> > reduces your MTTR. Get your free trial!
> > https://ad.doubleclick.net/ddm/clk/302982198;130105516;z
> > _______________________________________________
> > Doxygen-users mailing list
> > Dox...@li...
> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
> 
> 
> 

Re: [Doxygen-users] Link to README.md

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

Hi Christian,

I've tested with the setup below and "it works for me". I've attached
a screenshot too.


$   cat -> main.md
My Main Page                         {#mainpage}
============

Documentation that will appear on the main page

See [Link to README](README.md) for more info.


-------8<-----------


$   cat -> README.md
Other
============

Documentation that will appear on the other page.


On Thu, Apr 28, 2016 at 3:15 PM, Christian <0x...@po...> wrote:
> Hi,
>
> I am using doxygen 1.8.11 and I try to link my README markdown file.
>
> I was reading
> https://www.stack.nl/~dimitri/doxygen/manual/markdown.html#md_page_header
>
> and it seems a simple [Link to README](README.md) should be enough, but the link
> is not created. The README file does appear though under the Related Pages Tab
> and it has a Level 1 Header if this important. If I use a header label
> {#myheader}, then I can do [Link to README](@ref myheader) but this header label
> is also rendered by github and that doesn't look very nice.
>
> So how do I get doxygen to create a link to my README.md file?
>
> Regards
> Christian
>
> ------------------------------------------------------------------------------
> Find and fix application performance issues faster with Applications Manager
> Applications Manager provides deep performance insights into multiple tiers of
> your business applications. It resolves application problems quickly and
> reduces your MTTR. Get your free trial!
> https://ad.doubleclick.net/ddm/clk/302982198;130105516;z
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users



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

[Doxygen-users] Link to README.md

[Christian <0x...@po...>]

Hi,

I am using doxygen 1.8.11 and I try to link my README markdown file. 

I was reading 
https://www.stack.nl/~dimitri/doxygen/manual/markdown.html#md_page_header

and it seems a simple [Link to README](README.md) should be enough, but the link
is not created. The README file does appear though under the Related Pages Tab
and it has a Level 1 Header if this important. If I use a header label
{#myheader}, then I can do [Link to README](@ref myheader) but this header label
is also rendered by github and that doesn't look very nice.

So how do I get doxygen to create a link to my README.md file?

Regards
Christian

[Doxygen-users] .qch generation and functions

[Marcin M. <mar...@gm...>]

Hi,

I'm developing a C project with QtCreator. Thus, I enabled the .qch 
generation in my Doxyfile, by the following options:

    |GENERATE_QHP = YES QCH_FILE = <project>.qch QHP_NAMESPACE =
    <namespace> QHP_VIRTUAL_FOLDER = doc QHG_LOCATION = qhelpgenerator |

||

Then I added the .qch to the QtCreator registered documentation., unlike 
the data structres see the screenshot: http://i.stack.imgur.com/ECyeE.png

Thus, when I tap F1 (the help shorcut) near the `command` usage, I 
automatically get the documentation for `command`. But when I do the 
same near `move`, it is claimed there exists no documentation for the 
function.

What am I doing wrong? Have I missed some configuration option? Or 
should I rather ask on the Qt forum?

Re: [Doxygen-users] 'Undefined control sequence' error when using user-defined Latex header.tex

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

Alexey,

Are you, by default, using your own header.tex file, in that case you
probably have to update your own header.tex file,  otherwise what happens
when generating the documentation with the current version of doxygen
(1.8.11) ?

Albert

On Wed, Apr 27, 2016 at 5:20 PM, Alexey Kushnir <ale...@gm...
> wrote:

> Hi,
>
> I'm using pdflatex to produce PDF file from Latex .tex files initially
> generated by Doxygen from C-header files.
>
> Problem description:
>
> Doxygen is started with config file that contains LATEX_HEADER section
> with absolute path to user-defined header.tex file. Doxygen generates
> annotated.tex file which contains '\+' entries (probably some concatenation
> commands).
> Consequently pdflatex is executed and the error 'Undefined control
> sequence' is reported, which points to undefined '\+' sequences inside
> generated annotated.tex file.
>
> If I execute doxygen at first without latex header input file, the default
> generated header.tex contains the following line:
>
> \newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}}
>
> By adding this line inside my user-defined header.tex file, the
> aforementioned error disappears.
>
> The question is how can I run doxygen to tell him to generate default
> latex header in the first place and only after that to read my user-defined
> latex header to overwrite specific commands inside my header file keeping
> all the default generated commands as well?
>
> Is it possible at all? Since I as user shouldn't be aware of every single
> command internally used by Doxygen that I don't want to overwrite in
> user-defined header input file.
>
> Looking forward for your answer, thank you!
>
> --------------------------------------------------------------
> <pwd>$ doxygen -v
>
> 1.8.9.1
> --------------------------------------------------------------
> <pwd>$ pdflatex -v
>
> pdfTeX 3.14159265-2.6-1.40.16 (TeX Live 2015/Debian)
> kpathsea version 6.2.1
> Copyright 2015 Peter Breitenlohner (eTeX)/Han The Thanh (pdfTeX).
> There is NO warranty.  Redistribution of this software is
> covered by the terms of both the pdfTeX copyright and
> the Lesser GNU General Public License.
> For more information about these matters, see the file
> named COPYING and the pdfTeX source.
> Primary author of pdfTeX: Peter Breitenlohner (eTeX)/Han The Thanh
> (pdfTeX).
> Compiled with libpng 1.6.17; using libpng 1.6.17
> Compiled with zlib 1.2.8; using zlib 1.2.8
> Compiled with poppler version 0.33.0
> --------------------------------------------------------------
>
> Best regards,
> Alexey Kushnir
>
>
>
>
>
> ------------------------------------------------------------------------------
> Find and fix application performance issues faster with Applications
> Manager
> Applications Manager provides deep performance insights into multiple
> tiers of
> your business applications. It resolves application problems quickly and
> reduces your MTTR. Get your free trial!
> https://ad.doubleclick.net/ddm/clk/302982198;130105516;z
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] 'Undefined control sequence' error when using user-defined Latex header.tex

[Alexey K. <ale...@gm...>]

Hi,

I'm using pdflatex to produce PDF file from Latex .tex files initially
generated by Doxygen from C-header files.

Problem description:

Doxygen is started with config file that contains LATEX_HEADER section with
absolute path to user-defined header.tex file. Doxygen generates
annotated.tex file which contains '\+' entries (probably some concatenation
commands).
Consequently pdflatex is executed and the error 'Undefined control
sequence' is reported, which points to undefined '\+' sequences inside
generated annotated.tex file.

If I execute doxygen at first without latex header input file, the default
generated header.tex contains the following line:

\newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}}

By adding this line inside my user-defined header.tex file, the
aforementioned error disappears.

The question is how can I run doxygen to tell him to generate default latex
header in the first place and only after that to read my user-defined latex
header to overwrite specific commands inside my header file keeping all the
default generated commands as well?

Is it possible at all? Since I as user shouldn't be aware of every single
command internally used by Doxygen that I don't want to overwrite in
user-defined header input file.

Looking forward for your answer, thank you!

--------------------------------------------------------------
<pwd>$ doxygen -v

1.8.9.1
--------------------------------------------------------------
<pwd>$ pdflatex -v

pdfTeX 3.14159265-2.6-1.40.16 (TeX Live 2015/Debian)
kpathsea version 6.2.1
Copyright 2015 Peter Breitenlohner (eTeX)/Han The Thanh (pdfTeX).
There is NO warranty.  Redistribution of this software is
covered by the terms of both the pdfTeX copyright and
the Lesser GNU General Public License.
For more information about these matters, see the file
named COPYING and the pdfTeX source.
Primary author of pdfTeX: Peter Breitenlohner (eTeX)/Han The Thanh (pdfTeX).
Compiled with libpng 1.6.17; using libpng 1.6.17
Compiled with zlib 1.2.8; using zlib 1.2.8
Compiled with poppler version 0.33.0
--------------------------------------------------------------

Best regards,
Alexey Kushnir

Re: [Doxygen-users] Documenting macro which are not defined in the code

[Edward D. <eld...@tr...>]

On 4/26/2016 8:04 AM, Richard Damon wrote:
> On 4/26/16 3:37 AM, Edward Diener wrote:
>> In my library there are is a macro which, if defined at all by the
>> end-user, changes the way the code works. I want to include this macro
>> in the doxygen documentation to my library. So I add the doxygen comments:
>>
>> /** @file some_header.hpp
>>       @brief Some brief file description.
>>
>>       Some longer file description.
>> */
>>
>> /** @def MYLIB_SOME_MACRO
>>       @brief When this macro is defined at all, changes the way that xxx
>> works.
>>
>>       When this macro is defined at all xxx works in such and such way
>>       whereas when this macro is not defined xxx works in so and so way.
>> */
>>
>> Unfortunately because the macro itself is never actually defined in any
>> header, when I run doxygen I get output such as:
>>
>> Somepath/some_header.hpp:7: warning: documentation for unknown define
>> MYLIB_SOME_MACRO found.
>>
>> In other words even though I want to include the documentation for the
>> MYLIB_SOME_MACRO macro in my doxygen documentation it is rejected
>> because the macro is never actually defined in any of the source files
>> which doxygen parses.
>>
>> is there any way to tell doxygen to include the doxygen comments for the
>> macro in its documentation even though the macro is not actually defined
>> anywhere ?
>>
>>
> You can include a definition of the macro surrounded by an ifdef guard
> that won't be defined in normal compilation, but will be defined in your
> doxygen config file. Then Doxygen will see that definition and document
> it. I sometimes use the macro DOXYGEN for this. Something like:
>
> #ifdef DOXYGEN
> #define MYLIB_SOME_MACRO
> #endif

Thanks ! That works well.

Re: [Doxygen-users] Documenting macro which are not defined in the code

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

On 4/26/16 3:37 AM, Edward Diener wrote:
> In my library there are is a macro which, if defined at all by the
> end-user, changes the way the code works. I want to include this macro
> in the doxygen documentation to my library. So I add the doxygen comments:
>
> /** @file some_header.hpp
>       @brief Some brief file description.
>
>       Some longer file description.
> */
>
> /** @def MYLIB_SOME_MACRO
>       @brief When this macro is defined at all, changes the way that xxx
> works.
>
>       When this macro is defined at all xxx works in such and such way
>       whereas when this macro is not defined xxx works in so and so way.
> */
>
> Unfortunately because the macro itself is never actually defined in any
> header, when I run doxygen I get output such as:
>
> Somepath/some_header.hpp:7: warning: documentation for unknown define
> MYLIB_SOME_MACRO found.
>
> In other words even though I want to include the documentation for the
> MYLIB_SOME_MACRO macro in my doxygen documentation it is rejected
> because the macro is never actually defined in any of the source files
> which doxygen parses.
>
> is there any way to tell doxygen to include the doxygen comments for the
> macro in its documentation even though the macro is not actually defined
> anywhere ?
>
>
You can include a definition of the macro surrounded by an ifdef guard 
that won't be defined in normal compilation, but will be defined in your 
doxygen config file. Then Doxygen will see that definition and document 
it. I sometimes use the macro DOXYGEN for this. Something like:

#ifdef DOXYGEN
#define MYLIB_SOME_MACRO
#endif


-- 
Richard Damon

[Doxygen-users] Documenting macro which are not defined in the code

[Edward D. <eld...@tr...>]

In my library there are is a macro which, if defined at all by the 
end-user, changes the way the code works. I want to include this macro 
in the doxygen documentation to my library. So I add the doxygen comments:

/** @file some_header.hpp
     @brief Some brief file description.

     Some longer file description.
*/

/** @def MYLIB_SOME_MACRO
     @brief When this macro is defined at all, changes the way that xxx 
works.

     When this macro is defined at all xxx works in such and such way
     whereas when this macro is not defined xxx works in so and so way.
*/

Unfortunately because the macro itself is never actually defined in any 
header, when I run doxygen I get output such as:

Somepath/some_header.hpp:7: warning: documentation for unknown define 
MYLIB_SOME_MACRO found.

In other words even though I want to include the documentation for the 
MYLIB_SOME_MACRO macro in my doxygen documentation it is rejected 
because the macro is never actually defined in any of the source files 
which doxygen parses.

is there any way to tell doxygen to include the doxygen comments for the 
macro in its documentation even though the macro is not actually defined 
anywhere ?

[Doxygen-users] Generated order of source files

[Edward D. <eld...@tr...>]

The order of the files I specify for the INPUT tag is not the same as 
the generated order of files I see as command line output to the doxygen 
command. In the doxygen output I might see:

Reading and parsing tag files
Parsing files
Preprocessing afile.hpp...
Parsing file afile.hpp...
Preprocessing bfile.hpp...
Parsing file bfile.hpp...
etc.

and then later:

Generating file documentation...
Generating docs for file bfile.hpp...
Generating docs for file afile.hpp...

For doxygen HTML output this does not matter as doxygen's output for the 
Files | File List shows a tree structure of the files with each 
directory of the tree showing my files in alphabetic order.

But if I specify XML output rather than HTML output the information for 
the files in the generated XML files is in the order in which the docs 
are generated, which is not necessarily the order of the INPUT files 
parsing and preprocessing order.

This matter because a tool processing the XML file will likely show the 
files in the generated order and not the INPUT order. This is actually 
the case for Boost libraries using doxygen to generate the reference 
section for a library.

Is there any way to force doxygen to generate file documentation in the 
order in which the files are specified by the INPUT tag of the 
configuration file, which is evidently also the order in which the files 
are first parsed ?

Re: [Doxygen-users] documentation of cuda fortran code

[Jian T. Z. <jt....@un...>]

Hi Albert,

This works great. I used the macro expansion, but what I didn`t know before
is that the file extension needs to be in capital for preprocessing. After
I changed file .cuf to .CUF, I got the documentation I wanted.

Thanks very much for your help.

Tao
*---*

*Jian Tao ZhangMSc Mechanical Engineering*

On Sat, Apr 23, 2016 at 9:05 AM, Albert <alb...@gm...> wrote:

> Dear Tao,
>
> Cuda Fortran has indeed some special extensions, that can be removed by
> means of preprocessing, but one has to see to it that the FORTRAN code is
> preprocessed. A FORTRAN file can be preprocessed when its extension is in
> capitals. In the later case setting:
> MACRO_EXPANSION        = YES
> EXPAND_ONLY_PREDEF     = YES
> PREDEFINED             = attributes(device)=
>
> should be sufficient.
>
> Albert
>
> On Sat, Apr 23, 2016 at 4:21 AM, Jian Tao Zhang <jt....@un...> wrote:
>
>> Hello,
>>
>> I am trying to document a source code which includes fortran90 and some
>> cuda fortran files. Doxygen handles fortran90 very well, but it has issues
>> with recognizing subroutines in cuda fortran code. In the below example
>> code, the module mod_index is documented properly, but the subroutine idx
>> is not documented. The cause of that I found is that "attributes(device)",
>> a syntax of cuda fortran, is in front of subroutine. If I remove
>> "attributes(device)" from the source code, then doxygen can list the
>> subroutine idx as a member of the module mod_index.
>>
>> It's almost impossible to remove by hand as too many places in the code.
>> I was hoping something more automatic. I tried enabling preprocessor and
>> predefined macros, but I need more information to understand it better. I
>> use doxygen 1.8.11 on windows 7 machine.
>>
>> +++++++++++++++++++++
>> module mod_index
>>      use cudafor
>>      implicit none
>>
>>      contains
>>
>>      attributes(device) subroutine idx(i,j)
>>      integer :: i,j,k
>>         ~~~~~~~~
>>      end subroutine
>> end module mod_index
>> +++++++++++++++++++++
>>
>> Thanks
>> Tao
>> *---*
>>
>> *Jian Tao ZhangMSc Mechanical Engineering*
>>
>>
>> ------------------------------------------------------------------------------
>> Find and fix application performance issues faster with Applications
>> Manager
>> Applications Manager provides deep performance insights into multiple
>> tiers of
>> your business applications. It resolves application problems quickly and
>> reduces your MTTR. Get your free trial!
>> https://ad.doubleclick.net/ddm/clk/302982198;130105516;z
>> _______________________________________________
>> Doxygen-users mailing list
>> Dox...@li...
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
>>
>

Re: [Doxygen-users] documentation of cuda fortran code

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

Dear Tao,

Cuda Fortran has indeed some special extensions, that can be removed by
means of preprocessing, but one has to see to it that the FORTRAN code is
preprocessed. A FORTRAN file can be preprocessed when its extension is in
capitals. In the later case setting:
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
PREDEFINED             = attributes(device)=

should be sufficient.

Albert

On Sat, Apr 23, 2016 at 4:21 AM, Jian Tao Zhang <jt....@un...> wrote:

> Hello,
>
> I am trying to document a source code which includes fortran90 and some
> cuda fortran files. Doxygen handles fortran90 very well, but it has issues
> with recognizing subroutines in cuda fortran code. In the below example
> code, the module mod_index is documented properly, but the subroutine idx
> is not documented. The cause of that I found is that "attributes(device)",
> a syntax of cuda fortran, is in front of subroutine. If I remove
> "attributes(device)" from the source code, then doxygen can list the
> subroutine idx as a member of the module mod_index.
>
> It's almost impossible to remove by hand as too many places in the code. I
> was hoping something more automatic. I tried enabling preprocessor and
> predefined macros, but I need more information to understand it better. I
> use doxygen 1.8.11 on windows 7 machine.
>
> +++++++++++++++++++++
> module mod_index
>      use cudafor
>      implicit none
>
>      contains
>
>      attributes(device) subroutine idx(i,j)
>      integer :: i,j,k
>         ~~~~~~~~
>      end subroutine
> end module mod_index
> +++++++++++++++++++++
>
> Thanks
> Tao
> *---*
>
> *Jian Tao ZhangMSc Mechanical Engineering*
>
>
> ------------------------------------------------------------------------------
> Find and fix application performance issues faster with Applications
> Manager
> Applications Manager provides deep performance insights into multiple
> tiers of
> your business applications. It resolves application problems quickly and
> reduces your MTTR. Get your free trial!
> https://ad.doubleclick.net/ddm/clk/302982198;130105516;z
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] documentation of cuda fortran code

[Jian T. Z. <jt....@un...>]

Hello,

I am trying to document a source code which includes fortran90 and some
cuda fortran files. Doxygen handles fortran90 very well, but it has issues
with recognizing subroutines in cuda fortran code. In the below example
code, the module mod_index is documented properly, but the subroutine idx
is not documented. The cause of that I found is that "attributes(device)",
a syntax of cuda fortran, is in front of subroutine. If I remove
"attributes(device)" from the source code, then doxygen can list the
subroutine idx as a member of the module mod_index.

It's almost impossible to remove by hand as too many places in the code. I
was hoping something more automatic. I tried enabling preprocessor and
predefined macros, but I need more information to understand it better. I
use doxygen 1.8.11 on windows 7 machine.

+++++++++++++++++++++
module mod_index
     use cudafor
     implicit none

     contains

     attributes(device) subroutine idx(i,j)
     integer :: i,j,k
        ~~~~~~~~
     end subroutine
end module mod_index
+++++++++++++++++++++

Thanks
Tao
*---*

*Jian Tao ZhangMSc Mechanical Engineering*

[Doxygen-users] INPUT_FILTER being added to mainpage?

[roach <lis...@ci...>]

I posted this on StackOverflow and have not received a response, so I am
hoping someone can help here!

I am trying to use the mainpage functionality of doxygen to specify what
will be displayed on the index.html page. I want my README.md file to be the
index page. 

I currently have set in my doxyfile:

INPUT                  = README.md /path/to/my/project/files
USE_MDFILE_AS_MAINPAGE = README.md
FILE_PATTERNS          = *.proto *.md
INPUT_FILTER           = "python /path/to/my/docs/proto2cpp.py"
EXCLUDE_PATTERNS       = *.py

Doxygen is finding the README.md and adding it to the index.html page, but
it is /also/ adding the proto2cpp.py file to the index page.  So my index
page has all the code and documentation for the proto2cpp script, and then
the README.md is appended at the bottom. proto2cpp is in a different
directory than what is indicated in the INPUT configuration, so it must be
picking it up somehow from the INPUT_FILTER? 

I can't figure out how to get rid of this python script, any ideas?

Thanks!



--
View this message in context: http://doxygen.10944.n7.nabble.com/INPUT-FILTER-being-added-to-mainpage-tp7593.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.