Doxygen w ciałem komentuje

Question

mam jakiś kod, który chcę, aby udokumentować zw ciałem komentarzach tak:

/*! \file best.cpp 
* \brief The best 
* 
* I am the best 
*/ 

/*! \fn void theBestFunction(int) 
* I'm the best blah blah blah 
*/ 
void theBestFunction(int ever) 
{ 
    doThings(); 
    /*! 
    * Does some more things 
    */ 
    doMoreThings(); 
    /*! 
    * Checks that the things it does are the best 
    */ 
    checkBest(); 
} 

Ale kiedy biegnę doxygen na to wydaje się sformatować wewnątrz bloków na fragmenty kodu, tak jakby użyto poleceń @code lub \code (których nie było). Chciałbym, aby komentarze w treści były sformatowane jak normalny tekst.

Czy ktoś to wcześniej spotkał? Dzięki.

Answer 1

Udało mi się rozwiązać problem. Okazuje się, że w jakiś sposób Doxygen przetwarzał te bloki jako wcięte względem siebie, a wcięcie w Markdown (podobnie jak w StackOverflow) wskazuje blok kodu (http://en.wikipedia.org/wiki/Markdown#Code) . Po prostu wyłączyłem Markdown i naprawiłem problem.

Dla każdego, kto przeczyta to pytanie w przyszłości, jeśli nadal chcesz obsługiwać Markdown, uważaj, aby nie blokować komentarzy w drugiej linii - od razu zacznij komentarze.

Zmiana mojego minimalny przykład tak:

/*! \fn void theBestFunction(int) 
* I'm the best blah blah blah 
*/ 
void theBestFunction(int ever) 
{ 
    doThings(); 
    /*! Does some more things 
    */ 
    doMoreThings(); 
    /*! Checks that the things it does are the best 
    */ 
    checkBest(); 
} 

(natychmiast zauważyć początek komentarzach w-ciele, w przeciwieństwie do pierwszej pustej linii) rozwiązuje ten problem.