Brug af doxygen

Doxygen : https://www.doxygen.nl/
Downkload : https://www.doxygen.nl/download.html

Et eksempel med kildetekst

Src folder list: here

Der er nederst en zip fil med hele test mappen src/aversumdoxytest.zip

Den genererede doku her src/aversumdoxytest/html/index.html
Kildeteksterne er her: her src/aversumdoxytest/html/files.html

download doxygen
installer det på dit OS
lave en test mappe på din pc
hent eksempel src/aversumdoxytest.zip og pak ud der
gå ind i den mappe hvor du finder confilg: Doxyfile
start program doxywizard og åben Doxyfil config fil i mappen
tryk Run

Nu kan du rette i kildetekst

putte info på funktioner

Du skal lave en funktiomn og en kommentar lige ovenover funktion
Kommentar skal starte i position 1 og være / vigtigt med to stjerner
kommentar afsluttes lige før funktionshoved med */


/**
@brief set ceiling priority on a mutex

   Enter mutex (eq to k_wait...)
   use k_mut_enter / k_mut_leave instead of wait and signal
   @param[in] sem aka mutex
   @param[in] timeout  timeout value
   @return 0: if you have been waiting, 1 if you just went through, -1 for
   timeout, -3 if your priority was higher than ceiling priority
 */
int k_mut_ceil_enter(struct k_t *sem, int timeout);

Jens