Skip to content

Commit

Permalink
more tinkering with the javadocs
Browse files Browse the repository at this point in the history 
Signed-off-by: Ceki Gulcu <ceki@qos.ch>
  • Loading branch information
@ceki
ceki committed Dec 22, 2023
1 parent b56795b commit 9af7ed2
Show file tree
Hide file tree
Showing 3 changed files with 67 additions and 87 deletions.
113 changes: 26 additions & 87 deletions parent/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,23 +126,24 @@
<version>${maven-deploy-plugin.version}</version>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${maven-javadoc-plugin.version}</version>
<configuration>
<verbose>true</verbose>
<skippedModules>
slf4j-ext,log4j-over-slf4j,log4j-over-slf4j-blackbox,jul-to-slf4j-blackbox,slf4j-migrator,osgi-over-slf4j
</skippedModules>
<detectLinks>true</detectLinks>
<linksource>true</linksource>
<additionalOptions>
<additionalOption>-Xdoclint:none</additionalOption>
<!-- <additionalOption>doclint:none</additionalOption>-->
</additionalOptions>
</configuration>
</plugin>
<!-- <plugin>-->
<!-- <groupId>org.apache.maven.plugins</groupId>-->
<!-- <artifactId>maven-javadoc-plugin</artifactId>-->
<!-- <version>${maven-javadoc-plugin.version}</version>-->
<!-- <configuration>-->
<!-- <verbose>true</verbose>-->
<!-- <skippedModules>-->
<!-- slf4j-ext,log4j-over-slf4j,log4j-over-slf4j-blackbox,jul-to-slf4j-blackbox,slf4j-migrator,osgi-over-slf4j-->
<!-- </skippedModules>-->
<!-- <detectLinks>true</detectLinks>-->
<!-- <doctitle>SLF4J project ${project.version}</doctitle>-->
<!-- <linksource>true</linksource>-->
<!-- <additionalOptions>-->
<!-- <additionalOption>-Xdoclint:none</additionalOption>-->
<!-- &lt;!&ndash; <additionalOption>doclint:none</additionalOption>&ndash;&gt;-->
<!-- </additionalOptions>-->
<!-- </configuration>-->
<!-- </plugin>-->
</plugins>
</pluginManagement>

Expand Down Expand Up @@ -251,67 +252,29 @@
</executions>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>${maven-site-plugin.version}</version>
</plugin>

<!-- <plugin>-->
<!-- <groupId>org.apache.maven.plugins</groupId>-->
<!-- <artifactId>maven-javadoc-plugin</artifactId>-->
<!-- <configuration>-->
<!-- <skippedModules>-->
<!-- :slf4j-ext,:log4j-over-slf4j,:log4j-over-slf4j-blackbox,jul-to-slf4j-blackbox,slf4j-migrator,:osgi-over-slf4j-->
<!-- </skippedModules>-->
<!-- </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/apidocs2/</javadocDir>
<linkJavadoc>true</linkJavadoc>
</configuration>
</plugin>

</plugins>
</build>

<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${maven-javadoc-plugin.version}</version>
<configuration>
<configuration combine.self="append">
<verbose>true</verbose>
<skippedModules>
slf4j-ext,log4j-over-slf4j,log4j-over-slf4j-blackbox,jul-to-slf4j-blackbox,slf4j-migrator,osgi-over-slf4j
</skippedModules>
<detectLinks>true</detectLinks>
<doctitle>SLF4J project ${project.version}</doctitle>
<linksource>true</linksource>
<additionalOptions>
<additionalOption>-Xdoclint:none</additionalOption>
<!-- <additionalOption>doclint:none</additionalOption>-->
<!-- <additionalOption>doclint:none</additionalOption>-->
</additionalOptions>
</configuration>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jxr-plugin</artifactId>
<version>${maven-jxr-plugin.version}</version>
<configuration>
<javadocDir>target/site/apidocs/</javadocDir>
<linkJavadoc>true</linkJavadoc>
</configuration>
</plugin>

</plugins>
</build>

<reporting>
</reporting>

<profiles>
Expand Down Expand Up @@ -350,6 +313,8 @@
</build>
</profile>



<profile>
<id>license</id>
<build>
Expand Down Expand Up @@ -412,32 +377,6 @@
</build>
</profile>

<!--
<profile>
<id>travis</id>
<activation>
<property>
<name>env.TRAVIS</name>
<value>true</value>
</property>
</activation>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-toolchains-plugin</artifactId>
<version>1.1</version>
<executions>
<execution>
<id>toolchain</id>
<phase>none</phase>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
-->
</profiles>


Expand Down
34 changes: 34 additions & 0 deletions pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,40 @@
</plugins>
</build>
</profile>

<profile>
<id>prayer</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.6.3</version>
<executions>
<execution>
<id>default</id>
<goals>
<goal>aggregate</goal>
</goals>
</execution>
</executions>
<configuration>
<verbose>true</verbose>
<skippedModules>
slf4j-ext,log4j-over-slf4j,log4j-over-slf4j-blackbox,jul-to-slf4j-blackbox,slf4j-migrator,osgi-over-slf4j
</skippedModules>
<detectLinks>true</detectLinks>
<doctitle>SLF4J project ${project.version}</doctitle>
<windowtitle>SLF4J bla</windowtitle>
<linksource>true</linksource>
<additionalOptions>
<additionalOption>-Xdoclint:none</additionalOption>
</additionalOptions>
</configuration>
</plugin>
</plugins>
</build>
</profile>
</profiles>

</project>
7 changes: 7 additions & 0 deletions src/main/javadoc/overview.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<html>
<body>

<p>This is the javadocs for modules produces by the SLF4J project.</p>

</body>
</html>

0 comments on commit 9af7ed2

Please sign in to comment.