Due to a ransomware attack, the wiki was reverted to a July 2022 version. . We apologize for the lack of a more recent valid backup.
This section covers development and test environment setup and configuration.
This page assumes you have successfully downloaded and installed ONOS. If you have not done that yet, please follow the tutorial Installing and Running ONOS.
Building API Docs
To build a local set of the ONOS Java API documentation bundle, use the onos-build-docs utility, which uses Maven to generate both internal and external documentation.
Running onos-build-docs from any location generates HTML pages under ONOS_ROOT/docs/, and can be accessed by pointing a browser to ONOS_ROOT/docs/target/site/apidocs/index.html .
The generated documentation is also wrapped into a gzipped tar archive and placed under /tmp with the naming convention onos-apidocs-<onos-version>.<user>.tar.gz.
Home : Developer's Guide
Next : Test Environment Setup