Spesifik Doxygen Uyarılarını Bastırma

Question

Diğerleri bu soruyu daha önce sormuş gibi görünüyor. Sadece bir cevabın bulunup bulunmadığını kontrol edip görmek istedim.

Aşağıdaki durumla ilgili birkaç olayım var: çeşitli işlevleri belgelediğim için bazen bazı işlev parametrelerini belgelemek istediğim ancak başkalarını değil de durumun içine giriyorum. Örneğin, Doxygen belgelerine self_explanatory parametre ekleme

/** 
* This is the brief description for the function. 
* And here is the detailed description. 
* @param foo This parameter is not self-explanatory and needs a blurb 
*/ 
void some_function(void *foo, int self_explanatory) { 
    // function does stuff 
} 

sadece dağınıklığı ekler, bu yüzden oldukça dışında bırakmak istiyorum. Bununla birlikte, Doxygen parametrenin belgesiz olduğunu uyarır. Eclox kullanıyorum ve umurumda değil, bir sürü uyarının olması can sıkıcı.

EXTRACT_ALL   = YES 
WARNINGS    = YES 
WARN_IF_UNDOCUMENTED = NO 
WARN_IF_DOC_ERROR = YES 
WARN_NO_PARAM_DOC = NO 

uyarılar hala oluşturulur:

Şu anda, benim doxyfile aşağıdaki seçenekler ayarlanır sahiptir.

Bir seçenek, sorunlu kodu çevreleyen @cond ve @endcond eklemektir, ancak bu durumda işlevlerim için belgelerin hiçbiri üretilmez. Belgeleri istiyorum, sadece uyarıları değil. uyarılar kapalı kod bloğu oluşturulmaz ki aradığım Ne

... ...

/** @nowarn 
* This is the brief description for the function. 
* And here is the detailed description. 
* @param foo This parameter is not self-explanatory and needs a blurb 
* @endnowarn 
*/ 
void some_function(void *foo, int self_explanatory) { 
    // function does stuff 
} 

şey gibidir.

Diğer SO sorular buldum:
Suppressing Doxygen warnings
Suppress doxygen warning for undocumented member function, but leave synopsis in place
Is it possible to choose which Doxygen warning to show?

Answer 1

Sadece self_explanatory parametresini belgelemek, veya uyarılar vardır sadece aklınızda bulundurun: uyarılar. Tüm Doxygen size, gözden kaçırmış olabileceğiniz bir şey olduğunu söylüyor.

Uyarıyı alabilir veya göz ardı edebilirsiniz. Bu uyarıyı gerçekten bastırmak istiyorsanız, bağlandığınız ilk konuya bakmak isteyebilirsiniz. Spesifik olarak, https://stackoverflow.com/a/25137529/3121160.