-
Notifications
You must be signed in to change notification settings - Fork 41
Description
Although the "de-monolithisation" of Spdx-Java-Library makes a lot of sense from the perspective of the implementers of the library, it has caused a fragmented view of the overall "SPDX Java API" that Spdx-Java-Library offers to downstream developers, both directly and via upstream SPDX Java library dependencies.
While a single, consolidated JavaDoc reference across all of these SPDX Java libraries would be ideal, a simpler interim solution is to simply link to the (separate) JavaDocs published for each of the libraries from Spdx-Java-Library's own README. That way the downstream developer at least has a single launching point for accessing all of the JavaDoc reference documentation for the overall "SPDX Java API".
Specifically, I believe this involves adding these links to the README, immediately after the existing JavaDoc link (i.e. after line 9):
- spdx-java-core library's JavaDoc
- spdx-java-model-2_X library's JavaDoc
which isn't published anywhere yet (see this issue) - spdx-java-model-3_0 library's JavaDoc
which isn't published anywhere yet (see this issue)