improve site generation

pom.xml

@@ -304,6 +304,23 @@
  </execution>
  </executions>
  </plugin>
+ <plugin>
+ <artifactId>maven-antrun-plugin</artifactId>
+ <version>3.1.0</version>
+ <executions>
+ <execution>
+ <phase>pre-site</phase>
+ <goals>
+ <goal>run</goal>
+ </goals>
+ <configuration>
+ <target>
+ <copy file="${project.basedir}/README.md" tofile="${project.build.directory}/generated-site/markdown/index.md" />
+ </target>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
  </plugins>
  <pluginManagement>
  <plugins>
@@ -445,6 +462,10 @@
  <artifactId>maven-plugin-report-plugin</artifactId>
  <version>${plugin-tools.version}</version>
  </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ </plugin>
  </plugins>
  </reporting>
 

src/main/java/org/cyclonedx/maven/ModelConverter.java

@@ -26,8 +26,8 @@
 import org.cyclonedx.model.Metadata;
 
 /**
- * Model converter from Maven concepts (Artifact + MavenProject) to CycloneDX ones
- * (resp. pURL and Component + Metadata).
+ * Model converter from Maven concepts (dependency Artifact + MavenProject) to CycloneDX ones
+ * (resp. Component with pURL + Metadata).
  */
 public interface ModelConverter {
  String generatePackageUrl(Artifact artifact);

src/main/java/org/cyclonedx/maven/ProjectDependenciesConverter.java

@@ -28,8 +28,8 @@
 import java.util.Map;
 
 /**
- * Converts a Maven Project with its Maven dependencies resolution graph transformed into a SBOM dependencies list
- * with their dependsOn.
+ * Converts a Maven Project with its Maven dependencies resolution graph into a SBOM dependencies list
+ * with their {@code dependsOn}.
  */
 public interface ProjectDependenciesConverter {
 

src/site/site.xml

@@ -40,6 +40,7 @@
  </item>
  <!-- item name="Usage" href="usage.html"/>
  <item name="FAQ" href="faq.html"/ -->
+ <item name="Javadoc" href="apidocs/index.html"/>
  </menu>
  <menu ref="reports"/>
  </body>

src/test/java/org/cyclonedx/maven/BomDependenciesTest.java

@@ -25,7 +25,7 @@
 import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner;
 
 /**
- * test for https:/CycloneDX/cyclonedx-maven-plugin/issues/256
+ * test for <a href="https:/CycloneDX/cyclonedx-maven-plugin/issues/256">issue #256</a>.
  * 
  */
 @RunWith(MavenJUnitTestRunner.class)

src/test/java/org/cyclonedx/maven/BundleDependencyTest.java

@@ -12,7 +12,7 @@
 import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner;
 
 /**
- * test for https:/CycloneDX/cyclonedx-maven-plugin/issues/272
+ * test for <a href="https:/CycloneDX/cyclonedx-maven-plugin/issues/272">issue #272</a>:
  * dependency has a bundle packaging which causes Maven's ProjectBuildingException
  */
 @RunWith(MavenJUnitTestRunner.class)

src/test/java/org/cyclonedx/maven/CIFriendlyTest.java

@@ -12,7 +12,7 @@
 import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner;
 
 /**
- * test for https:/CycloneDX/cyclonedx-maven-plugin/issues/263
+ * test for <a href="https:/CycloneDX/cyclonedx-maven-plugin/issues/263">issue #263</a>:
  * when makeAggregateBom using CI-friendly versions, root component does not list modules as dependencies
  */
 @RunWith(MavenJUnitTestRunner.class)

src/test/java/org/cyclonedx/maven/Issue116Test.java

@@ -13,7 +13,7 @@
 import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner;
 
 /**
- * test for https:/CycloneDX/cyclonedx-maven-plugin/issues/116
+ * test for <a href="https:/CycloneDX/cyclonedx-maven-plugin/issues/116">issue #116</a>:
  * dependencies in BOM file are missing a reference
  */
 @RunWith(MavenJUnitTestRunner.class)

src/test/java/org/cyclonedx/maven/Issue117Test.java

@@ -10,7 +10,7 @@
 import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner;
 
 /**
- * test for https:/CycloneDX/cyclonedx-maven-plugin/issues/117
+ * test for <a href="https:/CycloneDX/cyclonedx-maven-plugin/issues/117">issue #117</a>:
  * issue with pom.xml UTF-8 encoding with Byte Order Mark
  */
 @RunWith(MavenJUnitTestRunner.class)

src/test/java/org/cyclonedx/maven/Issue284Test.java

@@ -24,7 +24,7 @@
 import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner;
 
 /**
- * test for https:/CycloneDX/cyclonedx-maven-plugin/issues/284
+ * test for <a href="https:/CycloneDX/cyclonedx-maven-plugin/issues/284">issue #284</a>:
  * Fix filtering of scopes
  */
 @RunWith(MavenJUnitTestRunner.class)

src/test/java/org/cyclonedx/maven/Issue289Test.java

@@ -21,7 +21,7 @@
 import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner;
 
 /**
- * test for https:/CycloneDX/cyclonedx-maven-plugin/issues/289
+ * test for <a href="https:/CycloneDX/cyclonedx-maven-plugin/issues/289">issue #289</a>:
  * NPE when handling relocations
  */
 @RunWith(MavenJUnitTestRunner.class)

src/test/java/org/cyclonedx/maven/Issue311Test.java

@@ -23,7 +23,7 @@
 import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner;
 
 /**
- * test for https:/CycloneDX/cyclonedx-maven-plugin/issues/311
+ * test for <a href="https:/CycloneDX/cyclonedx-maven-plugin/issues/311">issue #311</a>.
  */
 @RunWith(MavenJUnitTestRunner.class)
 @MavenVersions({"3.6.3"})

src/test/java/org/cyclonedx/maven/Issue64Test.java

@@ -14,7 +14,7 @@
 import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner;
 
 /**
- * test for https:/CycloneDX/cyclonedx-maven-plugin/issues/64
+ * test for <a href="https:/CycloneDX/cyclonedx-maven-plugin/issues/64">issue #64</a>:
  * include test scoped dependencies
  */
 @RunWith(MavenJUnitTestRunner.class)

src/test/java/org/cyclonedx/maven/VerboseTest.java

@@ -10,7 +10,7 @@
 import io.takari.maven.testing.executor.junit.MavenJUnitTestRunner;
 
 /**
- * test for https:/CycloneDX/cyclonedx-maven-plugin/issues/280
+ * test for <a href="https:/CycloneDX/cyclonedx-maven-plugin/issues/280">issue #280</a>:
  * how to switch verbosity off by default, but let the user activate with CLI parameter
  */
 @RunWith(MavenJUnitTestRunner.class)