This is an automated email from the ASF dual-hosted git repository.
asf-gitbox-commits pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/ant-antlibs-cyclonedx.git
The following commit(s) were added to refs/heads/main by this push:
new f747c8e javadoc warnings
f747c8e is described below
commit f747c8ecebb6684ce9e693fa33933cd58cc2077a
Author: Stefan Bodewig <[email protected]>
AuthorDate: Sun May 17 17:57:48 2026 +0200
javadoc warnings
---
src/main/org/apache/ant/cyclonedx/Component.java | 99 +++++++++++++++++++++-
.../org/apache/ant/cyclonedx/ComponentBomTask.java | 30 ++++++-
.../org/apache/ant/cyclonedx/ComponentScope.java | 7 ++
.../org/apache/ant/cyclonedx/ComponentType.java | 7 ++
src/main/org/apache/ant/cyclonedx/EnumUtils.java | 2 +-
.../apache/ant/cyclonedx/ExternalReference.java | 9 ++
.../apache/ant/cyclonedx/ExternalReferenceSet.java | 7 ++
src/main/org/apache/ant/cyclonedx/License.java | 11 +++
.../org/apache/ant/cyclonedx/Organization.java | 11 +++
.../org/apache/ant/cyclonedx/OutputFormat.java | 5 ++
src/main/org/apache/ant/cyclonedx/SpecVersion.java | 4 +
11 files changed, 187 insertions(+), 5 deletions(-)
diff --git a/src/main/org/apache/ant/cyclonedx/Component.java
b/src/main/org/apache/ant/cyclonedx/Component.java
index 3fe6758..52b93e9 100644
--- a/src/main/org/apache/ant/cyclonedx/Component.java
+++ b/src/main/org/apache/ant/cyclonedx/Component.java
@@ -79,6 +79,8 @@ public class Component extends DataType {
* <p>At most one resource can be set. Without a nested resource
* the component will not have any "hashes" when written to the
* SBOM.</p>
+ *
+ * @param resource the resource holding the component's content
*/
public void add(Resource resource) {
checkChildrenAllowed();
@@ -92,6 +94,8 @@ public class Component extends DataType {
* Sets the type of the component.
*
* <p>Defaults to "library".</p>
+ *
+ * @param type component type
*/
public void setType(ComponentType type) {
checkAttributesAllowed();
@@ -100,6 +104,8 @@ public class Component extends DataType {
/**
* Sets the name of the component.
+ *
+ * @param name component name
*/
public void setName(String name) {
checkAttributesAllowed();
@@ -108,6 +114,8 @@ public class Component extends DataType {
/**
* Sets the group of the component.
+ *
+ * @param group component group
*/
public void setGroup(String group) {
checkAttributesAllowed();
@@ -116,6 +124,8 @@ public class Component extends DataType {
/**
* Sets the version of the component.
+ *
+ * @param version component version
*/
public void setVersion(String version) {
checkAttributesAllowed();
@@ -124,6 +134,8 @@ public class Component extends DataType {
/**
* Sets the Package-URL (purl) of the component.
+ *
+ * @param purl component Package URL
*/
public void setPurl(String purl) {
checkAttributesAllowed();
@@ -132,6 +144,8 @@ public class Component extends DataType {
/**
* Sets the bom-ref of the component.
+ *
+ * @param bomRef component bom-ref
*/
public void setBomRef(String bomRef) {
checkAttributesAllowed();
@@ -140,6 +154,8 @@ public class Component extends DataType {
/**
* Sets the decription of the component.
+ *
+ * @param description component description
*/
public void setDescription(String description) {
checkAttributesAllowed();
@@ -148,6 +164,8 @@ public class Component extends DataType {
/**
* Sets the publisher of the component.
+ *
+ * @param publisher component publisher
*/
public void setPublisher(String publisher) {
checkAttributesAllowed();
@@ -156,6 +174,8 @@ public class Component extends DataType {
/**
* Sets the copyright of the component.
+ *
+ * @param copyright component copyright
*/
public void setCopyright(String copyright) {
checkAttributesAllowed();
@@ -164,6 +184,8 @@ public class Component extends DataType {
/**
* Sets the mime-type of the component.
+ *
+ * @param mimeType component mime-type
*/
public void setMimeType(String mimeType) {
checkAttributesAllowed();
@@ -174,6 +196,8 @@ public class Component extends DataType {
* Sets the manufacturer of the component.
*
* <p>At most one manufacturer can be set.</p>
+ *
+ * @param manufacturer component manufacturer
*/
public void addManufacturer(Organization manufacturer) {
checkChildrenAllowed();
@@ -187,6 +211,8 @@ public class Component extends DataType {
* Sets the supplier of the component.
*
* <p>At most one supplier can be set.</p>
+ *
+ * @param supplier compoment supplier
*/
public void addSupplier(Organization supplier) {
checkChildrenAllowed();
@@ -198,6 +224,8 @@ public class Component extends DataType {
/**
* Adds an author to the component.
+ *
+ * @param author component author
*/
public void addAuthor(OrganizationalContact author) {
checkChildrenAllowed();
@@ -206,6 +234,8 @@ public class Component extends DataType {
/**
* Adds a tag to the component.
+ *
+ * @param tag component tag
*/
public void addConfiguredTag(Tag tag) {
checkChildrenAllowed();
@@ -214,6 +244,8 @@ public class Component extends DataType {
/**
* Adds a property to the component.
+ *
+ * @param property component property
*/
public void addProperty(Property property) {
checkChildrenAllowed();
@@ -223,6 +255,9 @@ public class Component extends DataType {
/**
* If set to {@code true} the manufacturer will also be used to
* provide the supplier information.
+ *
+ * @param manufacturerIsSupplier whether to use manufacturer as
+ * supplier as well
*/
public void setManufacturerIsSupplier(boolean manufacturerIsSupplier) {
checkAttributesAllowed();
@@ -231,6 +266,8 @@ public class Component extends DataType {
/**
* Adds a license to this component.
+ *
+ * @param l compoment license
*/
public void addConfiguredLicense(License l) {
checkChildrenAllowed();
@@ -239,6 +276,8 @@ public class Component extends DataType {
/**
* Adds an external reference to the component.
+ *
+ * @param ref external reference of component
*/
public void addConfiguredExternalReference(ExternalReference ref) {
checkChildrenAllowed();
@@ -247,6 +286,8 @@ public class Component extends DataType {
/**
* Adds a set of external references to the component.
+ *
+ * @param set set of external references of component
*/
public void addConfiguredExternalReferenceSet(ExternalReferenceSet set) {
checkChildrenAllowed();
@@ -257,6 +298,8 @@ public class Component extends DataType {
* Sets the scope of this component.
*
* <p>Must not be set for the main component of the SBOM.</p>
+ *
+ * @param scope component scope
*/
public void setScope(ComponentScope scope) {
checkAttributesAllowed();
@@ -276,6 +319,8 @@ public class Component extends DataType {
*
* <p>Right now this attribute has no effect until the CycloneDX
* core library supports the specification version 1.7.</p>
+ *
+ * @param isExternal whether the component is external
*/
public void setIsExternal(boolean isExternal) {
checkAttributesAllowed();
@@ -284,6 +329,8 @@ public class Component extends DataType {
/**
* Adds a dependency to this component.
+ *
+ * @param d component dependency
*/
public void addDependency(Dependency d) {
checkChildrenAllowed();
@@ -296,6 +343,8 @@ public class Component extends DataType {
* <p>This flag is needed to be able to tell dependencies with
* unknown dependencies from components without any
* dependencies.</p>
+ *
+ * @param unknownDependencies whether dependencies are unknown
*/
public void setUnknownDependencies(boolean unknownDependencies) {
checkAttributesAllowed();
@@ -304,6 +353,8 @@ public class Component extends DataType {
/**
* Adds a nested component.
+ *
+ * @param c nested component
*/
public void addComponent(Component c) {
checkChildrenAllowed();
@@ -312,6 +363,11 @@ public class Component extends DataType {
setChecked(false);
}
+ /**
+ * Container for SBOM link resource.
+ *
+ * @return container for SBOM link resource
+ */
public Union createSbomLink() {
checkChildrenAllowed();
return sbomLink == null ? (sbomLink = new Union()) : sbomLink;
@@ -319,6 +375,8 @@ public class Component extends DataType {
/**
* Gets the name of the component.
+ *
+ * @return component name
*/
public String getName() {
if (isReference()) {
@@ -330,6 +388,8 @@ public class Component extends DataType {
/**
* Gets the group of the component.
+ *
+ * @return component group
*/
public String getGroup() {
if (isReference()) {
@@ -378,6 +438,8 @@ public class Component extends DataType {
/**
* Gets the dependencies of the component.
+ *
+ * @return component's dependencies
*/
public Iterable<Dependency> getDependencies() {
if (isReference()) {
@@ -388,6 +450,8 @@ public class Component extends DataType {
}
/**
+ * Whether dependencies are unknoown.
+ *
* @return the value set with {@link #setUnknownDependencies}
* or {@code false}.
*/
@@ -401,6 +465,8 @@ public class Component extends DataType {
/**
* Recursively returns the nested components of this component.
+ *
+ * @return nested components of this component
*/
public List<Component> getNestedComponents() {
if (isReference()) {
@@ -422,6 +488,7 @@ public class Component extends DataType {
*
* @return the "addtional" components defined in the linked SBOM
* that are dependencies of this component.
+ * @throws IOException if reading the SBOM links fails
*/
public synchronized Collection<Component> resolve() throws IOException {
if (isReference()) {
@@ -456,6 +523,10 @@ public class Component extends DataType {
/**
* Creates a new "file" type component for a resource.
+ *
+ * @param project project to use when resolving paths
+ * @param r the resource holding the file
+ * @return the component
*/
public static Component createFileComponent(Project project, Resource r) {
Component c = new Component();
@@ -468,6 +539,10 @@ public class Component extends DataType {
/**
* Translates this component to a CycloneDX component suitable for the
metadata.component.
+ *
+ * @param bomVersion specification version
+ * @return mapped component
+ * @throws IOException if calculating component hashes fails
*/
public org.cyclonedx.model.Component toMainCycloneDxComponent(Version
bomVersion)
throws IOException {
@@ -485,6 +560,10 @@ public class Component extends DataType {
/**
* Translates this component to a CycloneDX component suitable for the
components.component.
+ *
+ * @param bomVersion specification version
+ * @return mapped component
+ * @throws IOException if calculating component hashes fails
*/
public org.cyclonedx.model.Component
toAdditionalCycloneDxComponent(Version bomVersion)
throws IOException {
@@ -500,7 +579,11 @@ public class Component extends DataType {
}
/**
- * Maps all common data except for <code>scope</scop> and
<scope>isExternal</code>.
+ * Maps all common data except for <code>scope</code> and
<code>isExternal</code>.
+ *
+ * @param bomVersion specification version
+ * @return mapped component
+ * @throws IOException if calculating component hashes fails
*/
protected org.cyclonedx.model.Component toCycloneDxComponent(Version
bomVersion)
throws IOException {
@@ -716,6 +799,10 @@ public class Component extends DataType {
* If this component has a nested resource child, all hashes
* supported by the CycloneDX Core library for the spec version are
* created and added to the given component.
+ *
+ * @param component component to add hashes to
+ * @param bomVersion specification version
+ * @throws IOException if calculating component hashes fails
*/
protected void addHashes(org.cyclonedx.model.Component component, Version
bomVersion)
throws IOException {
@@ -771,6 +858,8 @@ public class Component extends DataType {
/**
* Identifies the dependency by its bom-ref.
+ *
+ * @param bomRef dependency's bom-ref
*/
public void setBomRef(String bomRef) {
this.bomRef = bomRef;
@@ -778,6 +867,9 @@ public class Component extends DataType {
/**
* Identifies the dependency by its Ant {@code id} attribute.
+ *
+ * @param componentRef reference to component that constitutes
+ * the dependency
*/
public void setComponentRef(Reference componentRef) {
this.componentRef = componentRef;
@@ -785,6 +877,7 @@ public class Component extends DataType {
/**
* Looks up the bom-ref of the dependency.
+ * @return bom-ref of the dependency.
*/
public String getBomRef() {
if (bomRef == null && componentRef == null) {
@@ -824,6 +917,8 @@ public class Component extends DataType {
/**
* Sets the tag value.
+ *
+ * @param text the tag
*/
public void addText(String text) {
tag = text;
@@ -831,6 +926,8 @@ public class Component extends DataType {
/**
* Obtains the tag.
+ *
+ * @return tag
*/
public String getTag() {
return tag;
diff --git a/src/main/org/apache/ant/cyclonedx/ComponentBomTask.java
b/src/main/org/apache/ant/cyclonedx/ComponentBomTask.java
index 622fda0..929f2bc 100644
--- a/src/main/org/apache/ant/cyclonedx/ComponentBomTask.java
+++ b/src/main/org/apache/ant/cyclonedx/ComponentBomTask.java
@@ -55,6 +55,8 @@ public class ComponentBomTask extends Task {
* Specifies the CycloneDX version to use.
*
* <p>Defaults to 1.6.</p>
+ *
+ * @param specVersion specification version
*/
public void setSpecVersion(SpecVersion specVersion) {
this.specVersion = specVersion;
@@ -62,6 +64,8 @@ public class ComponentBomTask extends Task {
/**
* Which serialization format of CycloneDX SBOM to use.
+ *
+ * @param format output format
*/
public void setFormat(OutputFormat format) {
this.format = format;
@@ -72,6 +76,8 @@ public class ComponentBomTask extends Task {
*
* <p>The file name will be the base name plus the extension of
* the {@see #setFormat format}.
+ *
+ * @param bomName base name of generated file
*/
public void setBomName(String bomName) {
this.bomName = bomName;
@@ -79,6 +85,8 @@ public class ComponentBomTask extends Task {
/**
* Sets the output directory for the generated SBOM.
+ *
+ * @param f output directory
*/
public void setOutputDirectory(File f) {
outputDirectory = f;
@@ -86,6 +94,8 @@ public class ComponentBomTask extends Task {
/**
* Whether to use the supplier of the main component as supplier for the
BOM as well.
+ *
+ * @param useComponentSupplier whether to use supplier of component for
the BOM
*/
public void setUseComponentSupplier(boolean useComponentSupplier) {
this.useComponentSupplier = useComponentSupplier;
@@ -93,6 +103,8 @@ public class ComponentBomTask extends Task {
/**
* Sets the component for the SBOM.
+ *
+ * @return container for main component
*/
public Component createComponent() {
if (component != null) {
@@ -103,9 +115,11 @@ public class ComponentBomTask extends Task {
}
/**
- * Sets the manufacturer of the component.
+ * Sets the manufacturer of the SBOM.
*
* <p>At most one manufacturer can be set.</p>
+ *
+ * @return manufaturer of SBOM
*/
public Organization createManufacturer() {
if (manufacturer != null) {
@@ -116,9 +130,11 @@ public class ComponentBomTask extends Task {
}
/**
- * Sets the supplier of the component.
+ * Sets the supplier of the SBOM.
*
* <p>At most one supplier can be set.</p>
+ *
+ * @return supplier of SBOM
*/
public Organization createSupplier() {
if (supplier != null) {
@@ -130,6 +146,8 @@ public class ComponentBomTask extends Task {
/**
* Adds a license to the SBOM's metadata.
+ *
+ * @param l SBOM's license
*/
public void addConfiguredLicense(License l) {
licenses.add(l.toCycloneDxLicense());
@@ -137,6 +155,8 @@ public class ComponentBomTask extends Task {
/**
* Adds another component to the SBOM.
+ *
+ * @param c component to be added to SBOM
*/
public void addAdditionalComponent(Component c) {
additionalComponents.add(c);
@@ -147,7 +167,9 @@ public class ComponentBomTask extends Task {
* SBOM.
*
* <p>This is meant to be used by tools that have also taken part
- * in the generation of thsi SBOM.</p>
+ * in the generation of this SBOM.</p>
+ *
+ * @param c component to be added to tools
*/
public void addToolComponent(Component c) {
toolComponents.add(c);
@@ -156,6 +178,8 @@ public class ComponentBomTask extends Task {
/**
* Accepts arbitrary file-system only resources that will be added
* as components of type file.
+ *
+ * @return container for pure file components
*/
public Union createPureFileComponents() {
return pureFileComponents;
diff --git a/src/main/org/apache/ant/cyclonedx/ComponentScope.java
b/src/main/org/apache/ant/cyclonedx/ComponentScope.java
index 67ff30d..3d25804 100644
--- a/src/main/org/apache/ant/cyclonedx/ComponentScope.java
+++ b/src/main/org/apache/ant/cyclonedx/ComponentScope.java
@@ -22,12 +22,19 @@ public class ComponentScope extends EnumeratedAttribute {
/**
* Translates this instance to a {@link Scope}.
*
+ * @return translated scope
* @throws BuildException if the value can not be translated.
*/
public Scope getScope() {
return EnumUtils.valueOf(Scope.class, getValue(), Scope::getScopeName);
}
+ /**
+ * Maps a CycloneDX scope.
+ *
+ * @param scope CycloneDX scope.
+ * @return translated scope
+ */
public static ComponentScope from(Scope scope) {
ComponentScope s = new ComponentScope();
s.setValue(scope.name());
diff --git a/src/main/org/apache/ant/cyclonedx/ComponentType.java
b/src/main/org/apache/ant/cyclonedx/ComponentType.java
index 51c377b..4b604a0 100644
--- a/src/main/org/apache/ant/cyclonedx/ComponentType.java
+++ b/src/main/org/apache/ant/cyclonedx/ComponentType.java
@@ -23,11 +23,18 @@ public class ComponentType extends EnumeratedAttribute {
* Translates this instance to a {@link Type}.
*
* @throws BuildException if the value can not be translated.
+ * @return CycloneDX type of this instance
*/
public Type getType() {
return EnumUtils.valueOf(Type.class, getValue(), Type::getTypeName);
}
+ /**
+ * Maps a CycloneDX type.
+ *
+ * @param type CycloneDX type.
+ * @return translated type
+ */
public static ComponentType from(Type type) {
ComponentType t = new ComponentType();
t.setValue(type.name());
diff --git a/src/main/org/apache/ant/cyclonedx/EnumUtils.java
b/src/main/org/apache/ant/cyclonedx/EnumUtils.java
index 575454d..80ca6b4 100644
--- a/src/main/org/apache/ant/cyclonedx/EnumUtils.java
+++ b/src/main/org/apache/ant/cyclonedx/EnumUtils.java
@@ -7,7 +7,7 @@ import java.util.stream.Stream;
import org.apache.tools.ant.BuildException;
/**
- * Helpers for the <code>EnumeratedAttribute<code>s wrapping enums in this
package.
+ * Helpers for the <code>EnumeratedAttribute</code>s wrapping enums in this
package.
*/
public class EnumUtils {
diff --git a/src/main/org/apache/ant/cyclonedx/ExternalReference.java
b/src/main/org/apache/ant/cyclonedx/ExternalReference.java
index 81a1bf0..ed4cbd8 100644
--- a/src/main/org/apache/ant/cyclonedx/ExternalReference.java
+++ b/src/main/org/apache/ant/cyclonedx/ExternalReference.java
@@ -22,6 +22,8 @@ public class ExternalReference {
*
* <p>Required. This setter does not validate the value actually
* follows the URI syntax.</p>
+ *
+ * @param url reference's URI
*/
public void setUrl(String url) {
this.url = url;
@@ -37,11 +39,18 @@ public class ExternalReference {
Core (Java)</a>'s <a
href="https://javadoc.io/static/org.cyclonedx/cyclonedx-core-java/12.2.0/org/cyclonedx/model/ExternalReference.Type.html";>type
enum</a> are accepted.</p>
+ *
+ * @param type reference's type
*/
public void setType(String type) {
this.type = type;
}
+ /**
+ * Maps the instance to a CycloneDX ExternalReference.
+ *
+ * @return CycloneDX version of this instance.
+ */
public org.cyclonedx.model.ExternalReference
toCycloneDxExternalReference() {
if (url == null) {
throw new BuildException("external references must have an url");
diff --git a/src/main/org/apache/ant/cyclonedx/ExternalReferenceSet.java
b/src/main/org/apache/ant/cyclonedx/ExternalReferenceSet.java
index da1715d..1805620 100644
--- a/src/main/org/apache/ant/cyclonedx/ExternalReferenceSet.java
+++ b/src/main/org/apache/ant/cyclonedx/ExternalReferenceSet.java
@@ -19,12 +19,19 @@ public class ExternalReferenceSet extends DataType {
/**
* Adds an external reference to this set.
+ *
+ * @param ref reference to add
*/
public void addConfiguredExternalReference(ExternalReference ref) {
checkChildrenAllowed();
externalReferences.add(ref.toCycloneDxExternalReference());
}
+ /**
+ * Return the external references contained in this set.
+ *
+ * @return external references contained in this set
+ */
public Collection<org.cyclonedx.model.ExternalReference>
getExternalReferences() {
if (isReference()) {
return getRef().getExternalReferences();
diff --git a/src/main/org/apache/ant/cyclonedx/License.java
b/src/main/org/apache/ant/cyclonedx/License.java
index 0e29d91..c0b39fa 100644
--- a/src/main/org/apache/ant/cyclonedx/License.java
+++ b/src/main/org/apache/ant/cyclonedx/License.java
@@ -30,6 +30,8 @@ public class License extends DataType {
* <p>Must be a valid <a href="https://spdx.org/licenses/";>SPDX</a>
* identifier. This library doesn't enforce the SPDX identifier
* but the CycloneDX Core library does.</p>
+ *
+ * @param id SPDX id of license
*/
public void setLicenseId(String id) {
checkAttributesAllowed();
@@ -38,6 +40,8 @@ public class License extends DataType {
/**
* Sets the name of the license.
+ *
+ * @param name license name
*/
public void setName(String name) {
checkAttributesAllowed();
@@ -49,6 +53,8 @@ public class License extends DataType {
*
* <p>Even though this is a nested element of the license element,
* at most one child is allowed.</p>
+ *
+ * @param url url of license
*/
public void addConfiguredUrl(URLResource url) {
checkChildrenAllowed();
@@ -58,6 +64,11 @@ public class License extends DataType {
this.url = url.getURL().toExternalForm();
}
+ /**
+ * Maps the license to its CycloneDX counterpart.
+ *
+ * @return CycloneDX version of this instance
+ */
public org.cyclonedx.model.License toCycloneDxLicense() {
if (isReference()) {
return getRef().toCycloneDxLicense();
diff --git a/src/main/org/apache/ant/cyclonedx/Organization.java
b/src/main/org/apache/ant/cyclonedx/Organization.java
index 8363b03..672813c 100644
--- a/src/main/org/apache/ant/cyclonedx/Organization.java
+++ b/src/main/org/apache/ant/cyclonedx/Organization.java
@@ -26,6 +26,8 @@ public class Organization extends DataType {
/**
* Sets the name of the organization.
+ *
+ * @param name organization name
*/
public void setName(String name) {
checkAttributesAllowed();
@@ -34,12 +36,19 @@ public class Organization extends DataType {
/**
* Adds an url of the organization.
+ *
+ * @param url organization URI
*/
public void addConfiguredUrl(URLResource url) {
checkChildrenAllowed();
urls.add(url.getURL().toExternalForm());
}
+ /**
+ * Translates this organisation to its CycloneDX counterpart.
+ *
+ * @return the CycloneDX version of this instance.
+ */
public OrganizationalEntity toOrganizationalEntity() {
if (isReference()) {
return getRef().toOrganizationalEntity();
@@ -57,6 +66,8 @@ public class Organization extends DataType {
/**
* Creates a new instance from the CycloneDX counterpart.
+ *
+ * @return the instance created
*/
static Organization from(OrganizationalEntity oe) {
Organization o = new Organization();
diff --git a/src/main/org/apache/ant/cyclonedx/OutputFormat.java
b/src/main/org/apache/ant/cyclonedx/OutputFormat.java
index f24248f..24357c0 100644
--- a/src/main/org/apache/ant/cyclonedx/OutputFormat.java
+++ b/src/main/org/apache/ant/cyclonedx/OutputFormat.java
@@ -26,6 +26,9 @@ public class OutputFormat extends EnumeratedAttribute {
private static final String ALL = "ALL";
+ /**
+ * JSON output format.
+ */
public static final OutputFormat JSON;
static {
@@ -45,6 +48,8 @@ public class OutputFormat extends EnumeratedAttribute {
* Translates this instance to {@link Format}s.
*
* @throws BuildException if the value can not be translated.
+ * @param version spec version
+ * @return all suported formats of version
*/
public Iterable<Format> getCycloneDxFormats(Version version) {
String value = getValue();
diff --git a/src/main/org/apache/ant/cyclonedx/SpecVersion.java
b/src/main/org/apache/ant/cyclonedx/SpecVersion.java
index 4e124ba..b3695ee 100644
--- a/src/main/org/apache/ant/cyclonedx/SpecVersion.java
+++ b/src/main/org/apache/ant/cyclonedx/SpecVersion.java
@@ -16,6 +16,9 @@ import org.cyclonedx.Version;
*/
public class SpecVersion extends EnumeratedAttribute {
+ /**
+ * Default spec version.
+ */
public static final SpecVersion DEFAULT;
static {
@@ -32,6 +35,7 @@ public class SpecVersion extends EnumeratedAttribute {
* Translates this instance to a {@link Version}.
*
* @throws BuildException if the value can not be translated.
+ * @return CycloneDX version of this instance
*/
public Version getVersion() {
Version version = Version.fromVersionString(getValue());
