doxygen

c++: generate function call tree

I want to parse current c++ files in a project and list out all the methods/functions in it and then generate the function call and caller trees. F.g. you can refer how doxygen generates the call tree. I have checked gccxml but it doesn't list the functions called from another function. Please suggest me some lightweight tools (open so...

How do I link to an Objective-C category within a Doxygen comment?

Say I have an ObjC category defined as @interface NSObject (L0SomeCategory) that defines a -doSomething method that I documented. How do I link to its docs from another Doxygen block? I tried unsuccessfully: NSObject::doSomething NSObject(L0SomeCategory)::doSomething L0SomeCategory::doSomething Any ideas? ...

Doxygen comments on declarations or on definitions?

Just started using Doxygen for documenting my code here and can't decide where to put them. At first look it seems better to put them in the declaration files as it is there where you actually declare what you receive, what you are going to return and stuff like that, apart from that things like data members that are only in the decla...

Is there a javadoc-like program for C/C++?

Some people suggested Doxygen, some ccdoc, which should be more similar to javadoc but is less supported. What's your opinion? ...

Doxygen with C# internal access modifier

I am using Doxygen to generate some API docs for a C# project I am working on. I have quite a bit of "internal" functionality in this project and don't want Doxygen producing these signatures in the generated html it produces. I have tried enabling HIDE_FRIEND_COMPOUNDS but this still results in my internal classes being exposed in the ...

Documenting an existing website (symfony)

Hi, I need to document a web application which wasn't built by me. It was built in symfony. The documentation needed is code documentation, including list/description of classes, components etc and their interdependencies. At the moment the code isn’t commented much and the way it has been commented is inconsistent. I was thinking of...

how to change default font size for graphviz?

I use doxygen + graphviz for documenting my code. graphviz does a nice job of generating images. Is there any way to change the default fontsize for graphviz? The default is 14, but I want to use 12 instead. Its a real pain to change the fontsize for individual elements like, nodes, subgraphs, edges ... etc. UPDATE: For reference h...

Emacs c-mode fill-paragraph with Doxygen Comments

Hello, I have a question that is very similar to http://stackoverflow.com/questions/71788/getting-emacs-fill-paragraph-to-play-nice-with-javadoc-like-comments, but I wasn't sure if I would get many answers in a year old thread. Anyhow, I have C code that has some Doxygen comments that look like the following: /** * Description * * ...

How can I change the margins on a PDF document created by Doxygen?

Hello, I am using Doxygen to generate a PDF of my code documentation. The PDF has very big margins when using PAPER_TYPE = letter. It looks ok when using a4wide but I would like to have more control over it. I want to use a package called geometry but can't figure out where to add code like this: \usepackage[top=2.9cm,left=2in,bottom...

Algorithm to parse a config file in php (Doxygen file)

hi, I have a conf file like this: http://pastie.org/768582 and my goal is to get in an array the comments and the key/value of each keys. array( array( 'comment' => "The PROJECT_NAME tag is a single", 'key' => "PROJECT_NAME", 'value' => "JMK", ), ) I would know what algoritm do I have to use? I have already tra...

exec() or system() on doxygen command returns me "Exiting"

Itry to run this script public function execDoxygen($doxyFile) { $command = "doxygen $doxyFile"; exec($command, $output); return $output; } and the outputs is "Exiting..." if I run it separetely in a terminal with the same file it works well. If I run exec("doxygen --help") it works correctly. Why does it ...

Is there a way to continue doxygen lists across multiple comment blocks?

Basically, I'm trying to do document code along the lines of: //Description of Step 1 DoStep1_1(); DoStep1_2(); ... //Description of Step 2 DoStep2_1(); DoStep2_2(); I want the two comment blocks to turn into an ordered list in the Doxygen output. I've read the documentation on creating lists, and I understand that I can just use HTML...

Doxygen and Objective-C categories

Although the latest releases of Doxygen claim better handling of Objective-C categories, it still seems to choke on categories in my source code. I'm wondering if someone has gotten it to document categories properly. As an example, I have a category on NSString defined as: @interface NSString (CCFExtensions) with an interface file ...

Documenting variables with Doxygen in C

Code: include /* * \var int iOne * \brief Integer 1 */ /* * \var int iTwo * \brief Integer 2 */ /* * \var int iThree * \brief Integer 3 */ /** * \brief Imitates a sheep. */ void sheep(); /** * \brief Main function for test code */ int main() { int iOne, iTwo, iThree; iOne = 1; iTwo = 2; iThree = 3; p...

Doxyclean Error

I'm trying to run doxyclean but can't get it to work, any help would be appreciated... I'm running from terminal : ./doxyclean.py --input=./xml/ --output=./clean/ --name="MyProject" --phone -v I have my doxygen xml in the folder xml, in the same directory as doxyclean.py The result is : Checking arguments Cleaning XML files: Traceb...

Doxygen GUI on Ubuntu

I can't figure out how to install the Doxygen GUI (doxywizard) on Ubuntu. Where can I get it? ...

Dual purpose code commenting(users & maintainers)...HOW?

Hi, I am writing a C++ static library and I have been commenting with doxygen comments in the implementation files. I have never really had to care very much about documentation but I am working on something now that needs to be documented well for the users and also I am trying to replace my previous bad habit of just wanting to code a...

how to eclox (doxygen plugin for eclipse)

How to get eclox to work in eclipse 3.5? Im on Ubuntu 9.04. I installed Doxygen from ubuntu repositories(version 1.5.8). Then I installed eclox on eclipse through the update site. Still I don't get any option to in any menu to initiate it. Also the eclox site(eclox) doesn't seem to give any "getting started" guide. Please help. ...

Is there a standard for documenting GET/POST parameters?

In a PHP project, even when front controller logic is used for the main application, there can be many stand-alone scripts, ajax snippets and so on. Is there a standardized way - either PHPDoc or something else - to define in the first comment block of the script what GET and/or POST parameters the script will accept / require and of wh...

Doxygen latex fine-tuning ?

Hi, I've got 2 questions concerning the latex output of doxygen: How can one organize the related pages (those created by \page) ? (They seem to be organized according to the title of the page) How to specify which latex stylesheet to use ? (i've found nothing in the Doxyfile) I would like to get rid of the paragraph numbers for the cl...