Skip to content

Commit b0eaf36

Browse files
committed
Publish the generated libosrm C++ API reference at /libosrm-api/
The site's own libosrm page (/docs/<version>/libosrm) has, since 2016, pointed C++ embedders at header files on GitHub instead of offering a reference. This adds the rendered reference to the site so those types are browsable here, and links it from the front page next to DEMO and DOCUMENTATION. libosrm-api/ is generated output pinned to osrm-backend commit e9abd4e0268c692210c4f8e6dcd1d184ff2c8f72 (tip of master, after v26.8.0). Every file except the README is byte-for-byte the output of tools/api-docs/build.py in the backend repo, which runs Doxygen over the public headers and renders the XML with sourcey@3.6.5. Every symbol links back to its exact file and line at that commit. _og/ is intentionally not committed: Jekyll drops leading-underscore paths on GitHub Pages and those files are only social-preview images.
1 parent 2f1daa8 commit b0eaf36

66 files changed

Lines changed: 9916 additions & 1 deletion

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<div class='col6 margin3 pad4y clearfix'>
2020
<div class='pad2y title '>Modern C++ routing engine for shortest paths in road networks.</div>
2121
<div class='center'>
22-
<a href='https://map.project-osrm.org/'><input type='button' class='button' value='VIEW DEMO' name='' /></a> <a href='docs/'><input type='button' class='button' value="DOCUMENTATION" name='' /></a>
22+
<a href='https://map.project-osrm.org/'><input type='button' class='button' value='VIEW DEMO' name='' /></a> <a href='docs/'><input type='button' class='button' value="DOCUMENTATION" name='' /></a> <a href='libosrm-api/'><input type='button' class='button' value="LIBOSRM C++ API" name='' /></a>
2323
<p class='pad2x'><a class="github-button" href="https://github.com/Project-OSRM/osrm-backend" data-icon="octicon-mark-github" data-style="mega" aria-label="View Project-OSRM/osrm-backend on GitHub">View on GitHub</a></p>
2424
</div>
2525
</div>

‎libosrm-api/README.md‎

Lines changed: 33 additions & 0 deletions

‎libosrm-api/api.html‎

Lines changed: 74 additions & 0 deletions
Large diffs are not rendered by default.

‎libosrm-api/api/osrm-EngineConfig.html‎

Lines changed: 260 additions & 0 deletions
Large diffs are not rendered by default.

‎libosrm-api/api/osrm-MatchParameters.html‎

Lines changed: 204 additions & 0 deletions
Large diffs are not rendered by default.

‎libosrm-api/api/osrm-NearestParameters.html‎

Lines changed: 96 additions & 0 deletions
Large diffs are not rendered by default.

‎libosrm-api/api/osrm-OSRM.html‎

Lines changed: 266 additions & 0 deletions
Large diffs are not rendered by default.

‎libosrm-api/api/osrm-RouteParameters.html‎

Lines changed: 315 additions & 0 deletions
Large diffs are not rendered by default.

‎libosrm-api/api/osrm-TableParameters.html‎

Lines changed: 228 additions & 0 deletions
Large diffs are not rendered by default.

‎libosrm-api/api/osrm-TileParameters.html‎

Lines changed: 99 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)