I am a big fan of Doxygen which I have used for years with various languages. In particular, I appreciate its wiki-like ability to include images and run the Graphviz dot generator to have arbitrary inline diagrams from inline DOT code or external files. RDoc has diagramming support to generate class diagrams using Graphviz but I can't ...
I'm using doxygen to generate an API reference from source code, aiming to convert it into a CHM help file and eventually into a plugin for Eclipse. Unfortunately the default ordering and nesting of the classes, namespaces, etc. in the Table of Contents is not exactly ideal and I'd prefer to customize it if possible. By default, doxygen...
To be precise: I know how to dox enums at the point of declaration, I want to dox them out-of-line instead. I want to keep the header file free of doxygen comments; they're all in the .cpp file. This is not a problem for functions, classes, typedefs and so on. I can also document the enum itself like this: /*! \enum MyClass::MyEnum ...
Right now I get an error message saying: No file _formulas.aux. ... ! Missing $ inserted. ... I've tried looking for and single @f$ tags in the code, but I have not been successful in locating the culprit thus far. How can I go about solving this specific issue? In addition, what are some general tips for debugging latex errors in do...
Looking for something similar to Modelmaker that was for Delphi. Showing dependecies of modules. Any help is appreciated. Doxygen has been great so far. If someone know if it's possible to achieve what I want with Doxygen, then please let me know :) ...
I want to create a docset for my API that looks and works like the Apple Core Library docset. For example, look at the page for NSString. I've tried Doxygen and I've tried headerdoc2html. Neither does very close to what I want. The files generated by headerdoc don't have most of the higher-level structure that the Apple files do, and t...
Public c++ header files must be provided with a lot of comments. It is hard to format and wrap doxygen comments. Does some formatting tool exists? With features like auto wrap lines on 80th character, easy visual function grouping. Ideally documentation writer prepares a documentation separately, then inject it into or link using doxyta...
I have very strange problem with Doxygen: I used it to create documentation from XML tags of my C# code as suggested in some other StackOverflow question. Basically heres the situation: //file: Foo1 public class Foo1 { public enum Bar { Bar1, Bar2 } } //file: Foo2 public class Foo2 { public enum Bar {...
I'm using Doxygen with some embedded C source. Given a .c/.h file pair, do you put Doxygen comments on the function prototype (.h file) or the function definition (.c file), or do you duplicate them in both places? I'm having a problem in which Doxygen is warning about missing comments when I document in one place but not the other; is ...
I have lines in header files that are like: public: //! @name Constructor / Destructor //@{ //! Constructor. CP_AboutBox( CP_Application_Imp *inOwnerApp ); virtual ~CP_AboutBox() throw(); //@} //! @name Instance //@{ static CP_AboutBox *Instance(); //@} //! @name Display //@{ ...
Could someone tell me what is wrong with this code so doxygen cannot handle? /*! \file Enumerator.h \brief Implements an Enumerator pointer for accessing linked list elements. */ #pragma once #ifndef __MSCL_ENUMERATOR_H__ #define __MSCL_ENUMERATOR_H__ namespace MSCL { /*! \typedef Enumerator Pointer to linked list data structu...
Which is the correct doxygen format for PHP comments? #1 /** Create HTML for tags * @param string @tags */ #2 /** * Create HTML for tags * @param string @tags */ #3 /**! Create HTML for tags * @param string @tags */ ...
What does the main argument of the following statement explicitly mean? The manual says Doxygen supports only partially PHP. I would like to know what this means explicitly, since I could not find an answer to it in the homepage. ...
How can you ignore files by Doxygen similarly as by Git's .git/info/exclude? Doxygen generates docs for me based on 3rd party codes such Email -component and of my Git -repo, which I do not want. I need to keep the files where they are. ...
I run this command unsuccessufully doxygen -w latex headerFile styleSheetFile project.doxy ...
How can you make this \"{a} to present a with dots in Doxygen? My files are full of the character \"{a}. It should be universal encoding for a with dots. However, it is clearly not the case. My encoding is UTF-8 at the moment. The symbol works with the encoding in Vim. ...
How can you document components of your code such as the following effectively when the source codes of the components are in different locations? Example of my components in my first database project homepage - user_bar, check_login_status ask_question - form_ask_question login - form_login question_id - (form_login), form...
Am having trouble having the class heirarchy place the classes in the same package under the same node. For some reason currently this is what I get: |-q.r.s.t +-a.b.c.d |---a.b.c.d.e <---This is a class part of the a.b.c.d package |-a.b.c.d.f <-- Even though this is also part of the same package this class for some r...
Kate features a very handy shortcut (Ctrl+D) to apply single- and multi-line comment to the selected region of text. How can I configure Kate to apply doxygen style comments in C/C++ source files? /** * reduces the channel complexity * args: None * returns: None */ void Channel::reduce(); ...
Which Doxygen option can completely disable sorting members by type (Private / Public / Method / Variable), and output members purely based on the order in which they were declared? ...