Fix some typos in comments

This commit is contained in:
Sebastian Kürten 2016-11-07 14:54:43 +01:00
parent 42e9b19c77
commit 9fe38af528
21 changed files with 32 additions and 31 deletions

View File

@ -321,9 +321,9 @@ public abstract class LogFactory {
* Returns a string that uniquely identifies the specified object, including
* its class.
* <p>
* The returned string is of form "classname@hashcode", ie is the same as the
* The returned string is of form "classname@hashcode", i.e. is the same as the
* return value of the Object.toString() method, but works even when the
* specified object's class has overidden the toString method.
* specified object's class has overridden the toString method.
*
* @param o
* may be null.

View File

@ -87,7 +87,7 @@ public class SimpleLog implements Log, Serializable {
/** Properties loaded from simplelog.properties */
static protected final Properties simpleLogProps = new Properties();
/** The default format to use when formating dates */
/** The default format to use when formatting dates */
static protected final String DEFAULT_DATE_TIME_FORMAT = "yyyy/MM/dd HH:mm:ss:SSS zzz";
/** Include the instance name in the log message? */

View File

@ -118,7 +118,7 @@ public interface Appender {
* disposal. If this method returns <code>false</code>, meaning that
* a layout is not required, then layout configuration will be
* skipped even if there is available layout configuration
* information at the disposal of the configurator..
* information at the disposal of the configurator.
* <p/>
* <p>In the rather exceptional case, where the appender
* implementation admits a layout but can also work without it, then

View File

@ -145,7 +145,7 @@ public class Category {
}
/**
* Delegates tob {@link org.slf4j.Logger#isWarnEnabled} method in SLF4J
* Delegates to {@link org.slf4j.Logger#isWarnEnabled} method in SLF4J
*/
public boolean isWarnEnabled() {
return slf4jLogger.isWarnEnabled();

View File

@ -209,13 +209,13 @@ public class Level extends Priority implements Serializable {
/**
* Resolved deserialized level to one of the stock instances.
* May be overriden in classes derived from Level.
* May be overridden in classes derived from Level.
* @return resolved object.
* @throws ObjectStreamException if exception during resolution.
*/
private Object readResolve() throws ObjectStreamException {
//
// if the deserizalized object is exactly an instance of Level
// if the deserialized object is exactly an instance of Level
//
if (getClass() == Level.class) {
return toLevel(level);

View File

@ -19,7 +19,7 @@ package org.apache.log4j.spi;
import org.apache.log4j.*;
/**
Listen to events occuring within a {@link
Listen to events occurring within a {@link
org.apache.log4j.Hierarchy Hierarchy}.
@author Ceki G&uuml;lc&uuml;

View File

@ -42,7 +42,7 @@ import org.slf4j.spi.MDCAdapter;
* i.e. this class, will delegate to the underlying system's MDC. Note that at
* this time, only two logging systems, namely log4j and logback, offer MDC
* functionality. For java.util.logging which does not support MDC,
* {@link BasicMDCAdapter} will be used. For other systems, i.e slf4j-simple
* {@link BasicMDCAdapter} will be used. For other systems, i.e. slf4j-simple
* and slf4j-nop, {@link NOPMDCAdapter} will be used.
*
* <p>

View File

@ -42,7 +42,7 @@ public class NOPLogger extends MarkerIgnoringBase {
public static final NOPLogger NOP_LOGGER = new NOPLogger();
/**
* There is no point in creating multiple instances of NOPLOgger,
* There is no point in creating multiple instances of NOPLogger,
* except by derived classes, hence the protected access for the constructor.
*/
protected NOPLogger() {

View File

@ -32,9 +32,10 @@ import org.slf4j.LoggerFactory;
/**
* Serves as base class for named logger implementation. More significantly, this
* class establishes deserialization behavior. See @see #readResolve.
* class establishes deserialization behavior.
*
* @author Ceki Gulcu
* @see #readResolve
* @since 1.5.3
*/
abstract class NamedLoggerBase implements Logger, Serializable {

View File

@ -47,9 +47,9 @@ public interface LoggerFactoryBinder {
* The String form of the {@link ILoggerFactory} object that this
* <code>LoggerFactoryBinder</code> instance is <em>intended</em> to return.
*
* <p>This method allows the developer to intterogate this binder's intention
* <p>This method allows the developer to interrogate this binder's intention
* which may be different from the {@link ILoggerFactory} instance it is able to
* yield in practice. The discrepency should only occur in case of errors.
* yield in practice. The discrepancy should only occur in case of errors.
*
* @return the class name of the intended {@link ILoggerFactory} instance
*/

View File

@ -38,7 +38,7 @@ public interface MDCAdapter {
/**
* Put a context value (the <code>val</code> parameter) as identified with
* the <code>key</code> parameter into the current thread's context map.
* The <code>key</code> parameter cannot be null. The code>val</code> parameter
* The <code>key</code> parameter cannot be null. The <code>val</code> parameter
* can be null only if the underlying implementation supports it.
*
* <p>If the current thread does not have a context map it is created as a side

View File

@ -47,9 +47,9 @@ public interface MarkerFactoryBinder {
* The String form of the {@link IMarkerFactory} object that this
* <code>MarkerFactoryBinder</code> instance is <em>intended</em> to return.
*
* <p>This method allows the developer to intterogate this binder's intention
* <p>This method allows the developer to interrogate this binder's intention
* which may be different from the {@link IMarkerFactory} instance it is able to
* return. Such a discrepency should only occur in case of errors.
* return. Such a discrepancy should only occur in case of errors.
*
* @return the class name of the intended {@link IMarkerFactory} instance
*/

View File

@ -88,7 +88,7 @@ public class EventData implements Serializable {
/**
* Serialize all the EventData items into an XML representation.
*
* @return an XML String containing all the EventDAta items.
* @return an XML String containing all the EventData items.
*/
public String toXML() {
return toXML(eventData);
@ -98,7 +98,7 @@ public class EventData implements Serializable {
* Serialize all the EventData items into an XML representation.
*
* @param map the Map to transform
* @return an XML String containing all the EventDAta items.
* @return an XML String containing all the EventData items.
*/
public static String toXML(Map<String, Object> map) {
ByteArrayOutputStream baos = new ByteArrayOutputStream();
@ -243,7 +243,7 @@ public class EventData implements Serializable {
}
/**
* Returns an Iterator over all the entries in the EventDAta.
* Returns an Iterator over all the entries in the EventData.
*
* @return an Iterator that can be used to access all the event attributes.
*/

View File

@ -58,7 +58,7 @@ public class EventException extends RuntimeException {
* Constructor that chains another Exception or Error and also allows a message
* to be specified.
* @param exceptionMessage The exception message.
* @param originalException The original excepton.
* @param originalException The original exception.
*/
public EventException(String exceptionMessage, Throwable originalException) {
super(exceptionMessage, originalException);

View File

@ -40,9 +40,9 @@ import javassist.bytecode.LocalVariableAttribute;
public class JavassistHelper {
/**
* Create a javaassist source snippet which either is empty (for anything
* Create a javassist source snippet which either is empty (for anything
* which does not return a value) or a explanatory text around the $_
* javaassist return value variable.
* javassist return value variable.
*
* @param method
* descriptor of method
@ -82,7 +82,7 @@ public class JavassistHelper {
}
/**
* Return javaassist source snippet which lists all the parameters and their
* Return javassist source snippet which lists all the parameters and their
* values. If available the source names are extracted from the debug
* information and used, otherwise just a number is shown.
*

View File

@ -80,7 +80,7 @@ public class LogTransformer implements ClassFileTransformer {
/**
* Should each method log entry (with parameters) and exit (with parameters
* and returnvalue)?
* and return value)?
*
* @param b
* value of flag

View File

@ -214,7 +214,7 @@ public class Profiler implements TimeInstrument {
}
/**
* Return a copy of the global stopwath of this Profiler instance.
* Return a copy of the global stopwatch of this Profiler instance.
*
* @return a copy of this instance's global stop watch
* @since 1.5.9

View File

@ -25,7 +25,7 @@
package org.slf4j.profiler;
/**
* A very basic @{link TimeInstrument} which can be started and stopped
* A very basic {@link TimeInstrument} which can be started and stopped
* once and only once.
*
* @author Ceki G&uuml;lc&uuml;

View File

@ -43,7 +43,7 @@ public interface TimeInstrument {
TimeInstrumentStatus getStatus();
/**
* Start tis time instrument.
* Start this time instrument.
*
* @param name
*/

View File

@ -47,7 +47,7 @@ public class PerfTest {
// when the code is guarded by a logger.isLoggable condition,
// duration is about 16 *micro*seconds for 1000 iterations
// when it is not guarded the figure is 90 milliseconds,
// i.e a ration of 1 to 5000
// i.e. a ration of 1 to 5000
}
double debugLoop(int len) {

View File

@ -55,7 +55,7 @@ public class AternativeApproach extends TestCase {
/**
* In this test we replace, using the simple Pattern (Log), the full Log
* declaration and instanciation. This is not convenient because we will also
* declaration and instantiation. This is not convenient because we will also
* replace all String containing "Log".
*/
public void test2() {
@ -82,7 +82,7 @@ public class AternativeApproach extends TestCase {
}
/**
* In this test we use a simple Pattern to replace the log instanciation
* In this test we use a simple Pattern to replace the log instantiation
* without influence on Log declaration.
*
*/
@ -101,7 +101,7 @@ public class AternativeApproach extends TestCase {
/**
* In this test we try to replace keyword Log without influence on String
* containg Log We see that we have to use two differents Patterns
* containing Log We see that we have to use two different Patterns
*/
public void test4() {
Pattern pat = Pattern.compile("(\\sLog\\b)");