fix: publish sources and javadocs (#68)

SchweizerischeBundesbahnen · Sep 13, 2024 · 0377086 · 0377086
1 parent dcb8afe
commit 0377086
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 8 deletions.
diff --git a/pom.xml b/pom.xml
@@ -40,6 +40,8 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 
+        <maven-javadoc-plugin.version>3.10.0</maven-javadoc-plugin.version>
+        <maven-source-plugin.version>3.3.1</maven-source-plugin.version>
         <maven-gpg-plugin.version>3.2.5</maven-gpg-plugin.version>
 
         <nexus-staging-maven-plugin.version>1.7.0</nexus-staging-maven-plugin.version>
@@ -145,6 +147,37 @@
                     <version>3.4.2</version>
                 </plugin>
 
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-source-plugin</artifactId>
+                    <version>${maven-source-plugin.version}</version>
+                    <executions>
+                        <execution>
+                            <id>attach-sources</id>
+                            <goals>
+                                <goal>jar-no-fork</goal>
+                            </goals>
+                        </execution>
+                    </executions>
+                </plugin>
+
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-javadoc-plugin</artifactId>
+                    <version>${maven-javadoc-plugin.version}</version>
+                    <executions>
+                        <execution>
+                            <id>attach-javadocs</id>
+                            <goals>
+                                <goal>jar</goal>
+                            </goals>
+                        </execution>
+                    </executions>
+                    <configuration>
+                        <sourcepath>${basedir}/src/main/java</sourcepath>
+                    </configuration>
+                </plugin>
+
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-gpg-plugin</artifactId>
@@ -213,6 +246,16 @@
                     </environmentVariables>
                 </configuration>
             </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+            </plugin>
+
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+            </plugin>
         </plugins>
     </build>
 

diff --git a/src/main/java/org/eclipse/compare/rangedifferencer/RangeDifferencer.java b/src/main/java/org/eclipse/compare/rangedifferencer/RangeDifferencer.java
@@ -30,8 +30,8 @@
  * Alternatively, the <code>findRanges</code> methods not only return objects
  * for the differing ranges but for non-differing ranges too.
  * <p>
- * The algorithm used is an objectified version of one described in: <it>A File
- * Comparison Program,</it> by Webb Miller and Eugene W. Myers, Software
+ * The algorithm used is an objectified version of one described in: <i>A File
+ * Comparison Program,</i> by Webb Miller and Eugene W. Myers, Software
  * Practice and Experience, Vol. 15, Nov. 1985.
  *
  * @see IRangeComparator

diff --git a/src/main/java/org/outerj/daisy/diff/html/TextNodeComparator.java b/src/main/java/org/outerj/daisy/diff/html/TextNodeComparator.java
@@ -220,7 +220,7 @@ public void handlePossibleChangedPart(int leftstart, int leftend,
      * @param end
      * @param oldComp
      * @param before
-     * @param anOutputFormat specifies how this range shall be formatted in the output
+     * @param outputFormat specifies how this range shall be formatted in the output
      */
     public void markAsDeleted(int start, int end, TextNodeComparator oldComp,
                               int before, int after, ModificationType outputFormat) {
@@ -440,7 +440,7 @@ public void setStartDeletedID(long aDeletedID) {
      * output document. The IDs must be successive along the different
      * comparators.
      *
-     * @param aDeletedID
+     * @param aChangedID
      */
     public void setStartChangedID(long aChangedID) {
         changedID = aChangedID;
@@ -451,7 +451,7 @@ public void setStartChangedID(long aChangedID) {
      * output document. The IDs must be successive along the different
      * comparators.
      *
-     * @param aDeletedID
+     * @param aNewID
      */
     public void setStartNewID(long aNewID) {
         newID = aNewID;

diff --git a/src/main/java/org/outerj/daisy/diff/html/dom/SeparatingNode.java b/src/main/java/org/outerj/daisy/diff/html/dom/SeparatingNode.java
@@ -8,7 +8,7 @@
  * Such nodes will be created between two text nodes, when they really
  * are separate, e.g. in two successive table cells.
  *
- * @author Carsten Pfeiffer <[email protected]>
+ * @author Carsten Pfeiffer &lt;[email protected]&gt;
  */
 public class SeparatingNode extends TextNode {
 

diff --git a/src/main/java/org/outerj/daisy/diff/html/dom/TagNode.java b/src/main/java/org/outerj/daisy/diff/html/dom/TagNode.java
@@ -294,7 +294,7 @@ public String getEndTag() {
      * <p>It actually might have nothing to do with being really deleted, because
      * the element might be kept after its text content was deleted.<br>
      * Example:<br>
-     * table cells can be kept after its text content was deleted</br>
+     * table cells can be kept after its text content was deleted<br>
      * horizontal rule has never had text content, but can be deleted</p>
      */
     @Override

diff --git a/src/main/java/org/outerj/daisy/diff/output/Differ.java b/src/main/java/org/outerj/daisy/diff/output/Differ.java
@@ -23,7 +23,7 @@
  * as produced by DaisyDiff.
  *
  * @author kapelonk
- * @see HtmlDiffer
+ * @see org.outerj.daisy.diff.html.HTMLDiffer
  */
 public interface Differ {