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

Improve Script API docs #12373

Merged
merged 10 commits into from
May 10, 2024
Merged

Improve Script API docs #12373

merged 10 commits into from
May 10, 2024

Conversation

frosch123
Copy link
Member

This PR includes #12372 as prerequisite.

Motivation / Problem

Description

  • Add main pages to the AI/GS docs.
  • Fix doxygen syntax errors and broken links.
  • Complete and fix the game ID documentation.
  • Document timekeeping and which method returns economy- or calendar-time.
    • The methods link to documentation sections "ScriptEconomyDate" and "ScriptCalendarDate". These can be turned into classes with the same name later.
  • Replace C++ types with squirrel-like types in signatures:
    • char *, std::string, std::optional<std::string>, ... should all just be string in the API docs.
    • SQInteger, uint, int16_t, ... should all just be int in the API docs.

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 touches english.txt or translations? Check the guidelines
  • 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, game_changelog.hpp need updating.
    • The compatibility wrappers (compat_*.nut) need updating.
  • This PR affects the NewGRF API? (label 'needs review: NewGRF')

@2TallTyler
Copy link
Member

@frosch123 Do you want to merge this? It's been approved for a minute. 😉

@PeterN
Copy link
Member

PeterN commented May 10, 2024

Let's assume this is still good to go... and can be fixed if not.

@PeterN PeterN merged commit dc22edc into OpenTTD:master May 10, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants