Я работаю над документированием большой библиотеки кода (ANSI C, а не C ++), и у меня есть специфичный для платформы заголовок для каждого из моих целевых устройств (различные встроенные устройства и Win32).
IЯ хотел бы задокументировать typedefs и макросы, которые должны определять эти заголовки, и я подумал, что он будет прекрасно работать после прочтения документации в других местах раздела руководства по Doxygen.Я добавил документацию к общему файлу platform.h, который # включает заголовок платформы цели.
Мои заголовки платформы цели (например, platform_win32.h) включают в себя разметку @file и отображаются, как и ожидалось в файлесписок.Когда я щелкаю файл, он отображает список typedefs и макросов, но он показывает только описания для , уникальных для этого заголовка .Любые макросы / типы, которые появляются в нескольких заголовках, не документированы.
Есть идеи, что я могу с этим сделать?Мне бы очень хотелось, чтобы описания появлялись в нескольких файлах.Это какая-то проблема с пространством имен?
EDIT (информация для Йенса):
Вот сумасшедшая вещь - у меня есть два макроса, задокументированных рядом в platform.h.Тот, который появляется в platform_foo.h, появляется в списке глобальных переменных, но тот, который появляется в platform_win32.h и platform_bar.h, не появляется в списке.
Ни одна из документации по макросам не появляется вplatform.h представление файла, которое имеет смысл, поскольку макросы и typedefs не используются в этом файле - он просто содержит документацию.
Интересно: я только что нашел справку HTML, и она указана в globals_0x78.html (0x78 = 'x', первая буква имени макроса).Теперь я думаю, что это может иметь отношение к пространствам имен.Глядя на исходный файл HTML, я вижу его в списке group_name::MACRO_NAME.
. Позже рассмотрим - время для другой встречи.