Hangi Doxygen uyarısının gösterileceğini seçmek mümkün mü?

Question

Doxygen, bina için bir Compound ? is not documented. uyarısını gösterir. Belirli bir proje için Bileşik belgelemek istemiyorum. Dağınıklığı kaldırmak için bunun dışındaki tüm diğer uyarıları görmek istiyorum. Doxygen çıkışını temizlemenin bir yolu var mı?

Answer 1

Bunun mümkün olduğunu düşünmüyorum, ancak kendi işlemcinizi Doxygen çıkışını filtrelemek için yazmanız yeterli. Senin durumunda, bu çok zor olmamalı, basit grep yeterli olmalıdır:

doxygen <config_file> | grep -v "warning: Compound .* is not documented" 

Doxygen bu özelliği sağlamaz Gerçekten neden emin değilim: belki de çok fazla seçenek gerektirecektir veya daha karmaşık seçenekler. Diğer bir olasılık ise, bir şey belgelenmediğinde uyarılmak istediğinizden, kaynak kodunda açıkça belirtildiği durumlar dışında (örneğin, \cond ve kullanarak), bu tür bir ihmalin gerekçesiyle bir istisna yapılmaması gerektiğini varsaymışlardır. sadece durum bazında karar verilmelidir. Ya da belki hiç kimse bu özelliği eklemelerini istemedi: feature request'u doldurmakta özgürsünüz.

Answer 2

Aradığınız şeyin if, ifnot ve endif komutları olduğunu düşünüyorum. Sadece uygun bir etikete karar verin ve doğru etiketi kullanın. Örn .: Bu etiketin bilir ve bunları yapmazsa, o da aynı açıklama blokta \endif komuta herhangi bir yorumda kadar görmezden edersen

/* 
* \if DISPLAY_COMPOUND 
* Compound doc. 
* ... 
* \endif 
*/ 

doxygen değerlendirecek

Sonra gerek ENABLED_SECTIONS içindeki doxyfile etiketinizi tanımlayın (veya değil).

#comment the next line if you don't want to document Compound 
ENABLED_SECTIONS = DISPLAY_COMPOUND 

\cond ve \endcond komutları bir göz hangi (onlar değil, sadece tek bir yorum bloğu bir dosyanın tüm bölümlerini etkinleştirmek veya devre dışı) oldukça birbirine benzer ancak aynı değildir çok var.

Answer 3

Doxygen konfigürasyonunda uyarıları kapatabilirsiniz. buraya bakınız: doxygen documenation

Benim favorim: WARN_IF_UNDOCUMENTED = HAYIR