I'm using Doxygen to generate documentation for my (C++) code, and am wondering if there is a tool that would give me a list of all functions/methods for which the current Doxygen markup doesn't describe all the arguments (or describes too many)? Maybe this is already included in Doxygen? (in which case I couldn't find the feature !) ...
My team is starting to document our C code using doxygen, paying particular attention to our public API headers. There appears to be a lot of flexibility and different special commands in doxygen, which is great, but it's not clear what's a good thing and what's a bad thing without trial and error. What are your favourite ways to mark ...
I like doxygen to create documentation of C or PHP code. I have an upcoming Python project and I think I remember that Python doesn't have /* .. */ comments and also has its own self-documentation facility which seems to be the pythonic way to document. Can I just use doxygen? Anything particular to be aware of? I have done some coding...
How do I Configuring DoxyGen to document ActionScript files? I've included the *.as and *.asi files in doxygen's search pattern, but the classes, functions and variables don't show there. ...
I am using Doxygen to generate HTML documentation from my code. However I find that default stylesheet has quite poor choice of fonts and layout. I know I can write my own CSS file to get exactly the output I want, but before I spend my time on it, I am wondering if there are any decent custom stylesheets already available. ...
Doxygen is a bit slow - it takes about a couple of minutes to process my whole project, so for small incremental changes this is longer than actually building the rest of my code. There are thousands of files without any documentation so I guess it is spending most of its time processing them. Is there any way to get it to skip files wit...
I have some C++ source code with templates maybe like this - doxygen runs without errors but none of the documentation is added to the output, what is going on? /// /// A class /// class A { /// /// A typedef /// typedef B<C<D>> SomeTypedefOfTemplates; }; ...
I am generating doxygen documentation for my (fairly small) project on each build. I did the following to accomplish this: Added the index.html, which doxygen generates, to the project Specified a Custom Build Step for this file (not the whole project) Command line: doxygen ../doc/Doxyfile Outputs: ..doc/html/index.html Additional Dep...
I just realized from an article in CACM that Doxygen works with Java (and several other languages) too. But Java has already the Javadoc tool. Can someone explain what are the pros and cons of either approach? Are they mutually exclusive? Is there a Maven plugin for Doxygen? ...
I'd like to use Doxygen to document legacy code that's a mix of C and x86 assembly language. The assembly language is not inline, but in separate assembly-only files. What is the recommended way to deal with the assembly language portion? ...
I noticed that doxygen uses the graphviz library for creating diagrams. Have you ever used graphviz for generating documentation? Is it worth learning the graphviz for documentation purposes outside the scope of doxygen? Or am I better off to sticking with a standard data modeling package like Visio? I understand the merits of it as a g...
The common sense tells that the Doxygen comment blocks have to be put in the header files where the classes, structs, enums, functions, declarations are. I agree that this is a sound argument for a libraries that are mean to be distributed without its source (only headers and libs with object code). BUT...I've been thinking of the exact...
Can Doxygen create the HTML documentation as a single, very long file? I want something like the RTF output, but as HTML. The reason: I need my API published as a single, printable, document. Something that can be loaded into Word, converted to PDF, etc. Thanks. ...
I have a collection of legacy C code which I'm refactoring to split the C computational code from the GUI. This is complicated by the heavily recursive mathematical core code being K&R style declarations. I've already abandoned an attempt to convert these to ANSI declarations due to nested use of function parameters (just couldn't get th...
Hi, I am trying to figure out if there is a way to create a custom tag using Doxygen. I did find the ALIAS config line but that does not do exactly what I need. Basically in code I want to be able to write something like /// \req Requirement #322 - blah blah And then have Doxygen create a list like it does for BUG and TODO comman...
The html documentation generated by doxygen for enums lists the enum to the left and the documentation to the right. However I need quite detailed documentation for each value and some of the names are very long thus making the right column with the documentation appear far out to the right and it looks very bad. Is there no possibility ...
I used to use doxygen lot for C++, and really like the ability to document function and method arguments inline using ///< , or variations. Conversely I really dislike having to repeat arguments in the comments when not using the inline style (as most over code doc systems only support). So recently I've been setting up doxygen with my ...
Hello, I am using doxygen to generate documentation for our API, written in csharp. However, it exposes private/protected members. Is there a way to hide those? I fugured out how to hide files: EXCLUDE = List of file names Yet, I need more granularity and thus shield users from unnecessery API noise. A sample dyxyge...
Is there doxygen documentation of the Boost libraries somewhere on the web? I could create my own, but I think it should already exist somewhere on the web? Thanks! ...
I'm running doxygen (1.5.8) on a C# project off of Visual Studio 2008 on a Windows machine running XP. While generating the latex code, some illegal sequences are included. It always involves the following sequence: "" (a latin-i with a dieresis, something like the binary shift operator, and a Spanish open-question-mark). I've seen it...