SimPaths API¶
The API documentation is generated from Javadoc comments in the Java source. Use it to inspect classes and methods; use the Repository Guide and model schedule to understand how those components work together.
Generate the API locally¶
From the repository root, with the project's JDK and Maven installed:
Inspect the generated HTML under target/reports/apidocs/ or target/site/apidocs/, depending on the Maven Javadoc plugin version and configuration. The command output reports the destination.
When changing a public method, document its purpose, inputs, return value, side effects and relevant assumptions. Verify the generated page before submitting the change through the normal code-review process.
Publishing workflow¶
The Javadoc workflow builds on pushes to develop and pull requests to main or develop. It compiles SimPaths, generates Javadoc and includes a publishing step targeting the javadoc branch.
Check the actual workflow run before assuming that a source change has been published. Generation and publication are separate steps, and the publishing step has its own event condition.
The generated Javadoc branch is separate from this MkDocs site. The documentation website uses its own documentation branch and Pages workflow; updating API output does not by itself rebuild these explanatory pages.