minor edits

Signed-off-by: Ceki Gulcu <ceki@qos.ch>
qos-ch · Dec 28, 2023 · 2cec82b · 2cec82b
1 parent aafbd04
commit 2cec82b
Show file tree

Hide file tree

Showing 8 changed files with 11 additions and 31 deletions.
diff --git a/parent/pom.xml b/parent/pom.xml
@@ -18,7 +18,7 @@
 
 
   <organization>
-    <name>QOS.ch</name>
+    <name>QOS.CH Sarl</name>
     <url>http://www.qos.ch</url>
   </organization>
   <inceptionYear>2005</inceptionYear>
@@ -126,24 +126,6 @@
           <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>-->
-        <!--            <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>
 

diff --git a/pom.xml b/pom.xml
@@ -33,13 +33,13 @@
   <modules>
     <module>parent</module>
     <module>slf4j-api</module>
-    <module>slf4j-testing</module>    
+    <module>slf4j-testing</module>
     <module>slf4j-simple</module>
     <module>slf4j-nop</module>
     <module>slf4j-jdk14</module>
     <module>slf4j-jdk-platform-logging</module>
     <module>slf4j-log4j12</module>
-    <module>slf4j-reload4j</module>    
+    <module>slf4j-reload4j</module>
     <module>slf4j-ext</module>
     <module>jcl-over-slf4j</module>
     <module>jcl-over-slf4j-blackbox</module>
@@ -165,15 +165,13 @@
         </executions>
         <configuration>
           <verbose>true</verbose>
-<!--          <sourceFileExcludes>-->
-<!--            <sourceFileExclude>**/xmodule-info.java</sourceFileExclude>-->
-<!--          </sourceFileExcludes>-->
           <skippedModules>
             slf4j-testing,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 modules ${project.version}</doctitle>
+          <doctitle>SLF4J project modules 2.1.0-alpha0</doctitle>
           <windowtitle>SLF4J javadoc</windowtitle>
+          <bottom><![CDATA[Copyright  &copy; 2005-{currentYear} QOS.CH Sarl. All rights reserved]]></bottom>
           <linksource>true</linksource>
           <additionalOptions>
             <additionalOption>-Xdoclint:none</additionalOption>

diff --git a/slf4j-api/src/main/java/module-info.java b/slf4j-api/src/main/java/module-info.java
@@ -1,5 +1,5 @@
 /**
- *  <p>This module defines the SLF4J API. </p>
+ *  <p>This module defines the client-facing SLF4J API. </p>
  *
  *  <p>More specifically, the {@link org.slf4j} package contains client-facing classes and interfaces.</p>
  *

diff --git a/slf4j-api/src/main/java/org/slf4j/MDCAmbit.java b/slf4j-api/src/main/java/org/slf4j/MDCAmbit.java
@@ -121,7 +121,7 @@ public MDCAmbit addKey(String key) {
     }
 
     /**
-     *  Keep track of several keys for later removal by a call to {@link #()}.
+     *  Keep track of several keys for later removal by a call to {@link #clear()} .
      * @param keys
      * @return this instance
      */

diff --git a/slf4j-jdk-platform-logging/src/main/java/module-info.java b/slf4j-jdk-platform-logging/src/main/java/module-info.java
@@ -23,7 +23,7 @@
  *
  */
 /**
- * Implementation of {@link System.Logger} interface relaying into SLF4J.
+ * Implementation of {@link System.Logger} interface relaying events to SLF4J.
  *
  * @since 2.0.0
  */

diff --git a/slf4j-nop/src/main/java/module-info.java b/slf4j-nop/src/main/java/module-info.java
@@ -1,5 +1,5 @@
 /**
- * A no-operation logging back-end that drops all events.
+ * A no-operation logging provider, aka back-end, that drops all events.
  */
 module org.slf4j.nop {
   requires org.slf4j;

diff --git a/slf4j-nop/src/main/java/org/slf4j/nop/NOPServiceProvider.java b/slf4j-nop/src/main/java/org/slf4j/nop/NOPServiceProvider.java
@@ -9,7 +9,7 @@
 import org.slf4j.spi.SLF4JServiceProvider;
 
 /**
- * As the name indicates, this service provider discards all events.
+ * As the name indicates, this {#link SLF4JServiceProvider} implementation git sdiscards all events.
  *
  * @author Ceki G&uuml;lc&uuml;
  */

diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html
@@ -1,7 +1,7 @@
 <html>
   <body>
 
-    <p>This is the javadocs for modules produced by the SLF4J project.</p>
+    <p>Here are the javadocs for the modules produced by the SLF4J project.</p>
 
   </body>
 </html>