Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from Jun 11, 2021

Conversation

@glx22
Copy link
Contributor

@glx22 glx22 commented Jun 11, 2021

Motivation / Problem

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

Description

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

Limitations

Checklist for review

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')
@glx22 glx22 merged commit ee5f233 into OpenTTD:master Jun 11, 2021
15 checks passed
Loading
@glx22 glx22 deleted the api_doc branch Jun 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants