Fix readme and JavaDoc

veraPDF · Jun 12, 2024 · acd2742 · acd2742
1 parent 6cbacb9
commit acd2742
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@ Quick Start
 
 ### veraPDF GUI
 #### Download release version
-You can download a Java-based installer for the latest veraPDF GUI release [from our download site](https://software.verapdf.org/rel/verapdf-installer.zip). The current installation process requires Java 8 - 21 to be pre-installed.
+You can download a Java-based installer for the latest veraPDF GUI release [from our download site](https://software.verapdf.org/rel/verapdf-installer.zip). The current installation process requires Java 8, 11, 17 or 21 to be pre-installed.
 
 #### Download latest development version
 If you want to try the latest development version you can obtain it from our [development download site](https://software.verapdf.org/dev/verapdf-installer.zip). Be aware that we release development snapshots regularly, often more than once a day. While we try to ensure that development builds are well tested there are no guarantees.
@@ -68,7 +68,7 @@ Building the veraPDF-apps from Source
 
 In order to build this project you'll need:
 
- * Java 8 - 21, which can be downloaded [from Oracle](https://www.oracle.com/technetwork/java/javase/downloads/index.html), or for Linux users [OpenJDK](https://openjdk.java.net/install/index.html).
+ * Java 8, 11, 17 or 21, which can be downloaded [from Oracle](https://www.oracle.com/technetwork/java/javase/downloads/index.html), or for Linux users [OpenJDK](https://openjdk.java.net/install/index.html).
  * [Maven v3+](https://maven.apache.org/)
 
 Life will be easier if you also use [Git](https://git-scm.com/) to obtain and manage the source.

diff --git a/gui/src/test/java/org/verapdf/cli/VeraPdfCliProcessorTest.java b/gui/src/test/java/org/verapdf/cli/VeraPdfCliProcessorTest.java
@@ -54,12 +54,12 @@ public class VeraPdfCliProcessorTest {
 
 	/**
 	 * Test method for
-	 * {@link org.verapdf.cli.VeraPdfCliProcessor#createProcessorFromArgs(org.verapdf.cli.commands.VeraCliArgParser)}
+	 * {@link org.verapdf.cli.VeraPdfCliProcessor#createProcessorFromArgs(VeraCliArgParser, ConfigManager)}
 	 * .
 	 *
 	 * @throws IOException
 	 * @throws FileNotFoundException
-	 * @throws ProfileException
+	 * @throws org.verapdf.core.ProfileException
 	 */
 	@Test
 	public final void testCreateProcessorFromArgsFormat() throws IOException, VeraPDFException {
@@ -83,12 +83,12 @@ public final void testCreateProcessorFromArgsFormat() throws IOException, VeraPD
 
 	/**
 	 * Test method for
-	 * {@link org.verapdf.cli.VeraPdfCliProcessor#createProcessorFromArgs(org.verapdf.cli.commands.VeraCliArgParser)}
+	 * {@link org.verapdf.cli.VeraPdfCliProcessor#createProcessorFromArgs(VeraCliArgParser, ConfigManager)}
 	 * .
 	 *
 	 * @throws IOException
 	 * @throws FileNotFoundException
-	 * @throws ProfileException
+	 * @throws org.verapdf.core.ProfileException
 	 */
 	@Test
 	public final void testCreateProcessorFromArgsLogPassed() throws VeraPDFException, IOException {
@@ -112,12 +112,12 @@ public final void testCreateProcessorFromArgsLogPassed() throws VeraPDFException
 
 	/**
 	 * Test method for
-	 * {@link org.verapdf.cli.VeraPdfCliProcessor#createProcessorFromArgs(org.verapdf.cli.commands.VeraCliArgParser)}
+	 * {@link org.verapdf.cli.VeraPdfCliProcessor#createProcessorFromArgs(VeraCliArgParser, ConfigManager)}
 	 * .
 	 *
 	 * @throws IOException
 	 * @throws FileNotFoundException
-	 * @throws ProfileException
+	 * @throws org.verapdf.core.ProfileException
 	 */
 	@Test
 	public final void testCreateProcessorFromArgsExtract() throws IOException, VeraPDFException {
@@ -195,12 +195,12 @@ public final void testCreateProcessorFromArgsConfig() throws IOException, VeraPD
 
 	/**
 	 * Test method for
-	 * {@link org.verapdf.cli.VeraPdfCliProcessor#createProcessorFromArgs(org.verapdf.cli.commands.VeraCliArgParser)}
+	 * {@link org.verapdf.cli.VeraPdfCliProcessor#createProcessorFromArgs(VeraCliArgParser, ConfigManager)}
 	 * .
 	 *
 	 * @throws IOException
 	 * @throws FileNotFoundException
-	 * @throws ProfileException
+	 * @throws org.verapdf.core.ProfileException
 	 */
 
 	@Test
@@ -234,12 +234,12 @@ public final void testCreateProcessorFromArgsFlavour() throws IOException, VeraP
 	// TODO: ModelParser that can not be NO_FLAVOUR or AUTO.
 	/**
 	 * Test method for
-	 * {@link org.verapdf.cli.VeraPdfCliProcessor#createProcessorFromArgs(org.verapdf.cli.commands.VeraCliArgParser)}
+	 * {@link org.verapdf.cli.VeraPdfCliProcessor#createProcessorFromArgs(VeraCliArgParser, ConfigManager)}
 	 * .
 	 *
 	 * @throws IOException
 	 * @throws FileNotFoundException
-	 * @throws ProfileException
+	 * @throws org.verapdf.core.ProfileException
 	 */
 	@Test
 	public final void testCreateProcessorFromArgsNoFlavour()

diff --git a/pdfbox-apps/src/test/java/org/verapdf/processor/test/ProcessorImplProfileTest.java b/pdfbox-apps/src/test/java/org/verapdf/processor/test/ProcessorImplProfileTest.java
@@ -50,7 +50,9 @@ public class ProcessorImplProfileTest {
 
 	/**
 	 * Test method for
-	 * {@link org.verapdf.processor.ProcessorImpl#profileFromConfig(Config)}
+	 * {@link org.verapdf.processor.ProcessorFactory#fromValues(org.verapdf.pdfa.validation.validators.ValidatorConfig, 
+	 * org.verapdf.features.FeatureExtractorConfig, PluginsCollectionConfig, org.verapdf.metadata.fixer.MetadataFixerConfig, 
+	 * EnumSet, ValidationProfile)}
 	 * .
 	 *
 	 * @throws IOException