doxygen

Doxygen-like equation writing in html

Doxygen has the ability to produce code with inline equations with LaTeX (I am a TeXnician). I want to do the same thing just for html pages. How can I achieve this? What does doxygen use to achieve it? ...

Is it possible to use SandCastle with Visual Studio 2008 and C++ (non-CLI)?

Hi, I'm mystified: I'm using Visual Studio 2008 with C++ (non-CLI), and I can't for the life of me work out how to build the help file with Sandcastle. Once its installed, and its generating an .xml file, shouldn't there be a menu option somewhere to switch on the build of the docs? Or at least a menu option to trigger the build of the...

Doxygen for procedural programs

I have some large, mostly procedural codes that need to be well documented. This generally involves repeated use of a number of functions that must be executed in a certain order. Doxygen is a great product, but it seems very oriented towards documenting OOP codes. Does anyone have any tips on how to use doxygen in a natural way to docu...

Doxygen a Switch

I have quite a large switch statement (or equally a large if statement) that I would like to document some how in Doxygen, perhaps in it's Caller Graph, or maybe in a some Flow Chart format. How can I achieve this ? Thanks ! ...

Doxygen/Objective-C : how can I make constants that are declared outside the class definition show up in the class docs?

Hi, I'm using Doxygen to document some Objective-C code. I have some constants declared outside the class definition. I want these to show up in the class docs. How can I make doxygen include them? (Using \file just shows them in a separate documentation page). #import blah blah /** * This is my constant */ extern NSString*constant...

Doxygen and \dontinclude on same file?

I'd like to use doxygen to comment code line-by-line just like in the \dontinclude example, but I want to do it within the file, not in a completely separate file as in that example. So taking the doxygen example, something like this: /** \dontinclude thisfile.cpp * Our main function starts like this: * \skip main * \until { ...

Integrate ivy and doxygen

Is there a way to integrate ivy and doxygen? I want to publish my doxygen docs through ivy is that possible? And if so how? Is there documentation for how to? ...

Visual Studio: Syntax highlighting for Doxygen-style C++ comments

Hi all! I want enchanted syntax coloring in comments for C++ language in Visual Studio 2010. For example, I have the following code: /*! \sa testMeToo() \param a the first argument. \param s the second argument. */ int testMe(int a,const char *s); In Visual Studio all \param, \sa and other Doxygen commands are not h...

Can Doxygen be integrated with Netbeans C++?

I've been reading up on Doxygen online, and I think I'd like to try it out on my Netbeans C++ projects. The problem is, I cannot find any tutorials/guides anywhere to how to get Doxygen working with Netbeans. I've found some blog posts that seem to be about using Doxygen in Netbeans, but they seem semi-feature requesty, and I cannot tell...

Doxygen and Visiblity Keywords in PHP

I am finding that in PHP if I do this: class Foo{ /** * Does something cool * @return * Always returns 1 */ public function bar() { return 1; } } doxygen will not document the member function 'bar' If I take out the 'public' keyword, it does. Is there some setting that controls this? I've l...

boost doxygen documentation

hello I have been trying to generate doxygen documentation for boost, as a way to browse source tree and have man documentation. However, doxygen has been running for past week or so on IBM power5, and I have no idea how much longer (right now I am on boost_1_43_0/boost/mpl/). Is there prebuilt doxygen documentation, if not, is there a...

How to define own doxygen comment styles?

I would like to know whether it is possible to define own doxygen comment styles. The usual style is something like this (Javadoc-like): /** * * Descriptions and stuff * */ or (when using Qt): /*! * * Descriptions and stuff * */ I would prefer something like /*!=============================================================== * ...

How does Sandcastle Conceptual Help compare to Doxygen Pages?

Sandcastle has a fairly complex XML MAML for generating Conceptual Help, as discussed in a nice intro from 2007. How does this compare to Doxygen in terms of ease of writing content and control over generation of the pages? I am a big fan of using the Doxygen page facility to write such conceptual help including discussions of design is...

Differentiation between const and non-const versions of methods in C++

I have a few questions regarding differentiation between const and non-const versions of methods in C++. Example: MyObject* MyClass::objectReference() const MyObject* MyClass::objectReference() const My questions are: Is there any way at all to differentiate between which version of the method is called manually? Or is it ful...

Doxygen tricks, how to remove File Documentation?

I need to produce a report for a project which I've heavvily commented with Doxygen. Like here I'm experimenting some troubles. Since the report must be at most 8 page long, I hacked the documentation make command as follows: report: (cat doc/Doxyfile ;\ echo "GENERATE_HTML=NO" ;\ echo "GENERATE_LATEX=YES" ;\ echo "I...

C++ meta-programming doxygen documentation

I am documenting some code which uses meta-programming heavily, for example: template<rysq::type A, rysq::type B, rysq::type C, rysq::type D, class Transform> struct Kernel<meta::braket<A,B,C,D>, Transform, typename boost::enable_if< quadrature<meta::braket<A,B,C,D>, Transform> >::type> : Eri <Transf...

Doxygen javadoc-style tag description spanning multiple lines

In a C++ project I'm using doxygen and the javadoc style for documentation. I'm fairly new to javadoc and am not sure whether this type of thing is valid. /** * ...stuff... * @return foo foo foo foo foo. Foo foo * foo foo foo foo foo. */ i.e. the information for what is being returned (and my question applies to all tags) needs to...

Scripting Xcode documentation with DOxygen problems

Hi I am trying to use the following script by duckrowing (http://www.duckrowing.com/2010/03/18/documenting-objective-c-with-doxygen-part-ii/), to document an existing xcode project. # # Build the doxygen documentation for the project and load the docset into Xcode # # Created by Fred McCann on 03/16/2010. # http://www.duckrowing.com...

Doxygen structural command for methods

Hi I have a protocol in a header file with several methods. I am using Doxygen to document the APIs. What I am trying to do is to put the Doxygen comments 'outside' of the protocol, so as to enable readability of the whole protocol without the comments. Doxygen has a structural command for protocol so i can put something like this at t...

doxygen doesn't show dependencies between static and public functions

HI, I am trying to document my C# code using doxygen. The problem is that the dependencies between static functions and public/private function are not being shown. Where as, those between public/private are being shown correctly. Can anyone help me in this matter? Pasting the config here along with some example code: #----------------...