3,218 questions
Score of 0
1 answer
102 views
How to @copydoc from a function that is yielded
I have a function testFixture that contains a large block of Doxygen documentation. This function is called within a test function testA that yields testFixture
Applying @copydoc testFixture or its ...
Score of 1
0 answers
59 views
Doxygen is not searching in folders that begin with a period character
I have a .build folder that contains some generated files and .dox files and I noticed that doxygen is not looking into the folder which starts with a . .
I tried doing using the doxygen.cfg and add
...
Score of 0
1 answer
32 views
Doxygen shows two sidebars in API docs
I have a Doxyfile set up for a C project. I enabled GENERATE_TREEVIEW to create a summary of functions, but now when I display a module page I get two sidebars, mostly with identical contents, one to ...
Score of 2
0 answers
41 views
How to circumvent problem with non-ASCII characters in file names?
I want to create HTML help for an existing project. Previously the source code was in a sub-directory of D:\schoening (which worked), now it is in a sub-directory of D:\Schöning. The latter doesn't ...
Advice
0
votes
2
replies
69
views
When I can download the Doxygen Version 1.15.0 from NuGet package manager?
I can not find Doxygen Version 1.15.0 from NuGet package manager. when it will be available in NuGet ?
Best practices
0
votes
1
replies
57
views
How to show include directive for global functions in Doxygen
I have a Doxygen-documented C++ project.
Class documentation works well, but I also have dozens of utility functions in a namespace. They are documented and grouped into topics, which is fine, but the ...
Score of 2
1 answer
251 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 ...
Score of 5
0 answers
218 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, ...
Score of 1
1 answer
78 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 ...
Score of 2
1 answer
204 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 ...
Score of 0
0 answers
56 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<...
Score of 0
0 answers
63 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 ...
Score of 0
0 answers
56 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 ...
Score of 0
0 answers
35 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 ...
Score of 1
0 answers
95 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 ...