notes about javadocs

Signed-off-by: Ceki Gulcu <ceki@qos.ch>
qos-ch · Apr 12, 2024 · a91d2b6 · a91d2b6
1 parent c7c5e89
commit a91d2b6
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 59 deletions.
diff --git a/pom.xml b/pom.xml
@@ -383,13 +383,62 @@
         </executions>
       </plugin>
 
-      <!--
       <plugin>
-        <groupId>org.simplify4u.plugins</groupId>
-        <artifactId>pgpverify-maven-plugin</artifactId>
-        <version>1.16.0</version>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>default-cli</id>
+            <goals>
+              <goal>aggregate</goal>
+            </goals>
+          </execution>
+        </executions>
+
+        <configuration>
+          <linksource>true</linksource>
+          <doclint>none</doclint>
+          <skippedModules>
+            logback-core-blackbox,logback-classic-blackbox,logback-examples
+          </skippedModules>
+          <additionalOptions>
+            <additionalOption>-Xdoclint:none</additionalOption>
+          </additionalOptions>
+
+          <links>
+            <link>
+              http://docs.oracle.com/javase/7/docs/api/
+            </link>
+          </links>
+
+          <groups>
+            <group>
+              <title>Logback Core</title>
+              <packages>ch.qos.logback.core:ch.qos.logback.core.*
+              </packages>
+            </group>
+            <group>
+              <title>Logback Classic</title>
+              <packages>
+                ch.qos.logback:ch.qos.logback.classic:ch.qos.logback.classic.*
+              </packages>
+            </group>
+          </groups>
+        </configuration>
+      </plugin>
+
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-jxr-plugin</artifactId>
+        <version>${maven-jxr-plugin.version}</version>
+        <configuration>
+          <aggregate>true</aggregate>
+          <javadocDir>target/site/apidocs/</javadocDir>
+          <linkJavadoc>true</linkJavadoc>
+        </configuration>
       </plugin>
-      -->
+
+
     </plugins>
   </build>
 
@@ -417,61 +466,9 @@
       </plugin>
       -->
 
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-jxr-plugin</artifactId>
-        <version>${maven-jxr-plugin.version}</version>
-        <configuration>
-          <aggregate>true</aggregate>
-          <javadocDir>target/site/apidocs/</javadocDir>
-          <linkJavadoc>true</linkJavadoc>
-        </configuration>
-      </plugin>
-
-
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-javadoc-plugin</artifactId>
-
-        <configuration>                                
-          <aggregate>true</aggregate>
-          <linkJavadoc>true</linkJavadoc>
-          <linksource>true</linksource>
-          <doclint>none</doclint>
-          <sourceFileExcludes>
-            <sourceFileExclude>**/module-info.java</sourceFileExclude>
-          </sourceFileExcludes>
-          <links>
-            <link>
-              http://docs.oracle.com/javase/7/docs/api/
-            </link>
-          </links>
-
-          <groups>
-            <group>
-              <title>Logback Core</title>
-              <packages>ch.qos.logback.core:ch.qos.logback.core.*
-              </packages>
-            </group>
-            <group>
-              <title>Logback Classic</title>
-              <packages>
-                ch.qos.logback:ch.qos.logback.classic:ch.qos.logback.classic.*
-              </packages>
-            </group>
-            <group>
-              <title>Logback Access</title>
-              <packages>ch.qos.logback.access:ch.qos.logback.access.*
-              </packages>
-            </group>
-            <group>
-              <title>Examples</title>
-              <packages>chapter*:joran*</packages>
-            </group>
-          </groups>                  
-        </configuration>
-      </plugin>
+
 
+
 
     </plugins>
   </reporting>

diff --git a/release.sh b/release.sh
@@ -1,5 +1,15 @@
 mvn versions:set -DgenerateBackupPoms=false -DnewVersion=${VERSION_NUMBER} 
 
+# mvn  -Dmaven.javadoc.skippedModules=logback-core-blackbox,logback-classic-blackbox,logback-examples javadoc:aggregate
+
+# mvn -Ddoclint=none -Dmaven.javadoc.skippedModules=slf4j-ext,log4j-over-slf4j,log4j-over-slf4j-blackbox,jul-to-slf4j-blackbox,slf4j-migrator,osgi-over-slf4j javadoc:aggregate
+
+#mvn -Ddoclint=none  -DXXadditionalparam=-Xdoclint:none -Dmaven.javadoc.skippedModules=osgi-over-slf4j,slf4j-ext,log4j-over-slf4j-blackbox,log4j-over-slf4j javadoc:aggregate
+
+
+
+
+
 mvn clean
 mvn install
 mvn animal-sniffer:check