Andrew Glassman created SLF4J-446:
-------------------------------------
Summary: Update JavaDoc on Logger to explicitly state desired
functionality.
Key: SLF4J-446
URL: https://jira.qos.ch/browse/SLF4J-446
Project: SLF4J
Issue Type: Improvement
Components: Core API
Reporter: Andrew Glassman
Assignee: SLF4J developers list
Priority: Minor
{{In slf4j-api/src/main/java/org/slf4j/Logger.java i}}t is not specified in the
JavaDoc that the last parameter of string templated arrays are expected to be
treated differently if they extend Throwable.
Pull request that addresses this issue:
https://github.com/qos-ch/slf4j/pull/185
JavaDoc on the interface should explicitly state that if the last element of
the array extends Throwable, it will not be used to template the string, and
will be "the exception (throwable) to log".
Documenting this expected functionality in docs outside of the JavaDoc is fine,
but it should explicitly be stated in the interface contract if implementations
are expected to do that.
--
This message was sent by Atlassian JIRA
(v7.3.1#73012)
_______________________________________________
slf4j-dev mailing list
[email protected]
http://mailman.qos.ch/mailman/listinfo/slf4j-dev
