doxygen, belgelenmemiş işlevlerin oluşturulmuş xml'den çıkmasını mümkün mü?

Question

Sadece oksijen yorumları olan kodlar için belge oluşturmak istiyorum. . Ben 1.8.9.1 bir Doxyfiledoxygen aracılığıyla v oluşturulan ve sadece xml ve tüm belgesiz kodunu gizlemek için çıkışa bunu yapılandırmış: ben belgelenmiş ve biri ile basit c başlığını test.h oluşturulan sonra

GENERATE_HTML   = NO 
GENERATE_LATEX   = NO 
GENERATE_XML   = YES 
HIDE_UNDOC_MEMBERS  = YES 
HIDE_UNDOC_CLASSES  = YES 

olmayan belgelenmiş fonksiyon tanımlamaları:

void foo(int a); 

/** 
* "bar" function description 
* @param b sample param 
*/ 
void bar(int b); 

ben sadece bar belgelerine umuyordum doxygen yürüterek xml çıkan dahil edilecek. Ne yazık ki, her iki işlev için de belge üretilir. Sadece oksijen yorumları olan ya da xmldoxygen çıkışı için dokümantasyon oluşturmak mümkün mü?

Answer 1

Daha fazla okumadan önce EXTRACT_ALL'un NO olarak ayarlandığından emin olun.

Aşağıdaki çözümün hayranı değilim ama işe yarıyor. Kullanım kendi dokümanlarında bir ÖNTANIMLI makro ayarlamak zorunda ama en azından doxygen benim sürümünde bu ihtiyaç duyulmadı, önişlemci

#ifdef PROJECT_NO_DOC 
void foo(int a); 
#endif /* PROJECT_NO_DOC */ 

/** 
* * "bar" function description 
* * @param b sample param 
* */ 
void bar(int b); 

Not doxygens.

PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS 

sonra tüm bloklar

sürece Doxygen tarafından atlanan edilmelidir yapılandırma dosyasında: Onların belgeler bu şekilde gizli ve konulmalıdır bloklar etrafında set a predefined macro in the config to do it for you

#ifndef DOXYGEN_SHOULD_SKIP_THIS 

/* code that must be skipped by Doxygen */ 

#endif /* DOXYGEN_SHOULD_SKIP_THIS */ 

yapmak belirtmek

ENABLE_PREPROCESSING = YES 

Başka yöntemler de vardır, ancak ek kısıtlamalarla birlikte gelirler, yani genel dokümanda statik yöntem görünmediğinden emin olmak için EXTRACT_STATIC ila NO.