doxygen-users — List for users of doxygen

[Doxygen-users] Doxygen 1.9.6 [Windows 10 Pro 64-Bit ] seem to cut Text in final Output

[Jens K. <pau...@gm...>]

Hello,

I have a big problem with Doxygen 1.9.6:
It seems, that Doxygen cut Text in final result.
Here is the Source Code that I used, to create the Documentation:

https://dpaste.com/6YCU9T2PD

And here, I have created Screen-Shots, so you can see what is
going on at my Computer Side:

https://imgur.com/5o6bB1v
https://imgur.com/SOpUCzh

Thanks for reading
Jens



-- 
Diese E-Mail wurde von Avast-Antivirussoftware auf Viren geprüft.
www.avast.com

Re: [Doxygen-users] localization of documentation does not work for me

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

The official way to support multiple languages, which I’ve used successfully in the past, is to mark the comment language with \~[LanguageId], e.g.

/** comment
\~English
\brief English brief description
A longer description
\~German
\brief Deutsche kurzbeschreibung
Eine längere Beschreibung
*/

and in the doxygen project configuration file set OUTPUT_LANGUAGE = English or OUTPUT_LANGUAGE = German.

Regards

    -Mark

> On Feb 25, 2023, at 8:37, Jens Kallup <pau...@gm...> wrote:
> 
> Hello,
> 
> I searching for a way, to make the Documenation available for
> more as one Language.
> 
> I have add following lines to the Doxygen config file:
> OUTPUT_LANGUAGE      = German
> ENABLED_SECTIONS     = YES
> ENABLE_PREPROCESSING = YES
> PREDEFINED           = "DOXYGEN_COMMENT" "EnglishDox" "DeutschDox"
> 
> In a test.cc file, I use:
> 
> //! comment
> #ifdef EnglishDOX
> Output
> #endif
> #ifdef DeutschDox
> Ausgabe
> #endif
> 
> But the Doxygen run bring me the Sekeleton in German, but the Text
> in Dokumentation Block is always in English.
> Do I miss something - or is the use of Options wrong ?
> 
> Thanks for reading.
> 
> 
> -- 
> Diese E-Mail wurde von Avast-Antivirussoftware auf Viren geprüft.
> www.avast.com
> 
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] localization of documentation does not work for me

[Jens K. <pau...@gm...>]

Hello,

I searching for a way, to make the Documenation available for
more as one Language.

I have add following lines to the Doxygen config file:
OUTPUT_LANGUAGE      = German
ENABLED_SECTIONS     = YES
ENABLE_PREPROCESSING = YES
PREDEFINED           = "DOXYGEN_COMMENT" "EnglishDox" "DeutschDox"

In a test.cc file, I use:

//! comment
#ifdef EnglishDOX
Output
#endif
#ifdef DeutschDox
Ausgabe
#endif

But the Doxygen run bring me the Sekeleton in German, but the Text
in Dokumentation Block is always in English.
Do I miss something - or is the use of Options wrong ?

Thanks for reading.


-- 
Diese E-Mail wurde von Avast-Antivirussoftware auf Viren geprüft.
www.avast.com

[Doxygen-users] dvips for inline formulas stopped working

[Johannes R. <joh...@fr...>]

Hi,
since the latest doxygen update all my inline LaTeX formulas, which I have included in doxygen comments are broken. The formulas itself are ok, file _fomulas.log does not show any error. It turned out, that dvips makes the problem. The doxygen output says
...
Generating images for formulas in HTML...
Generating image form_0.png for formula
dvips: ! Couldn't find header file: l3backend-dvips.pro
error: Problems running dvips. Check your installation!  
…

I have checked my LaTeX-installation. The file exits in the following path
/usr/local/texlive/2022/texmf-dist/dvips/l3backend/l3backend-dvips.pro.
My Latex distribution, which is also used by doxygen is located in /usr/local/texlive/2022/texmf-dist/ (I can see this e.g. from _formulas.log).
So it seems, that the installation is ok.
As I have probably also updated latex and probably also other resources, I cannot say, that the error is cause only be doxygen, but I have no idea what I can do …
Any suggestions are very welcome!
Thanks in advance,
Johannes

[Doxygen-users] Mismatch between deprecated tags/default doxyfile

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

Today I got the latest version of Doxygen after some time.

I noted that I'm getting a whole bunch of 'deprecated' warnings from the
Doxywizard on a bunch of tags that are actually in the default generated
Doxyfile. Running doxygen -u on that file doesn't help.

My gut feeling is I hit a bug, where there is a discrepancy between the
code behind '-g' and the supported tags. So: where do I report such bugs, I
seem to be unable to find some bug-tracker.

Sincerely,
Jakob van Bethlehem

Re: [Doxygen-users] How to generate collaboration graph with all classes that depend on the class will be included?

[Robert H. <co...@ro...>]

On 2022-12-02 07:03, Kulagin wrote:
> I did find the CALL_GRAPH option for the individual functions and see
> what functions call them, but that's not what I want, as you can see.
> Is there a way to do this in Doxygen?

In the version I use (1.18.20) there is also a COLLABORATION_GRAPH 
setting under the "Dot" group (in Doxywizard, "Dot" is at the bottom 
under the "Expert" tab).

Did you try that?

[Doxygen-users] How to generate collaboration graph with all classes that depend on the class will be included?

[Kulagin <ser...@gm...>]

Consider the program:

class MyClass1 {public:
	int integer{};};
class MyClass2 {public:
	MyClass1* myClass1Ptr{};};
class MyClass3 {public:
	void DoSomething(MyClass1* myClass1Ptr);};
void main() {
	MyClass1{};}

I checked out getting started guide and generated the documentation for the
test solution. What I'd like to have is a collaboration graph for MyClass1
to include all the classes that directly depend on it, not just things it
depends on.[image: Classdiagram1.png]
I did find the CALL_GRAPH option for the individual functions and see what
functions call them, but that's not what I want, as you can see. Is there a
way to do this in Doxygen?

[Doxygen-users] Download link down

[Simon D. <sim...@te...>]

Hi,

The link https://www.doxygen.nl/dl/github_emojis.zip mentioned in https://www.doxygen.nl/manual/emojisup.html is down.
Please text me, if the download is available again, or if you need help to compile the python script.
I don't bother to execute the python script if you already have the result.

Many Thanks

Simon

[Doxygen-users] Fwd: [DOXYGEN] Addressing "unbalanced grouping command" warnings in ITK

[Jon H. L. G. <jon...@gm...>]

Hi,
we managed to solve/find a fix to the second question I posted:

> 2. Additionally, I am wondering how we can link automatically the
modules: e.g. the ITKTransform module is not being automatically
linked in the Group Registration description in:
https://itk.org/Doxygen/html/modules.html

However, we are still looking for some help to try to address the
"unbalanced grouping command" warnings.

Anybody, please?

Thanks.

---------- Forwarded message ---------
From: Jon Haitz Legarreta Gorroño <jon...@gm...>
Date: Tue, Sep 20, 2022 at 9:12 PM
Subject: [DOXYGEN] Addressing "unbalanced grouping command" warnings in ITK
To: <dox...@li...>


Hi,
I am trying to fix/improve some Doxygen related warnings/aspects in
ITK, and I have a few questions:

1. Our Doxygen build is raising a number of "unbalanced grouping
commands" warnings:
https://open.cdash.org/viewBuildError.php?type=1&buildid=8167118

They usually point to the end of the file, e.g.
https://github.com/InsightSoftwareConsortium/ITK/blob/master/Modules/Core/Common/include/itkAutoPointer.h#L261
or
https://github.com/InsightSoftwareConsortium/ITK/blob/master/Modules/Core/Common/include/itkBSplineInterpolationWeightFunction.h#L136

Although I have done some investigation across the Doxygen
documentation and GitHub issues I have not found any solution to the
above warnings.

Following the warning description I am guessing that these might be
due to a potential improper use of "\ingroup" commands in our files,
or the impossibility to correctly interpret them the way we define our
groups.

Besides the code modules that we parse as groups:
https://github.com/InsightSoftwareConsortium/ITK/blob/d12f14e105500362a30264e683a4045eed21ba14/CMake/ITKGroups.cmake

we define a number of other groups in
https://github.com/InsightSoftwareConsortium/ITK/blob/bcac6f9db2cb134d3d3c60a21041cde136feb1d9/Documentation/Doxygen/Modules.dox

That give rise to the Doxygen page:
https://itk.org/Doxygen/html/modules.html

Despite the warnings, many of these filters seem to display the
modules/groups they belong to correctly in the header of the file,
e.g.
"Data Processing Objects » FunctionsData Processing Objects »
Functions » Image Functions » | Image InterpolatorsGroup Core » |
Module ITKCommon"
https://itk.org/Doxygen/html/classitk_1_1BSplineInterpolationWeightFunction.html

So I am wondering how to fix the warnings.

2. Additionally, I am wondering how we can link automatically the
modules: e.g. the ITKTransform module is not being automatically
linked in the Group Registration description in:
https://itk.org/Doxygen/html/modules.html


Thanks.

[Doxygen-users] Newbie Qs for preparing branded PDF via LaTeX output

[Orly Z. <or...@xs...>]

HI All,
I’m new to Doxygen so these are probably newbie Qs. I did search the archives and could not find answers.
I’m the TW. My engineers have created fine looking HTML pages.
Now we need a PDF – which they also created via LaTeX (generated a workding refman.tex), however, we’d like to brand the PDF with our corporate “look and feel”.

  *   Add the company logo to the header
  *   Add front matter (title page with background image, Disclaimer page, TOC, etc).
  *   Format the Headers and Footers on each page( like we have on our other docs).

I created a dummy LaTeX file (e.g. mycompany.tex) that works fine and prepares a document similar to my other docs vis-a-via its “look and feel”.
This seems to be a fine template.
However, now I’m stuck.
I would like to load a LATEX_HEADER and/or LATEX_EXTRA_STYLE  sheet in order to rebrand refman.tex, via the Doxygen Wizard.
Here are my main Qs:

  1.  What type of file is the LATEX_HEADER? (*.tex or *.cls or *.sty)?
  2.  What part of my dummy file should go in the LATEX_HEADER – I imagine everything before “Document{begin} – but then how do I get my title page included properly?

I’m wondering if the title must be defined via a class file – where do I learn to create one of those?

  1.  When do I need a LATEX_EXTRA_STYLE sheet? (can that be derived from my dummy template?)
  2.  Should I disable the Doxygen.sty? If so, how?

Any other pointers would be much appreciated.

Thanks,
Orly Zimmerman

[Doxygen-users] [DOXYGEN] Addressing "unbalanced grouping command" warnings in ITK

[Jon H. L. G. <jon...@gm...>]

Hi,
I am trying to fix/improve some Doxygen related warnings/aspects in
ITK, and I have a few questions:

1. Our Doxygen build is raising a number of "unbalanced grouping
commands" warnings:
https://open.cdash.org/viewBuildError.php?type=1&buildid=8167118

They usually point to the end of the file, e.g.
https://github.com/InsightSoftwareConsortium/ITK/blob/master/Modules/Core/Common/include/itkAutoPointer.h#L261
or
https://github.com/InsightSoftwareConsortium/ITK/blob/master/Modules/Core/Common/include/itkBSplineInterpolationWeightFunction.h#L136

Although I have done some investigation across the Doxygen
documentation and GitHub issues I have not found any solution to the
above warnings.

Following the warning description I am guessing that these might be
due to a potential improper use of "\ingroup" commands in our files,
or the impossibility to correctly interpret them the way we define our
groups.

Besides the code modules that we parse as groups:
https://github.com/InsightSoftwareConsortium/ITK/blob/d12f14e105500362a30264e683a4045eed21ba14/CMake/ITKGroups.cmake

we define a number of other groups in
https://github.com/InsightSoftwareConsortium/ITK/blob/bcac6f9db2cb134d3d3c60a21041cde136feb1d9/Documentation/Doxygen/Modules.dox

That give rise to the Doxygen page:
https://itk.org/Doxygen/html/modules.html

Despite the warnings, many of these filters seem to display the
modules/groups they belong to correctly in the header of the file,
e.g.
"Data Processing Objects » FunctionsData Processing Objects »
Functions » Image Functions » | Image InterpolatorsGroup Core » |
Module ITKCommon"
https://itk.org/Doxygen/html/classitk_1_1BSplineInterpolationWeightFunction.html

So I am wondering how to fix the warnings.

2. Additionally, I am wondering how we can link automatically the
modules: e.g. the ITKTransform module is not being automatically
linked in the Group Registration description in:
https://itk.org/Doxygen/html/modules.html


Thanks.

[Doxygen-users] Doxygen Markdown Question

[Randy Y. <Ra...@as...>]

Hello All,

We are using doxygen to document non-code projects and are using markdown (.md files) as our standard documentation format.

I have noticed that doxygen’s standard processing of markdown documents is to scan the project’s directory hierarchy and create entries into the main table of contents (the left pane in the output html) in alphabetical order.

We would like to create hierarchical doxygen output (html) that is independent of the location of various .md files in the directory structure and of their spelling, e.g., by defining entries in the mainpage.md in a certain order which reference other secondary-level .md files in other places.

For example, we have a status/status-reports.md page that we would like to place at a specific place in the output hiearchy (not necessarily at the top level), but doxygen by default places that at the top level (in the left pane of the html output).

We would also like those .md files to be ONLY referenced in that specific location and not duplicated at other levels in the hierarchy.

Is there a way you force your own hierarchy on .md files this way in doxygen html output?

Randy Yates<mailto::ra...@as...>
Apex Semiconductors (USA) Company Limited<http://www.apexsemi-usa.com>
984-368-8148 (cell, work)
919-412-8994 (cell, personal)

Generated on Mon Sep 19 14:00:19 2022 by LaTeXML [[LOGO]] <http://dlmf.nist.gov/LaTeXML/>



This message contains confidential information. If you are not the intended recipient, notify the sender immediately and delete this e-mail from your system. You should always check e-mail for viruses. Sender does not accept liability for any viruses that may be inadvertently transmitted.

Re: [Doxygen-users] Regression in 1.9.5? Or my mistake?

[flap <fb...@oh...>]

Hi Andreas,

Am Montag, 19. September 2022, 13:23:59 CEST schrieb Andreas Tscharner:
> Am 18.09.2022 um 17:59 schrieb flap:
> > Am Sonntag, 18. September 2022, 15:48:57 CEST I wrote:
> >> […]
> >> recently I switched from doxygen-1.8.17 to doxygen-1.9.5. Since I have no
> >> clue how to search for it in the github bug database I ask first here:
> >> Since my doxygen update a simple documentation block gets parsed in a
> >> strange manner. The block is:
> >> 
> >> /**
> >> 
> >>   <some text>
> >>   
> >>   @attention Do not add any path to the *Driver Feature Configuration INI
> >>   file* name. It is always expected in the @ref driver_config_path.
> >> 
> >> */
> > 
> > The corresponding warning message is:
> >    warning: unable to resolve reference to 'driver_config_path.\ifile' for
> >    \ref command
> I've had a similar problem and it has already been fixed (for next
> version): https://github.com/doxygen/doxygen/issues/9584
> 
> Maybe the fix works for your problem too?
> 
> But to answer your question: It is not your fault.

Thanks for clarification. I don't want to build doxygen from source. I will 
wait for the next release and try again.

Cheers,
Jürgen

Re: [Doxygen-users] Regression in 1.9.5? Or my mistake?

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

Am 18.09.2022 um 17:59 schrieb flap:
> Am Sonntag, 18. September 2022, 15:48:57 CEST I wrote:
>> […]
>> recently I switched from doxygen-1.8.17 to doxygen-1.9.5. Since I have no
>> clue how to search for it in the github bug database I ask first here:
>> Since my doxygen update a simple documentation block gets parsed in a
>> strange manner. The block is:
>>
>> /**
>>   <some text>
>>
>>   @attention Do not add any path to the *Driver Feature Configuration INI file*
>>              name. It is always expected in the @ref driver_config_path.
>> */
> 
> The corresponding warning message is:
> 
>    warning: unable to resolve reference to 'driver_config_path.\ifile' for \ref command
> 

I've had a similar problem and it has already been fixed (for next 
version): https://github.com/doxygen/doxygen/issues/9584

Maybe the fix works for your problem too?

But to answer your question: It is not your fault.

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

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

Re: [Doxygen-users] Regression in 1.9.5? Or my mistake?

[flap <fb...@oh...>]

Am Sonntag, 18. September 2022, 15:48:57 CEST I wrote:
> […]
> recently I switched from doxygen-1.8.17 to doxygen-1.9.5. Since I have no
> clue how to search for it in the github bug database I ask first here:
> Since my doxygen update a simple documentation block gets parsed in a
> strange manner. The block is:
> 
> /**
>  <some text>
> 
>  @attention Do not add any path to the *Driver Feature Configuration INI file*
>             name. It is always expected in the @ref driver_config_path.
> */

The corresponding warning message is:

  warning: unable to resolve reference to 'driver_config_path.\ifile' for \ref command

Cheers
Jürgen

[Doxygen-users] Regression in 1.9.5? Or my mistake?

[flap <fb...@oh...>]

Hi all,

ups, second try with a correct email address and new findings...

recently I switched from doxygen-1.8.17 to doxygen-1.9.5. Since I have no clue 
how to search for it in the github bug database I ask first here: Since my 
doxygen update a simple documentation block gets parsed in a strange manner. 
The block is:

/**
 <some text>

 @attention Do not add any path to the *Driver Feature Configuration INI file*
            name. It is always expected in the @ref driver_config_path.
*/

In doxygen-1.8.17 it works and the reference to "driver_config_path" is linked 
correctly in the HTML result. With doxygen-1.9.5 it stops working: instead of 
a link the full filename of the source .dox file is listed in the HTML output.

If I add at least one trailing word, it works again:

/**
 <some text>

 @attention Do not add any path to the *Driver Feature Configuration INI file*
            name. It is always expected in the @ref driver_config_path <word>.
*/

Or:

/**
 <some text>

 @attention Do not add any path to the *Driver Feature Configuration INI file*
            name. It is always expected in the @ref driver_config_path.

 <word>
*/

Is it a known bug?

Cheers
Jürgen

[Doxygen-users] doxygen 1.9.5 AUTOLINK_SUPPORT

[Astrid G. <a.g...@st...>]

Hi all!

I see, that you have changed something regarding the automatic linkage to functions, members, namespaces,… since doxygen version 1.9.5 (AUTOLINK_SUPPORT =YES).

In my project I have the namespace CVB which is not documented and thus is not in the tag file. Only the functions of this namespace are there:

    <member kind="function">
      <type>cvbbool_t</type>
      <name>CVB::GetPixel</name>
      <anchorfile>d2/dd4/group___image_handling.html</anchorfile>
      <anchor>ga867dd557a0995d64602b7dd59d4a13f8</anchor>
      <arglist>(IMG Image, cvbval_t PlaneIndex, cvbval_t X, cvbval_t Y, cvbval_t &amp;Value)</arglist>
      <docanchor file="d2/dd4/group___image_handling.html">GetPixel</docanchor>
    </member>


In my overall project, which is a md file now the word “CVB” links to the dll documentation where CVB namespace is found. Is this really intended? I did not expect that.
It would be nice, if you could find some time to answer my question. 😊

Best regards,
Astrid Gruber

[Doxygen-users] Building doxygen from source in VS2017 fails with: "error C2280: attempting to reference a deleted function"

[Eric E. <eri...@hs...>]

Hello

I am trying to build doxygen from source on Windows using Visual Studio 2017.  The build fails with the following error message:

5>doxycfg.vcxproj -> C:\erik\projects\doxygen\build17\build\lib\Debug\doxycfg.lib
6>C:\ projects\doxygen\doxygen-1.9.5\src\docbookgen.cpp(632): error C2280: 'DocbookDocVisitor::DocbookDocVisitor(const DocbookDocVisitor &)': attempting to reference a deleted function
6>c:\ projects\doxygen\doxygen-1.9.5\src\docbookvisitor.h(152): note: compiler has generated 'DocbookDocVisitor::DocbookDocVisitor' here
6>c:\ projects\doxygen\doxygen-1.9.5\src\docbookvisitor.h(152): note: 'DocbookDocVisitor::DocbookDocVisitor(const DocbookDocVisitor &)': function was implicitly deleted because a base class invokes a deleted or inaccessible function 'DocVisitor::DocVisitor(const DocVisitor &)'
6>c:\ projects\doxygen\doxygen-1.9.5\src\docvisitor.h(37): note: 'DocVisitor::DocVisitor(const DocVisitor &)': function was implicitly deleted because a data member invokes a deleted or inaccessible function 'std::unique_ptr<DocVisitor::Private,std::default_delete<_Ty>>::unique_ptr(const std::unique_ptr<_Ty,std::default_delete<_Ty>> &)'
6>        with
6>        [
6>            _Ty=DocVisitor::Private
6>        ]
6>C:\Program Files (x86)\Microsoft Visual Studio\2017\Enterprise\VC\Tools\MSVC\14.12.25827\include\memory(2380): note: 'std::unique_ptr<DocVisitor::Private,std::default_delete<_Ty>>::unique_ptr(const std::unique_ptr<_Ty,std::default_delete<_Ty>> &)': function was explicitly deleted
6>        with
6>        [
6>            _Ty=DocVisitor::Private
6>        ]

Any idea what I'm doing wrong?

Regards,
Eric


PUBLIC

-----------------------------------------
SAVE PAPER - THINK BEFORE YOU PRINT!

This E-mail is confidential. 

It may also be legally privileged. If you are not the addressee you may not copy,
forward, disclose or use any part of it. If you have received this message in error,
please delete it and all copies from your system and notify the sender immediately by
return E-mail.

Internet communications cannot be guaranteed to be timely secure, error or virus-free.
The sender does not accept liability for any errors or omissions.

Re: [Doxygen-users] Doxygen confused between a member method and a local variable which have the same name

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

On Mon, Aug 29, 2022 at 7:04 AM <dox...@li...>
wrote:

> Date: Mon, 29 Aug 2022 10:45:22 +0000
> From: ericruan(???) <eri...@fu...>
> Subject: [Doxygen-users] Doxygen confused between a member method and
>         a local variable which have the same name
>
[...]

> The class graphs seems okay but there is a mistake in called by graph. In
> onStart method it has a reference to start which should be detected as a
> reference to the local variable start but doxygen detected it as a
> reference to a method named start which is a member method to it?s
> superclass. Is this a bug of doxygen or it?s some setting that can cause it?
>

It might be a design limitation of Doxygen. Even in languages that allow a
symbol with local scope to override a symbol in a surrounding scope, it is
not good practice to do so.

If you are documenting legacy code, is the onStart method only
referencing the local variable, or is it also referencing the super-class'
start method?

If only referencing the local variable, then a simple filter script could
add a prefix or suffix to the variable name.

If referencing both, a filter would need to discriminate between a variable
access and a method call. Presumably the compiler already does this.

[Doxygen-users] Doxygen confused between a member method and a local variable which have the same name

[ericruan(阮俊鹏) <eri...@fu...>]

Hi,

Doxygen version is 1.9.4
I am generating class graphs and called by graphs for QuickFix engine with graphviz.
The class graphs seems okay but there is a mistake in called by graph. In onStart method it has a reference to start which should be detected as a reference to the local variable start but doxygen detected it as a reference to a method named start which is a member method to it’s superclass. Is this a bug of doxygen or it’s some setting that can cause it?
I paste a snipshot below to show this situation.
[cid:image001.png@01D8BBD7.424B8D40]

[Doxygen-users] IDL - include files are not parsed correctly

[Thomas N. <TNe...@te...>]

Hi,

I have following problem:
Doxygen 1.9.4 does not parse include files correctly. So the interfaces contained in the include files do not appear in the generated help files.
The problem seems to be the actual version (I am using 1.9.4). Previous versions of doxygen (e.g. 1.7.6.1) worked correctly.

So it seems that this feature got lost between these two versions.

Detailed information:
I am using doxygen to parse an .idl file, which contains a definition of a COM library. This library contains several interfaces which are located in separated include files that are included in the body of the library definition.

In former versions of doxygen, these include files were parsed correctly and the generated documentation contained the help for all these interfaces.
But in the actual version of doxygen, all these include files are ignored and the help file does not reference them.

I tried a workaround by adding all the include files directly to the INPUT files. This worked partially, because the relationship between the COM library and the interfaces got lost.
That means that doxygen does not know that the interfaces are part of the COM library.

Could you please help us

-          by either fixing this problem

-          or explaining a workaround that gives us a satisfying alternative solution.

Thank you!

[Doxygen-users] PlantUML integration: using a different engine

[Tobias G. <ge...@ho...>]

Hi guys,

Doxygen version is 1.8.18.

I'm trying to get the JSON diagrams generated by plantUML into my doxygen documentation.

I'm using variations of the following snippet
///@startuml{engine=json}
///{
///  "firstName": "John",
///  "lastName": "Smith",
///  "isAlive": true,
///  "age": 27,
///  "address": {
///    "streetAddress": "21 2nd Street",
///    "city": "New York",
///    "state": "NY",
///    "postalCode": "10021-3100"
///  },
///  "phoneNumbers": [
///    {
///      "type": "home",
///      "number": "212 555-1234"
///    },
///    {
///      "type": "office",
///      "number": "646 555-4567"
///    }
///  ],
///  "children": [],
///  "spouse": null
///}
///@enduml


I've altered the startuml syntax as follows
@startjson
@startuml{json}

I get either a syntax error from doxygen when it runs plantUML or I get the json text flat in the documentation.

Any Ideas

Thanks
Tobi

Re: [Doxygen-users] Class missing at the class index page

[Javier G. <jav...@un...>]

Ok, forget it. it looks is some browser related issue. I see that in other computer it appears. Perhaps a cached page loading issue.

> On 13 May 2022, at 12:47, Javier Galán <jav...@un...> wrote:
> 
> Hi there,
> 
> I am using doxygen version 1.8.13.
> 
> Usually everything works smoothly when generating our document files with doxygen.
> 
> https://sultan.unizar.es/test/index.html <https://sultan.unizar.es/test/index.html>
> 
> However, I realised that at the “Index” class page, https://sultan.unizar.es/test/classes.html <https://sultan.unizar.es/test/classes.html> the class “TRestRingsMask” is not listed. It is however listed at the “List” page https://sultan.unizar.es/test/annotated.html <https://sultan.unizar.es/test/annotated.html> and the class documentation page is there.
> 
> So, my question, why the class TRestRingsMask is not indexed at https://sultan.unizar.es/test/classes.html? <https://sultan.unizar.es/test/classes.html?>
> 
> Best regards,
> and thanks!
> Javier
> 
> Our doxygen file just in case: https://github.com/rest-for-physics/framework/blob/master/doc/doxygen/REST.conf <https://github.com/rest-for-physics/framework/blob/master/doc/doxygen/REST.conf>
> 
> 
> 
> Javier Galán, Ph.D.
> Centro de Astroparticulas y Fisica de Altas Energias (CAPA)
> Facultad de Ciencias, Universidad de Zaragoza,
> C/ Pedro Cerbuna, 12, 50009, Zaragoza (Spain)
> Phone: +34 976 76 12 48
> E-mail: jav...@un... <mailto:jav...@un...>

Javier Galán, Ph.D.
Centro de Astroparticulas y Fisica de Altas Energias (CAPA)
Facultad de Ciencias, Universidad de Zaragoza,
C/ Pedro Cerbuna, 12, 50009, Zaragoza (Spain)
Phone: +34 976 76 12 48
E-mail: jav...@un...

[Doxygen-users] Class missing at the class index page

[Javier G. <jav...@un...>]

Hi there,

I am using doxygen version 1.8.13.

Usually everything works smoothly when generating our document files with doxygen.

https://sultan.unizar.es/test/index.html <https://sultan.unizar.es/test/index.html>

However, I realised that at the “Index” class page, https://sultan.unizar.es/test/classes.html <https://sultan.unizar.es/test/classes.html> the class “TRestRingsMask” is not listed. It is however listed at the “List” page https://sultan.unizar.es/test/annotated.html <https://sultan.unizar.es/test/annotated.html> and the class documentation page is there.

So, my question, why the class TRestRingsMask is not indexed at https://sultan.unizar.es/test/classes.html? <https://sultan.unizar.es/test/classes.html?>

Best regards,
and thanks!
Javier

Our doxygen file just in case: https://github.com/rest-for-physics/framework/blob/master/doc/doxygen/REST.conf <https://github.com/rest-for-physics/framework/blob/master/doc/doxygen/REST.conf>



Javier Galán, Ph.D.
Centro de Astroparticulas y Fisica de Altas Energias (CAPA)
Facultad de Ciencias, Universidad de Zaragoza,
C/ Pedro Cerbuna, 12, 50009, Zaragoza (Spain)
Phone: +34 976 76 12 48
E-mail: jav...@un...

[Doxygen-users] Creating snippets of non-code text for reuse in multiple locations

[Davina R. <Dav...@ma...>]

Hi all,

I'm trying to figure out a way to reuse snippets of non-code text in multiple dox files. I've tried a few things from creating .md files to .cpp files to .dox files and added plain text there which I then try to reference in another .dox file but I cannot get it to work. I got it to work from a .cpp file but the text that appeared was formatted by default as code rather than plain text. Is this possible in Doxygen? For example, supported systems information is common to many products, and I want to have one file with the supported systems text snippet in it, which I then reference in all dox files that need that info. I can then update that text snippet only once in a file where I have all snippets defined and that snippet is then automatically updated for all locations where it is referenced in at time of compiling. FYI, I'm a technical writer and not a programmer but I can read some code and fiddle around with code a little.

Thanks for any pointers.

The preceding e-mail message (including any attachments) contains information that may be confidential, may be protected by the attorney-client or other applicable privileges, or may constitute non-public information. It is intended to be conveyed only to the designated recipient(s) named above. If you are not an intended recipient of this message, please notify the sender by replying to this message and then delete all copies of it from your computer system. Any use, dissemination, distribution, or reproduction of this message by unintended recipients is not authorized and may be unlawful.