This directory contains documentation, configuration, and other resources for documentation.
Here's a listing of these documentation and generated documentation resources:
- Online copy of the generated API docs.
- The source code style guide for the project.
- Physical units interface insight.
- Collision handling differences from Box2D 2.3.2.
Application Programming Interface documentation (API docs) can be manually generated from the library source code from some of this configuration using the Doxygen tool. Using CMake, this can be done using steps like these:
cmake -S PlayRho -B PlayRhoBuild -DCMAKE_BUILD_TYPE=Release -DPLAYRHO_BUILD_DOC=ON -DPLAYRHO_BUILD_LIBRARY=OFF
cmake --build PlayRhoBuild --config Release
cmake --install PlayRhoBuild --prefix PlayRhoInstallThis assumes you're in the parent directory of the PlayRho directory,
that you're specifically interested in a Release build,
that you just want to build the API documentation,
that you want to build things in a separate directory called PlayRhoBuild,
and that you want to install the documentation under the PlayRhoInstall directory.
This is also done automatically as part of GitHub's continuous integration workflow system (see docs.yml for details).
Alternatively, see the top-level building & installation document.