Fix documentation build by replacing removed --polyglot flag #7292
+286
−194
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue
Fixes #7274
The
--polyglotflag was removed from documentation.js in 2017. When OSRM upgraded to v14 in PR #7141, this went unnoticed because documentation.js silently ignores unknown arguments (exits 0 after printing help).This PR adds a simple script to extract JSDoc comments from the C++ file and feed them to documentation.js, replacing the old
--polyglotfunctionality.Note: The docbox HTML build (the second part of
npm run docs) also fails due to ESM/CommonJS conflicts introduced when the project switched to"type": "module". That's tracked separately in the issue #7293.Tasklist