Как комментировать файлы заголовков?

Question

/* ---------------------------------------------------------- 
** functions used for converting between different data types 
** ---------------------------------------------------------*/ 

#ifndef TYPECONVERTER_H_INCLUDED 
#define TYPECONVERTER_H_INCLUDED 


/** 
    converts binary to decimal 
    @return converted decimal number 
*/ 
int toDecimal(bool binary[], int noOfNumbers); 

/** 
    converts decimal to binary and stores it in a given array 
*/ 
void toBinary(int origin[], bool binary[], int noOfNumbers); 

#endif // TYPECONVERTER_H_INCLUDED 

Как я могу комментировать, что делает этот заголовок, поэтому Doxygen его понимает? Сейчас он просто назначает верхний комментарий первой функции.

This is what it looks like

Answer 1

Doxygen имеет \file команду, которая знаменует блок комментария как документирование определенного файла. Когда используется как \file filename.ext, он назначит его файлу filename.ext. Как только \file, он применяется к файлу, в котором он встречается.

Пример:

/** 
@file 
functions used for converting between different data types 
*/