doxygen-users — List for users of doxygen

[Doxygen-users] Order of header files

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

When I look at doxygen output as it generates the documentation I can 
see it is processing the input files in the order I specify as INPUT but 
I also see that it says it is generating docs in a different order.

Why is that and how can I change doxygen so that I can control the order 
of the header files listed in the final doxygen HTML documentation ?

[Doxygen-users] Doxygen renders Markdown link incorrectly in a Heading

[Jimi D. <jd...@ac...>]

Hi,

I'm using Doxygen version 1.8.6  on Ubuntu 14.04


I have a heading link that looks like the following


## <a name="NonCmakeBuild"></a> Regular [GNU 
make](https://www.gnu.org/software/make/) based build


This renders perfectly fine on GitHub ( as part of the README.md ) , but 
fails when rendered through Doxygen.


I consider this a bug but I first thought I would ask the users group 
first to see if there is a work around.


Thanks,

-Jimi


-- 
WARNING - This e-mail or its attachments may contain controlled technical 
data or controlled technology within the definition of the International 
Traffic in Arms Regulations (ITAR) or Export Administration Regulations 
(EAR), and are subject to the export control laws of the U.S. Government. 
Transfer of this data or technology by any means to a foreign person, 
whether in the United States or abroad, without an export license or other 
approval from the U.S. Government, is prohibited. The information contained 
in this document is CONFIDENTIAL and property of ACCES I/O Products, Inc. 
Any unauthorized review, use, disclosure or distribution is prohibited 
without express written consent of ACCES I/O Products, Inc. If you are not 
the intended recipient, please contact the sender and destroy all copies of 
the original message and enclosed attachments.

Re: [Doxygen-users] HTML help: Populating the index

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

To anyone interested,

I've just solved this riddle myself by having a very close look at the
source code: Support for two-level nested indices is indeed implemented,
but contrary to intuition (and even contrary to the in-source
documentation) needs the following format:

    @addindex command-line?starting from
    @addindex command-line?options

While I consider this a bogosity (because it makes life more difficult
when targeting multiple output formats), I guess I can live with that.


Regards
Christoph


Am 11.04.2016 um 15:46 schrieb Christoph Lipka:
> I'm trying to use Doxygen to compile a set of Markdown files into a user
> manual in various output formats, including HTML Help. Of couse I want
> to make use of HTML Help's index feature.
> 
> I have found that I can populate the index using the "@addindex" tag in
> places I want indexed. So far so good.
> 
> However, I want to use HTML-Help's feature of grouping index entries,
> like so:
> 
>     command-line
>       starting from
>       options
> 
> The naive attempt to do this via
> 
>     @addindex command-line, starting from
>     @addindex command-line, options
> 
> doesn't work. Any ideas (short of postprocessing the .hhk file)?
> 
> ------------------------------------------------------------------------------
> 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! http://pubads.g.doubleclick.net/
> gampad/clk?id=1444514301&iu=/ca-pub-7940484522588532
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
> 

[Doxygen-users] HTML help: Populating the index

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

I'm trying to use Doxygen to compile a set of Markdown files into a user
manual in various output formats, including HTML Help. Of couse I want
to make use of HTML Help's index feature.

I have found that I can populate the index using the "@addindex" tag in
places I want indexed. So far so good.

However, I want to use HTML-Help's feature of grouping index entries,
like so:

    command-line
      starting from
      options

The naive attempt to do this via

    @addindex command-line, starting from
    @addindex command-line, options

doesn't work. Any ideas (short of postprocessing the .hhk file)?

Re: [Doxygen-users] Table of contents breaks when documentation spans multiple comment blocks with same @page

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

Based on this question I've pushed a proposed solution to github (pull
request 468) so that when tableofcontents is set once for a page it remains
set.

On Wed, Apr 6, 2016 at 10:27 PM, Jimi Damon <jd...@ac...> wrote:

> Hi Albert,
>
> I apologize for now responding as my mail program filtered  / hid this.
>
> Your solution worked great .
>
> adding an extra @tableofcontents after each @page solved this problem
>
> -Jimi
>
>
> On Fri, Mar 25, 2016 at 9:51 AM, Albert <alb...@gm...> wrote:
>
>> Jimi,
>>
>> Did you try to specify @tableofcontents after the second page as well,
>> looks like, at least when I interpret the output and question correctly,
>> the second page command disables the tableofcontents and can be enabled
>> again by calling tableofcontents again
>>
>> Albert
>>
>> On Fri, Mar 25, 2016 at 4:58 PM, Jimi Damon <jd...@ac...> wrote:
>>
>>> Hi
>>>
>>> I see the same behavior of the Table of Contents not being displayed
>>> when I added another
>>> comment section with the /** @page sample_one */    when using the
>>> 1.8.11 version of Doxygen .
>>>
>>>
>>> -Jimi
>>>
>>>
>>>
>>> On 03/25/2016 03:05 AM, Albert wrote:
>>>
>>> Jimi,
>>>
>>> You wrote that you are using doxygen 1.8.6, the current version is
>>> 1.8.11, how/what are the results with this newer version?
>>>
>>>
>>> Albert
>>>
>>> On Thu, Mar 24, 2016 at 7:59 PM, Jimi Damon <jd...@ac...> wrote:
>>>
>>>> Hi,
>>>>
>>>> I am using 1.8.6 ( on Ubuntu 14.04 ) and I have a C sample file that is
>>>> being used to illustrate the order in which to make certain API calls. So ,
>>>> what I get is a C file that has chunks of code and before each code
>>>> section, I am trying to add documentation that explains what is happening
>>>> as well as providing an anchor for a higher up Doxygen page that can point
>>>> to these sections.
>>>>
>>>> What i am finding is that when I split up my Doxygen comments, it
>>>> breaks the @tableofcontents  entry that I have supplied at the top of the C
>>>> file.
>>>>
>>>> Here are my two files
>>>>
>>>> 1.  Top level README.doc
>>>>
>>>> /*! @page top_level   A subpage
>>>>
>>>>
>>>> @subpage sample_one A Sample
>>>>
>>>> */
>>>>
>>>>
>>>>
>>>> 1. Sample C file called sample_one.c at the same level as README.doc
>>>>
>>>>
>>>>
>>>> /**
>>>>  * @file sample_one.c
>>>>  * @author $Format: %an <%ae>$
>>>>  * @date   $Format: %ad$
>>>>  * @version $Format: %h$
>>>>  * @page sample_one Sample One example
>>>>  * @tableofcontents
>>>>  * @section sample_one_first Some interesting stuff
>>>>  *
>>>>  * Some random text
>>>>  *
>>>>  * @section sample_one_two  More interesting stuff
>>>>  *
>>>>  *
>>>>  * @subsection sample_one_two_one  A subsection header
>>>>  *
>>>>  *
>>>>  */
>>>>
>>>>
>>>> /**
>>>>  * @brief A general foo structure
>>>>  *
>>>>  */
>>>> struct foo {
>>>>     int a;
>>>>     char *b;
>>>> }
>>>>
>>>> int
>>>> main(int argc, char *argv[] )
>>>> {
>>>>     struct foo a;
>>>>
>>>>     /**
>>>>      * *@page sample_one Sample One example*
>>>>      * @section configuring_something
>>>>      * @brief Initialization
>>>>      *
>>>>      */
>>>>     Init(a);
>>>> }
>>>>
>>>>
>>>> If I remove the last @page sample_one Sample One example line, then the
>>>> table of contents is provided correctly. However, I would prefer all of
>>>> these separate sections to be included in a subpage that is called
>>>> "sample_one".  This won't happen unless I have the @page sample_one
>>>> sprinkled throughout my .C file so that they are included.
>>>>
>>>>
>>>>
>>>> I feel like this is a bug because Doxygen never warns me that
>>>> processing this second @page causes problems.
>>>>
>>>>
>>>> Thanks for any ideas about what I might be missing and whether this is
>>>> in fact a bug.
>>>>
>>>> -Jimi
>>>>
>>>>
>>>>
>>>>
>>>>
>>>> WARNING - This e-mail or its attachments may contain controlled
>>>> technical data or controlled technology within the definition of the
>>>> International Traffic in Arms Regulations (ITAR) or Export Administration
>>>> Regulations (EAR), and are subject to the export control laws of the U.S.
>>>> Government. Transfer of this data or technology by any means to a foreign
>>>> person, whether in the United States or abroad, without an export license
>>>> or other approval from the U.S. Government, is prohibited. The information
>>>> contained in this document is CONFIDENTIAL and property of ACCES I/O
>>>> Products, Inc. Any unauthorized review, use, disclosure or distribution is
>>>> prohibited without express written consent of ACCES I/O Products, Inc. If
>>>> you are not the intended recipient, please contact the sender and destroy
>>>> all copies of the original message and enclosed attachments.
>>>>
>>>> ------------------------------------------------------------------------------
>>>> Transform Data into Opportunity.
>>>> Accelerate data analysis in your applications with
>>>> Intel Data Analytics Acceleration Library.
>>>> Click to learn more.
>>>> http://pubads.g.doubleclick.net/gampad/clk?id=278785351&iu=/4140
>>>> _______________________________________________
>>>> Doxygen-users mailing list
>>>> Dox...@li...
>>>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>>>
>>>>
>>>
>>>
>>> WARNING - This e-mail or its attachments may contain controlled
>>> technical data or controlled technology within the definition of the
>>> International Traffic in Arms Regulations (ITAR) or Export Administration
>>> Regulations (EAR), and are subject to the export control laws of the U.S.
>>> Government. Transfer of this data or technology by any means to a foreign
>>> person, whether in the United States or abroad, without an export license
>>> or other approval from the U.S. Government, is prohibited. The information
>>> contained in this document is CONFIDENTIAL and property of ACCES I/O
>>> Products, Inc. Any unauthorized review, use, disclosure or distribution is
>>> prohibited without express written consent of ACCES I/O Products, Inc. If
>>> you are not the intended recipient, please contact the sender and destroy
>>> all copies of the original message and enclosed attachments.
>>>
>>
>>
>
>
> --
>
> Jimi Damon
> ACCES I/O Products, Inc.
> <http://accesio.com/go.cgi?p=/contact/contact.html>
> Linux Engineer
> JD...@ac...
> (858) 550-7320 x3015
> [image: ACCES I/O Logo]
> 10623 Roselle Street San Diego CA 92121-1506 <http://accesio.com/>
>
>
> WARNING - This e-mail or its attachments may contain controlled technical
> data or controlled technology within the definition of the International
> Traffic in Arms Regulations (ITAR) or Export Administration Regulations
> (EAR), and are subject to the export control laws of the U.S. Government.
> Transfer of this data or technology by any means to a foreign person,
> whether in the United States or abroad, without an export license or other
> approval from the U.S. Government, is prohibited. The information contained
> in this document is CONFIDENTIAL and property of ACCES I/O Products, Inc.
> Any unauthorized review, use, disclosure or distribution is prohibited
> without express written consent of ACCES I/O Products, Inc. If you are not
> the intended recipient, please contact the sender and destroy all copies of
> the original message and enclosed attachments.
>

Re: [Doxygen-users] Table of contents breaks when documentation spans multiple comment blocks with same @page

[Jimi D. <jd...@ac...>]

Hi Albert,

I apologize for now responding as my mail program filtered  / hid this.

Your solution worked great .

adding an extra @tableofcontents after each @page solved this problem

-Jimi


On Fri, Mar 25, 2016 at 9:51 AM, Albert <alb...@gm...> wrote:

> Jimi,
>
> Did you try to specify @tableofcontents after the second page as well,
> looks like, at least when I interpret the output and question correctly,
> the second page command disables the tableofcontents and can be enabled
> again by calling tableofcontents again
>
> Albert
>
> On Fri, Mar 25, 2016 at 4:58 PM, Jimi Damon <jd...@ac...> wrote:
>
>> Hi
>>
>> I see the same behavior of the Table of Contents not being displayed when
>> I added another
>> comment section with the /** @page sample_one */    when using the 1.8.11
>> version of Doxygen .
>>
>>
>> -Jimi
>>
>>
>>
>> On 03/25/2016 03:05 AM, Albert wrote:
>>
>> Jimi,
>>
>> You wrote that you are using doxygen 1.8.6, the current version is
>> 1.8.11, how/what are the results with this newer version?
>>
>>
>> Albert
>>
>> On Thu, Mar 24, 2016 at 7:59 PM, Jimi Damon <jd...@ac...> wrote:
>>
>>> Hi,
>>>
>>> I am using 1.8.6 ( on Ubuntu 14.04 ) and I have a C sample file that is
>>> being used to illustrate the order in which to make certain API calls. So ,
>>> what I get is a C file that has chunks of code and before each code
>>> section, I am trying to add documentation that explains what is happening
>>> as well as providing an anchor for a higher up Doxygen page that can point
>>> to these sections.
>>>
>>> What i am finding is that when I split up my Doxygen comments, it breaks
>>> the @tableofcontents  entry that I have supplied at the top of the C file.
>>>
>>> Here are my two files
>>>
>>> 1.  Top level README.doc
>>>
>>> /*! @page top_level   A subpage
>>>
>>>
>>> @subpage sample_one A Sample
>>>
>>> */
>>>
>>>
>>>
>>> 1. Sample C file called sample_one.c at the same level as README.doc
>>>
>>>
>>>
>>> /**
>>>  * @file sample_one.c
>>>  * @author $Format: %an <%ae>$
>>>  * @date   $Format: %ad$
>>>  * @version $Format: %h$
>>>  * @page sample_one Sample One example
>>>  * @tableofcontents
>>>  * @section sample_one_first Some interesting stuff
>>>  *
>>>  * Some random text
>>>  *
>>>  * @section sample_one_two  More interesting stuff
>>>  *
>>>  *
>>>  * @subsection sample_one_two_one  A subsection header
>>>  *
>>>  *
>>>  */
>>>
>>>
>>> /**
>>>  * @brief A general foo structure
>>>  *
>>>  */
>>> struct foo {
>>>     int a;
>>>     char *b;
>>> }
>>>
>>> int
>>> main(int argc, char *argv[] )
>>> {
>>>     struct foo a;
>>>
>>>     /**
>>>      * *@page sample_one Sample One example*
>>>      * @section configuring_something
>>>      * @brief Initialization
>>>      *
>>>      */
>>>     Init(a);
>>> }
>>>
>>>
>>> If I remove the last @page sample_one Sample One example line, then the
>>> table of contents is provided correctly. However, I would prefer all of
>>> these separate sections to be included in a subpage that is called
>>> "sample_one".  This won't happen unless I have the @page sample_one
>>> sprinkled throughout my .C file so that they are included.
>>>
>>>
>>>
>>> I feel like this is a bug because Doxygen never warns me that processing
>>> this second @page causes problems.
>>>
>>>
>>> Thanks for any ideas about what I might be missing and whether this is
>>> in fact a bug.
>>>
>>> -Jimi
>>>
>>>
>>>
>>>
>>>
>>> WARNING - This e-mail or its attachments may contain controlled
>>> technical data or controlled technology within the definition of the
>>> International Traffic in Arms Regulations (ITAR) or Export Administration
>>> Regulations (EAR), and are subject to the export control laws of the U.S.
>>> Government. Transfer of this data or technology by any means to a foreign
>>> person, whether in the United States or abroad, without an export license
>>> or other approval from the U.S. Government, is prohibited. The information
>>> contained in this document is CONFIDENTIAL and property of ACCES I/O
>>> Products, Inc. Any unauthorized review, use, disclosure or distribution is
>>> prohibited without express written consent of ACCES I/O Products, Inc. If
>>> you are not the intended recipient, please contact the sender and destroy
>>> all copies of the original message and enclosed attachments.
>>>
>>> ------------------------------------------------------------------------------
>>> Transform Data into Opportunity.
>>> Accelerate data analysis in your applications with
>>> Intel Data Analytics Acceleration Library.
>>> Click to learn more.
>>> http://pubads.g.doubleclick.net/gampad/clk?id=278785351&iu=/4140
>>> _______________________________________________
>>> Doxygen-users mailing list
>>> Dox...@li...
>>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>>
>>>
>>
>>
>> WARNING - This e-mail or its attachments may contain controlled technical
>> data or controlled technology within the definition of the International
>> Traffic in Arms Regulations (ITAR) or Export Administration Regulations
>> (EAR), and are subject to the export control laws of the U.S. Government.
>> Transfer of this data or technology by any means to a foreign person,
>> whether in the United States or abroad, without an export license or other
>> approval from the U.S. Government, is prohibited. The information contained
>> in this document is CONFIDENTIAL and property of ACCES I/O Products, Inc.
>> Any unauthorized review, use, disclosure or distribution is prohibited
>> without express written consent of ACCES I/O Products, Inc. If you are not
>> the intended recipient, please contact the sender and destroy all copies of
>> the original message and enclosed attachments.
>>
>
>


-- 

Jimi Damon
ACCES I/O Products, Inc. <http://accesio.com/go.cgi?p=/contact/contact.html>
Linux Engineer
JD...@ac...
(858) 550-7320 x3015
[image: ACCES I/O Logo]
10623 Roselle Street San Diego CA 92121-1506 <http://accesio.com/>

-- 
WARNING - This e-mail or its attachments may contain controlled technical 
data or controlled technology within the definition of the International 
Traffic in Arms Regulations (ITAR) or Export Administration Regulations 
(EAR), and are subject to the export control laws of the U.S. Government. 
Transfer of this data or technology by any means to a foreign person, 
whether in the United States or abroad, without an export license or other 
approval from the U.S. Government, is prohibited. The information contained 
in this document is CONFIDENTIAL and property of ACCES I/O Products, Inc. 
Any unauthorized review, use, disclosure or distribution is prohibited 
without express written consent of ACCES I/O Products, Inc. If you are not 
the intended recipient, please contact the sender and destroy all copies of 
the original message and enclosed attachments.

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

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

I've just pushed a proposed patch to github (pull request 463)

The project logo was only copied for HTML, now it is done also for LaTeX
and RTF.

A current work around is to specify the project logo in LATEX_EXTRA_FILES

On Fri, Feb 26, 2016 at 12:31 AM, Vega, Luis A <lui...@lm...> wrote:

> When outputting documentation in LaTeX format,  doxygen fails to copy the
> image set in “PROJECT_LOGO” to the output directory.  Because of this, the
> use of the $projectlogo command option within a customized LaTeX header
> will cause a failure to build the final refman.pdf output.
>
>
>
> Workaround:
>
> 1-      Copy the image into the output directory before calling make.
>
> 2-      Use the relative path (from the output dir) to the image (instead
> of $projectlogo) within the customized LaTeX header
>
>
>
>
>
>
> ------------------------------------------------------------------------------
> Site24x7 APM Insight: Get Deep Visibility into Application Performance
> APM + Mobile APM + RUM: Monitor 3 App instances at just $35/Month
> Monitor end-to-end web transactions and take corrective actions now
> Troubleshoot faster and improve end-user experience. Signup Now!
> http://pubads.g.doubleclick.net/gampad/clk?id=272487151&iu=/4140
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] Is it possible to make the header a frame (so it doesn't scroll away)?

[jandyman <an...@vo...>]

Hi,

I producing descriptive pages that are more than a page long. The means that
as I view content further down, the header and navindex and such scroll out
of view. Is there a way to keep them from scrolling using HTML frames, the
way that most such websites would work?

Thanks in advance for help!

- Andy



--
View this message in context: http://doxygen.10944.n7.nabble.com/Is-it-possible-to-make-the-header-a-frame-so-it-doesn-t-scroll-away-tp7583.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] Links to Enums in class descriptions

[jandyman <an...@vo...>]

I answered my own question. If you haven't documented the enum explicitly
with a formatted comment, it won't show up.

I have another question on enums, but I'll create a separate topic.



--
View this message in context: http://doxygen.10944.n7.nabble.com/Links-to-Enums-in-class-descriptions-tp7580p7581.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] Can I get enum documentation somewhere other than under "file"?

[jandyman <an...@vo...>]

Hi,

I'm a big fan of Doxygen, but I've never really cared for the "Files"
section. Generally, I like to document code in such a way that the user
shouldn't care what file something is defined in. To me, it is just "noise".

But it seems that enum documentation only shows up as part of a File page.
This makes some sense, given that you need to issue a \file directive to get
enums to show up at all. But I've never really understood why that is the
case, given that a class definition is just as "global" as an enum
definition.

Is there any way to get enum documentation to show up in a page other than a
"file" page?





--
View this message in context: http://doxygen.10944.n7.nabble.com/Can-I-get-enum-documentation-somewhere-other-than-under-file-tp7582.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] Links to Enums in class descriptions

[Andrew V. <an...@vo...>]

Hi,

I'm sure this has been asked many times before but I can't find it by
search.

When I create a class description and the type of one of the instance
variables of that class is itself is a class, a link is created in the type
column for the instance variable, so I can navigate to that class
description. However, this doesn't happen for enums. Putting a \file
directive in the file where the enum is declared doesn't help. Even putting
the enum declaration inside the enclosing class declaration doesn't help.
In this latter case, the enum is documented above the instance variable
descriptions, but there is still no link to the description from the type
column of the instance variable which is of type enum.

Is there any way to get this work?

Thanks in advance for any help.

- Andy

[Doxygen-users] "Public Member Functions Inherited from"

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

Hi,

This always appears as folded. One has to open the section to see them. 
That’s not very convenient to do a search on the page.
How to have these section always open ?
What is the option in Doxyfile ?

Cheers,
O.

[Doxygen-users] Customised look

[Liviu I. <il...@li...>]

If you are interested in a custom look for your doxygen site, you can take a look at the following site:

	http://micro-os-plus.github.io/reference/cmsis-plus/group__cmsis-plus-rtos.html


It is partly inspired by GitHub look (it tries to be similar to the main project site http://micro-os-plus.github.io).

The doxygen related files are publicly available from:

	https://github.com/micro-os-plus/cmsis-plus/tree/xpack/doxygen


Best Regards,

Liviu Ionescu

http://gnuarmeclipse.github.io
http://micro-os-plus.github.io

Re: [Doxygen-users] Table of contents breaks when documentation spans multiple comment blocks with same @page

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

Jimi,

Did you try to specify @tableofcontents after the second page as well,
looks like, at least when I interpret the output and question correctly,
the second page command disables the tableofcontents and can be enabled
again by calling tableofcontents again

Albert

On Fri, Mar 25, 2016 at 4:58 PM, Jimi Damon <jd...@ac...> wrote:

> Hi
>
> I see the same behavior of the Table of Contents not being displayed when
> I added another
> comment section with the /** @page sample_one */    when using the 1.8.11
> version of Doxygen .
>
>
> -Jimi
>
>
>
> On 03/25/2016 03:05 AM, Albert wrote:
>
> Jimi,
>
> You wrote that you are using doxygen 1.8.6, the current version is 1.8.11,
> how/what are the results with this newer version?
>
>
> Albert
>
> On Thu, Mar 24, 2016 at 7:59 PM, Jimi Damon <jd...@ac...> wrote:
>
>> Hi,
>>
>> I am using 1.8.6 ( on Ubuntu 14.04 ) and I have a C sample file that is
>> being used to illustrate the order in which to make certain API calls. So ,
>> what I get is a C file that has chunks of code and before each code
>> section, I am trying to add documentation that explains what is happening
>> as well as providing an anchor for a higher up Doxygen page that can point
>> to these sections.
>>
>> What i am finding is that when I split up my Doxygen comments, it breaks
>> the @tableofcontents  entry that I have supplied at the top of the C file.
>>
>> Here are my two files
>>
>> 1.  Top level README.doc
>>
>> /*! @page top_level   A subpage
>>
>>
>> @subpage sample_one A Sample
>>
>> */
>>
>>
>>
>> 1. Sample C file called sample_one.c at the same level as README.doc
>>
>>
>>
>> /**
>>  * @file sample_one.c
>>  * @author $Format: %an <%ae>$
>>  * @date   $Format: %ad$
>>  * @version $Format: %h$
>>  * @page sample_one Sample One example
>>  * @tableofcontents
>>  * @section sample_one_first Some interesting stuff
>>  *
>>  * Some random text
>>  *
>>  * @section sample_one_two  More interesting stuff
>>  *
>>  *
>>  * @subsection sample_one_two_one  A subsection header
>>  *
>>  *
>>  */
>>
>>
>> /**
>>  * @brief A general foo structure
>>  *
>>  */
>> struct foo {
>>     int a;
>>     char *b;
>> }
>>
>> int
>> main(int argc, char *argv[] )
>> {
>>     struct foo a;
>>
>>     /**
>>      * *@page sample_one Sample One example*
>>      * @section configuring_something
>>      * @brief Initialization
>>      *
>>      */
>>     Init(a);
>> }
>>
>>
>> If I remove the last @page sample_one Sample One example line, then the
>> table of contents is provided correctly. However, I would prefer all of
>> these separate sections to be included in a subpage that is called
>> "sample_one".  This won't happen unless I have the @page sample_one
>> sprinkled throughout my .C file so that they are included.
>>
>>
>>
>> I feel like this is a bug because Doxygen never warns me that processing
>> this second @page causes problems.
>>
>>
>> Thanks for any ideas about what I might be missing and whether this is in
>> fact a bug.
>>
>> -Jimi
>>
>>
>>
>>
>>
>> WARNING - This e-mail or its attachments may contain controlled technical
>> data or controlled technology within the definition of the International
>> Traffic in Arms Regulations (ITAR) or Export Administration Regulations
>> (EAR), and are subject to the export control laws of the U.S. Government.
>> Transfer of this data or technology by any means to a foreign person,
>> whether in the United States or abroad, without an export license or other
>> approval from the U.S. Government, is prohibited. The information contained
>> in this document is CONFIDENTIAL and property of ACCES I/O Products, Inc.
>> Any unauthorized review, use, disclosure or distribution is prohibited
>> without express written consent of ACCES I/O Products, Inc. If you are not
>> the intended recipient, please contact the sender and destroy all copies of
>> the original message and enclosed attachments.
>>
>> ------------------------------------------------------------------------------
>> Transform Data into Opportunity.
>> Accelerate data analysis in your applications with
>> Intel Data Analytics Acceleration Library.
>> Click to learn more.
>> http://pubads.g.doubleclick.net/gampad/clk?id=278785351&iu=/4140
>> _______________________________________________
>> Doxygen-users mailing list
>> Dox...@li...
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
>>
>
>
> WARNING - This e-mail or its attachments may contain controlled technical
> data or controlled technology within the definition of the International
> Traffic in Arms Regulations (ITAR) or Export Administration Regulations
> (EAR), and are subject to the export control laws of the U.S. Government.
> Transfer of this data or technology by any means to a foreign person,
> whether in the United States or abroad, without an export license or other
> approval from the U.S. Government, is prohibited. The information contained
> in this document is CONFIDENTIAL and property of ACCES I/O Products, Inc.
> Any unauthorized review, use, disclosure or distribution is prohibited
> without express written consent of ACCES I/O Products, Inc. If you are not
> the intended recipient, please contact the sender and destroy all copies of
> the original message and enclosed attachments.
>

Re: [Doxygen-users] Table of contents breaks when documentation spans multiple comment blocks with same @page

[Jimi D. <jd...@ac...>]

Hi

I see the same behavior of the Table of Contents not being displayed 
when I added another
comment section with the /** @page sample_one */    when using the 
1.8.11 version of Doxygen .


-Jimi


On 03/25/2016 03:05 AM, Albert wrote:
> Jimi,
>
> You wrote that you are using doxygen 1.8.6, the current version is 
> 1.8.11, how/what are the results with this newer version?
>
>
> Albert
>
> On Thu, Mar 24, 2016 at 7:59 PM, Jimi Damon <jd...@ac... 
> <mailto:jd...@ac...>> wrote:
>
>     Hi,
>
>     I am using 1.8.6 ( on Ubuntu 14.04 ) and I have a C sample file
>     that is being used to illustrate the order in which to make
>     certain API calls. So , what I get is a C file that has chunks of
>     code and before each code section, I am trying to add
>     documentation that explains what is happening as well as providing
>     an anchor for a higher up Doxygen page that can point to these
>     sections.
>
>     What i am finding is that when I split up my Doxygen comments, it
>     breaks the @tableofcontents  entry that I have supplied at the top
>     of the C file.
>
>     Here are my two files
>
>     1.  Top level README.doc
>
>     /*! @page top_level   A subpage
>
>
>     @subpage sample_one A Sample
>
>     */
>
>
>
>     1. Sample C file called sample_one.c at the same level as README.doc
>
>
>
>     /**
>      * @file sample_one.c
>      * @author $Format: %an <%ae>$
>      * @date   $Format: %ad$
>      * @version $Format: %h$
>      * @page sample_one Sample One example
>      * @tableofcontents
>      * @section sample_one_first Some interesting stuff
>      *
>      * Some random text
>      *
>      * @section sample_one_two  More interesting stuff
>      *
>      *
>      * @subsection sample_one_two_one  A subsection header
>      *
>      *
>      */
>
>
>     /**
>      * @brief A general foo structure
>      *
>      */
>     struct foo {
>         int a;
>         char *b;
>     }
>
>     int
>     main(int argc, char *argv[] )
>     {
>         struct foo a;
>
>         /**
>          * *@page sample_one Sample One example*
>          * @section configuring_something
>          * @brief Initialization
>          *
>          */
>         Init(a);
>     }
>
>
>     If I remove the last @page sample_one Sample One example line,
>     then the table of contents is provided correctly. However, I would
>     prefer all of these separate sections to be included in a subpage
>     that is called "sample_one". This won't happen unless I have the
>     @page sample_one sprinkled throughout my .C file so that they are
>     included.
>
>
>
>     I feel like this is a bug because Doxygen never warns me that
>     processing this second @page causes problems.
>
>
>     Thanks for any ideas about what I might be missing and whether
>     this is in fact a bug.
>
>     -Jimi
>
>
>
>
>
>     WARNING - This e-mail or its attachments may contain controlled
>     technical data or controlled technology within the definition of
>     the International Traffic in Arms Regulations (ITAR) or Export
>     Administration Regulations (EAR), and are subject to the export
>     control laws of the U.S. Government. Transfer of this data or
>     technology by any means to a foreign person, whether in the United
>     States or abroad, without an export license or other approval from
>     the U.S. Government, is prohibited. The information contained in
>     this document is CONFIDENTIAL and property of ACCES I/O Products,
>     Inc. Any unauthorized review, use, disclosure or distribution is
>     prohibited without express written consent of ACCES I/O Products,
>     Inc. If you are not the intended recipient, please contact the
>     sender and destroy all copies of the original message and enclosed
>     attachments.
>     ------------------------------------------------------------------------------
>     Transform Data into Opportunity.
>     Accelerate data analysis in your applications with
>     Intel Data Analytics Acceleration Library.
>     Click to learn more.
>     http://pubads.g.doubleclick.net/gampad/clk?id=278785351&iu=/4140
>     _______________________________________________
>     Doxygen-users mailing list
>     Dox...@li...
>     <mailto:Dox...@li...>
>     https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>


-- 
WARNING - This e-mail or its attachments may contain controlled technical 
data or controlled technology within the definition of the International 
Traffic in Arms Regulations (ITAR) or Export Administration Regulations 
(EAR), and are subject to the export control laws of the U.S. Government. 
Transfer of this data or technology by any means to a foreign person, 
whether in the United States or abroad, without an export license or other 
approval from the U.S. Government, is prohibited. The information contained 
in this document is CONFIDENTIAL and property of ACCES I/O Products, Inc. 
Any unauthorized review, use, disclosure or distribution is prohibited 
without express written consent of ACCES I/O Products, Inc. If you are not 
the intended recipient, please contact the sender and destroy all copies of 
the original message and enclosed attachments.

[Doxygen-users] Resolving refs in htmlonly/latexonly blocks

[Shawn H. <sha...@gm...>]

Hello,

I would like to use a footnote command based on the StackOverflow answer
[1], like this:

ALIASES +=
footnote{1}="\latexonly\footnote\{\1\}\endlatexonly\htmlonly<span
class=\"ref\"><span class=\"refnum\">†</span><span class=\"refbody\"
style=\"display:none;\">\1</span></span>\endhtmlonly"

This works great for plain text, but doxygen commands in the custom command
argument are not processed, due to the semantics of latexonly and htmlonly.

What I would like to do is include a reference in some footnotes, for
example:

Documentation for foo. @footnote{For more details on things like foo, see
@ref bar.}

Any ideas to allow a richer footnote command like this?

Thanks,
Shawn

[1] - http://stackoverflow.com/a/25292352/223029

Re: [Doxygen-users] Unwanted line numbers in dontinclude/skip/line/until examples

[Shawn H. <sha...@gm...>]

There seems to be a discrepancy between code blocks generated from markdown
pages and C doxygen comments. From the C comment, all forms of code blocks
I tested generate a formatted DIV fragment with no line numbers, except for
the indented code block, which generates an unformatted PRE fragment with
no line numbers.

On the other hand, the different code blocks generated from markdown pages
are rendered differently. The fenced code block with a file extension
declared and the indented code block render as above. The remaining cases
render as unformatted DIV fragments with line numbers, where I expected
.formatted DIV fragments without line numbers.

Is this difference expected?

Here are two sample HTML outputs (only the first section is relevant in
each page): markdown page output
<https://dl.dropboxusercontent.com/u/403607/doxygen/code%20block%20test/mca-data-acquisition.html>
, C doxygen comment output
<https://dl.dropboxusercontent.com/u/403607/doxygen/code%20block%20test/group__falconxn__psl.html>.
Both use the same text, as follows:

\@dontinclude hqsg-falconxn.c, followed by \@skipline

@dontinclude hqsg-falconxn.c

@skipline xiaInit

Here is a fenced code block with no language:

~~~
void foo(int x);
~~~

Here is a fenced code block with .c:

~~~{.c}
void foo(int x);
~~~

Now a \@code block:

@code
void foo(int x);
@endcode

Now an indented code block:

    void foo(int x);


On Fri, Mar 18, 2016 at 12:06 PM, Shawn Hoover <sha...@gm...>
wrote:

> Here's what my HTML looks like, for comparison with the better looking
> example in the doxygen manual:
>
>
> https://dl.dropboxusercontent.com/u/403607/doxygen/falconxn_qsg_0.1.2/html/falconxn-qsg/index.html
>
> On Fri, Mar 18, 2016 at 12:00 PM, Shawn Hoover <sha...@gm...>
> wrote:
>
>> Hello,
>>
>> We're using doxygen for API reference and user manuals and enjoying the
>> powerful linking features quite a lot.
>>
>> One issue I ran into is inconsistency with line numbers in snippet
>> examples vs. dontinclude examples. What I'm seeing is no line numbers for
>> snippets, while dontinclude examples do have line numbers. Further, each
>> skip/line/until command restarts the numbering at 1, which doesn't look
>> right if I'm trying to do a sequence of commands as one.
>>
>> I'm seeing this with doxygen 1.8.10 and 1.8.11 in HTML and PDF output.
>>
>> Looking at the doxygen manual, I see no line numbers for the dontinclude
>> example.
>>
>> https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmddontinclude
>>
>>
>> https://www.stack.nl/~dimitri/doxygen/manual/examples/include/html/example.html
>>
>> What I would like to do is turn off the line numbers for dontinclude
>> examples. Especially for a one-line example, it looks cleaner for my
>> document that way and would match the general look of snippets used in
>> other sections.
>>
>> Any ideas to turn this off or at least make the numbering continuous for
>> back-to-back commands?
>>
>> Thanks,
>> Shawn
>>
>
>

Re: [Doxygen-users] Table of contents breaks when documentation spans multiple comment blocks with same @page

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

Jimi,

You wrote that you are using doxygen 1.8.6, the current version is 1.8.11,
how/what are the results with this newer version?


Albert

On Thu, Mar 24, 2016 at 7:59 PM, Jimi Damon <jd...@ac...> wrote:

> Hi,
>
> I am using 1.8.6 ( on Ubuntu 14.04 ) and I have a C sample file that is
> being used to illustrate the order in which to make certain API calls. So ,
> what I get is a C file that has chunks of code and before each code
> section, I am trying to add documentation that explains what is happening
> as well as providing an anchor for a higher up Doxygen page that can point
> to these sections.
>
> What i am finding is that when I split up my Doxygen comments, it breaks
> the @tableofcontents  entry that I have supplied at the top of the C file.
>
> Here are my two files
>
> 1.  Top level README.doc
>
> /*! @page top_level   A subpage
>
>
> @subpage sample_one A Sample
>
> */
>
>
>
> 1. Sample C file called sample_one.c at the same level as README.doc
>
>
>
> /**
>  * @file sample_one.c
>  * @author $Format: %an <%ae>$
>  * @date   $Format: %ad$
>  * @version $Format: %h$
>  * @page sample_one Sample One example
>  * @tableofcontents
>  * @section sample_one_first Some interesting stuff
>  *
>  * Some random text
>  *
>  * @section sample_one_two  More interesting stuff
>  *
>  *
>  * @subsection sample_one_two_one  A subsection header
>  *
>  *
>  */
>
>
> /**
>  * @brief A general foo structure
>  *
>  */
> struct foo {
>     int a;
>     char *b;
> }
>
> int
> main(int argc, char *argv[] )
> {
>     struct foo a;
>
>     /**
>      * *@page sample_one Sample One example*
>      * @section configuring_something
>      * @brief Initialization
>      *
>      */
>     Init(a);
> }
>
>
> If I remove the last @page sample_one Sample One example line, then the
> table of contents is provided correctly. However, I would prefer all of
> these separate sections to be included in a subpage that is called
> "sample_one".  This won't happen unless I have the @page sample_one
> sprinkled throughout my .C file so that they are included.
>
>
>
> I feel like this is a bug because Doxygen never warns me that processing
> this second @page causes problems.
>
>
> Thanks for any ideas about what I might be missing and whether this is in
> fact a bug.
>
> -Jimi
>
>
>
>
>
> WARNING - This e-mail or its attachments may contain controlled technical
> data or controlled technology within the definition of the International
> Traffic in Arms Regulations (ITAR) or Export Administration Regulations
> (EAR), and are subject to the export control laws of the U.S. Government.
> Transfer of this data or technology by any means to a foreign person,
> whether in the United States or abroad, without an export license or other
> approval from the U.S. Government, is prohibited. The information contained
> in this document is CONFIDENTIAL and property of ACCES I/O Products, Inc.
> Any unauthorized review, use, disclosure or distribution is prohibited
> without express written consent of ACCES I/O Products, Inc. If you are not
> the intended recipient, please contact the sender and destroy all copies of
> the original message and enclosed attachments.
>
> ------------------------------------------------------------------------------
> Transform Data into Opportunity.
> Accelerate data analysis in your applications with
> Intel Data Analytics Acceleration Library.
> Click to learn more.
> http://pubads.g.doubleclick.net/gampad/clk?id=278785351&iu=/4140
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] Table of contents breaks when documentation spans multiple comment blocks with same @page

[Jimi D. <jd...@ac...>]

Hi,

I am using 1.8.6 ( on Ubuntu 14.04 ) and I have a C sample file that is 
being used to illustrate the order in which to make certain API calls. 
So , what I get is a C file that has chunks of code and before each code 
section, I am trying to add documentation that explains what is 
happening as well as providing an anchor for a higher up Doxygen page 
that can point to these sections.

What i am finding is that when I split up my Doxygen comments, it breaks 
the @tableofcontents  entry that I have supplied at the top of the C file.

Here are my two files

1.  Top level README.doc

/*! @page top_level   A subpage


@subpage sample_one A Sample

*/



1. Sample C file called sample_one.c at the same level as README.doc



/**
  * @file sample_one.c
  * @author $Format: %an <%ae>$
  * @date   $Format: %ad$
  * @version $Format: %h$
  * @page sample_one Sample One example
  * @tableofcontents
  * @section sample_one_first Some interesting stuff
  *
  * Some random text
  *
  * @section sample_one_two  More interesting stuff
  *
  *
  * @subsection sample_one_two_one  A subsection header
  *
  *
  */


/**
  * @brief A general foo structure
  *
  */
struct foo {
     int a;
     char *b;
}

int
main(int argc, char *argv[] )
{
     struct foo a;

     /**
      * *@page sample_one Sample One example*
      * @section configuring_something
      * @brief Initialization
      *
      */
     Init(a);
}


If I remove the last @page sample_one Sample One example line, then the 
table of contents is provided correctly. However, I would prefer all of 
these separate sections to be included in a subpage that is called 
"sample_one".  This won't happen unless I have the @page sample_one 
sprinkled throughout my .C file so that they are included.



I feel like this is a bug because Doxygen never warns me that processing 
this second @page causes problems.


Thanks for any ideas about what I might be missing and whether this is 
in fact a bug.

-Jimi





-- 
WARNING - This e-mail or its attachments may contain controlled technical 
data or controlled technology within the definition of the International 
Traffic in Arms Regulations (ITAR) or Export Administration Regulations 
(EAR), and are subject to the export control laws of the U.S. Government. 
Transfer of this data or technology by any means to a foreign person, 
whether in the United States or abroad, without an export license or other 
approval from the U.S. Government, is prohibited. The information contained 
in this document is CONFIDENTIAL and property of ACCES I/O Products, Inc. 
Any unauthorized review, use, disclosure or distribution is prohibited 
without express written consent of ACCES I/O Products, Inc. If you are not 
the intended recipient, please contact the sender and destroy all copies of 
the original message and enclosed attachments.

[Doxygen-users] References within a markdown page

[Tim R. <tim...@gm...>]

Can't get links within a single markdown working for HTML output (as described 
in http://www.stack.nl/~dimitri/doxygen/manual/markdown.html#md_header_id). 

Here both methods won't navigate to the 'Author' section:
[Author](#author)
[Author](@ref author)

... text ...

## Author ##   {#author}
bla


My current workaround is:
[Author](#author)

... text ...

## <a name="author"/>Author
bla


But seems like a hack. Any idea why the documented methods won't work ? 
(Doxygen 1.8.11 here).


Regards, Tim

Re: [Doxygen-users] Unwanted line numbers in dontinclude/skip/line/until examples

[Shawn H. <sha...@gm...>]

Here's what my HTML looks like, for comparison with the better looking
example in the doxygen manual:

https://dl.dropboxusercontent.com/u/403607/doxygen/falconxn_qsg_0.1.2/html/falconxn-qsg/index.html

On Fri, Mar 18, 2016 at 12:00 PM, Shawn Hoover <sha...@gm...>
wrote:

> Hello,
>
> We're using doxygen for API reference and user manuals and enjoying the
> powerful linking features quite a lot.
>
> One issue I ran into is inconsistency with line numbers in snippet
> examples vs. dontinclude examples. What I'm seeing is no line numbers for
> snippets, while dontinclude examples do have line numbers. Further, each
> skip/line/until command restarts the numbering at 1, which doesn't look
> right if I'm trying to do a sequence of commands as one.
>
> I'm seeing this with doxygen 1.8.10 and 1.8.11 in HTML and PDF output.
>
> Looking at the doxygen manual, I see no line numbers for the dontinclude
> example.
>
> https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmddontinclude
>
>
> https://www.stack.nl/~dimitri/doxygen/manual/examples/include/html/example.html
>
> What I would like to do is turn off the line numbers for dontinclude
> examples. Especially for a one-line example, it looks cleaner for my
> document that way and would match the general look of snippets used in
> other sections.
>
> Any ideas to turn this off or at least make the numbering continuous for
> back-to-back commands?
>
> Thanks,
> Shawn
>

[Doxygen-users] Unwanted line numbers in dontinclude/skip/line/until examples

[Shawn H. <sha...@gm...>]

Hello,

We're using doxygen for API reference and user manuals and enjoying the
powerful linking features quite a lot.

One issue I ran into is inconsistency with line numbers in snippet examples
vs. dontinclude examples. What I'm seeing is no line numbers for snippets,
while dontinclude examples do have line numbers. Further, each
skip/line/until command restarts the numbering at 1, which doesn't look
right if I'm trying to do a sequence of commands as one.

I'm seeing this with doxygen 1.8.10 and 1.8.11 in HTML and PDF output.

Looking at the doxygen manual, I see no line numbers for the dontinclude
example.

https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmddontinclude

https://www.stack.nl/~dimitri/doxygen/manual/examples/include/html/example.html

What I would like to do is turn off the line numbers for dontinclude
examples. Especially for a one-line example, it looks cleaner for my
document that way and would match the general look of snippets used in
other sections.

Any ideas to turn this off or at least make the numbering continuous for
back-to-back commands?

Thanks,
Shawn

[Doxygen-users] Doxygen collecting information on dedicated page or in dedicated group

[Roman K. <mu...@gm...>]

<html><head></head><body><div style="font-family: Verdana;font-size: 12.0px;"><div>Hello</div>

<div>&nbsp;</div>

<div>For our technical support I was trying to collect information which is somewhat distributed in the code and therefore in the Doxygen documentation on a single page or in a group for their easier access.</div>

<div>&nbsp;</div>

<div>Most of this information is about members of C structures (firmware parameters) or global or module static variables. The information is available in the respective file and module (code and then doxygen), but gathering those struct member documentation on a or some pages did not work for me.</div>

<div>&nbsp;</div>

<div>The idea was that a tag e.g. @addtolist &lt;listname&gt; to a object such as variables or struct members would add those objects to a list and then could be &quot;printed&quot; on a page @showlist &lt;listname&gt;. The goal was to have that somewhat &quot;automatic&quot; by simply adding new object to those list when required at their source and not to have to maintain a manually written &quot;TechnicalSupport.doxy&quot; page.</div>

<div>&nbsp;</div>

<div>Is there a way to collect different objects and show such documentation information on a dedicated page?</div>

<div>&nbsp;</div>

<div>Regards</div>

<div>&nbsp;</div>

<div>&nbsp;</div>

<div>&nbsp;</div>

<div>&nbsp;</div></div></body></html>

[Doxygen-users] Question on adding unique strings (name tags) to Doxygen indexing

[Tom G. <ger...@gm...>]

Hi,

I have a simple question that I'm unable to find answers for..

In my code there is an extensive use of custom and unique strings that
refer to name texts.

For example,

Parameter.set_name_tag("*XNIIF1052*");

Is there any way in which I can feed/add a list of these unique strings to
the Doxygen generation in order for Doxygen to recognize them, so they are
indexed and hyperlinked similar to variables and objects?

Best regards,

Tom Geraedts

[Doxygen-users] Doxygen mainpage broken ?

[Tim R. <tim...@gm...>]

Hi,

I am struggling all day with a mainpage.md not showing up correctly as the 
mainpage.

After a while I realized that the Doxygen online docs have the same problem...
Goto http://www.stack.nl/~dimitri/doxygen/manual/index.html

The text starts with 'The first part forms a user manual:'. But the index.doc 
starts with 'Introduction' / "Doxygen is the de facto standard tool...".

Klicking on 'Doxygen Manual' in the left top of the tree view, it jumps 
immediately to 'Overview'.

Bug or feature !?

Tim