update javadocs (#200)

Author: caring-coder

.github/workflows/codeql.yml

@@ -4,19 +4,32 @@
 name: Java CI with Maven
 
 on:
+  workflow_dispatch:
   push:
     branches: [ "master" ]
   pull_request:
     branches: [ "master" ]
+  schedule:
+    - cron: '* 11 * * 1'
 
 permissions:
   pull-requests: read
 
 jobs:
-  build:
-
+  ci:
+    name: Continuous Integration
     runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
 
+    strategy:
+      fail-fast: false
+      matrix:        
+        version: [ '17', '18', '19', '20' ]
+        language: [ 'java' ]
+        
     steps:
       - uses: actions/checkout@v3
         with:
@@ -25,7 +38,7 @@ jobs:
       - name: Set up JDK
         uses: actions/setup-java@v3
         with:
-          java-version: '17'
+          java-version: ${{ matrix.version }}
           distribution: 'temurin'
           cache: 'maven'
 
@@ -42,10 +55,18 @@ jobs:
           path: ~/.m2
           key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
           restore-keys: ${{ runner.os }}-m2
-          
+       
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+ 
       - name: Build with Maven
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}          
           SONAR_HOST_URL: https://sonarcloud.io
         run: mvn --batch-mode --no-transfer-progress package org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.organization=verronpro
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2   

.github/workflows/maven.yml

@@ -150,7 +150,6 @@
                 <version>3.5.0</version>
                 <configuration>
                     <encoding>UTF-8</encoding>
-                    <failOnError>false</failOnError>
                 </configuration>
                 <executions>
                     <execution>
@@ -205,8 +204,6 @@
                     </dependency>
                 </dependencies>
             </plugin>
-                 
-         
 
             <plugin>
                 <groupId>org.jacoco</groupId>
@@ -225,11 +222,11 @@
                         <goals>
                             <goal>report</goal>
                         </goals>
-                                       <configuration>
-            <formats>
-              <format>XML</format>
-            </formats>
-          </configuration>
+                        <configuration>
+                            <formats>
+                                <format>XML</format>
+                            </formats>
+                        </configuration>
                     </execution>
                 </executions>
             </plugin>
@@ -247,19 +244,11 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-project-info-reports-plugin</artifactId>
                 <version>3.4.5</version>
-                <configuration>
-                    <inputEncoding>UTF-8</inputEncoding>
-                    <outputEncoding>UTF-8</outputEncoding>
-                </configuration>
             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
                 <version>3.5.0</version>
-                <configuration>
-                    <encoding>UTF-8</encoding>
-                    <failOnError>false</failOnError>
-                </configuration>
                 <reportSets>
                     <reportSet>
                         <reports>
@@ -272,6 +261,7 @@
             <plugin>
                 <groupId>org.jacoco</groupId>
                 <artifactId>jacoco-maven-plugin</artifactId>
+                <version>0.8.10</version>
                 <reportSets>
                     <reportSet>
                         <reports>
@@ -295,13 +285,6 @@
             <artifactId>docx4j-core</artifactId>
             <version>11.4.9</version>
         </dependency>
-        <dependency>
-            <groupId>org.projectlombok</groupId>
-            <artifactId>lombok</artifactId>
-            <version>1.18.28</version>
-            <optional>true</optional>
-            <scope>provided</scope>
-        </dependency>
         <dependency>
             <groupId>org.javassist</groupId>
             <artifactId>javassist</artifactId>

pom.xml

@@ -2,6 +2,18 @@
 
 import org.wickedsource.docxstamper.replace.PlaceholderReplacer;
 
+/**
+ * Factory interface for creating {@link org.wickedsource.docxstamper.api.commentprocessor.ICommentProcessor} instances.
+ *
+ * @author joseph
+ * @version $Id: $Id
+ */
 public interface CommentProcessorBuilder {
+    /**
+     * Creates a {@link org.wickedsource.docxstamper.api.commentprocessor.ICommentProcessor} instance.
+     *
+     * @param placeholderReplacer the placeholder replacer that should be used by the comment processor.
+     * @return a {@link org.wickedsource.docxstamper.api.commentprocessor.ICommentProcessor} instance.
+     */
     Object create(PlaceholderReplacer placeholderReplacer);
 }

src/main/java/org/wickedsource/docxstamper/CommentProcessorBuilder.java

@@ -21,7 +21,6 @@
 import org.wickedsource.docxstamper.replace.typeresolver.image.Image;
 import org.wickedsource.docxstamper.replace.typeresolver.image.ImageResolver;
 import pro.verron.docxstamper.OpcStamper;
-import pro.verron.docxstamper.StamperFactory;
 
 import java.io.InputStream;
 import java.io.OutputStream;
@@ -39,6 +38,9 @@
  * Main class of the docx-stamper library. This class can be used to "stamp" .docx templates
  * to create a .docx document filled with custom data at runtime.
  * </p>
+ *
+ * @author joseph
+ * @version $Id: $Id
  */
 public class DocxStamper<T> implements OpcStamper<WordprocessingMLPackage> {
 	private final List<PreProcessor> preprocessors;
@@ -48,7 +50,7 @@ public class DocxStamper<T> implements OpcStamper<WordprocessingMLPackage> {
 	/**
 	 * Creates a new DocxStamper with the default configuration.
 	 *
-	 * @deprecated since 1.6.4, use {@link StamperFactory#newDocxStamper()} or {@link StamperFactory#nopreprocessingDocxStamper()} instead.
+	 * @deprecated since 1.6.4, use {@link pro.verron.docxstamper.StamperFactory#newDocxStamper()} or {@link pro.verron.docxstamper.StamperFactory#nopreprocessingDocxStamper()} instead.
 	 */
 	@Deprecated(since = "1.6.4", forRemoval = true)
 	public DocxStamper() {
@@ -165,6 +167,8 @@ private static TypedValue throwException(ReflectiveOperationException exception)
 	}
 
 	/**
+	 * {@inheritDoc}
+	 *
 	 * <p>
 	 * Reads in a .docx template and "stamps" it into the given OutputStream, using the specified context object to
 	 * fill out any expressions it finds.
@@ -191,11 +195,6 @@ private static TypedValue throwException(ReflectiveOperationException exception)
 	 * If you need a wider vocabulary of methods available in the comments, you can create your own ICommentProcessor
 	 * and register it via getCommentProcessorRegistry().addCommentProcessor().
 	 * </p>
-	 *
-	 * @param template    the .docx template.
-	 * @param contextRoot the context root object against which all expressions found in the template are evaluated.
-	 * @param out         the output stream in which to write the resulting .docx document.
-	 * @throws DocxStamperException in case of an error.
 	 */
 	public void stamp(InputStream template, Object contextRoot, OutputStream out) throws DocxStamperException {
 		try {
@@ -208,13 +207,10 @@ public void stamp(InputStream template, Object contextRoot, OutputStream out) th
 
 
 	/**
+	 * {@inheritDoc}
+	 *
 	 * Same as stamp(InputStream, T, OutputStream) except that you may pass in a DOCX4J document as a template instead
 	 * of an InputStream.
-	 *
-	 * @param document    the .docx template.
-	 * @param contextRoot the context root object against which all expressions found in the template are evaluated.
-	 * @param out         the output stream in which to write the resulting .docx document.
-	 * @throws DocxStamperException in case of an error.
 	 */
 	@Override
 	public void stamp(WordprocessingMLPackage document, Object contextRoot, OutputStream out) throws DocxStamperException {