2011-10-17 16 views
13

"Parametre sonrasında" işlev parametreleri için belge kullanırsam, örneğin her parametre için //!< kullanın, üstbilgide @param yerine "Parametreler" Bölüm, oluşturulan çıktı dosyasında her zaman "İade" sonra yerleştirilir.doxygen function parametre belgeleri (//! <Vs @param)

Siparişi "Parametreler" "İade" öncesinde yerleştirilecek şekilde tanımlamak mümkün mü?

/** 
***************************************************************************************** 
* @brief  Test API 
* 
* @usage  This API can be called at any time 
* 
* @return  0 if successful; or 1 if failed 
****************************************************************************************/ 

int TestAPI(
    int argument1,  //!< first argument 
    int argument2  //!< second argument 
    ); 
+0

"Üyeden sonra" belgeleri nerede belgeleniyor? – To1ne

+0

+1, tam olarak aradığım şey, ve ayrıca //! <[In] ilk giriş argümanı yönünü de gösterebiliriz, aynı zamanda Int TestAPI'den sonra dönüşü de satır içi (// \ return 0 ise başarılı olur .. –

cevap

15

Sadece Doxygen 1.7.5.1 kodunuzu denedik, ve kod ile, çıkışta Parametre listesi Dönüş açıklamasında sonra gelir doğruladık. //!< tarzı @param ile tüm parametrelerin isimlerini tekrar belirlemek zorunda daha güzel olduğu gibi

Bu

, bir utanç: Ben olmadığını görmek için, Doxygen Bugzilla bug database bir bakış vardı

/** 
***************************************************************************************** 
* @brief  Test API 
* 
* @usage  This API can be called at any time 
* 
* @param  argument1 first argument 
* @param  argument2 second argument 
* 
* @return  0 if successful; or 1 if failed 
****************************************************************************************/ 

int TestAPI2(
    int argument1, 
    int argument2 
    ); 

o nispeten yeni bir hataydı (daha sonra eski bir yüklemeye geri dönmeyi deneyebilirsiniz).

Doxygen Bug 316311'u bulduğuma inanıyorum: Eylül 2005'te raporlanan ve düzeltilmemiş olan 'satır içi yorumlar kullanarak dokümantasyonundan sonra parametre belgeleri.

Maalesef, sorunuzun cevabından korkuyorum Siparişi "Parametreler" "İade" öncesinde yerleştirilecek şekilde tanımlamak mümkün mü? sayılı

Düzenleme

Ben sadece bunun için soran Doxygen Bug 316311 bir not ekledim ONAYLANDI = Statüsüne değiştirilmesi neredeyse kesin olduğunu.

+1

kesinlikle kabul edilir – Michael

İlgili konular