Список необъявленных функций списка кислорода

Question

Я хочу задокументировать ассемблерный код с помощью Doxygen, и моя идея состоит в том, что я определяю ассемблерные функции с помощью \ fn. Но Doxygen не перечислит эти функции, потому что не может найти объявление.

Я нашел эту ветку Doxygen: принудительно задокументировать необъявленные функции , но я не могу объявить эту C -функцию, потому что если я это сделаю, мой ассемблер не будет собирать мой файл. Есть ли способ заставить Doxygen перечислить функции, задокументированные с помощью \ fn, хотя они не объявлены?

Пример кода:

/*
 * \fn void pinSetup(int pin)
 *
 * \param pin   pin number
 */
pinSetup:
    mov r1, r0
    ...

Answer 1

Хитрость заключается в том, чтобы предоставить больше «кода» для doxygen, чем для компилятора.

Например, определить фиктивное определение, всегда истинное при построении с doxygen:

PREDEFINED = IN_DOXYGEN

И в некотором C коде добавьте поддельную функцию, подобную этой:

#ifdef IN_DOXYGEN
/**
  Doc for pinSetup.
  @param pin   pin number
*/
void pinSetup(int pin) { /* Implemented in asm */ }
#endif /* IN_DOXYGEN */