A system has up to 100 VC++ projects, each spitting out a DLL or EXE. In addition there are many COM components with IDL and generated .h/.c files. What's 'the right way' or at least a good way to organise this with Doxygen? One overall doxy project or one per project/solution? And what's the right way to handle COM, which has generated...
Is there a way to use extra latex packages and/or extra latex commands with Doxygen code documentation system. For example I define the shortcut in a custom sty file. \newcommand{\tf}{\Theta_f} Then I use it about 300 time in the code, which is across about a dozen files. /*! Stochastic approximation of the latent response*/ void d...
Where can I find documentation for Qt documentation comments? I'm referring to how Qt uses a specific style for documentation comments, like so: /*! \class MyClassName \brief The MyClassName class is used as an example on Stack Overflow. This class serves a few functions, the most important being: \list \i So p...
If you have a C++ project that has a bunch of .ODL files and the generated .h files from the ODL compiler, should doxygen be told to parse both .odl and .h, or only one or the other? In general I don't like documenting generated code but IDL is sort of a special case. In any case, it seems like the member listing of ODL files is not qui...
For instance I set the source code path as c:\code\testapp\src. Is this then available as a var I can use - for instance so I can spit out a tag file in a location relative to this, not relative to the working dir of doxygen? I think I'm looking for something like how Ant defines vars for just about everything and these can be re-used; d...
In one project, some pages were added - it was a new project in which doxygen was being tested properly - adding comments & pages - rather than simply auto-generating docs from our existing code-base. The problem is when doxygen is run on the main code-base, that project's pages show up at a top level. e.g they have a main-page and som...
I have a situation where I need to nest aliases like this: /* \activate{ * \no, * \no, * \no, * \yes * \changes * - E-mail * - Is main * - Home phone * - Cell phone * - Rel...
We are going to publish API documentation on our web site. The documentation is generated by Doxygen from sources. The problem is that Doxygen generates weird file names (which is not so good for SEO). For example, for the source file RO4_Languages.h, Doxygen generates _r_o4___languages_8h.htm. Is it possible to change name of generated...
I have debugging functions that are called in just about every function of a large program. They are conditionally turned on by a defined macro variable. I don't want these showing up in call graphs, since I can be fairly sure that every function has them. Is there a way to exclude the function from the graph /*! Step 3: * @callgrap...
We are slowly moving towards better-standardized commenting in a large C++ project, introducing Doxygen. I personally find it a pain typing in comments, especially since Java IDEs are so good at automating this. So I wondered what tools there might be? A search turned up DoxyComment which looks quite nice, is this the best/standard tool...
I wasn't able to determine what the behavior of doxygen is regarding the \mainpage section, in two cases: If you specify no \mainpage section, does it use any other page instead and if so how is this picked? What if two files both specify a \mainpage section? ...
Hi, My company develops a primarily C-based API, using IDLs to define the interfaces and generate the C headers. We'd like to use Doxygen to document the interfaces in the IDLs, but we'd also like the API reference to document the C headers. In other words, the fact that we are using IDLs should be transparent to the customers of our ...
I'm just getting started with Doxygen, and have done considerable searching on this, so forgive me if there's an obvious answer. I'm working on an embedded project where functions can be tagged as debug or nodebug before the return type. In most of our libraries, we use a conditional macro to set libname_debug to either debug or nodebu...
I prefer to define certain macros inside of my struct definitions, so it's easy to see possible values for a given member. For example: typedef struct foo_t { uint16_t flags; #define FOO_FLAG_BELL 0x0001 #define FOO_FLAG_BOOK 0x0002 #define FOO_FLAG_CANDLE 0x0004 #define FOO_FLAG_LANT...
Anyone know if there is a way to importing .NET XML doc comment files into Doxygen project? I have a project that uses assemblies that that have XML comment files. I'd like Doygen to pick up that documentation and add it to my doc output. ...
By default, the first page that doxygen generates, in Rich Text Format (RTF), states: TITLE AUTHOR Version CREATEDATE I want to customize this. I've tried the following, but it customizes the section after the index, rather than the very first page of the document: /*! * @mainpage My Project * @version 0.91 * @author Jack Vance, ...
I am aware of the Trac Doxygen plugin. It allows linking to the Doxygen docs from the Trac wiki. I am looking for something that will help me automate the documentation. Since the project is huge, it is probably not possible to update the documentation on every commit especially since Doxygen doesn't do incremental documentation builds...
I'm working on documenting a large library of code (ANSI C, not C++), and have a platform-specific header for each of my target devices (various embedded devices and Win32). I'd like to document the typedefs and macros those headers need to define, and I thought it'd work just fine after reading the Documentation at other places section...
Hi all, I am using Visual Studio and an external library that is commented in doxygen-style. Is there any way to display doxygen documentation in the editor tooltip like DocXML? ...
We are using doxygen to document our code. When I have a documented function it appears in the class reference summary table as follows: FUBAR Class Reference PUBLIC MEMBER FUNCTIONS: FOO() foo description BAR() bar description I would like it to appear like this: FUBAR CLASS Reference PUBLIC ...