#9287 [RFE] makeapi should validate the generated API doc vs stored doc
Closed: fixed a year ago by frenaud. Opened 2 years ago by frenaud.

Request for enhancement

When a developer modifies IPA API but forgets to run python makeapi.in, the generated API doc (in doc/api/) can become out of date.
The tool makeapi.in currently does multiple tasks:
- generate the file API.txt
- generate the doc in doc/api
and it supports the option --validate but this option does not check the accuracy of the doc/api files.

It would be nice if python makeapi.in --validate could also check the accuracy of the doc/api files, as this command is executed in our azure pipelines. This way, when a developer opens a PR but forgets to update the API files, the CI would catch the issue.


Metadata Update from @antorres:
- Issue assigned to antorres

2 years ago

master:

  • f44bde9 API doc: validate generated reference

ipa-4-9:

  • 34a06d7 API doc: validate generated reference

ipa-4-10:

  • 364116c API doc: validate generated reference

Metadata Update from @frenaud:
- Issue close_status updated to: fixed
- Issue status updated to: Closed (was: Open)

a year ago

Log in to comment on this ticket.

Metadata