Używanie komentarzy do linta z doxygen

Question

W celu dokumentacji zwykle musimy utworzyć dodatkowy dokument opisujący, co zrobiliśmy, gdy jakiekolwiek wiadomości były wyłączone w kodzie (e.g. /* lint --e228). Ułatwiłoby to korzystanie z niego z doxygen (jak to stworzyliśmy w każdym razie).

Mimo to, nie byłem w stanie znaleźć żadnego rozwiązania, jak zrobić doxygen używając tych komentarzy lint. Czy ktoś próbował tego? Czy jest jakieś rozwiązanie, jak korzystać z stric '/*lint', ale w każdym razie dodać go do doxygen?

Dzięki!

Answer 1

Można to osiągnąć definiując makro, aby rozwinąć się w komentarz do wyrażenia kłaczków, ale czyniąc makro rozwinięciem do innego komentarza po rozwinięciu przez doxygen.

Sztuką jest użycie instrukcji -save PC-szarpie ^TM lub FlexeLint ^TM:

#ifndef LINT_CONTROL 
#define LINT_CONTROL(X) /*lint -save X */ //lint X 
#endif 

int main() { 
    int a; LINT_CONTROL(-e530) 
    return a != a; 
} 

Następnie w pliku konfiguracyjnym doxygen można włączyć rozszerzenie niektórych makr preprocesora. W szczególności możemy zmienić LINT_CONTROL, aby zamiast tego zamienić komentarz na doxygen.

ENABLE_PREPROCESSING = YES 
MACRO_EXPANSION  = YES 
EXPAND_ONLY_PREDEF  = YES 
PREDEFINED    = "LINT_CONTROL(X)=//! lint control: X" 

Ewentualnie, jeśli masz FlexeLint ^TM, a następnie można modyfikować owiane źródło tak że komentarz Doxygen można wykorzystać do uruchomienia kontroli włókna. Technika jest opisana na Gimpel Software Discussion Forum.

_{PC-lint i FlexeLint są znakami towarowymi firmy Gimpel Software.}