CODEWITHSUNDEEP
doxygendoxywizard
sivakarthik
sivakarthik

Reputation: 57

How to give description for directory in Doxygen

I am working with Doxygen to document my project. I know, by using the below Doxygen commands, we can give a description for source files.

/**
* \file example.cpp
* \brief Implementation of example functions 
*/

Is there any way to give a description for a directory/folder in Doxygen?

Upvotes: 4

Views: 2503

Answers (1)

Phil
Phil

Reputation: 6174

Use the \dir doxygen command. I asked a similar question how to link to documentation of directory in which I show

/// \dir cpp/vtutil 
///      
/// \brief Brief description of the dir cpp/vtutil goes here
/// 
/// \details A more detailed description goes here.

This works to provide documentation of the directory. In my original question, I was having trouble using \ref to link to the directory documentation. After more digging and experimenting I was able to get it to work. I commented in my answer that Doxygen is pretty forgiving or flexible with the path used when documenting a directory with the \dir command, but it is rather picky when referencing it with the \ref command.

Upvotes: 2

Related Questions