2012-12-18 13 views
10

Enum öğesinin gerçek değerini doxygen çıkışında almak istiyorum. Mesela Ben:Sayısal değerleri css değiştirmeden göstermek için doxygen almak için bir yol var mı?

///MyEnum 
typedef enum My_Enum 
{ 
MY_ENUM_0,///<MY_ENUM_0 
MY_ENUM_1,///<MY_ENUM_1 
MY_ENUM_2 ///<MY_ENUM_2 
} My_Enum; 

çıktısı:

MyEnum. 
Enumerator: 
MY_ENUM_0 
     MY_ENUM_0. 
MY_ENUM_1 
     MY_ENUM_1. 
MY_ENUM_2 
     MY_ENUM_2. 

İstediğim geçerli: benzer

Enumerator: 
MY_ENUM_0 
      0 MY_ENUM_0. 
MY_ENUM_1 
      1 MY_ENUM_1. 
MY_ENUM_2 
      2 MY_ENUM_2. 

Ya da bir şey. doxygen kullanma

cevap

0

, biz belgelenebilir:

  • her değer

ait

  • bir açıklama Aşağıdaki kod parçası bir anlatır enum
  • Onun değerleri Yukarıdaki 3 için örnek.

    /*! \enum My_Enum 
    * Documentation of the enum type. 
    */ 
    
    typedef enum My_Enum { 
        MY_ENUM_0, /*!< Document the value 0 */ 
        MY_ENUM_1, /*!< Document the value 1 */ 
    } My_Enum; 
    
    /*! \var My_Enum MY_ENUM_0 
    * The description of the MY_ENUM_0. Can contain its enumerated name */ 
    
    /*! \var My_Enum MY_ENUM_1 
    * The description of the MY_ENUM_1. Can contain its enumerated name*/ 
    

    Ayrıca makro/enum genişleme doxygen açıklamaların içinde gerçekleşmesi DEĞİLDİR beri unutmayın. Herhangi bir doxygen yorumu içinde kullanılırsa, INPUT_FILTER kullanılarak genişletilmeleri gerekir. Örneğin:

    • ///< <comment>
    • :

      INPUT_FILTER = sed /MY_ENUM_0/0 
      

      Ayrıca
      typedef enum My_Enum { 
          MY_ENUM_0, /*!< MY_ENUM_0 */ 
          ... 
      

      birden doxygen ilgili ayrıntılar yorumlama tarzları için bu answer Ödemeye aşağıdaki kod parçacığı için gereklidir

    • /*!< <comment> */
  • +3

    Bu soruya cevap vermiyor. MY_ENUM_0 değeri 0'dır, ancak cevabınızdaki kod tarafından üretilen doxygen dokümanı içinde görünmez. –

    +0

    Doxygen comnent '/ *! TheCodeArtist

    +4

    Kendiniz "0" yazdınız çünkü OP, Doxygen'in "0" ı nasıl üreteceğini soruyor. –

    İlgili konular