Fix: [Script] doxygen_filter is very strict about DOXYGEN_API usage #9351

glx22 · 2021-06-11T14:13:02Z

Motivation / Problem

Some api documentation is not generated. This is due to doxygen_filter.awk outputting incomplete files.

doxygen_filter.awk expects #endif /* DOXYGEN_API */ to detect the end of a conditional block.
(Seems script_text.hpp was parsed fine by luck)

Some things are not automated, and forgotten often. This list is a reminder for the reviewers.

The bug fix is important enough to be backported? (label: 'backport requested')
This PR affects the save game format? (label 'savegame upgrade')
This PR affects the GS/AI API? (label 'needs review: Script API')
- ai_changelog.hpp, gs_changelog.hpp need updating.
- The compatibility wrappers (compat_*.nut) need updating.
This PR affects the NewGRF API? (label 'needs review: NewGRF')
- newgrf_debug_data.h may need updating.
- PR must be added to API tracker

Fix: [Script] doxygen_filter is very strict about DOXYGEN_API usage

3ddf821

TrueBrain approved these changes Jun 11, 2021

View reviewed changes

glx22 added the backport requested This PR should be backport to current release (RC / stable) label Jun 11, 2021

glx22 merged commit ee5f233 into OpenTTD:master Jun 11, 2021

glx22 deleted the api_doc branch June 11, 2021 14:40

TrueBrain removed the backport requested This PR should be backport to current release (RC / stable) label Oct 3, 2021