FAQ Database Discussion Community


how to add table of contents to doxygen generated html file?

markdown,doxygen,toc
I have a C-project documented with doxygen and want to add a table of contents that shows the sections and subsections. I tried the \tableofcontents and the [TOC] as described in the doxygen manual, but nothing happens. Here is a small example: /***********************************//** * \file Bsp.c * \brief example *...

How can I exclude a method inside a class with doxygen

objective-c,doxygen
I am using Objective-C language. And I have 3 classes: Chicken, Dove, Dog. Each of class has run method. Chicken.h -(void)run; Dove.h -(void)run; Dog.h -(void)run; I want to exclude run method inside Dove class. I found that EXCLUDE_SYMBOLS can do that. But if I set configuration : EXCLUDE_SYMBOLS = save,...

doxygen misrendering macro type as public member function

c,macros,doxygen
I'm using a type macro list(type) which expands to a dynamic type [ list_of_type ] like below : main snippet ... #define list(type) force_append_macro(list_of_,type) ... typedef struct _improperlydocumented { list(char_ptr) *words; }improperlydocumented; ... problem doxygen is incorrectly rendering this type [ list(char_ptr) ] as a public member function ( instead...

Customize treeview in Doxygen

treeview,doxygen
I am trying to use Doxygen for the first time and so far I am pleased with most things. You can say the manual I am creating consists of two parts: one that is built up using .dox-files containing general information about the product; then part two is built from...

How to build LLVM doxygen in HTML ? I tried but failed

clang,llvm,doxygen
I want to get a copy of the doxygen web-pages of llvm, so I can work with it without the internet. I did as follows: $ cd LLVM_ROOT_DIR $ mkdir out $ cd out/ $ ../configure --enable-doxygen $ make ENABLE_OPTIMIZED=1 But it only built llvm without documentation. I also tried...

Doxygen. How can I exclude more than one file?

doxygen
In my configuration file where EXCLUDE = ./fileToBeExcluded and it works fine, but if I want to exclude more files, there is no way. I have tried: EXCLUDE = ./fileToBeExcluded ./fileToBeExcluded2 EXCLUDE = ./fileToBeExcluded, ./fileToBeExcluded2 EXCLUDE = ./fileToBeExcluded EXCLUDE = ./fileToBeExcluded2 Any suggestions?? Thank you...

Doxygen last enum member not documented

c++,c,enums,doxygen
I have an enum that uses member grouping to set the members values all at once in a group. Here is the code : /** MP format tags * * See the DC-007_E Specification. * 5.2.2.3 Table 3, page 13 */ typedef enum { /*MP Index IFD*/ ///@{ ///Mandatory MPTag_MPFVersion...

How to use Doxygen and Doxygen::Filter::Perl to generate documentation for Perl sub routines?

perl,doxygen
I am trying to figure out how to use Doxygen::Filter::Perl to generate documentation for Perl files. I am starting with a very simple file just to see if I can get it to work (test_doxygen.pl): #! /usr/bin/env perl #** @file test_doxygen.pl # @brief Testing Doxygen using Doxygen::Filter::Perl # # Description...

How can I regenerate a class url in doxygen?

doxygen
I am using doxygen to generate documentation for a program. Now I would like to link the generated documentation in another website/program (totally independent). My idea is to generate a URL as same as doxygen generated, e.g. My class name is Models.PMF.Phen.GenericPhase, and doxygen generated url is class_models_1_1_p_m_f_1_1_phen_1_1_generic_phase.html. I don't...

X-macro breaks doxygen callgraph

c,doxygen,x-macros
I have 3 files: test.c int table[] = { #define X(val) val, #include "test.x" #undef X }; void level2(void) { level3(); level4(); } void level3(void) { level4(); } test2.c void level1(void) { level2(); level3(); level4(); } void level4(void) { } test.x X(1) X(2) X(3) I use doxygen to create callgraphs...

Doxygen \cond not working

comments,doxygen
I am writing some documentation of some software in a .dox file and wand to include some comments that will not show in the webpage. I am using \cond but I am not getting any output after calling \endcond. /// \section cuboids_sec Cuboids /// /// \cond /// [TODO] /// \endcond...

How could I “dry” common documentation for common methods through several C++ classes?

c++,doxygen
I'm using doxygen for documenting a C++ library. Let's say I have several classes A, B, C, etc., which share a common set of methods A::m1(), B::m1(), ...etc. The methods essentially do the same thing in each class. I want a single implementation of those common methods. An alternative is...

Doxygen interpreting C code as C++

doxygen
Im using doxygen 1.8.6 on trusty. The problem is that it shows no content at all except for structs. No functions or variables. It also includes Classes tab in the html output which is for cpp. How can i tell doxygen to interpret my code as C code?

How to generate CHM with Doxygen and HTML Help Compiler?

c++,doxygen,chm,doxygen-wizard,html-help-workshop
The short story: I can generate a CHM file with Doxygen. Launching the CHM file, I observe that the Contents and Index tabs do list the pages, namespaces, classes, and members of those classes. However, clicking on the items in those Contents and Index lists do not display any content....

Output Full File Path to HTML with Doxygen

doxygen
I am creating a test list in Doxygen using the \test special command. I understand that I can click on the class name for that section and get taken through to the page that this test is in reference too. What I would like however is in the test description...

Visual Studio multiple projects C# and C++ documentation

c#,c++,visual-studio,documentation,doxygen
I have a Visual Studio 2013 Solution with multiple projects (C++, C#). So I have different comment styles in the C# files I'm using the XML style. /// <summary> /// Comment /// </summary> In the C++ files I'm using these comments. /*Comment*/ Now I tried to create a documentation with...

Doxygen does not generate links to methods without explicit classname

c#,documentation,doxygen,static-methods,call-graph
I am using Doxygen 1.8.9.1 to generate some html docs for my C# code. The problem is Doxygen does not seem to understand method calls to methods in the same Class unless you explicitly type the class name before the method name. In this example class I have 2 identical...

Automation of documenting code base using Doxygen plug in Jenkins CI environment

jenkins,doxygen,jenkins-plugins
I use a shell script to create/run doxygen doxyfile to document my code base which works absolutely fine(Schedule runs and recursive scan code base also works fine). Now my requirement is to do the same job using Jenkins CI. I added doxygen plug which generates documentation output and stores the...

Could not find Doxygen (missing: DOXYGEN_EXECUTABLE) in Mac OS X

osx,doxygen
I want to install meta on my Mac OS X. I have OS X 10.9.3, and I received the following errors: DICU_ROOT=/usr/local/opt/icu4c -- Compiler supports C++1y (using it) -- Could NOT find Doxygen (missing: DOXYGEN_EXECUTABLE) -- Locating libc++... -- Located libc++, using it. -- Locating libc++'s abi... -- Found libc++abi,...

Doxygen group warning: end of file inside a group

c,module,grouping,doxygen
I am attempting to use a doxygen(v1.8.9.1) @defgroup comment in a C header file that finishes with an @{ as follows: /** @file foo.h * @brief This is a foo file */ #ifndef FOO_H_ #define FOO_H_ #include somebar.h /** @defgroup foo Foo * @details This foo file does foo stuff...

Doxygen parse const member function incorrectly when const at another line

c++,coding-style,doxygen
I've tried searching stackoverflow and users mailing list in the official website but not found something useful to my problem, there are a lot of results unrelated... Doxygen I used is version 1.8.5. I prefer to style my member function declaration like this, let's call it const-at-another-line style. ReturnType FunctionName()...

C++ private class member variables doesn't appear in the documentation

c++,doxygen
Class is documented as follows: /** * @brief Number representation */ class CNumber : public CElem { /** @brief Holds true for negative values */ bool neg; ... However, the variable documented in the code doesn't appear in the documentation (class brief shows fine...). What am I doing wrong?...

how to get graphical class hierarchy if we are having texture class hierarchy with doxygen

doxygen
I used the multiple inheritance in C++ classes and for documentation I used doxyWizard.In doxygen, I am getting only texture class hierarchy for my project. I have set GraphViz Package=true Graphical_Hierarchy=YES Class_Graph=YES Include_Graph=YES COLLABORATION_GRAPH=YES But I did not get Graphical Class Hierarchy. ...

Naming a doxygen @ref

syntax,documentation,doxygen,documentation-generation
How would I go about naming a Doxygen @ref tag? I have tried the following: See @ref hello_world hello for more information Which outputs this: See hello_world hello for more information Where hello_world is linked to hello_world. I am looking for this output: See hello for more information Where hello...

using doxygen for java with Doxywizard

java,doxygen,doxywizard,doxygen-wizard
Doxywizard Doxygen not scanning the packages for java files Need help on Doxygen/Doxywizard These are my Doxywizard settings: Working directory from where doxygen will run: C:/Program Files/doxygen In 'Wizard' tab, the below values are set. Source code directory: C:/workspace/git/employeeapp/src/main/java Destination directory: C:/Doxy-docs/1 In 'Expert' tab, under Topics-'Build' , selected the...

C++ function pointer as parameter in Doxygen

c++,doxygen
I have a situation where I need to document the bsearch() signature in Doxygen. That signature looks like this: void * __cdecl bsearch ( const void *key, const void *base, size_t num, size_t width, int(__cdecl *compare)(const void *, const void *) ) The problem I am having is how to...

Generating separate consecutive Note entries with Doxygen

doxygen
Suppose I'm writing a Doxygen comment like so /** * \brief Foo * \details FooFooBar * \note Note1 goes here * \note Note2 goes here */ Note1 and Note2 are rendered as two paragraph of the same Note section. I would like them to the two separated Note sections one...

Using git with Doxygen FILE_VERSION_FILTER

git,version-control,doxygen
What command would be used with git for the doxygen FILE_VERSION_FILTER? The output would preferably be the number of times that file as been revised in the repo.

Unable to Document Header File with Doxygen

documentation,doxygen,documentation-generation
I'm attempting to generate documentation for a header file that just contains some constants and I'm not able to generate it. As suggested in the doxygen manual, I've tried adding the @file keyword to a comment block and still no luck. What am I missing? Here's a snippet: MyFile.h /**...

Comment a file in Doxygen

c,doxygen
I have a C header for which I want to write an introductory comment. Like this: /** * @brief Provides stuff for my great program. */ #ifndef MYHEADER_H #define MYHEADER_H #define __USE_GLIBC #endif Furthermore, I have this Doxyfile: FULL_PATH_NAMES = YES TAB_SIZE = 8 OPTIMIZE_OUTPUT_FOR_C = YES RECURSIVE = YES...