Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Doxygen does not find files when specifying Source directory

Tags:

doxygen


Hello,

I try to use doxygen to generate code documentation from a set of folders. My folder structure is like this:

+root
+-include/
+-include/subdir/file.h
+-src
+-src/subdir/file.cpp
+-Documentation/doxygen.config

Then in the configuration file I have the following settings in the "default" configuration file (Which is stated in the documentation and other questions here):

INPUT                  = "../include" "../src"
RECURSIVE              = YES

The problem is that when running this configuration, the HTML output does not contain any documentation whatsoever. When I add all individual files like

INPUT  = "../include/subdir/file.h"

to the input, it does generate documentation for those files. Is there an additional setting in the default configuration that I need to include in order for doxygen to find the files and create documentation?

I'm using doxygen 1.8.4 on Linux Ubuntu (12.04 LTS).

Thanks in advance for any hints or tips.

like image 825
Jan Jaap Avatar asked Aug 15 '13 09:08

Jan Jaap


People also ask

How long does Doxygen take?

Doxygen takes about 12 hours to run on our code base. This is primarily because there is a lot of code to process (~1.5M lines).

How do I exclude a file in Doxygen?

Doxygen provides two configuration options to exclude certain files and directories from being indexed: EXCLUDE and EXCLUDE_PATTERNS . Note that these need to be specified in a format that is counter-intuitive to what is common among software tools. EXCLUDE is used to specify files that need to be excluded.


2 Answers

You can just simply do ../root instead of declaring both ../include and ../src

Also make sure you don't put quotes around the full absolute path, for it works just fine without those.

Make sure recursive is set to YES as you did.

Putting in the directory to the INPUT tag worked for me.

like image 96
steveohmn Avatar answered Sep 19 '22 14:09

steveohmn


I am not sure if you still need this, but I have been struggling with this for some time and found the solution (at least for me)!

Leave the INPUT empty and set the RECURSIVE tag to YES. I am not an expert maybe someone else that knows these tags better can give a better answer, I just stumbled on the solution

At the very top of your source files, place:

/// \file

This tells Doxygen to include it in the HTML and it will show up in the files tab.

like image 29
Gijs Avatar answered Sep 22 '22 14:09

Gijs