Doxygen isn’t generating descriptions for files

by

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

  • Which version of doxygen are you using? What is in $relpath and in $copyright? When the \file command is in the same file as the file it documents it is not necessary.

    – 

  • @albert Doxygen’s version is 1.9.8. I think both variables are empty. I deleted both \file and \copyright. They were both automatically as WinCC OA files are created by default like this

    – 

  • and what happens now ?

    – 

Leave a Comment