3,224 questions
2
votes
0
answers
117
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
0
votes
0
answers
55
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
2
votes
1
answer
76
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
45
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
24
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
0
votes
2
answers
82
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
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
0
answers
37
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
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
1
answer
93
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
0
votes
0
answers
27
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
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
1
vote
0
answers
98
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
1
answer
73
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
1
answer
128
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
1
vote
1
answer
148
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
0
votes
0
answers
27
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
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
127
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
1
vote
1
answer
289
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
1
vote
0
answers
146
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
1
answer
61
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
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
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