doxygen-users — List for users of doxygen

[Doxygen-users] Doxygen LaTeX output broken with MikTeX 2.9.7100

[Leonardo P. S. <Leo...@on...>]

Hello All!

Has anyone experienced problems with the LaTeX output and MikTeX 2.9.7100? When trying to generate the PDF output from the LaTeX output, I'm getting several errors like this:

Missing } inserted. \end{DoxyEnumFields}

The HTML output looks OK. I don't see any warnings when running Doxygen.

I'm trying a VERY simple project componed of two source files, a header file and a source file. I'm using a fresh install of MikTeX 2.9.7100.

Can anyone who was a LaTeX distributon installed give this example a go? This a showstopper for us.

Thank you very much!

Header file:

/**
* @file regular_c.h
* @brief This is a simple C header file with some examples.
*/


#ifndef REGULAR_C_H_
#define REGULAR_C_H_

/* ----------------------------------------------------------------------------
* If building with a C++ compiler, make all of the definitions in this header
* have a C binding.
* ------------------------------------------------------------------------- */
#ifdef __cplusplus
extern "C"
{
#endif    /* ifdef __cplusplus */

/* ----------------------------------------------------------------------------
* Include files
* --------------------------------------------------------------------------*/

/* ----------------------------------------------------------------------------
* Defines
* --------------------------------------------------------------------------*/

/** Boolean true value */
#define TRUE    1
/** Boolean false value */
#define FALSE   0

/* ----------------------------------------------------------------------------
* Global variables and types
* --------------------------------------------------------------------------*/

/**
* This enumeration has the return codes for the @ref some_c_function function.
*/
enum SOME_C_FUNCTION_RETURN {
    SOME_C_FUNCTION_RETURN_everthing_ok        = 0,    ///< Nothing to see here
    SOME_C_FUNCTION_RETURN_some_weird_error,           ///< This is not the error you're looking for
    SOME_C_FUNCTION_RETURN_some_very_bad_error,        ///< This is not the error we are looking for
   SOME_C_FUNCTION_RETURN_life_is_sad_just_cope       ///< Move along
};

/**
* @brief Some C function that is here just as an example.
*
* This function doesn't actually do anything useful. We just use to have some
* documentation that links back to a Markdown source file
*
* @param[in]   v   We do something with this value.
* @param[out]  ptr Some value will be written here.
*
* @return Returns a value that depends on what happened:
* - @ref SOME_C_FUNCTION_RETURN_everthing_ok
*        Uh, everything is under control. Situation normal.
* - @ref SOME_C_FUNCTION_RETURN_some_weird_error
*        Uh, had a slight weapons malfunction.
* - @ref SOME_C_FUNCTION_RETURN_some_very_bad_error
*        We had a reactor leak here now. Give us a few minutes to lock it down.
*        Large leak... very dangerous.
* - @ref SOME_C_FUNCTION_RETURN_life_is_sad_just_cope
*        Who is this?? What's your operating number?
*
* @see SOME_C_FUNCTION_RETURN
*/
int some_c_function(uint32_t v, void* ptr);

/* ----------------------------------------------------------------------------
* Close the 'extern "C"' block
* ------------------------------------------------------------------------- */
#ifdef __cplusplus
}
#endif    /* ifdef __cplusplus */

#endif /* REGULAR_C_H_ */


Source File:

/**
* @file regular_c.c
* @brief This is a simple C source file with some examples. The functions are
* documented in the header file.
*/

#include "regular_c.h"

int some_c_function(uint32_t v, void* ptr)
{
    switch(v)
    {
        /* Not a real case, just using some enum */
        case SOME_C_FUNCTION_RETURN_everthing_ok:
            *((uint8_t*)ptr) = v*v;
            break;
        case SOME_C_FUNCTION_RETURN_some_weird_error:
            *((uint8_t*)ptr) = -1;
            break;
        case SOME_C_FUNCTION_RETURN_some_very_bad_error:
            *((uint8_t*)ptr) = -2;
            break;
        case SOME_C_FUNCTION_RETURN_life_is_sad_just_cope:
            *((uint8_t*)ptr) = 0;
            break;
    }

    return SOME_C_FUNCTION_RETURN_everthing_ok;
}


Doxyfile

# General options
PROJECT_NAME           = "Doxygen"
INPUT                  = src/regular_c.c include/regular_c.h
OUTPUT_DIRECTORY       = output_doc

____________________________________________________________
Leonardo Pereira Santos | ON Semiconductor
Design Engineer

200-611 Kumpf Dr        | Waterloo, Ontario, Canada, N2N 1A8
519-884-9696 x2269 (O)  | Leo...@on...<mailto:Leo...@on...>

[Doxygen-users] Using PREDEFINED with concatenation macros

[Leonardo P. S. <Leo...@on...>]

Hello All!

I'm trying to use a PREDEFINED statement to create the equivalent of the following macro:

#define concat_something(a,b) a##b

So, having this in a source file:

#define concat_something(a,b) a##b

int concat_something(foo, bar)=0;

And

EXPAND_AS_DEFINED      = concat_something

Does indeed generates a global variable:
Variables

int

foobar =0



I can also see this if I run Doxygen's preprocessor.

I need an equivalent PREDEFINED because I can't have this macro on macro as it'll break the compilation. So I tried this:

PREDEFINED             = concat_something(a,b)=a##b


But I don't get the result I expected:
Functions

int

concat_something (foo, bar)=0



I don't understand why the concat_something macro and the PREDEFINED statement don't do the same thing.

Thanks!!

____________________________________________________________
Leonardo Pereira Santos | ON Semiconductor
Design Engineer

200-611 Kumpf Dr        | Waterloo, Ontario, Canada, N2N 1A8
519-884-9696 x2269 (O)  | Leo...@on...<mailto:Leo...@on...>

[Doxygen-users] Is there any way of configuring doxygen to only create HTML links and nothing more?

[LM O. <lmo...@gm...>]

I have a group of HTML files which have content where we discuss our API in
paragraph form, and I would like to use doxygen to create links to our
doxygen-generated reference manual. But our HTML is formatted exactly as we
want it and it would be nice to be able to use doxygen to create the links
to the classes in our API and nothing more. We do this currently, but
doxygen likes to make a lot of its own formatting. We don't want any
headers, footers, no extraneaous HTML tags - we just want to send the our
files through doxygen and for links to the API to appear. Is this possible?

For example, our text:

<p>In order to use our HST::ProductConfigurator class, you need to...</p>

I want doxygen to make a link on HST::ProductConfigurator, but change
*nothing else* for the output file. Can it do this?

Thanks
Leo

Re: [Doxygen-users] Doxygen and C function names with modifiers with arguments

[Ron W <ron...@gm...>]

On Tue, Jul 23, 2019 at 11:41 AM Leonardo Pereira Santos <
Leo...@on...> wrote:

> There’s an odd behaviour when expanding the macro.
>
>
> If I use a PREDEFINED as suggested:
>
> PREDEFINED             = chess_storage(x)=chess_storage_##x
>
>
>
> I get the documentation as
>
>
>
> int chess_storage_
>
> *firmware_function*
> <http://regular__c_8h.html#a10ebc6e9e9d0553d708d2daddb03c294> (unsigned
> long int chess_storage_ param)
>
>
>
> But if I use this macro:
>
>
>
> *#define* chess_storage( x )    chess_storage_*##*x
>
>
>
> And
>
>
>
> EXPAND_AS_DEFINED      = chess_storage
>
>
>
> I get the correct concatenation:
>
>
>
> int chess_storage_x0
>
> *firmware_function*
> <http://regular__c_8h.html#adbbb22277ff4bb26c338cf1bbb34b76a> (unsigned
> long int chess_storage_a0 param)
>
>
>
> Any ideas as to why Doxygen is not concatenating?
>

It may be that # is used to start a comment in Doxygen config files. Maybe
try escaping the # like::

PREDEFINED             = chess_storage(x)=chess_storage_\#\#x

Re: [Doxygen-users] Doxygen and C function names with modifiers with arguments

[Leonardo P. S. <Leo...@on...>]

Ron,

Thanks for your reply, I definitively got closer to what I need.

There’s an odd behaviour when expanding the macro.

I’m using this function:

/**
* A C function with a modifier
* @param param A parameter
* @return zero.
*/
int chess_storage(x0) firmware_function(unsigned long int chess_storage(a0) param);

If I use a PREDEFINED as suggested:

PREDEFINED             = chess_storage(x)=chess_storage_##x

I get the documentation as

int chess_storage_

firmware_function<regular__c_8h.html#a10ebc6e9e9d0553d708d2daddb03c294> (unsigned long int chess_storage_ param)


But if I use this macro:

#define chess_storage( x )    chess_storage_##x

And

EXPAND_AS_DEFINED      = chess_storage

I get the correct concatenation:

int chess_storage_x0

firmware_function<regular__c_8h.html#adbbb22277ff4bb26c338cf1bbb34b76a> (unsigned long int chess_storage_a0 param)


Any ideas as to why Doxygen is not concatenating?

Thank you very much,

Leonardo

From: Ron W [mailto:ron...@gm...]
Sent: July-19-19 9:14 PM
To: doxygen-users <dox...@li...>
Subject: Re: [Doxygen-users] Doxygen and C function names with modifiers with arguments


[External Email]: This email arrived from an external source - Please exercise caution when opening any attachments or clicking on links.

On Fri, Jul 19, 2019 at 8:03 AM <dox...@li...<mailto:dox...@li...>> wrote:
Date: Thu, 18 Jul 2019 21:09:12 +0000
From: Leonardo Pereira Santos <Leo...@on...<mailto:Leo...@on...>>
Subject: [Doxygen-users] Doxygen and C function names with modifiers with arguments

Because the directive has a parameter, Doxygens interprets the directive as the function name.

The usual solution would be to use PREDEFINED directive in the Doxyfile as suggested here<http://doxygen.10944.n7.nabble.com/Is-it-possible-to-force-doxygen-to-ignore-compiler-specific-keywords-td2857.html<https://urldefense.proofpoint.com/v2/url?u=http-3A__doxygen.10944.n7.nabble.com_Is-2Dit-2Dpossible-2Dto-2Dforce-2Ddoxygen-2Dto-2Dignore-2Dcompiler-2Dspecific-2Dkeywords-2Dtd2857.html&d=DwMFaQ&c=MHZppzMdXMt3JYjCV71UsQ&r=k8KpFgIlnqWJ_UCMIorh7Kaa71fn5J46EO16Eh-Dgx5RVhccwhWRNbrzEpx0RhhR&m=g-riXF1SYJAuGArmVPDklJZABzcPz0dJfJ6jg0cJHdI&s=LKy49M3L0BEk3AMMp4aDgRAMUNmba3b3B1QnrsryYZM&e=>> to completely ignore the storage modifier:



PREDEFINED             = chess_storage(x)=

Not currently able to test this, but maybe this would work:

PREDEFINED = chess_storage(x))=chess_storage_##x

If not, you may need to create your own preprocessor to handle this case.

Re: [Doxygen-users] Doxygen and C function names with modifiers with arguments

[Ron W <ron...@gm...>]

On Fri, Jul 19, 2019 at 8:03 AM <dox...@li...>
wrote:

> Date: Thu, 18 Jul 2019 21:09:12 +0000
> From: Leonardo Pereira Santos <Leo...@on...>
> Subject: [Doxygen-users] Doxygen and C function names with modifiers with
> arguments
>
> Because the directive has a parameter, Doxygens interprets the directive
> as the function name.
>
> The usual solution would be to use PREDEFINED directive in the Doxyfile as
> suggested here<
> http://doxygen.10944.n7.nabble.com/Is-it-possible-to-force-doxygen-to-ignore-compiler-specific-keywords-td2857.html>
> to completely ignore the storage modifier:
>
>
>
> PREDEFINED             = chess_storage(x)=
>

Not currently able to test this, but maybe this would work:

PREDEFINED = chess_storage(x))=chess_storage_##x

If not, you may need to create your own preprocessor to handle this case.

[Doxygen-users] Doxygen and C function names with modifiers with arguments

[Leonardo P. S. <Leo...@on...>]

I'm documenting some embedded C code and some functions have storage modifiers that are specific to the compiler, like so:

int chess_storage(x0) firmware_function(unsigned long int chess_storage(a0) param)



Because the directive has a parameter, Doxygens interprets the directive as the function name.

The usual solution would be to use PREDEFINED directive in the Doxyfile as suggested here<http://doxygen.10944.n7.nabble.com/Is-it-possible-to-force-doxygen-to-ignore-compiler-specific-keywords-td2857.html> to completely ignore the storage modifier:



PREDEFINED             = chess_storage(x)=



The problem with this approach is that the documentation would not be accurate, as the actual function does have that modifier.

I've also tried to use @fn, but it didn't work either.



/**

 * @fn int firmware_function(unsigned long int param);

 *

 * A C function with a modifier

 *

 * @param param A parameter

 * @return zero.

 */

int chess_storage(x0) firmware_function(unsigned long int chess_storage(a0) param);



So the goal here is not to ignore the parameter, but make Doxygen aware that it's just a word and treat it the same as a __near modifier.
Thank you!

____________________________________________________________
Leonardo Pereira Santos | ON Semiconductor
Design Engineer

200-611 Kumpf Dr        | Waterloo, Ontario, Canada, N2N 1A8
519-884-9696 x2269 (O)  | Leo...@on...<mailto:Leo...@on...>

[Doxygen-users] Error during doxygen build

[ariblumer <ari...@gm...>]

Hi there, 

I am new to doxygen, so please bear with me... During doxygen build, when i
execute the "make" command, I get the following error:

[ 31%] Built target vhdlparser
[ 31%] [BISON][constexp] Building parser with bison 2.3
constexp.y:43.14-25: syntax error, unexpected string, expecting =
make[2]: *** [generated_src/ce_parse.cpp] Error 1
make[1]: *** [src/CMakeFiles/_doxygen.dir/all] Error 2
make: *** [all] Error 2


I have looked around this forum and others, and can't seem to find an
answer. Some people with similar issues have been suggested to update Bison
or flex, but I have tried that and still get the same error.

Thanks in advance!



--
Sent from: http://doxygen.10944.n7.nabble.com/Doxygen-Users-f3.html

Re: [Doxygen-users] How to prevent trivial man pages being generated?

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

> On Jul 8, 2019, at 11:38, Mark <dox...@er...> wrote:
> 
> Is there some way to limit Doxygen to generating man pages just for the API functions?

Other than not documenting the fields.

Regards

    -Mark

[Doxygen-users] How to prevent trivial man pages being generated?

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

Hi,

I use Doxygen to generate man pages for a library with a c API. Unfortunately it generates a vast number of man pages including a man page for each field in structures used in the API. Since these fields tend to have generic names, such as imageFormat, depth or data, these man pages pollute the global man page name space and clearly they should not be installed in man3 on anybody’s system. I do not want to prefix these field names with the name of my library. The structure names are already prefixed. Even if I did, I’m still not uncomfortable installing such man pages. You won’t find a man page for, e.g st_dev, a field in a statbuf struct. You won’t even find a man page for statbuf.

Is there some way to limit Doxygen to generating man pages just for the API functions?

Regards

    -Mark

[Doxygen-users] fortran doxygen state 5 errors

[Reich, M. <M....@ir...>]

Hi, 

I’m getting state 5 errors while trying to analyse some Fortran code: 
Error in file /Users/…/BladedInterface.F90 line: 721, state: 5(SubprogBodyContains)
I’m using Doxygen 1.8.15 on a Mac.

Has anyone experienced an error like this and knows the reason or is willing to look into the problem?
As the mail system doesn’t allow any attachments, I can send you the source code I’m trying to analyse, the config file, and Doxygen log in private. 

Regards, 
Martin

Re: [Doxygen-users] Callgraph output other than map

[jinho h. <hwa...@gm...>]

On Fri, May 10, 2019 at 1:41 PM Ron W <ron...@gm...> wrote:

> On Fri, May 10, 2019 at 8:02 AM <
> dox...@li...> wrote:
>
>> Date: Thu, 9 May 2019 23:08:00 -0400
>> From: jinho hwang <hwa...@gm...>
>> Subject: [Doxygen-users] Callgraph output other than map
>> Message-ID:
>>         <
>> CAP...@ma...>
>> Content-Type: text/plain; charset="utf-8"
>>
>> Hi,
>>
>> I get the callgraphs in png files, and see the maps are created to the
>> links. However, that does not give explicit mapping unless I interpret the
>> coordinates in the map file. Is there a way to output the callgraph in any
>> other formats such as text, xml, json?
>>
>
> The graphs are generated using Graphviz, which supports many output
> formats.
>
> I think Doxygen has  way to set the options for Graphviz. If nothing else,
> you could create a wrapper script around Graphviz and modify PATH so
> Doxygen finds the wrapper before it finds Graphviz.
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

Thanks for the reply. I ended up parsing dot files to get all the elements
needed.

Re: [Doxygen-users] Callgraph output other than map

[Ron W <ron...@gm...>]

On Fri, May 10, 2019 at 8:02 AM <dox...@li...>
wrote:

> Date: Thu, 9 May 2019 23:08:00 -0400
> From: jinho hwang <hwa...@gm...>
> Subject: [Doxygen-users] Callgraph output other than map
> Message-ID:
>         <
> CAP...@ma...>
> Content-Type: text/plain; charset="utf-8"
>
> Hi,
>
> I get the callgraphs in png files, and see the maps are created to the
> links. However, that does not give explicit mapping unless I interpret the
> coordinates in the map file. Is there a way to output the callgraph in any
> other formats such as text, xml, json?
>

The graphs are generated using Graphviz, which supports many output formats.

I think Doxygen has  way to set the options for Graphviz. If nothing else,
you could create a wrapper script around Graphviz and modify PATH so
Doxygen finds the wrapper before it finds Graphviz.

[Doxygen-users] Callgraph output other than map

[jinho h. <hwa...@gm...>]

Hi,

I get the callgraphs in png files, and see the maps are created to the
links. However, that does not give explicit mapping unless I interpret the
coordinates in the map file. Is there a way to output the callgraph in any
other formats such as text, xml, json?

Thanks in advance.

[Doxygen-users] Broken links on generated documentation

[Diego M. D. <die...@gm...>]

Dear all,

While browsing the documentation of L4Re (https://l4re.org/doc/), which is
generated using Doxygen, I noticed that the link for the documentation of
some C++ classes in the search bar is broken. This seems to happen in some
cases where there are multiple interfaces with the same name. For example,
while searching for 'Task', two results come out in the search bar.
Clicking on the first takes the user to the C interface, while clicking on
the second result takes no effect.

I thought this could be related to the fact that the name 'Task' is used to
name two interfaces (one in C, one in C++), but then I noticed that both
the C++ and C interfaces for Factory are both named 'Factory', and there
the links for each individual interface work as expected.

Looking into the html code of the page in the Chrome DevTools, I noticed
that when searching for 'Factory' (which is the case where the link
actually works), if I click over the link in the result panel in the search
bar, it updates the SRChildren element adding the attribute:

style="display: block;"

This does not happen when I search for 'Task'. Two results appear, but only
one of the links has an effect when clicked on. I also noticed that if I
manually edit the content of the page in Chrome DevTools by adding

style="display: block;"

to

<div class="SRChildren" classname="SRChildren">

then it expands the sub-menu and shows the link for the Task class
documentation.

Looking at the source codes for both classes (Factory/Task), I could not
spot anything that was able to justify this behaviour. I wonder if this is
a bug in Doxygen, or may it be some configuration missing on the source
code of L4Re which is causing the link to be broken.


Link for the sources (Task C/C++ and Factory C/C++) are given here:

   - Task C++ Interface

[In Doxygen] https://l4re.org/doc/task_source.html
[In Github]
https://github.com/kernkonzept/l4re-core/blob/master/l4sys/include/task


   - Task C interface

[In Doxygen] https://l4re.org/doc/task_8h_source.html

[In Github]
https://github.com/kernkonzept/l4re-core/blob/master/l4sys/include/task.h



   - Factory C++ Interface

[In Doxygen] https://l4re.org/doc/factory_source.html

[In Github]
https://github.com/kernkonzept/l4re-core/blob/master/l4sys/include/factory



   - Factory C Interface

[In Doxygen] https://l4re.org/doc/factory_8h_source.html

[In Github]
https://github.com/kernkonzept/l4re-core/blob/master/l4sys/include/factory.h



I've tried compile the documentation myself with two versions of Doxygen:
1.8.13 and 1.8.15 (the latest), but I saw no difference with respect to the
broken link.

Kind regards,
Diego Machado Dias

[Doxygen-users] Permission issue with plugin

[<Sac...@co...>]

Hi All,

                We are using doxygen to generate documentation for our project.
We are hosting it in confluence using appfustion plugin. But we are facing access issue with it.
As far as I know , doxygen does not provide any control in providing permission to individual users in generating documentation.

Please correct me if I am wrong or looking for solution at wrong place.
Any pointer will be helpful on this.

Regards,
Sachin



This e-mail and any files transmitted with it are for the sole use of the intended recipient(s) and may contain confidential and privileged information. If you are not the intended recipient(s), please reply to the sender and destroy all copies of the original message. Any unauthorized review, use, disclosure, dissemination, forwarding, printing or copying of this email, and/or any action taken in reliance on the contents of this e-mail is strictly prohibited and may be unlawful. Where permitted by applicable law, this e-mail and other e-mail communications sent to and from Cognizant e-mail addresses may be monitored. This e-mail and any files transmitted with it are for the sole use of the intended recipient(s) and may contain confidential and privileged information. If you are not the intended recipient(s), please reply to the sender and destroy all copies of the original message. Any unauthorized review, use, disclosure, dissemination, forwarding, printing or copying of this email, and/or any action taken in reliance on the contents of this e-mail is strictly prohibited and may be unlawful. Where permitted by applicable law, this e-mail and other e-mail communications sent to and from Cognizant e-mail addresses may be monitored.

Re: [Doxygen-users] using short argument names $foo $bar in description

[<dr...@pe...>]

On 12/04/2019 16:36, Clemens Feige wrote:
> dr...@pe... wrote on 12.04.2019 at 14:25:
>>
>> I have documentation like
>>
>>
>> /// Calculates cost of rectangle with size @p sx x @p sy meters, using
>> given @p price and adding discount if @p prio is  below 10.
>>
>> float rect_cost(float sx, float sy, float price, int prio)
>>
>>
>> the problem is that it is not comfortable to human-read nor to write,
>> instead I was looking for something in terms of:
>>
>> /// Calculates cost of rectangle with size $sx x $sy meters, using given
>> $price and adding discount if $prio is  below 10.
>>
>> Does such a thing exist, for parameters?
>>
>> If not, could it please be added?
>>
>>
>> Btw: for more general solution it seems that simply defining ALIAS on
>> character, not on @something would work, something like:
>>
>> CHAR_ALIASES="$=\p "
>>
>> would do the trick here and as well allow user to define other custom
>> special rules, from the set of characters that are not used and not
>> reserved.
>>
>> If characters are unicode it could have some interesting future use too.
>>
>
> What is wrong with the ALIASES config option?
>
> http://www.doxygen.nl/manual/config.html#cfg_aliases
>
> This tag can be used to specify a number of aliases that act as
> commands in the documentation. An alias has the form: name=value
>
I want to get to short syntax like   "Adds $x and $radius" instead of
"Adds \p x and \p radius".   With aliases it would be still the "\A x"
format instead of "$x" right? (where A is defined by me string of at
least 1 characters)

Re: [Doxygen-users] using short argument names $foo $bar in description

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

dr...@pe... wrote on 12.04.2019 at 14:25:
> 
> I have documentation like
> 
> 
> /// Calculates cost of rectangle with size @p sx x @p sy meters, using
> given @p price and adding discount if @p prio is  below 10.
> 
> float rect_cost(float sx, float sy, float price, int prio)
> 
> 
> the problem is that it is not comfortable to human-read nor to write,
> instead I was looking for something in terms of:
> 
> /// Calculates cost of rectangle with size $sx x $sy meters, using given
> $price and adding discount if $prio is  below 10.
> 
> Does such a thing exist, for parameters?
> 
> If not, could it please be added?
> 
> 
> Btw: for more general solution it seems that simply defining ALIAS on
> character, not on @something would work, something like:
> 
> CHAR_ALIASES="$=\p "
> 
> would do the trick here and as well allow user to define other custom
> special rules, from the set of characters that are not used and not
> reserved.
> 
> If characters are unicode it could have some interesting future use too.
> 

What is wrong with the ALIASES config option?

http://www.doxygen.nl/manual/config.html#cfg_aliases

This tag can be used to specify a number of aliases that act as commands 
in the documentation. An alias has the form: name=value

[Doxygen-users] using short argument names $foo $bar in description

[<dr...@pe...>]

I have documentation like


/// Calculates cost of rectangle with size @p sx x @p sy meters, using
given @p price and adding discount if @p prio is  below 10.

float rect_cost(float sx, float sy, float price, int prio)


the problem is that it is not comfortable to human-read nor to write,
instead I was looking for something in terms of:

/// Calculates cost of rectangle with size $sx x $sy meters, using given
$price and adding discount if $prio is  below 10.

Does such a thing exist, for parameters?

If not, could it please be added?


Btw: for more general solution it seems that simply defining ALIAS on
character, not on @something would work, something like:

CHAR_ALIASES="$=\p "

would do the trick here and as well allow user to define other custom
special rules, from the set of characters that are not used and not
reserved.

If characters are unicode it could have some interesting future use too.

[Doxygen-users] Functions on a new page in document

[Simon C. <smn...@gm...>]

Hello,

I am using Latex output to generate PDF documentation.

The formatting is generally good, however the generated output has more
than one function per page,

e.g.

*1.2.3.4 Function A*
*1.2.3.4 Function B*

What i want is to insert a page break before each function

How do i do this ?

Regards

[Doxygen-users] Doxygen to identify an extra attribute

[Weng, J. <Jia...@av...>]

Hello,

I have a question about doxygen to retrieve the information from C source code.

Is it possible to identify an attribute like read-only, write-only, read-write for a global variable when it is referenced or updated in a function by doxygen?

For example,

/* 4 sides of the AOT databases parameters in the voting structure compare to each others,
* and the following 6 varieties indicate each compare results of each compare group. */
static UINT32 zero_oneConst;
static UINT32 one_twoConst;


static void  aot2Outof3 (void* bufAdrs_0, void* bufAdrs_1,
                                                                                void* bufAdrs_2, ULONG cmpSize,
                                                                                VOTE_MINOR_TYPE *pVoteMinor
                                                                                )
{

                zero_oneConst = memcmp(bufAdrs_0, bufAdrs_1, cmpSize);
                one_twoConst = memcmp(bufAdrs_1, bufAdrs_2, cmpSize);

                if((zero_oneConst == 0U) && (one_twoConst == 0U) )
                {
                       *pVoteMinor = NO_MINOR;
                 }

        ....

}

static void aot3Outof4 (void* bufAdrs_0, void* bufAdrs_1,
                                               )
{

                two_threeConst  = memcmp(bufAdrs_2, bufAdrs_3, cmpSize);


                if((zero_oneConst == 0U) && (one_twoConst == 0U) && (two_threeConst == 0U) )
                {
                         *pVoteMinor = NO_MINOR;
                  }
 ...
}

How can we identify global variable zero_oneConst and one_twoConst are read_write in function aot2Outof3() but they are read-only in function aot3Outof4()?

Thanks,
Jian Weng

Re: [Doxygen-users] Another problem with "Missing } inserted. \end{DoxyParams}"

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

On Mon, 4 Mar 2019 at 09:24, Clemens Feige <c....@os...> wrote:

> Tim Rowe wrote on 04.03.2019 at 00:03:
> > Sorry, the nabble page seems to have eaten a bit of the source code. The
> > source code I tried to quote was:
> >
> >          ///// <summary>
> >          ///// Invoked when the application is launched normally by the
> > end user.  Other entry points
> >          ///// will be used such as when the application is launched to
> > open a specific file.
> >          ///// </summary>
> >          ///// <param name="e">Details about the launch request and
> > process.</param>
> >
> > On Sun, 3 Mar 2019 at 22:43, digitig <di...@gm...
> > <mailto:di...@gm...>> wrote:
> >
> >     I see a lot of people get this error, but it always seems to be down
> to
> >     unusual characters in the doc comments. I'm getting it on a /lot/ of
> the
> >     generated laTeX  files with no sign of unusual characters. For
> >     instance, I'm
> >     getting it at the beginning of the last line of:
> >
> >              \begin{DoxyParams}{Parameters}
> >              {\em e} & Details about the launch request and process.\\
> >              \hline
> >              \end{DoxyParams}
> >
> >     Generated by this doc comment in the C# source file
> >
> >              /// <summary>
> >              /// Invoked when the application is launched normally by
> >     the end
> >     user.  Other entry points
> >              /// will be used such as when the application is launched
> >     to open a
> >     specific file.
> >              /// </summary>
> >              /// Details about the launch request and process.
> >
> >     (That comment was, in turn, generated automatically by Visual Studio
> >     when I
> >     created the project.)
> >
> >     The version of laTeX I am using is MiKTeX-pdfTeX 2.9.6959 (1.40.20)
> >     (MiKTeX
> >     2.9.6960 64-bit), and the version of DOxygen is 1.8.15, on Windows
> 10.
> >
> >     How do I resolve this - here and everywhere else? Thanks.
> >
>
> Hello Tim
>
> I do not use Doxygen with Latex, so I cannot help.
>
> But this recent message on the mailing list might be related:
>
> [Doxygen-users] Issue with Doxygen and LaTex pdf generation when using
> grouping and params
> From: Joonas Greis <joonas.greis@ka...> - 2019-02-20 07:21:22
> https://sourceforge.net/p/doxygen/mailman/message/36591989/
>
> There is also StackOverFlow question about this in
>
> https://stackoverflow.com/questions/54780072/doxygen-latex-cannot-create-pdf-when-using-param-tags
>
>
> Someone believes that this issue might be caused by a problem with the
> LaTeX tabu package...
>
> Clemens
>
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

Thanks. I'm not using grouping, so the first link doesn't apply. I'm using
the latest version of MikTex, which is supposed to include the tabu patch,
so that just leaves hacking the doxygen.sty file each time it's created.
Unfortunately, applying the change proposed (replacing \begin{longtabu*}
with \begin{longtable}{|c|c|c|c|}, and presumably \end{longtabu*} with
\end{longtable}, just changes the error to:

! Misplaced \omit.
\multispan ->\omit
                   \@multispan

That seems to be because the content isn't separated correctly (
https://tex.stackexchange.com/questions/149819/misplaced-omit-multispan-omit-multispan),
or maybe the number of columns is wrong. I'm not really enough of a laTeX
power user to debug .sty files, so should I take it that Doxygen can't
reliably produce laTeX documentation until this is fixed?

-- 
Tim Rowe

Re: [Doxygen-users] Another problem with "Missing } inserted. \end{DoxyParams}"

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

Tim Rowe wrote on 04.03.2019 at 00:03:
> Sorry, the nabble page seems to have eaten a bit of the source code. The 
> source code I tried to quote was:
> 
>          ///// <summary>
>          ///// Invoked when the application is launched normally by the 
> end user.  Other entry points
>          ///// will be used such as when the application is launched to 
> open a specific file.
>          ///// </summary>
>          ///// <param name="e">Details about the launch request and 
> process.</param>
> 
> On Sun, 3 Mar 2019 at 22:43, digitig <di...@gm... 
> <mailto:di...@gm...>> wrote:
> 
>     I see a lot of people get this error, but it always seems to be down to
>     unusual characters in the doc comments. I'm getting it on a /lot/ of the
>     generated laTeX  files with no sign of unusual characters. For
>     instance, I'm
>     getting it at the beginning of the last line of:
> 
>              \begin{DoxyParams}{Parameters}
>              {\em e} & Details about the launch request and process.\\
>              \hline
>              \end{DoxyParams}
> 
>     Generated by this doc comment in the C# source file
> 
>              /// <summary>
>              /// Invoked when the application is launched normally by
>     the end
>     user.  Other entry points
>              /// will be used such as when the application is launched
>     to open a
>     specific file.
>              /// </summary>
>              /// Details about the launch request and process.
> 
>     (That comment was, in turn, generated automatically by Visual Studio
>     when I
>     created the project.)
> 
>     The version of laTeX I am using is MiKTeX-pdfTeX 2.9.6959 (1.40.20)
>     (MiKTeX
>     2.9.6960 64-bit), and the version of DOxygen is 1.8.15, on Windows 10.
> 
>     How do I resolve this - here and everywhere else? Thanks.
> 

Hello Tim

I do not use Doxygen with Latex, so I cannot help.

But this recent message on the mailing list might be related:

[Doxygen-users] Issue with Doxygen and LaTex pdf generation when using 
grouping and params
From: Joonas Greis <joonas.greis@ka...> - 2019-02-20 07:21:22
https://sourceforge.net/p/doxygen/mailman/message/36591989/

There is also StackOverFlow question about this in 
https://stackoverflow.com/questions/54780072/doxygen-latex-cannot-create-pdf-when-using-param-tags 


Someone believes that this issue might be caused by a problem with the 
LaTeX tabu package...

Clemens

Re: [Doxygen-users] Another problem with "Missing } inserted. \end{DoxyParams}"

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

Sorry, the nabble page seems to have eaten a bit of the source code. The
source code I tried to quote was:

        ///// <summary>
        ///// Invoked when the application is launched normally by the end
user.  Other entry points
        ///// will be used such as when the application is launched to open
a specific file.
        ///// </summary>
        ///// <param name="e">Details about the launch request and
process.</param>

On Sun, 3 Mar 2019 at 22:43, digitig <di...@gm...> wrote:

> I see a lot of people get this error, but it always seems to be down to
> unusual characters in the doc comments. I'm getting it on a /lot/ of the
> generated laTeX  files with no sign of unusual characters. For instance,
> I'm
> getting it at the beginning of the last line of:
>
>         \begin{DoxyParams}{Parameters}
>         {\em e} & Details about the launch request and process.\\
>         \hline
>         \end{DoxyParams}
>
> Generated by this doc comment in the C# source file
>
>         /// <summary>
>         /// Invoked when the application is launched normally by the end
> user.  Other entry points
>         /// will be used such as when the application is launched to open a
> specific file.
>         /// </summary>
>         /// Details about the launch request and process.
>
> (That comment was, in turn, generated automatically by Visual Studio when I
> created the project.)
>
> The version of laTeX I am using is MiKTeX-pdfTeX 2.9.6959 (1.40.20) (MiKTeX
> 2.9.6960 64-bit), and the version of DOxygen is 1.8.15, on Windows 10.
>
> How do I resolve this - here and everywhere else? Thanks.
>
>
>
>
>
> --
> Sent from: http://doxygen.10944.n7.nabble.com/Doxygen-Users-f3.html
>
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>


-- 
Tim Rowe

[Doxygen-users] Another problem with "Missing } inserted. \end{DoxyParams}"

[digitig <di...@gm...>]

I see a lot of people get this error, but it always seems to be down to
unusual characters in the doc comments. I'm getting it on a /lot/ of the
generated laTeX  files with no sign of unusual characters. For instance, I'm
getting it at the beginning of the last line of:

        \begin{DoxyParams}{Parameters}
        {\em e} & Details about the launch request and process.\\
        \hline
        \end{DoxyParams}

Generated by this doc comment in the C# source file

        /// <summary>
        /// Invoked when the application is launched normally by the end
user.  Other entry points
        /// will be used such as when the application is launched to open a
specific file.
        /// </summary>
        /// Details about the launch request and process.

(That comment was, in turn, generated automatically by Visual Studio when I
created the project.)

The version of laTeX I am using is MiKTeX-pdfTeX 2.9.6959 (1.40.20) (MiKTeX
2.9.6960 64-bit), and the version of DOxygen is 1.8.15, on Windows 10.

How do I resolve this - here and everywhere else? Thanks.





--
Sent from: http://doxygen.10944.n7.nabble.com/Doxygen-Users-f3.html