Skip to content

Commit a91d2b6

Browse files
committed
notes about javadocs
Signed-off-by: Ceki Gulcu <[email protected]>
1 parent c7c5e89 commit a91d2b6

File tree

2 files changed

+66
-59
lines changed

2 files changed

+66
-59
lines changed

pom.xml

+56-59
Original file line numberDiff line numberDiff line change
@@ -383,13 +383,62 @@
383383
</executions>
384384
</plugin>
385385

386-
<!--
387386
<plugin>
388-
<groupId>org.simplify4u.plugins</groupId>
389-
<artifactId>pgpverify-maven-plugin</artifactId>
390-
<version>1.16.0</version>
387+
<groupId>org.apache.maven.plugins</groupId>
388+
<artifactId>maven-javadoc-plugin</artifactId>
389+
<executions>
390+
<execution>
391+
<id>default-cli</id>
392+
<goals>
393+
<goal>aggregate</goal>
394+
</goals>
395+
</execution>
396+
</executions>
397+
398+
<configuration>
399+
<linksource>true</linksource>
400+
<doclint>none</doclint>
401+
<skippedModules>
402+
logback-core-blackbox,logback-classic-blackbox,logback-examples
403+
</skippedModules>
404+
<additionalOptions>
405+
<additionalOption>-Xdoclint:none</additionalOption>
406+
</additionalOptions>
407+
408+
<links>
409+
<link>
410+
http://docs.oracle.com/javase/7/docs/api/
411+
</link>
412+
</links>
413+
414+
<groups>
415+
<group>
416+
<title>Logback Core</title>
417+
<packages>ch.qos.logback.core:ch.qos.logback.core.*
418+
</packages>
419+
</group>
420+
<group>
421+
<title>Logback Classic</title>
422+
<packages>
423+
ch.qos.logback:ch.qos.logback.classic:ch.qos.logback.classic.*
424+
</packages>
425+
</group>
426+
</groups>
427+
</configuration>
428+
</plugin>
429+
430+
<plugin>
431+
<groupId>org.apache.maven.plugins</groupId>
432+
<artifactId>maven-jxr-plugin</artifactId>
433+
<version>${maven-jxr-plugin.version}</version>
434+
<configuration>
435+
<aggregate>true</aggregate>
436+
<javadocDir>target/site/apidocs/</javadocDir>
437+
<linkJavadoc>true</linkJavadoc>
438+
</configuration>
391439
</plugin>
392-
-->
440+
441+
393442
</plugins>
394443
</build>
395444

@@ -417,61 +466,9 @@
417466
</plugin>
418467
-->
419468

420-
<plugin>
421-
<groupId>org.apache.maven.plugins</groupId>
422-
<artifactId>maven-jxr-plugin</artifactId>
423-
<version>${maven-jxr-plugin.version}</version>
424-
<configuration>
425-
<aggregate>true</aggregate>
426-
<javadocDir>target/site/apidocs/</javadocDir>
427-
<linkJavadoc>true</linkJavadoc>
428-
</configuration>
429-
</plugin>
430-
431-
432-
<plugin>
433-
<groupId>org.apache.maven.plugins</groupId>
434-
<artifactId>maven-javadoc-plugin</artifactId>
435-
436-
<configuration>
437-
<aggregate>true</aggregate>
438-
<linkJavadoc>true</linkJavadoc>
439-
<linksource>true</linksource>
440-
<doclint>none</doclint>
441-
<sourceFileExcludes>
442-
<sourceFileExclude>**/module-info.java</sourceFileExclude>
443-
</sourceFileExcludes>
444-
<links>
445-
<link>
446-
http://docs.oracle.com/javase/7/docs/api/
447-
</link>
448-
</links>
449-
450-
<groups>
451-
<group>
452-
<title>Logback Core</title>
453-
<packages>ch.qos.logback.core:ch.qos.logback.core.*
454-
</packages>
455-
</group>
456-
<group>
457-
<title>Logback Classic</title>
458-
<packages>
459-
ch.qos.logback:ch.qos.logback.classic:ch.qos.logback.classic.*
460-
</packages>
461-
</group>
462-
<group>
463-
<title>Logback Access</title>
464-
<packages>ch.qos.logback.access:ch.qos.logback.access.*
465-
</packages>
466-
</group>
467-
<group>
468-
<title>Examples</title>
469-
<packages>chapter*:joran*</packages>
470-
</group>
471-
</groups>
472-
</configuration>
473-
</plugin>
469+
474470

471+
475472

476473
</plugins>
477474
</reporting>

release.sh

+10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
mvn versions:set -DgenerateBackupPoms=false -DnewVersion=${VERSION_NUMBER}
22

3+
# mvn -Dmaven.javadoc.skippedModules=logback-core-blackbox,logback-classic-blackbox,logback-examples javadoc:aggregate
4+
5+
# 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
6+
7+
#mvn -Ddoclint=none -DXXadditionalparam=-Xdoclint:none -Dmaven.javadoc.skippedModules=osgi-over-slf4j,slf4j-ext,log4j-over-slf4j-blackbox,log4j-over-slf4j javadoc:aggregate
8+
9+
10+
11+
12+
313
mvn clean
414
mvn install
515
mvn animal-sniffer:check

0 commit comments

Comments
 (0)