How do I tell Doxygen to document public sections after a private section in a (C++) class? E.g. class Brg { public: //! this function will be documented void documentedFunction1() private: void irrelevantFunction() public: //! this function will _not_ be documented void undocumentedFunction1() }; Even w...
I am building a Qt based project, and many Qt classes are found in the target documentation. How can I tell Doxygen to disable documentation generation for some classes? For Q.*? ...
In doxygen, the standard "/// \todo stuff" is used to tag a todo item. I do most of my coding in MSVC so it's handy to be able to see the TODO's in the Task List. MSVC uses "//TODO stuff" for their tags. Is there any way to make them work together? I found the properties pane for the Task list and try to add "\todo" to the list, but ...
We've got a fairly large project written in a mix of Java and Groovy. For a variety of reasons, we're looking to switch from Javadoc/groovydoc to doxygen for our code documentation generation needs. The Java code, of course, works fine. Doxygen, however, has no native support for groovy, and google doesn't seem to have turned up a dox...
I'm using Doxygen to build an API library from C# source code. Doxygen generates a library of TEX files. My client has asked for a PDF version of this API library so I need to convert the TEX file library into a single PDF or DOCX. I've been looking into tools such as LyX, OpenOffice, and ProText but still haven't found a solution. ...
Hi, I have one file (say file1.doxy) with doxygen comments: /** * Comment block 1 */ ... /** * Comment block 2 */ ... /** * Comment block 3 */ And I want to create the file file2.doxy of which output is the same as: /** * Comment block 1 * * Comment block 3 */ Actually I want to refer to file file1.doxy from file file...
I'm trying to write some Doxygen comment blocks, and I'd like to include example snippets of code. Of course, I'd like the examples to actually compile so they don't get stale. My example.cpp (that I \include in the .h file) looks like this: #include "stdafx.h" #include "../types_lib/Time_Limiter.h" #include <vector> void tl_demo ()...
I don't have much experience with documentation tools like doxygen, so I'm not sure exactly how in-code documentation should look. Should I write doxygen-style comments for each member variable in a class? Or is this overkill if the variable names are fairly self-explanatory? Should I include the comments from a header in the correspon...
I am creating internal documentation for a C++ project using Doxygen. I am having Doxygen include the source for methods, etc, but this makes the page kind of hard to scan. I'd like it to behave like rdoc and hide the source in a block that is collapsed by default. I thought that HTML_DYNAMIC_SECTIONS might let me do this, but alas, the...
I want to exclude a class from documentation in Doxygen. Usually these classes are in files named the same, but there are many times when they are included inside other class definitions. This is mainly for classes starting with "_" or "Private". Thanks, Kris ...
How can I tell Doxygen to use the first declaration in this code: typedef struct _decor_extents { int left; int right; int top; int bottom; } decor_extents_t; Cheers, Kris ...
I'd like to add a custom command to my doxygen documentation. Basically for each C function I'm writing doc for, I need to write which global variables are "touched" in read mode or write mode. It's like the "See also" list, just with a different caption. In my file I'd like to write something like this: /* * \read-globals #var1, #v...
I'm sure there's some way to do this with the \defgroup, \addgroup and \@{ \@} tags, but after a couple of hours of trial and (obviously) error, I'm asking SO..... I have: class C { public: void foo () const; }; and I have some helper non-member functions that really are part of C's interface, but aren't in the class: std::strin...
Hi, I wanted to document my source using doxygen + pas2dox. When I set everything up, including the filter and the extraction options (extract everything), doxygen runs fine. But the generated documentation only includes the source-files as links and no types/methodes were extracted. The filtered source looks fine though. Any hints how...
I have #define values in headers that I certainly want Doxygen to document but I have others in C files that I treat as static constants and I don't want Doxygen to document them. Something as simple and stupid as #define NUMBER_OF(a) (sizeof((a))/sizeof((a)[0])) #define MSTR(e) #e How can I keep Doxygen from putting those #defines i...
A subversion repository contains the html, latex and man directories that doxygen generates from the source code. Even for small source code changes, new files are being generated with random names which makes for large changes in the version control system. Is there are way around this? How can I minimize the changesets between revis...
I have a rather odd problem with Doxygen (1.6.1 on Mac OS X Snow Leopard) in that it does not seem to document my enums no matter what I do. I am programming in C and have followed the instructions in the manual. Here is my code: /** * \enum dccp_pkt_type * \brief specifies the available DCCP packet types */ enum dccp_pkt_type { ...
Hi, Maybe someone here has an idea if that is possible at all: [Code in header] class A { public: STDMETHOD(get_ValueFromA)(BOOL *pVal); STDMETHOD(set_ValueFromA)(BOOL newVal); }; This is a [simplified] example for some COM interface code. After we finally got the macro expansion working correctly there still is the problem of...
class EXAMPLE{ public func1() private func2() func3() } I have checked for documented entities only. I have documentation for func1 and func3 but no documentation for func2. I have EXTRACT_ALL = NO EXTRACT_PRIVATE = NO EXTRACT_STATIC = NO EXTRACT_LOCAL_CLASSES = YES EXTRACT_LOCAL_METHODS = NO ...
I've a java project which needs some documentation, is Doxygen the only way to go ? I would like to document the code but also the architecture, the Makefiles, in 3 words, the whole project. Maybe I should orient myself to eclipsewiki or something like that. Any help would be appreciated. ...