doxygen-users — List for users of doxygen

[Doxygen-users] Doxygen: longtabu and MiKTeX

[Paolo G. <pj...@ev...>]

Dear all,

This is my first mail in the list. thanks for the great software you made!

We are integrating Doxygen in our project
(https://github.com/evidence/erika3), and we are facing a few issues on
the Latex export on windows.

The current status is as follows:

On Linux:
- Ubuntu 18.04
- doxygen 1.8.13
- standard latex distribution, with longtabu version:
  tabu : 2011/02/26 v2.8 - tabu : Flexible LaTeX tabulars
- Everything ok, both HTML and Latex export!

On Windows
- Miktex updated to the last distribution, with longtabu version:
    tabu : 2019-01-11 - tabu : Flexible LaTeX tabulars
    Updated 2019-01-11
    see https://github.com/tabu-fixed/tabu
- Doxygen for windows 1.8.11, 1.8.14, 1.8.15 (the latest)
- HTML export ok
- Latex export NOT ok


On windows, it seems that longtabu has strange issues. In particular, it
fails on even small tables generated either from markdown or from HTML
conversion, with an error as follows:

--------------------------
[...]
! Missing } inserted.
<inserted text>
                }
l.26 \end{longtabu}

?
--------------------------

I wonder if anyone had the same issue in the latest days. Could it be
due to the recent update on the tabu package in miktex?

Regards,

Paolo

[Doxygen-users] Python Scripts appearing as namespaces

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

Hi,

When I set EXTRACT_ALL = YES in Doxyfile, all the python scripts
I have in my software (mainly written in C++)  appear in the NameSpaces
section. How can I avoid this ? 

Cheers,
O.Couet

Re: [Doxygen-users] Multiple executables with identical symbols?

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

At Sat, 19 Jan 2019 19:39:08 +0100 Hans <hgu...@xs...> wrote:

> 
> On 19/01/2019 19:29, Robert Heller wrote:
> > I'm presuming these classes are not actually in a public API library -- either
> > they are defined in "private" header files (header files only ever included in
> > the corresponding to the C++ main for the exe in question) or defined directly
> > in the C++ files specific to the exe in question). It might also make sense to
> > NOT use "correct" Doxygen commentting -- include comments of course, but not
> > formatted in a way that Doxygen recognizes (eg replace /** with /*+, etc.) --
> > Doxygen won't pick them up and won't document them (and won't get confused or
> > create confusing documentation). Since they don't document a public API, there
> > is no harm. Or don't actually feed the "private" header files or C++ source
> > code to Doxygen (unless you are using the C++ main program to create man1 or
> > man8 pages, or something like that -- eg program usage docs).
> > 
> > As Richard says "That isn't really how Doxygen is intended to be used...", you
> > probably *don't* want to "document" a non-public API, which is what these
> > classes sound like what they are. Doxygen is meant to document *public* APIs
> > (programs, classes, functions, etc.) that will be called by programs written
> > by other people, who would then link with your library or run your main
> > programs (your .exe files).
> 
> Well, an executable doesn't have a public API of course, it's a closed 
> unit so it's all private. My goal here is overal project documentation. 
> It is for new developers, allowing them to better understand the system.
> 
> Is that actually an unusual use for Doxygen? It seems perfect for doing 
> something like this - well, apart from the issue under discussion...

Normally, I use Doxygen three ways (and guess this would be typical):

1: Document a public library's API (classic use of Doxygen).  Create 
documentation for programmers who might be interested using the libraries in 
their own programs from the comments in the source code.

2: Create man1/man8 pages for utility and daemon programs (document things 
like command line arguments, files used, etc.  This helps end users to 
properly run these utility and daemon programs that are part of the project.

3: Write out-of-program user manuals (the source header files will contain
only Doxygen-style comments and no actual code) -- Doxygen is good here in
that it creates quality "hard copy" (printable PDF) by way of LaTeX AND
equally quality "help pages" (as HTML), from a common source. The two formats
are consistent with each other and cover both use cases -- eg those that like
to click on a Help button or menu and have the documentation on the screen
alongside the running program and those that want a paper manual to read. 

(In practice, 1 yields man3, PDF, and HTML, 2 yields man1/man8, and 3 yields 
HTML and PDF, and when creating a user manual for a complex project, the user 
manual uses sources for both 2 & 3 -- eg, the "man" pages for the utility and 
daemon programs end up in their own chapters or in the appendix.  Feel free to 
visit my Model RR System's source tree on GitHub at 
https://github.com/RobertPHeller/ModelRRSystem for a package where I do this.)

For what you are doing you either need to run Doxygen for each "program" 
separately, creating a separate self-contained document OR you need to put the 
"private" classes in program-specific name spaces.  *Actually* there are all 
sorts of good reasons to do that anyway.  When the classes, etc. are in 
program-specific name spaces Doxygen will properly consider them different and 
distinct from each other.

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

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

Re: [Doxygen-users] Multiple executables with identical symbols?

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

On 1/19/19 1:39 PM, Hans wrote:
> On 19/01/2019 19:29, Robert Heller wrote:
>> I'm presuming these classes are not actually in a public API library
>> -- either
>> they are defined in "private" header files (header files only ever
>> included in
>> the corresponding to the C++ main for the exe in question) or defined
>> directly
>> in the C++ files specific to the exe in question). It might also make
>> sense to
>> NOT use "correct" Doxygen commentting -- include comments of course,
>> but not
>> formatted in a way that Doxygen recognizes (eg replace /** with /*+,
>> etc.) --
>> Doxygen won't pick them up and won't document them (and won't get
>> confused or
>> create confusing documentation). Since they don't document a public
>> API, there
>> is no harm. Or don't actually feed the "private" header files or C++
>> source
>> code to Doxygen (unless you are using the C++ main program to create
>> man1 or
>> man8 pages, or something like that -- eg program usage docs).
>>
>> As Richard says "That isn't really how Doxygen is intended to be
>> used...", you
>> probably *don't* want to "document" a non-public API, which is what
>> these
>> classes sound like what they are. Doxygen is meant to document
>> *public* APIs
>> (programs, classes, functions, etc.) that will be called by programs
>> written
>> by other people, who would then link with your library or run your main
>> programs (your .exe files).
>
> Well, an executable doesn't have a public API of course, it's a closed
> unit so it's all private. My goal here is overal project
> documentation. It is for new developers, allowing them to better
> understand the system.
>
> Is that actually an unusual use for Doxygen? It seems perfect for
> doing something like this - well, apart from the issue under
> discussion...
>
I will use Doxygen for more than just Public API, which is one reason it
has the option to document internal/private members.

If the executables are really independent, I might be tempted to run
separate reports for each, and perhaps have the common library as a
independent set.

If the executables are more interrelated, my suggestion to put the
various executables into namespaces so as to make them unique can make
sense.

-- 
Richard Damon

Re: [Doxygen-users] Multiple executables with identical symbols?

[Hans <hgu...@xs...>]

On 19/01/2019 19:29, Robert Heller wrote:
> I'm presuming these classes are not actually in a public API library -- either
> they are defined in "private" header files (header files only ever included in
> the corresponding to the C++ main for the exe in question) or defined directly
> in the C++ files specific to the exe in question). It might also make sense to
> NOT use "correct" Doxygen commentting -- include comments of course, but not
> formatted in a way that Doxygen recognizes (eg replace /** with /*+, etc.) --
> Doxygen won't pick them up and won't document them (and won't get confused or
> create confusing documentation). Since they don't document a public API, there
> is no harm. Or don't actually feed the "private" header files or C++ source
> code to Doxygen (unless you are using the C++ main program to create man1 or
> man8 pages, or something like that -- eg program usage docs).
> 
> As Richard says "That isn't really how Doxygen is intended to be used...", you
> probably *don't* want to "document" a non-public API, which is what these
> classes sound like what they are. Doxygen is meant to document *public* APIs
> (programs, classes, functions, etc.) that will be called by programs written
> by other people, who would then link with your library or run your main
> programs (your .exe files).

Well, an executable doesn't have a public API of course, it's a closed 
unit so it's all private. My goal here is overal project documentation. 
It is for new developers, allowing them to better understand the system.

Is that actually an unusual use for Doxygen? It seems perfect for doing 
something like this - well, apart from the issue under discussion...

Re: [Doxygen-users] Multiple executables with identical symbols?

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

At Sat, 19 Jan 2019 12:24:33 -0500 Richard Damon <Ri...@Da...> wrote:

> 
> On 1/19/19 10:03 AM, Hans wrote:
> > Hi,
> >
> >
> > I have a largish project, consisting of 12 libraries and 50 or so
> > executables. Some of the executables declare 'duplicate' class names -
> > they are not real duplicates, of course, since they are never linked
> > together, but the same name is still find in several places. How do I
> > tell Doxygen that symbols from two executables really refer to two
> > different things?
> >
> > For example, foo.exe contains class MainWindow. bar.exe also contains
> > class MainWindow, but of course it is a different thing altogether.
> > Can I somehow get Doxygen to keep them separate in the output?
> >
> > I don't want to run Doxygen 50 times, once for each executable. It
> > would be incredibly slow, and take up a huge amount of diskspace.
> >
> >
> > Thanks in advance!
> >
> > H. Guijt
> >
> That isn't really how Doxygen is intended to be used from what I know,
> but one way around it would be for each executable to place its
> duplicates in a unique namespace (perhaps named for the executable), and
> then Doxygen would document each in its own namespace, and not see them
> as duplicates. The header declaring the class could even than bring the
> name into the global namespace so most of the program doesn't need to
> see the difference.

I'm presuming these classes are not actually in a public API library -- either
they are defined in "private" header files (header files only ever included in
the corresponding to the C++ main for the exe in question) or defined directly
in the C++ files specific to the exe in question). It might also make sense to
NOT use "correct" Doxygen commentting -- include comments of course, but not
formatted in a way that Doxygen recognizes (eg replace /** with /*+, etc.) --
Doxygen won't pick them up and won't document them (and won't get confused or
create confusing documentation). Since they don't document a public API, there
is no harm. Or don't actually feed the "private" header files or C++ source
code to Doxygen (unless you are using the C++ main program to create man1 or
man8 pages, or something like that -- eg program usage docs).

As Richard says "That isn't really how Doxygen is intended to be used...", you
probably *don't* want to "document" a non-public API, which is what these
classes sound like what they are. Doxygen is meant to document *public* APIs
(programs, classes, functions, etc.) that will be called by programs written
by other people, who would then link with your library or run your main 
programs (your .exe files).

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

Re: [Doxygen-users] Multiple executables with identical symbols?

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

On 1/19/19 10:03 AM, Hans wrote:
> Hi,
>
>
> I have a largish project, consisting of 12 libraries and 50 or so
> executables. Some of the executables declare 'duplicate' class names -
> they are not real duplicates, of course, since they are never linked
> together, but the same name is still find in several places. How do I
> tell Doxygen that symbols from two executables really refer to two
> different things?
>
> For example, foo.exe contains class MainWindow. bar.exe also contains
> class MainWindow, but of course it is a different thing altogether.
> Can I somehow get Doxygen to keep them separate in the output?
>
> I don't want to run Doxygen 50 times, once for each executable. It
> would be incredibly slow, and take up a huge amount of diskspace.
>
>
> Thanks in advance!
>
> H. Guijt
>
That isn't really how Doxygen is intended to be used from what I know,
but one way around it would be for each executable to place its
duplicates in a unique namespace (perhaps named for the executable), and
then Doxygen would document each in its own namespace, and not see them
as duplicates. The header declaring the class could even than bring the
name into the global namespace so most of the program doesn't need to
see the difference.

-- 
Richard Damon

[Doxygen-users] Multiple executables with identical symbols?

[Hans <hgu...@xs...>]

Hi,


I have a largish project, consisting of 12 libraries and 50 or so 
executables. Some of the executables declare 'duplicate' class names - 
they are not real duplicates, of course, since they are never linked 
together, but the same name is still find in several places. How do I 
tell Doxygen that symbols from two executables really refer to two 
different things?

For example, foo.exe contains class MainWindow. bar.exe also contains 
class MainWindow, but of course it is a different thing altogether. Can 
I somehow get Doxygen to keep them separate in the output?

I don't want to run Doxygen 50 times, once for each executable. It would 
be incredibly slow, and take up a huge amount of diskspace.


Thanks in advance!

H. Guijt

[Doxygen-users] EXTRACT_ALL = YES ... ?

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

Hi,

When I put EXTRACT_ALL = YES in my Doxyfile the python files are shown as NameSpaces… 

( I would like to it equal to YES because if equal to NO undocumented methods are not clickable ) .

How can I avoid to have the python files as NameSpaces when EXTRACT_ALL = YES ?

Is seems a kind of bug ….

Cheers,
Olivier

[Doxygen-users] Parsing comments from macro incorrectly

[Gil K. <gi...@me...>]

Hello Doxygen users,
I'm using macros to define enums (and strings) in C:

#define GENERATE_ENUM(ENUM, STR) ENUM,

typedef enum action {
    FOREACH_ACTION(GENERATE_ENUM)
} action_t;

#define FOREACH_ACTION(F)  \
    F(ACTION_1 = 1, "Action 1") \
    F(ACTION_2 = 2 /**< Some Doxygen comment */, "Action 2") \
    F(ACTION_3 = 3 /**< Some other Doxygen comment */, "Action 3") \
    F(ACTION_MIN = ACTION_1, "") \
    F(ACTION_MAX = ACTION_3, "")

I'm using doxygen 1.8.14 with MACRO_EXPANSION=YES in Doxifile (creating HTML output).
For some reason ACTION_3 is not being parsed correctly:

Enumerator

ACTION_1

ACTION_2

Some Doxygen comment GENERATE_ENUM (ACTION_3 = 3 /**< Some other Doxygen comment

ACTION_MIN

ACTION_MAX


Any idea how can I fix that so I will get ACTION_3 in the list with the matching comment?

Thanks.

[Doxygen-users] RTF Stylesheet

[Metz, D. <dm...@cu...>]

When is the syntax used within the RTF Stylesheet documented?

Thanks,
Donald Metz
Senior Software Engineer

Curtiss-Wright
28965 Avenue Penn, Santa Clarita, CA 91355
T: 661-705-1134 | F: 661-257-1585
dm...@cu...<mailto:dm...@cu...> | www.curtisswrightds.com<http://www.curtisswrightds.com/>

----------------------------------------------------------------------
This e-mail and any files transmitted with it are proprietary and intended solely for the use of the individual or entity to whom they are addressed. If you have reason to believe that you have received this e-mail in error, please notify the sender and destroy this e-mail and any attached files. Please note that any views or opinions presented in this e-mail are solely those of the author and do not necessarily represent those of the Curtiss-Wright Corporation or any of its subsidiaries. Documents attached hereto may contain technology subject to the U.S. Export Regulations. Recipient is solely responsible for ensuring that any re-export, transfer or disclosure of this information is in accordance with U.S. Export Regulations. The recipient should check this e-mail and any attachments for the presence of viruses. Curtiss-Wright Corporation and its subsidiaries accept no liability for any damage caused by any virus transmitted by this e-mail.

[Doxygen-users] Finding all leaf classes in a code base

[Konstantin T. <an...@ya...>]

Hi all,

I'd like to find a way to enumerate all leaf classes in a large C++ code base [*]. While it doesn't have
anything to do with documentation, Doxygen seems to be the only tool which can reliably analyze
inheritance hierarchy of the project. However, as there are too many classes, some kind of automation
is still missing.

Is there any better way to find all leaf classes then parsing of hierarchy.html contents?

[*] To avoid suspicions of XY problem, I need that to ensure all leaf classes have 'final' specifier

--
Regards,
Konstantin

[Doxygen-users] Dependencies of doxygen-1.8.14.linux.bin.tar.gz

[Mateusz L. <ma...@lo...>]

Hi,

I'm trying to use Doxygen installed from the Linux binaries
doxygen-1.8.14.linux.bin.tar.gz on Ubuntu 18.04 or Debian 9.

The binary description says it was compiled using
Ubuntu 14.04 with kernel 3.13.0 and gcc 4.8.2,
but what are the actual run-time dependencies?

It does not seem to be a self-contained statically-linked binary.
(like, for example, the CMake one [1], which has never caused
a problem to me on a variety of Linux distributions/versions).

I tried to get the Doxygen installed from the binary running

$ doxygen --version
doxygen: error while loading shared libraries: libclang.so.6: cannot
open shared object file: No such file or directory

I installed clang 6 libraries according to http://apt.llvm.org instructions.

$ ldconfig -p|grep clang
libclang-6.0.so.1 (libc6,x86-64) => /usr/lib/x86_64-linux-gnu/libclang-6.0.so.1
libclang-3.8.so.1 (libc6,x86-64) => /usr/lib/x86_64-linux-gnu/libclang-3.8.so.1

so, I added the symlink expected by doxygen

sudo ln -s /usr/lib/x86_64-linux-gnu/libclang-6.0.so.1
/usr/lib/x86_64-linux-gnu/libclang.so.6

Running again

$ doxygen --version
doxygen: /home/dimitri/doxygen/dev/llvm-svn/lib/Support/CommandLine.cpp:293:
void {anonymous}::CommandLineParser::registerCategory(llvm::cl::OptionCategory*):
Assertion `count_if(RegisteredOptionCategories, [cat](const
OptionCategory *Category) { return cat->getName() ==
Category->getName(); }) == 0 && "Duplicate option categories"' failed.
Aborted (core dumped)

Could anyone explain how to get the Linux binaries of Doxygen 1.8.14
installed and running?

Would it be possible to offer statically linked binary like CMake [1]?

This would greatly simplify using the very latest Doxygen on CI services,
where every minute of CPU time allowance is worth gold :-)

[1] https://cmake.org/files/v3.13/

Best regards,
-- 
Mateusz Loskot, http://mateusz.loskot.net

Re: [Doxygen-users] Macro and class definition

[Jakob v. B. <jak...@gm...>]

Hej,

You need to check out how to configure the Doxygen pre-processor. I don’t remember all detail by hart (http://www.doxygen.nl/manual/preprocessing.html <http://www.doxygen.nl/manual/preprocessing.html>, options ENABLE_PREPROCESSING, EXPAND_ONLY_PREDEF, PREDEFINED, EXPAND_AS_DEFINED) , but it is pretty well explained in the documentation, where for instance, you can find an elaborate example that handles __cdecl_* declarations, that are syntactically exactly like your example. If I remember correctly you would declare SOME_MACRO with PREDEFINED, and then set the other three options correctly.
 
Sincerely,
Jakob


> On 12 Dec 2018, at 15:57, Olivier Couet <Oli...@ce...> wrote:
> 
> Hello,
> 
> I have the following problem:
> 
> Some C macro defined as:
> 
> #
>  define SOME_MACRO
> 
> 
> A class defined as:
> 
> 
> /** \class A_CLASS
> 
>  A simple class.
> 
> */
> 
> 
> 
>  class
> SOME_MACRO
> A_CLASS <https://root.cern/doc/master/classTTreeReaderValue.html>  {
>     /// A method
>     void F();
>  }
> 
> Doxygen find the class description but does not find
> the method or anything in the class. This is because the
> the C macro name between the keyword “class” and the 
> class name.
> 
> I tried to set at YES the CLANG_ASSISTED_PARSING flag,
> but it does not help.
> 
> Some ideas ?
> 
> Cheers,
> O.
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] Github Markdown theme created for Doxygen HTML output

[Pieter C. <pi...@pi...>]

Hi everyone, 

I apologize for cross-posting, but the "doxygen-projects" mailing list
appears to be dead (?).

I created a theme for Doxygen HTML output so that it resembles Github
Markdown pages with a tree view navigator on the left. I am an HTML and
CSS novice and any fixes or improvements are most welcome! 

The theme can be found here: 

https://github.com/piconomix/doxygen-github-markdown-theme 

Here is an example usage of this theme: 

https://piconomix.com/fwlib/index.html 

Best regards, 

Pieter

[Doxygen-users] Macro and class definition

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

Hello,

I have the following problem:


  *   Some C macro defined as:

# define SOME_MACRO


  *   A class defined as:

/** \class A_CLASS
 A simple class.
*/

 class SOME_MACRO A_CLASS<https://root.cern/doc/master/classTTreeReaderValue.html>  {
    /// A method
    void F();
 }

Doxygen find the class description but does not find
the method or anything in the class. This is because the
the C macro name between the keyword “class” and the
class name.

I tried to set at YES the CLANG_ASSISTED_PARSING flag,
but it does not help.

Some ideas ?

Cheers,
O.

[Doxygen-users] Interrupting Doxygen comment with code

[perrola <per...@gm...>]

Hello All

Is it possible to interrupt Doxygen comment with code, so that for example,
a plant uml diagram is spread in my real code for a better link between the
diagram and the implementation ?
For example:

/**
* \brief Initialization of the component.
*
* Initialization function of the ALED component.
* \return No returned value
*
* \startuml
*/
void ALED_vidInit(void)
{
/**
* ALED->ALED : FunctionA()
*/
   FunctionA();
/**
* ALED->ALED : FunctionB()
*/
   FunctionB();
/**
* ALED->ALED : FunctionC()
*/
   FunctionC();
}
/**
* \enduml
*
*/


Thank you for your answer

regards



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

Re: [Doxygen-users] no matching class member

[<Phi...@En...>]

uint16_t aDeviceId vs uint32_t aDeviceId
________________________________________
From: Mwoua <dav...@le...>
Sent: Friday, November 30, 2018 9:54 AM
To: dox...@li...
Subject: [Doxygen-users] no matching class member

EXTERNAL EMAIL -- This message originates from outside of Engility.

Hello,

im trying to document this contructor:

////////////////////////////////////////////////////////////////////////////////////////////////////
/// \fn Core::LdProperty::LdProperty( ePropertyType aPropertyType,
eCategories aCategory, uint32_t aFeatures, uint32_t aId, uint16_t aDeviceId,
uint32_t aUnitSize, size_t aStride, const std::string &aDescription )
///
/// \brief  Constructor.
///
/// \param  aPropertyType   Type of the property.
/// \param  aCategory       Category of the property.
/// \param  aFeatures       Combination of feature bits from the eFeatures
enum.
/// \param  aId             The globally unique value identifying this
property. Also used as the file id. Cannot be 0.
/// \param  aDeviceId       The value used by the device to identify this
property. Can be 0 if the property is not involved in communication with
///                         the device.
/// \param  aUnitSize       The number of bytes for each value (for raw
storage for interaction with files and protocol).
/// \param  aStride         The number of bytes for each value in the local
storage.
/// \param  aDescription    Name or description of the property.
///
/// \author XXX
/// \date   January 2016
////////////////////////////////////////////////////////////////////////////////////////////////////
Core::LdProperty::LdProperty( ePropertyType aPropertyType, eCategories
aCategory, uint32_t aFeatures, uint32_t aId, uint32_t aDeviceId, uint32_t
aUnitSize, size_t aStride, const std::string &aDescription )


But it gives me the following error:

warning: no matching class member found for
  Core::LdProperty::LdProperty(Core::LdProperty::ePropertyType
aPropertyType, Core::LdProperty::eCategories aCategory, uint32_t aFeatures,
uint32_t aId, uint16_t aDeviceId, uint32_t aUnitSize, size_t aStride, const
std::string &aDescription)
Possible candidates:
  Core::LdProperty::LdProperty(ePropertyType aPropertyType, eCategories
aCategory, uint32_t aFeatures, uint32_t aId, uint32_t aDeviceId, uint32_t
aUnitSize, size_t aStride, const std::string &aDescription="")
  Core::LdProperty::LdProperty()


I dont see any difference between signatures, so I dont understand whts the
problem.

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

[Doxygen-users] no matching class member

[Mwoua <dav...@le...>]

Hello,

im trying to document this contructor:

////////////////////////////////////////////////////////////////////////////////////////////////////
/// \fn Core::LdProperty::LdProperty( ePropertyType aPropertyType,
eCategories aCategory, uint32_t aFeatures, uint32_t aId, uint16_t aDeviceId,
uint32_t aUnitSize, size_t aStride, const std::string &aDescription )
///
/// \brief  Constructor.
///
/// \param  aPropertyType   Type of the property.
/// \param  aCategory       Category of the property.
/// \param  aFeatures       Combination of feature bits from the eFeatures
enum.
/// \param  aId             The globally unique value identifying this
property. Also used as the file id. Cannot be 0.
/// \param  aDeviceId       The value used by the device to identify this
property. Can be 0 if the property is not involved in communication with
///                         the device.
/// \param  aUnitSize       The number of bytes for each value (for raw
storage for interaction with files and protocol).
/// \param  aStride         The number of bytes for each value in the local
storage.
/// \param  aDescription    Name or description of the property.
///
/// \author XXX
/// \date   January 2016
////////////////////////////////////////////////////////////////////////////////////////////////////
Core::LdProperty::LdProperty( ePropertyType aPropertyType, eCategories
aCategory, uint32_t aFeatures, uint32_t aId, uint32_t aDeviceId, uint32_t
aUnitSize, size_t aStride, const std::string &aDescription )


But it gives me the following error:

warning: no matching class member found for 
  Core::LdProperty::LdProperty(Core::LdProperty::ePropertyType
aPropertyType, Core::LdProperty::eCategories aCategory, uint32_t aFeatures,
uint32_t aId, uint16_t aDeviceId, uint32_t aUnitSize, size_t aStride, const
std::string &aDescription)
Possible candidates:
  Core::LdProperty::LdProperty(ePropertyType aPropertyType, eCategories
aCategory, uint32_t aFeatures, uint32_t aId, uint32_t aDeviceId, uint32_t
aUnitSize, size_t aStride, const std::string &aDescription="")
  Core::LdProperty::LdProperty()


I dont see any difference between signatures, so I dont understand whts the
problem.

Thanks




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

[Doxygen-users] Showing variables that are not variables

[InluxBDX <tal...@gm...>]

After running doxygen, a php file with this line of code is shown as a
variable in the documentation.

if($_SESSION['autenticado'] !='validado') {
    header("location: index.php");
    exit;
 }

And the very funny thing, is that the true variable $ menu, in the next line
is set in the same line of the code before.

This is how the documentation is shown.

Variables:

if($_SESSION['autenticado']!='validado')    $menu = new Menu()

Is there any chance to fix this?This has happened in others context too, I
suppose the same problem happening.

I'm using the last version 1.8.15, but the problem also has occurred in
version 1.8.11




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

[Doxygen-users] Using custom ghostscript installation

[marco r. <mre...@gm...>]

Dear all,
   I am using doxygen+latex to generate png files for some equations.
I have a custom latex Installation which is not included in the system
path - using LATEX_CMD_NAME I can select the latex executable
from the doxyfile, but I can not find a way to select also my custom
ghostscript executable. Is there such an option?

Thank you,
   Marco

[Doxygen-users] duplicate anchor in tag file

[markus i. <mar...@se...>]

Dear all,

I am using doxygen 1.8.14 windows release.
For a project I am using the anchor tag is used in library A. This library is generating a tag file. This library generates its documentation through doxygen without any warnings or errors.
Then there is library B which is linking against the tag file for A. When the doxygen generation for library B is done there are many warnings about duplicate anchors in the tag file of library A. It seems like when reading tag files an anchor can not be specified in groups, namespaces and classes without generating two warnings. Like I said, there are no warnings about this when generating documentation for library A.

Did anyone encounter this already and found a solution?
This warning does not seem to result in any issues with the generated output.

Cheers,
Markus

Re: [Doxygen-users] Internal inconsistency scope for class not found with .tag file

[Markus <mar...@se...>]

Hello,

I know this is a really old mail issue that have no answer but we are
encountering the same problem atm.
Did you happen to find a solution for this issue? Warnings are annoying even
if they don't seem to generate any issues with the final documentation.

Cheers,
Markus @ SenseGraphics



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

Re: [Doxygen-users] html anchor name scheme for dokumentation elements (files, groups, functions, ...)

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

"René Staffen" wrote on 29.08.2018 at 14:50:
> Hi,
> I want to create some external links into doxygen documents based on some knowledge of the code.
> 
> Is it possible at all to (and if: how) create this links without searching the individual id of the elements in the already generated files?
> 
> e.g how should the hyperlink look like if i want to reference the function Fun_XYZ in File_ABC.h?
> 
> Do i have to process the xml output or
> 
> 
> Thanks and best regards
> René
> 

Hello René

The cryptic names and IDs are MD5 hashes. In 2006 somebody asked a 
similar question and Dimitri (who is the honorable author of Doxygen) 
answered as follows:

 > "you can look in src/memberdef.cpp for
 > MemberDef::setAnchor(const char *a)".

But watch out, at this time Doxygen 1.4.5 was the latest. Nevertheless, 
looks like this function still exist and you may examine how the MD5 
code is created.

https://github.com/doxygen/doxygen/blob/master/src/memberdef.cpp

Clemens

[Doxygen-users] html anchor name scheme for dokumentation elements (files, groups, functions, ...)

[René S. <r.s...@gm...>]

Hi,
I want to create some external links into doxygen documents based on some knowledge of the code.

Is it possible at all to (and if: how) create this links without searching the individual id of the elements in the already generated files?

e.g how should the hyperlink look like if i want to reference the function Fun_XYZ in File_ABC.h?

Do i have to process the xml output or 


Thanks and best regards
René