How to give description for directory in Doxygen

Question

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?

Dd you have a look at the manual chapter regarding "special commands" and in particular the paragraph about \dir? — albert, May 18 '16 at 07:55
sorry , just now i seen definition of "\dir" in Doxygen special commands... Now i can able to give description for directory... thank u @albert — sivakarthik, May 18 '16 at 09:15
yes , with the help of Doxygen \dir command , we can provide description for directory... — sivakarthik, May 18 '16 at 09:21

score 1 · Accepted Answer · edited Mar 20 '20 at 13:41

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.

How to give description for directory in Doxygen

1 Answers1

Linked