2017-05-08 3 views
0

Bien que j'aie cherché partout où je pourrais trouver ma réponse, je n'ai pas réussi à trouver comment documenter correctement la fonction "struct Entity * NewEntity()" pour qu'elle soit documentée quand doxywizard s'exécute.Comment documenter les fonctions avec le type de retour struct correctement en utilisant doxywizard?

Il ne cesse de me dire: "avertissement: membre NewEntity() (fonction) du fichier entity.h n'est pas documenté."

Pourtant, le code est:

/***********************************************************************************************//* 
* @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; 
} 

lecture de la documentation, il me dit de vous assurer que le fichier d'en-tête est documenté, mais il n'a rien changé et je reçois encore cet avertissement.

Répondre

1

Vous avez deux blocs de commentaire. /****...***/ /* @fn... */

Le deuxième commentaire n'est pas regardé par doxygen.

Un bloc de commentaire doxygen doit commencer par un '*' supplémentaire /** @fn... */.