如何评论头文件？

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了解它？现在它只是将最高评论分配给第一个函数.

这就是它的样子

Answer 1

Doxygen有一个\file命令,它将注释块标记为记录某个文件.用作时\file filename.ext,它会将其分配给文件filename.ext.只是\file,它适用于发生它的文件.

例:

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