From fdc41b143612455f56e27ef47f6cf467cb983992 Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Mon, 14 Dec 2020 14:38:35 -0500 Subject: [PATCH] Fix Javadoc for Java 15 and up. Disable Javadoc doclint for now. --- .github/workflows/maven.yml | 2 +- .../java/org/apache/commons/logging/package.html | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml index ce4bb2a..6768a6c 100644 --- a/.github/workflows/maven.yml +++ b/.github/workflows/maven.yml @@ -43,4 +43,4 @@ jobs: with: java-version: ${{ matrix.java }} - name: Build with Maven - run: mvn -V --no-transfer-progress -Ddoclint=all --file pom.xml + run: mvn -V --no-transfer-progress -D doclint=none --file pom.xml diff --git a/src/main/java/org/apache/commons/logging/package.html b/src/main/java/org/apache/commons/logging/package.html index 9a84549..cbe8cbe 100644 --- a/src/main/java/org/apache/commons/logging/package.html +++ b/src/main/java/org/apache/commons/logging/package.html @@ -21,7 +21,7 @@

Simple wrapper API around multiple logging APIs.

-

Overview

+

Overview

This package provides an API for logging in server-based applications that can be used around a variety of different logging implementations, including @@ -45,7 +45,7 @@ prebuilt support for the following:

-

Quick Start Guide

+

Quick Start Guide

For those impatient to just get on with it, the following example illustrates the typical declaration and use of a logger that is named (by @@ -79,10 +79,10 @@ this page in order to understand how to configure logging for your application.

-

Configuring the Commons Logging Package

+

Configuring the Commons Logging Package

-

Choosing a LogFactory Implementation

+

Choosing a LogFactory Implementation

From an application perspective, the first requirement is to retrieve an object reference to the LogFactory instance that will be used @@ -122,7 +122,7 @@ implementation, if it so desires. An instance of this class will then be created, and cached per class loader. -

The Default LogFactory Implementation

+

The Default LogFactory Implementation

The Logging Package APIs include a default LogFactory implementation class ( @@ -169,7 +169,7 @@ implementation uses the following rules:

configuration information for this default implementation.

-

Configuring the Underlying Logging System

+

Configuring the Underlying Logging System

The basic principle is that the user is totally responsible for the configuration of the underlying logging system. @@ -185,7 +185,7 @@ This file should be prepared in a manner that is specific to the actual logging technology being used.

-

Using the Logging Package APIs

+

Using the Logging Package APIs

Use of the Logging Package APIs, from the perspective of an application component, consists of the following steps: