Doxygen Hakkında

Başlatan yamak, 19 Mart 2015, 13:26:48

yamak

Merhaba arkadaşlar,
Fonksiyonların başına aşağıdaki gibi block comment eklemenin otomatik bi yolu var mı?Doxygen ile yapılabilir mi?
/**
  * @brief  Initializes the DMAy Streamx according to the specified parameters in 
  *         the DMA_InitStruct structure.
  * @note   Before calling this function, it is recommended to check that the Stream 
  *         is actually disabled using the function DMA_GetCmdStatus().  
  * @param  DMAy_Streamx: where y can be 1 or 2 to select the DMA and x can be 0
  *         to 7 to select the DMA Stream.
  * @param  DMA_InitStruct: pointer to a DMA_InitTypeDef structure that contains
  *         the configuration information for the specified DMA Stream.  
  * @retval None
  */

Burak B

#1
Bu verdiğin zaten Doxygen' in işlemesi için kullanılan comment şekli. Bunu otomatik oluşturmak istiyorsan bu daha çok kullandığın IDE ile alakalı. Kimi IDE' ler klavye kısayolları ile otomatik olarak bu türden commentler ekleyebiliyor. "/**" karakterlerini klavyeden girdiğinde otomatik tamamlama bu commenti eklemiyorsa IDE desteklemiyor olabilir. Mesela Eclipse bunu destekliyor.
"... a healthy dose of paranoia leads to better systems." Jack Ganssle

yamak

#2
Hocam IAR'da nasıl yapılır.Doxygen benim fonksiyonları bulup fonsiyonun başına bu tarz bi template ekleyebilir mi?

Burak B

    Doxygen' in görevi comment eklemek değil kodda oluşturduğun bu tip commentlerden dökümantasyon oluşturmak. Doxygen senin için dökümante edilmemiş elemanlardan boş comment blokları oluşturabilir ama yine bunları doldurmak sana kalıyor. Bunun yanında bunu doxygen için yapan araçlar da olabilir internetten bakmak gerek.

Bu linki bir incele;
http://www.doxygen.nl/helpers.html

  IAR kullanmıyorum. IAR için nasıl yapılır bilmiyorum. Ancak dediğim gibi Eclipse' de kod yazarken fonksiyonun üstünde /** yaparsan otomatik oluşturuyor Eclipse bu yapıyı.
"... a healthy dose of paranoia leads to better systems." Jack Ganssle

yamak

Hocam şimdi IAR da her tür fonskiyon için boş template'ler oluşturdum.Fonksiyonun yazdıktan sonra ctrl+alt+v ile oluşturduğum özel template'i fonsiyonun başına ekliyorum.
Verdiğiniz link için teşekkürler.Onu da bi inceleyeyim.