I am writng the documentation for a project with Doxygen, and everything works more or less as expected, except for the description of the files. In the begining of the files I have:
/**
@file $relPath
@copyright $copyright
@author dcasado
@brief Description test
*/
But then when opening the HTML and accessing the File List, none of the files have a description. Doxygen properly understands the /** */ syntax of that document, as it hiddes that part of the code when accessing the source code of the file.
The @brief argument works fine with classes and funcions, it's only failing with files.
My files are .ctl, but mapped to .cpp type.
As I cannot copy here all the doxyfile, I'm copying only the configs I changed from the default values:
OUTPUT_DIRECTORY = D:/DCasado/Desktop
TAB_SIZE = 2
EXTENSION_MAPPING = ctl=c++
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_PRIV_VIRTUAL = YES
EXTRACT_PACKAGE = YES
EXTRACT_STATIC = YES
EXTRACT_LOCAL_METHODS = YES
EXTRACT_ANON_NSPACES = YES
RECURSIVE = YES
INPUT = C:/WinCC_OA_Proj/NaturgyCCR/NTGY_sys1/NTGYProj_sys1/scripts
SOURCE_BROWSER = YES
GENERATE_TREEVIEW = YES
I tried changing configs and reading all the configs documentation, but anything appears to be a solution. I also tried changing @brief for \brief and adding *'s at the beggining of each line. I know they are not necessary, but I really cannot undertsand why it's not working at all.
Thank you in advance
As @albert pointed on the comments, the problem was the
$relPathvariable. It was not defined and, apparently, it was blocking the proper interpretation of the rest part. So just by deleting that variable, it started to work out again. The result is: