c - 如何使用 doxywizard 正确记录具有结构返回类型的函数？

Question

尽管我已经到处寻找我认为可能找到答案的地方，但我无法弄清楚如何正确记录函数“struct Entity * NewEntity()”，以便在 doxywizard 运行时显示记录。

它只是一直告诉我:“警告:文件entity.h的成员NewEntity()(函数)没有记录。”

但是，代码是:

/***********************************************************************************************//*
* @fn   struct Entity* NewEntity()
*
* @brief    Initialises single entity.
* @return   null if it fails, else finds empty spot in entity manager to use to make a new entity
* @author   br66
* @date     3/30/2017
**************************************************************************************************/
struct Entity* NewEntity()
{
    int i;

    for (i = 0; i < 255; i++)
    {
        if (_entityM[i].m_active == 0)
        {
            // clear that space, just in case there's anything left over from its last use
            memset(&_entityM[i], 0, sizeof(struct Entity));

            _entityM[i].m_active = 1;

            // any entity defaults? stay tooooooned

            _entity_max_recorded++;

            return &_entityM[i];
        }
    }

    return NULL;
}

阅读文档，它告诉我要确保头文件已记录，但它没有更改任何内容，我仍然收到该警告。

Answer 1

您有两个评论区。 /****...***//* @fn... */

doxygen 不会查看第二条评论。

doxygen 注释 block 应以额外的 '*' /** @fn... */ 开头。