Skip to content

Commit

Permalink
Update Javadoc information for GitHub
Browse files Browse the repository at this point in the history
  • Loading branch information
tsjensen committed Mar 4, 2025
1 parent b53e2f2 commit 70211af
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ dependencies {
## Usage

The API is described in detail in the
[Javadoc documentation](https://sbom.siemens.io/javadoc/latest/).
[Javadoc documentation](https://siemens.github.io/standard-bom-java/latest/).

Here are some examples:

Expand Down
6 changes: 3 additions & 3 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -215,14 +215,14 @@ javadocJar {
* - - - - JAVADOC - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
*/
tasks.named('javadoc').configure {
title = project.name + " v${project.version}"
title = project.ext.publishedName + " v${project.version}"
options.locale = 'en'
options.encoding = 'UTF-8'
options.docEncoding = 'UTF-8'
options.charSet = 'UTF-8'
options.windowTitle = project.name
options.windowTitle = project.ext.publishedName
options.noDeprecated = true
options.header = project.name + " v${project.version}"
options.header = project.ext.publishedName + " v${project.version}"
options.links('https://www.javadoc.io/doc/com.google.code.findbugs/jsr305/3.0.2/',
'https://docs.oracle.com/javase/8/docs/api/',
'https://cyclonedx.github.io/cyclonedx-core-java/')
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/siemens/sbom/standardbom/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*/

/**
* The standard-bom is an SBOM format based on CycloneDX. It adds conventions for custom properties and source
* references. SBOMs created with standard-bom can be consumed by tools which know only CycloneDX.
* Standard BOM is a reasonable subset of CycloneDX. It adds conventions for custom properties and source
* references. SBOMs created with standard-bom-java can be consumed by tools which know only CycloneDX.
*/
package com.siemens.sbom.standardbom;

0 comments on commit 70211af

Please sign in to comment.