Questions tagged [doxygen-addtogroup]

28 questions
28
votes
2 answers

Documenting namespaces with Doxygen

I'm having issues with Doxygen recognizing namespaces and modules. I believe the issue surrounds whether to place the \addtogroup within the namespace or outside the namespace. Example 1, outside the namespace: /*! * \addtogroup Records * @{ …
4
votes
1 answer

How to mirror C directory structure using Doxygen groups?

I need some basic help using Doxygen on C code. All basic docs are coming out fine, and I want help structuring the big long long list of files and functions. I have a C source tree which looks like this: src/ +--util/ +--file1.h …
David Kennedy
  • 321
  • 1
  • 3
  • 9
4
votes
1 answer

Doxygen groups and modules index

I am creating a Doxygen document for my project. Recently, I have grouped related classes using \addtogroup tag. After this, I have got a module tab in my documentation. It shows all modules. I want to add some description right below module name…
cppdev
  • 6,833
  • 13
  • 40
  • 45
3
votes
2 answers

doxygen defgroup results in empty group

I have a C++ class implementation file which has some constants. The constants appear before the class method implementations. I want to group the constants together. My groups and descriptions show up in the Modules tab, but the groups are all…
Simon Elliott
  • 2,087
  • 4
  • 30
  • 39
3
votes
1 answer

Putting images side by side On Doxygen

I am trying to put several images on my main page of the Doxygen file but had no luck finding an answer online, Doxygen puts the two pictures on top of each other. Is there any way to make it side by side?
JimBamFeng
  • 709
  • 1
  • 4
  • 20
3
votes
1 answer

Doxygen: warning end of file while inside a group from array creation

This issue is due to doxygen parsing constraints. I am using doxygen 1.8.11 with Eclox (the eclipse plugin) in Kinetis Design Studio for embedded C development. Almost all of the doxygen compiling works, except I need to have a few very large…
Andysics
  • 33
  • 3
3
votes
2 answers

C and doxygen - removing duplicates of variable documentation

I'm documenting my C code with doxygen. For better readability I group documentation of every .c/.h file pair (sometimes also more files) with defgroup and addtogroup (see doxygen in c: grouping of defines). The file pages look fine, but on the…
Bytemaster
  • 83
  • 1
  • 9
2
votes
0 answers

Does doxygen have better filter for JavaScript?

I know that Doxygen doesn't support JavaScript files. I have also looked at js2doxy.pl script and also this: Documenting JavaScript with Doxygen The first option(js2doxy.pl) is not producing relevant C++ code, it is also skipping all the prototype…
1
vote
1 answer

Doxygen are not collecting all \todo in global todo list

I have a problem with doxygen. Not all my \todo are collected in the global todo list, but most of them. I have made a simple C-example with a single source and header file, as well as a configuration file, where i have placed todos everywhere i…
1
vote
1 answer

How to hide private class declaration on doxygen documentation

class class1: public: ... private: class impl; //the class that i wanna hide std::unique_ptr impl_; //my doxygen file: EXTRACT_ALL = YES EXTRACT_PRIVATE = NO EXTRACT_PACKAGE = NO EXTRACT_STATIC =…
1
vote
1 answer

How to generate Doxygen documents from DSL language

I want to generate Doxygen document for my DSL(Domain Specific Language). As my DSL language is totally different from C,C++,Java languages. Basically mine is eclipse plugin project and we are developing IDE for DSL language in that i want to…
1
vote
0 answers

Do not include custom markdown pages as top-level pages when including them as subpage?

I include markdown files in my groups in doxygen like so: /** * @addtogroup foobar "Foo Bar" * @{ * @subpage doc_foo_bar */ And they show up in the module documentation as requested. But anyways, they show up as normal top-level-pages, like…
musicmatze
  • 4,124
  • 7
  • 33
  • 48
0
votes
1 answer

In Doxygen, how do I overwrite a group title to remove the group warning saying "ignoring title %s that does not match old title %s"?

P.S. I am a doxygen newbie. I have a few .c and .h files with a doxygen group format looking like this: /** \addtogroup