Is there a way to suppress Doxygen from giving "not documented" warnings on particular files? My project has several automatically generated code headers that cause it to throw hundreds or thousands of errors that make it difficult to sift through. ...
Hi there! I'm attempting to document class attributes using Doxygen. Currently, the protected attributes show up in the list at the top of the page for the specific class. I'd like to put an explanation for them. I've tried using @param [name] [description] both above the beginning of the class and right above the declaration of the at...
Consider I have 2 header files. // HEADER 1 /** * Doc for Foo here? */ namespace Foo { class This {...}; } && // HEADER 2 /** * Doc for Foo here? */ namespace Foo { class That {...}; } How should I handle this when documenting with Doxygen? ...
I'm working on a C++ and Objective C iPhone Project. I'm using git as my version control system. The codebase has been growing quite a bit, so I would like to add Doxygen to the project. The problem is that I'm not sure about what would be the best approach to do it. I've thought about a couple of options: 1) Create the Doxygen HTML d...
I am using doxygen for sometime. I previously generated a documentation for my source code with namespaces. It was working OK. But now I created a new project for my new sources and Doxygen does not put Namespaces tab to the documents although SHOW_NAMESPACES is YES and there are lots of namespaces in the source code. The namespace of cl...
Is it possible to document multiple enumeration/variables with the same documentation? For example: enum { /// Description of Values VALUE_1 = 0, VALUE_2 = 1, VALUE_3 = 2 }; This results only VALUE_1 getting described by the doxgen description, when in reality, I want all three values to have the same description. The onl...
Consider that I have a complex class structure where many elements inherit from other elements. I may have a method GetStuff(string stuffName, int count) defined in an interface, which is inherited by other interface, which is then implemented abstractly by an abstract class, which is then implement explicit in a concrete class etc. etc....
I'm at the beginning of a C++ project and I've been using Doxygen from the start. I'd like to know how you use Doxygen in your project, i.e. I have several questions: 1. Where do you put your Doxygen comments? Header or sources? I think that they should go to the header, because that's where I look to find out how to use methods. Howe...
I'am looking for an eclipse-plugin for doxygen code documentation. I have found the eclox-plugIn ( http://home.gna.org/eclox/ ). I would like find out, how can it automatically generate a "empty" doxygen comment, which could be filled out later or what is the better choice for a documentation eclipse plugIn? For example for a function: ...
Hello, I just started using Doxygen to generate documentation for my libraries and I found one minor glitch I can't get around. In the tree view there's the file list and you can click on one of the files and then get the source code. I found a way to get rid of the file list but then I can't see the enums anymore. Do you know any wa...
Hi, I've got the following function prototype: bool key_pressed(enum key key) const; I documented it using doxygen. Now I have an overloaded version of that function that does the same, so I wanted to copy the doxygen comment like this: /// @copydoc key_pressed(enum key) const bool key_pressed(char key) const; This does not work, ...
I currently have a couple of #define in c files that turn off some functionality to hardware for testing. However, I want to document them with doxygen when they are undefined as well. For example: This works fine: /// \def SIMULATE_SOME_HW_INTERFACE /// Define this when you want to simulate HW interface. #define SIMULATE_SOME_HW_INTE...
Hello, I'm using doxygen 1.7.1 mac gui front end. The generation of the documentation is fine except for every method in my classes it outputs 2 methods with the same signature. One is commented and the other is blank. If I take out the comments, I still get 2 methods with the same signature. Any ideas? Thanks ...
We all have the good habit of documenting our code, right? Nowadays, in-code documentation itself has a syntax. It's almost like a programming language onto itself. The questions are: What (How many) documentation syntax specifications exist? Is there a standard documentation syntax? Who is defining this standard? Is there an of...
Hi I need to document a (fairly) large project in java + jsp (1.0... don't get me start). For the middle tier (all .java classes) I just used doxygen to generate .html and .pdf documents, but my chief asked me to document and integrate the documentation of .jsp pages. AFAIK not doxygen nor javadoc are directly suitables for this job. ...
I am using Doxygen and Latex to generate pdf API document. I find that when I use "ingroup" command to put group A as a subgroup of group B, I can see group A is under group B in HTML output, but in PDF output, A and B are in same level. 5.1 Group B 5.2 Group A I am expecting: 5.1 Group B 5.1.1 Group A How do I do this? ...
Hey guys, I am programming in objc and am documenting my stuff with doxygen. Unfortunately it is not documenting my c functions only my classes and their methods. I have them defined in a .h like so: /// Returns whether the current machine is little endian based. BOOL littleEndian(void); and then I have them implemented in a .m. Does ...
I use a lot of illustrations, diagrams and equations to document C++ and python codes, and a way to do this is to inline them with doxygen. The problem is that, when coding, they are not directly available in the code (unless I use ascii-art for this purpose). Is there an automatic, quick and fast way to, while coding, view the generate...
Hi For a Qt/C++ project we will use doxygen to generate some documentation, therefore I'm searching for a "optimal" config file. One thing that I was thinking about is that you have stuff like OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_JAVA = NO OPTIMIZE_FOR_FORTRAN = NO OPTIMIZE_OUTPUT_VHDL = NO But I can't find something ...
I'm using doxygen to generate HTML documentation. I have a C++ source file that contains only global functions. All of the global functions are document, and the documentation is properly generated. For all of the headers in the project there is a link to “see the code that this documentation was generated by.” (as a link to the HTMLized...