Skip to content

Conversation

@afarber
Copy link
Contributor

@afarber afarber commented Dec 6, 2025

Issue

Fixes #7274

The --polyglot flag 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 --polyglot functionality.

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

@afarber afarber force-pushed the 7274-replace-polyglot branch from 9cbb117 to 57755fe Compare January 2, 2026 21:39
@afarber afarber force-pushed the 7274-replace-polyglot branch from 57755fe to 79bcc68 Compare January 3, 2026 21:55
Copy link
Member

@TheMarex TheMarex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. We should fix the Docbox issues though.

@TheMarex TheMarex merged commit b9e5c82 into Project-OSRM:master Jan 8, 2026
21 checks passed
@afarber afarber deleted the 7274-replace-polyglot branch January 8, 2026 14:31
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.

Documentation build fails with "Unknown argument: polyglot" error

2 participants