2017-05-08 6 views
0

doxywizardが実行されたときに文書化されるように、構造体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; 
} 

、それはヘッダファイルが文書化されていることを確認するために私に語ったが、それは何も変わっていないと私はまだその警告が表示されます。

答えて

1

コメントブロックは2つあります。 /****...***/ /* @fn... */

第2のコメントはdoxygenによって検討されていません。

doxygenコメントブロックは、追加の '*'で始まる必要があります。/** @fn... */

関連する問題