Bug 58710 - Errors in JavaDoc for org.apache.log4j.Category.shutdown()
Summary: Errors in JavaDoc for org.apache.log4j.Category.shutdown()
Status: NEW
Alias: None
Product: Log4j - Now in Jira
Classification: Unclassified
Component: Site & Docs (show other bugs)
Version: unspecified
Hardware: All All
: P2 normal
Target Milestone: ---
Assignee: log4j-dev
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2015-12-09 15:52 UTC by Daniel U. Thibault
Modified: 2015-12-09 16:45 UTC (History)
1 user (show)



Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Daniel U. Thibault 2015-12-09 15:52:36 UTC
http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Category.html

The javaDoc for org.apache.log4j.Category.shutdown() reads in part:

"Calling this method will safely close and remove all appenders in all the categories including root contained in the default hierachy.

Some appenders such as SocketAppender and AsyncAppender need to be closed before the application exists. Otherwise, pending logging events might be lost.

The shutdown method is careful to close nested appenders before closing regular appenders. This is allows configurations where a regular appender is attached to a category and again to a nested appender."

which should be:

"Calling this method will safely close and remove all appenders in all the categories (including root) contained in the default hierachy.

Some appenders such as SocketAppender and AsyncAppender need to be closed before the application exits. Otherwise, pending logging events might be lost.

The shutdown method is careful to close nested appenders before closing regular appenders. This allows configurations where a regular appender is attached to a category and again to a nested appender."
Comment 1 Ralph Goers 2015-12-09 16:45:10 UTC
Log4j 1.x has reached end-of-life. Please see https://blogs.apache.org/foundation/entry/apache_logging_services_project_announces.