diff options
author | Reinier Zwitserloot <reinier@tipit.to> | 2009-10-16 10:16:03 +0200 |
---|---|---|
committer | Reinier Zwitserloot <reinier@tipit.to> | 2009-10-16 10:16:03 +0200 |
commit | 2d3b98e847b9dc1878b657de97fce2f54104776d (patch) | |
tree | a66995df3efe3d1f4c5075ec098a1b7114aabb4d /src/lombok/EqualsAndHashCode.java | |
parent | b5c8b725655d2ad8a715cfb1fbbdf25dbdcd4ceb (diff) | |
download | lombok-2d3b98e847b9dc1878b657de97fce2f54104776d.tar.gz lombok-2d3b98e847b9dc1878b657de97fce2f54104776d.tar.bz2 lombok-2d3b98e847b9dc1878b657de97fce2f54104776d.zip |
Switched all use of <code></code> in javadoc to {@code}.
Diffstat (limited to 'src/lombok/EqualsAndHashCode.java')
-rw-r--r-- | src/lombok/EqualsAndHashCode.java | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/src/lombok/EqualsAndHashCode.java b/src/lombok/EqualsAndHashCode.java index f752d70c..88d72051 100644 --- a/src/lombok/EqualsAndHashCode.java +++ b/src/lombok/EqualsAndHashCode.java @@ -27,29 +27,29 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * Generates implementations for the <code>equals</code> and <code>hashCode</code> methods inherited by all objects. + * Generates implementations for the {@code equals} and {@code hashCode} methods inherited by all objects. * <p> - * If either method already exists, then <code>@EqualsAndHashCode</code> will not generate that particular method. - * If they all exist, <code>@EqualsAndHashCode</code> generates no methods, and emits a warning instead to highlight + * If either method already exists, then {@code @EqualsAndHashCode} will not generate that particular method. + * If they all exist, {@code @EqualsAndHashCode} generates no methods, and emits a warning instead to highlight * that its doing nothing at all. The parameter list and return type are not relevant when deciding to skip generation of - * a method; any method named <code>hashCode</code> will make <code>@EqualsAndHashCode</code> not generate that method, + * a method; any method named {@code hashCode} will make {@code @EqualsAndHashCode} not generate that method, * for example. * <p> * By default, all fields that are non-static and non-transient are used in the equality check and hashCode generation. - * You can exclude more fields by specifying them in the <code>exclude</code> parameter. You can also explicitly specify - * the fields that are to be used by specifying them in the <code>of</code> parameter. + * You can exclude more fields by specifying them in the {@code exclude} parameter. You can also explicitly specify + * the fields that are to be used by specifying them in the {@code of} parameter. * <p> - * Normally, auto-generating <code>hashCode</code> and <code>equals</code> implementations in a subclass is a bad idea, as + * Normally, auto-generating {@code hashCode} and {@code equals} implementations in a subclass is a bad idea, as * the superclass also defines fields, for which equality checks/hashcodes won't be auto-generated. Therefore, a warning - * is emitted when you try. Instead, you can set the <code>callSuper</code> parameter to <em>true</em> which will call - * <code>super.equals</code> and <code>super.hashCode</code>. Doing this with <code>java.lang.Object</code> as superclass is + * is emitted when you try. Instead, you can set the {@code callSuper} parameter to <em>true</em> which will call + * {@code super.equals} and {@code super.hashCode}. Doing this with {@code java.lang.Object} as superclass is * pointless, so, conversely, setting this flag when <em>NOT</em> extending something (other than Object) will also generate - * a warning. Be aware that not all implementations of <code>equals</code> correctly handle being called from a subclass! - * Fortunately, lombok-generated <code>equals</code> implementations do correctly handle it. + * a warning. Be aware that not all implementations of {@code equals} correctly handle being called from a subclass! + * Fortunately, lombok-generated {@code equals} implementations do correctly handle it. * <p> * Array fields are handled by way of {@link java.util.Arrays#deepEquals(Object[], Object[])} where necessary, as well - * as <code>deepHashCode</code>. The downside is that arrays with circular references (arrays that contain themselves, - * possibly indirectly) results in calls to <code>hashCode</code> and <code>equals</code> throwing a + * as {@code deepHashCode}. The downside is that arrays with circular references (arrays that contain themselves, + * possibly indirectly) results in calls to {@code hashCode} and {@code equals} throwing a * {@link java.lang.StackOverflowError}. However, the implementations for java's own {@link java.util.ArrayList} suffer * from the same flaw. */ @@ -58,7 +58,7 @@ import java.lang.annotation.Target; public @interface EqualsAndHashCode { /** * Any fields listed here will not be taken into account in the generated - * <code>equals</code> and <code>hashCode</code> implementations. + * {@code equals} and {@code hashCode} implementations. * Mutually exclusive with {@link #of()}. */ String[] exclude() default {}; @@ -72,7 +72,7 @@ public @interface EqualsAndHashCode { String[] of() default {}; /** - * Call on the superclass's implementations of <code>equals</code> and <code>hashCode</code> before calculating + * Call on the superclass's implementations of {@code equals} and {@code hashCode} before calculating * for the fields in this class. * <strong>default: false</strong> */ |