I'm working on a C project that has seen many different authors and many different documentation styles. I'm a big fan of doyxgen and other documentation generations tools, and I would like to migrate this project to use one of these systems. Is anybody aware of a tool that can scan source code comments for keywords like "Description",...
I develop an open-source Objective-C framework, and I use Doxygen to generate the documentation (http://dysart.cs.byu.edu/CHDataStructures). Overall, Doxygen does a nice job, but I have a perennial annoyance that I can't figure out for the life of me. I use the \name command and Member Groups to group methods by task (these Apple docs s...
Hi, I have set SOURCE_BROWSER = NO and VERBATIM_HEADERS = YES because I want clients to be able to see the header files, however I only want to allow them to see certain headers. How is the best way to do this. Thanks in advance for any help! csmithmaui EDIT: SOLVED! I actually just figured out one way to do it. EXCLUDE_PATTERNS ...
Does someone know a tool, that can extract the code structure from undocumented xsl files? I know there is XSLTdoc, which can extract documentation elements from xsl files to build html reference pages. But for undocumented xsl files, XSLTdoc's output is rather useless. Doxygen is able to produce valuable output even if the code is not...
Is there any way to change the version in a comment block? For e.g. const char VER[] = "1.2.3.4"; /** * \version (VER) */ I know how to do this with preprocessing and I was wondering if there were any other way? On a related note, how do you guys handle changing version numbers in documentation, the application, etc. without chan...
I'm having issues with Doxygen recognizing namespaces and modules. I believe the issue surrounds whether to place the \addtogroup within the namespace or outside the namespace. Example 1, outside the namespace: /*! * \addtogroup Records * @{ */ //! Generic record interfaces and implementations namespace Records { //! Describe...
Has anyone tried embedding Doxygen comments within Lazy C++ source files? Any problems? Where do the Doxygen comments go after generating the header/source files? ...
hi Is it possible to document configure.ac such that doxygen can pick up embedded comments and produce documentation for options, variables, etc. in generated manuals? Thanks ...
I'm trying out the Atomineer addin to document my c++ code, and I want to use the DocXML format that VS uses in csharp code. I can create the comments, but running doxygen over the project directory always results in warnings like this: Warning: documented function `bool CBaseItem::ValidateInterval' was not declared or defined. All fun...
While doxygen seems to be good at indexing a large C++ project, I have some major gripes with it. The generated output is ugly and poorly organized. Just finding a function in doxygen websites is generally a pain. Slow turnaround on finding markup errors. i.e. I have to index my whole project to find I used the wrong syntax on some fun...
I have the following code: /// \file Doxygen_tests.h /** * * \enum Tick_Column_Type * * \brief Values that represent Tick_Column_Type. **/ enum Tick_Column_Type { TC_OPEN, ///< Opening price TC_HIGH, ///< High price TC_MAX, ///< Required as last enum marker. }; /** * * \struct Tick...
I have a several html pages explaining different parts of my code, and I've recently ran Doxygen on it as well. I would like to add links to my current html pages under the Doxygen'd "Related Pages" page. Is there a way to do this other than manually inserting them? ...
I'm using Doxygen to generate documentation for my code. I need to make a PDF version of this and using Doxygen's LaTeX output appears to be the way to do it. However I've run into a number of annoying problems, and not knowing anything about LaTeX previously haven't really got much of an idea on how to approach them, and the countless ...
Is it possible to document preprocessor defines in Doxygen? I expected to be able to do it just like a variable or function, however the Doxygen output appears to have "lost" the documentation for the define, and does not contain the define its self either. I tried the following /**My Preprocessor Macro.*/ #define TEST_DEFINE(x) (x*x) ...
I've done enough Googling to know that if I have something like class SubObject { public: //blah blah blah }; class Aggregate { public: boost::shared_ptr<SubObject> m_ptr; }; I can get Doxygen to create the "correct" collaboration diagram if I have a dummy declaration like namespace boost { template<class T> class shared_ptr {...
Hi, I would like to display all the classes within a given directory (and its subdirectories) from the doxygen generated documentation. I could use doxygen /addtogroup and other group commands, but I would like to do this without having to add group tags for each classes within a given directory. the SHOW_DIRECTORIES options does gene...
Does anybody know of a python module to parse a doxygen style C++ comment string? I mean a string like this (simple example): /** * A constructor. * A more elaborate description of the constructor. * @param param1 test1 * @param param2 test2 */ and I would like to extract the brief, the long description, the parameter...
I use Doxygen to generate docs for my objective c code. Up to now though, I haven't been able to find any guidelines for how to correctly document properties. Examples I've looked at do it every conceivable way. Some people document the variables themselves, some people document the @property declarations. Some use //, while others u...
Is there any way to configure doxygen to include the log from svn for a file as part of the output. Basically we enter pretty rigorous log messages into svn when we do commits, and I'd like those messages to have a section inside the doxygen output. ...
I am currently starting using doxygen to document my source code. I have notice that the syntax is very heavy, every time I modify the source code, I also need to change the comment and I really have the impression to pass too much time modifying the comment for every change I make in the source code. Do you have some tips to document m...