[C++] probleme de documentation avec doxygen et les enums
Bonjour à tous
alors voila pas moyen de trouver une reponse je vous expose d'abord un code
Code:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
|
/*!
* \file test.h
* \brief This header file contains definitions of the interface
* \version 1.0
*/
class Test
{
public:
enum TEnum { Val1, Val2 };
/*! Another enum, with inline docs */
enum AnotherEnum
{
V1, /*!< value 1 */
V2 /*!< value 2 */
};
};
enum alone_In_The_Class { var1 , var2 };
/*! \class Test
* The class description.
*/
/*! \enum Test::TEnum
* A description of the enum type.
*/
/*! \var Test::TEnum Test::Val1
* The description of the first enum value.
*/
/*! \var Test::TEnum Test::Val2
* The description of the second enum value.
*/
/*! \enum ::alone_In_The_Class
* A description of the enum type.
*/
/*! \var ::alone_In_The_Class ::var1
* The description of the first enum value.
*/
/*! \var ::alone_In_The_Class ::var2
* The description of the second enum value.
*/ |
Mon problème est que aucune documentation n'est généré pour le enum alone_In_The_Class ce qui est très embêtant et pas moyen de trouver une solution sans faire un truc moche.
voici en gros la solution que j'ai trouvé:
Code:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
|
/*!
* \file SVMGRAPI2.h
* \brief This header file contains definitions of the interface
* methods that must be implemented by a SV manager and the API
* provided by SV32 to write a SV manager.
* \version 9.0
*/
/*!
* \mainpage manager API
*
* test
* \page Enumerations Enumerations
* - \subpage alone_In_The_Class Enumerates the variable types
*/
class Test
{
public:
enum TEnum { Val1, Val2 };
/*! Another enum, with inline docs */
enum AnotherEnum
{
V1, /*!< value 1 */
V2 /*!< value 2 */
};
};
/*! \class Test
* The class description.
*/
/*! \enum Test::TEnum
* A description of the enum type.
*/
/*! \var Test::TEnum Test::Val1
* The description of the first enum value.
*/
/*! \var Test::TEnum Test::Val2
* The description of the second enum value.
*/
/*!
* \page alone_In_The_Class alone_In_The_Class
*
* alone_In_The_Class contains the list of all possible alone_In_The_Class var.
*
* \par Values
*- var1: the first variable
*- var2: The second variable
*
*/
enum alone_In_The_Class { var1 , var2 }; |
le problème c'est qu'il faut tout faire à la main pour une dizaine d'enum je veux bien mais la je pars sur beaucoup plus !
[edit 11:04] petite précision, mon problème viens des enum en dehors d'une classe. ;)
Si quelqu'un a une idée je vous remercie.