3,227 questions
2
votes
1
answer
50
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,057
0
votes
1
answer
30
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 ...
- 354
0
votes
0
answers
16
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
128
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,901
2
votes
0
answers
34
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,772
0
votes
0
answers
35
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
28
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
96
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,215
0
votes
0
answers
25
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,
...
- 481
2
votes
0
answers
40
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
75
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 ...
- 61
0
votes
0
answers
34
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
#...
- 33
1
vote
0
answers
79
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 ...
- 976
0
votes
0
answers
21
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
34
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 ...
- 11.9k