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.
...
If you wish to build your own 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 .
...
you can use Bazel directly as follows:
| Code Block | ||||
|---|---|---|---|---|
| ||||
bazel build //docs:external |
The above will build the external Java API docs comprising only of those interfaces and classes that are considered part of the ONOS SDK, thus omitting much of the internal implementation classes. The result is available in bazel-bin/docs/external.jar file.
If you wish to build the Java API docs for the entire source tree, including all internal implementation classes, you can use the following:
| Code Block | ||||
|---|---|---|---|---|
| ||||
bazel build //docs:internal |
Similarly, The result is available in bazel-bin/docs/internal.jar file.
Alternatively, you can use the onos-build-docs utility, which uses Bazel to generate both internal and external sets of documentation. You can uncompress the jar files in a location of your choice and then open the top-level index.html file in your favourite web browser.