3,223 questions
2
votes
1
answer
168
views
Documenting type alias of template instantiation in a header with a Doxygen
I have this include/Interface.h file which looks something like this:
/**
* @file Interface.h
* @brief This is an interface file.
*/
namespace MyNamespace {
/**
* @brief Template struct ...
- 41
5
votes
0
answers
115
views
How to make Doxygen show warnings on undocumented code?
Environment
Windows 11
Doxygen 1.15.0
Command: doxygen Doxyfile
Goal
Fail the build when anything is undocumented. I expect warnings (and with WARN_AS_ERROR=YES, errors) for undocumented functions, ...
- 51
0
votes
0
answers
56
views
How to set colors from original RGBA?
I want to get Doxygen generated API doc with base color RGBA(255, 130, 0, 1).
Here it is:
Try to convert it into HSL (right?) and got:
Hue = 31
Sat = 100%
Lum = 100%
These values entered into ...
- 395
1
vote
1
answer
60
views
Qt Creator does not recognize \ character as Doxygen prefix
At the moment, I write Doxygen keywords as @brief, but I would like to write \brief.
The problem is that when I start typing the \ character, Qt Creator does not provide Doxygen keyword completion. It ...
- 511
2
votes
1
answer
90
views
How to create a Doxygen reference to a comment about an external document?
I am writing a C++ program and want to document it with Doxygen.
There are some reference documents that influence my code. For example, a PDF describing the hardware that the code should run on, or ...
- 21
0
votes
0
answers
52
views
Doxygen removes class template specialization with typedef
I observe a really weird behavior in doxygen (1.14.0) for C++ code.
If you have this minimal cpp file:
/// Test
template<bool x> class Test;
/// Test<true>
template<> class Test<...
- 1,250
0
votes
0
answers
46
views
ruby documentation that reports missing doc for parameters to methods
I use doxygen in most projects (C/C++, python), but doxygen does not support ruby (even though Gemini AI says it does).
I tried rdoc. There were issues with it, so I looked for another tool. I'm now ...
- 899
0
votes
0
answers
48
views
Messy call graphs for singleton classes
I'm trying to browse the C++ code for an embedded project using Doxygen 1.8.13.
I find the call/caller graphs very useful for this, but the project includes several singleton classes. Each of these ...
- 111
0
votes
0
answers
27
views
Doxygen Python module separator
I am using Doxygen to document a Python package. The package contains a subpackage called core that contains a module called models. I can refer to this module with @ref core.models however my output ...
- 61
1
vote
0
answers
78
views
Why does doxygen include classes in other namespaces?
I have a medium to large code base (depending on your perspective, 350k lines of original code including the comments) that is well formatted to have doxygen pick up the documentation. Overall, I'm ...
- 333
0
votes
2
answers
85
views
How to merge Doxygen snippets?
I have a project using Doxygen, Breathe, and Sphinx for documentation. The hardcoded example snippets of code in the documentation have become a pain to maintain, as the project is constantly evolving....
- 672
0
votes
0
answers
25
views
what are the sectioning commands in doxygen
I know that blank line is a sectioning command.
As in:
/**
@details ipsum lorem
*/
But what are the other commands? Google search is simply not returning anything useful, nor did a perusal of ...
3
votes
1
answer
69
views
How to document types like "unsigned short accum"
Is there a way in Doxygen to document types like unsigned short accum or long long sat fract? It's supposed to be in a documentation of stdfix.h (ISO/IEC TR18037), and the documentation should ...
- 4,337
0
votes
1
answer
287
views
Doxygen docstring displayable in vscode
I have a Python code, and I recently discovered Doxygen which generates the documentation automatically from the source code.
If I understood correctly, to make the generated code well detected by ...
- 396
0
votes
0
answers
41
views
How to remove markdown files from treeview in Doxygen 1.9.1
I am using Doxygen 1.9.1 to generate documentation for a code base. It works great generally, except for the top level documentation. I've written the top level docs using markdown, and every file ...
- 130
7
votes
1
answer
159
views
Document function-like macros without evaluating if/else with Doxygen
I am trying to document a header file which has different "overloads" when parsed by C or C++.
#ifdef __cplusplus
/// myfuncA
void myfuncA();
/// MYMACRO_A
#define ...
- 4,941
2
votes
0
answers
35
views
How can I get doxygen to see a member function declared via macro+include?
Here is a github repository with a minimal reproduction of my problem: https://github.com/Remi-Coulom/doxygen_test
The source code is two files. A.cpp:
#include <stdint.h>
class A
{
public:
/...
- 3,761
0
votes
0
answers
45
views
Trying to create a static resources repo in Bazel, how do you reference an exported file from one repo in another?
How do I reference an exported file from one repo in another? As an example -
# works - I can run this and see header.html in bazel-bin - so it can find it
genrule(
name = "copy_data_files&...
- 395
0
votes
1
answer
97
views
Include file with doxygen special commands
Does doxygen have a special command to include a file into a source file and doxygen treats the included file as if it were directly in the source file?
Both variants shall generate the same output. ...
- 55
-2
votes
1
answer
107
views
Best practice for code snippet in doc comment for C project? [closed]
I'm familiar with Rust, and recently I'm going to write a C project. In Rust, we usually embed some code snippets as usage examples directly in the doc comment. However, I found this hard to be ...
- 1,225
0
votes
0
answers
31
views
Pythonic Doxygen function signature rendering
given the python function:
@staticmethod
def check_for_conflicting_method(
this_scope: Scope, target_scope: Scope, new_function: Asts.FunctionPrototypeAst,
...
- 491
2
votes
0
answers
60
views
Doxygen support for python decorators
is there any possibility to document functions whith the @property decorator using doxygen?
class someClass:
"""! @brief My Example Class """
def __init__(self, name: ...
- 48
3
votes
0
answers
102
views
Can Doxygen generate architecture documentation from C code?
When approaching a new code, even for embedded software written in C, it is common to face a large number of big files, with no/scarce/wrong comments.
In this situation, to have a basic understanding ...
- 87
0
votes
0
answers
51
views
Doxygen hide compound reference for Namespace
The following option in the Doxyfile can be used to hide the trailing "Class Reference" text from a page title.
# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then Doxygen will
#...
- 61
1
vote
0
answers
101
views
Forward declared C struct typedef does not get recognized correctly by Doxygen
It seems Doxygen (1.13.2) still has some issues handling C typedefed structs even if I use the TYPEDEF_HIDES_STRUCT = YES option. (setting OPTIMIZE_OUTPUT_FOR_C has no effect on this either)
This one ...
- 978
0
votes
0
answers
30
views
How to make doxygen expand macros to include function calls in call graphs, etc., with clang
I am on Oracle Linux 9 (based on Redhat). Have built doxygen from source with clang support
cmake -Duse_libclang=ON -G "Unix Makefiles" ...
$ doxygen --version
1.13.2
Have turned on the ...
- 1
0
votes
1
answer
76
views
Group pages under a top level tree item in Doxygen
I have many .h files that only contain documentation about a topic. They all show nicely in the tree menu in Doxygen output. I am hoping to add one extra layer of grouping but haven't figured out the ...
- 12k
1
vote
0
answers
48
views
how to share the variable between doxygen and plantuml
I would like to define some variables and use them in .dox and plantuml in .dox. Is it possible to do that?
Currently, I defined the same variable at both places, Doxyfile and .pu to use the variable ...
- 1,337
1
vote
1
answer
133
views
How to have Doxygen give warnings about files that have no doxygen documentation/comments in the file?
I’m using Doxygen v1.9.8 (tested it with 1.13.1 with the same results) to document a C project, and I want it to warn me when files are missing documentation.
It does warn me if its partially ...
- 11
0
votes
0
answers
35
views
MOxygen ignoring elements when converting Doxygen documentation to Markdown
I am currently writing a documentation, part of it is the technical documentation generated from the code. As my final output is in Markdown format (for MKDocs), I am using a combination of Doxygen ...
- 1,820
1
vote
1
answer
152
views
Is there a way to check the doxygen comment is the same for the declaration and the definition?
In my team we have a design-by-contract approach to our C++ code, which we express through our Doxygen comments.
We write a Doxygen comment at the top of each function declaration, explaining what its ...
- 3,114
1
vote
1
answer
46
views
Doxygen update Class Detailed Description if Q_OBJECT present
Let's say I have the following class
/**
* @brief Brief description
*
* Longer description
*/
class MyClass: public QObject {
Q_OBJECT
public:
/**
* @brief CTOR
*/
MyClass()...
- 107
0
votes
0
answers
31
views
Show function definition on class page and topic page
Is is possible to set up Doxygen so that the detailed function definition blocks are shown on both class and topic pages?
Say I had the following class, with Doxygen comments above the method foo(). ...
- 61
1
vote
0
answers
78
views
Doxygen link to Topics page
How does one link to an auto-generated Doxygen page such as Topics or Namespaces? Typically, I would link to a page by defining its anchor and then using \ref as described here, but this is not ...
- 61
0
votes
0
answers
43
views
Semi-manual Doxygen callgraph
I'm using Doxygen to document a MATLAB codebase. Doxygen doesn't support MATLAB natively, so I am using the m2cpp.pl filter developed by Fabrice. The filter is good, but not good enough for Doxygen to ...
- 61
1
vote
1
answer
44
views
How to define exclude folder in Doxygen - which pattern to use
I'm having issues defining a path to exclude any folder in Doxygen called “_Build” in project's. I've tried /_Build/, **/_Build, _Build. But only direct absolute path works, but I really don't want to ...
- 4,144
1
vote
1
answer
128
views
Doxygen cannot see `m2cpp` filter inside of container
I am trying to automate the Doxygen documentation build for a MATLAB library using BitBucket pipelines. Doxygen doesn't support MATLAB natively, so I am using the m2cpp.pl filter developed by Fabrice. ...
- 61
0
votes
0
answers
95
views
CMake DOXYGEN_INCLUDE_PATH with all target include directories
I have a CMake project which is in essence a project with nested projects (i.e.: add_subdirectory is used for the various sub directories, and each can define a nested project or component). This is ...
- 107
1
vote
1
answer
300
views
doxygen documentation deployed successfully to GitHub Pages but getting 404 page not found error
I am trying to build the Doxygen documentation and publish it to GitHub Pages. Generally, I build the static HTML and CSS files, generate them, and push them with the repository. Then, I use a custom ...
- 73
0
votes
0
answers
57
views
How to make doxygen generate full list of fields in class diagram
I want to generate UML class diagram using doxygen from C++ sources, but for some reason some of the fields were added into connecting edge and not into main class box.
Source code is simple like this:...
- 2,416
1
vote
0
answers
149
views
sphinx+breathe doxygenfunction only works for the function has declaration?
I am new to sphinx and breathe, and I try a simple project
I add the index.rst
.. doxygenfunction:: main()
:project: MyCProject
.. doxygenfunction:: add(int, int)
:project: MyCProject
.. ...
- 131
1
vote
0
answers
74
views
How to insert (contents of) one .dox file into another?
Say I have two additional documentation files, main.dox and subsection.dox. I would like to include the contents of subsection.dox into main.dox. Can this be done with doxygen?
I do not want it as a ...
- 562
1
vote
1
answer
62
views
Ignore Doxygen trailing comments within function
I am using ST's RFAL library which has many comments on the definitions that are trailing the value.
Example:
#define RFAL_ANALOG_CONFIG_LUT_SIZE (87U) /*!< Maximum number of ...
- 80
0
votes
0
answers
35
views
Doxygen ignores NO_DIAGRAM
I'm documenting a C++ project with Doxygen and I want the dependency graph to only include my header file, not other libraries. I have it like this:
#ifndef CJT_ROBOT_HH
#define CJT_ROBOT_HH
#include &...
- 11
0
votes
0
answers
28
views
Reuse a line or a block of text without creating dummy code
In Doxygen, how to reuse a line or a block of text?
Suppose I write the following in some file:
/**
* \magicCommand{magicLabel}{this is some text that I want to show.}
*/
Then, when I write the ...
- 1,790
0
votes
1
answer
50
views
doxywizard fails to produce output while doxygen works
Using version 1.12.0 under Ubuntu 24.10, I configured a new project with doxywizard following the docs. I started the executable from command line:
$ ~/mark/doxygen-1.12.0/bin$ ./doxywizard
Other ...
- 5,355
0
votes
0
answers
43
views
Generating Doxygen for a software component inside big monorepo
I work with a project with "big" monorepo of mostly C++ code.
It is organized into multiple components inside, able to link/call each other.
If I generate single Doxygen for everything ...
- 724
0
votes
0
answers
47
views
How to make Doxygen ignore function-like macro?
I have multiple classes defined as follows:
class MyClass : public virtual Parent
{
MY_INTERFACE(MyClass, Parent)
void someFunction();
}
Doxygen does not see the contents of such classes (...
- 41
0
votes
0
answers
123
views
Doxygen "no matching class member" when using alias of template specialization
I'm new to using doxygen and can't figure out why I'm getting warnings in my project, which contain some weird templates/aliases. For info I just downloaded the most recent version 1.12.0 and still ...
- 41
0
votes
1
answer
16
views
Hide definition in a prototype of the declaration section
I have a C header file like this:
/*! @file */
/*!
Does something.
@param a The A.
*/
extern void meow_mix(int a) __MEOW;
__MEOW is defined by the build system.
I want to hide it from the Doxygen ...
- 7,655