From ec543dff8e91548b3533ab8510664fd26c898ae1 Mon Sep 17 00:00:00 2001 From: Reinier Zwitserloot Date: Mon, 25 Mar 2019 21:26:09 +0100 Subject: [javadoc] new javadoc tools, new boneheaded mistakes. Seemingly nobody gives a toss about this tool over at oracle? Used some hacks to work around the worst offenses. --- buildScripts/website.ant.xml | 25 ++++++++++++++++------ src/core/lombok/EqualsAndHashCode.java | 9 +++++++- src/core/lombok/ToString.java | 15 +++++++++++-- .../lombok/experimental/FieldNameConstants.java | 2 ++ 4 files changed, 42 insertions(+), 9 deletions(-) diff --git a/buildScripts/website.ant.xml b/buildScripts/website.ant.xml index 7fbd911e..62cb9a44 100644 --- a/buildScripts/website.ant.xml +++ b/buildScripts/website.ant.xml @@ -281,21 +281,21 @@ such as applying the templates to produce the website, converting the changelog Welcome to the lombok javadoc. If you're just looking to learn more about using lombok - You probably want to look at the feature documentation. Otherwise, + You probably want to look at the feature documentation. Otherwise, check the lombok package. If you're trying to extend lombok or write your own plugins, the other packages are what you're looking for. ]]> - +

Lombok - ]]>v${lombok.version}

- Copyright © 2009-2018 The Project Lombok Authors, licensed under the MIT licence.]]> + Copyright © 2009-2019 The Project Lombok Authors, licensed under the MIT licence.]]> + is-external=true doesn't actually do anything except mess with titles, so, we'll just get rid of it. --> @@ -304,12 +304,25 @@ such as applying the templates to produce the website, converting the changelog - + - + + + + + + + + + + + + + + diff --git a/src/core/lombok/EqualsAndHashCode.java b/src/core/lombok/EqualsAndHashCode.java index b2fc672d..e752165c 100644 --- a/src/core/lombok/EqualsAndHashCode.java +++ b/src/core/lombok/EqualsAndHashCode.java @@ -97,6 +97,8 @@ public @interface EqualsAndHashCode { /** * Only include fields and methods explicitly marked with {@code @EqualsAndHashCode.Include}. * Normally, all (non-static, non-transient) fields are included by default. + * + * @return If {@code true}, don't include non-static non-transient fields automatically (default: {@code false}). */ boolean onlyExplicitlyIncluded() default false; @@ -113,7 +115,12 @@ public @interface EqualsAndHashCode { @Target({ElementType.FIELD, ElementType.METHOD}) @Retention(RetentionPolicy.SOURCE) public @interface Include { - /** Defaults to the method name of the annotated member. If on a method and the name equals the name of a default-included field, this member takes its place. */ + /** + * Defaults to the method name of the annotated member. + * If on a method and the name equals the name of a default-included field, this member takes its place. + * + * @return If present, this method serves as replacement for the named field. + */ String replaces() default ""; } } diff --git a/src/core/lombok/ToString.java b/src/core/lombok/ToString.java index ae3f071f..34418a2f 100644 --- a/src/core/lombok/ToString.java +++ b/src/core/lombok/ToString.java @@ -83,6 +83,8 @@ public @interface ToString { /** * Only include fields and methods explicitly marked with {@code @ToString.Include}. * Normally, all (non-static) fields are included by default. + * + * @return If {@code true}, don't include non-static fields automatically (default: {@code false}). */ boolean onlyExplicitlyIncluded() default false; @@ -102,10 +104,19 @@ public @interface ToString { // /** If true and the return value is {@code null}, omit this member entirely from the {@code toString} output. */ // boolean skipNull() default false; // -- We'll add it later, it requires a complete rework on the toString code we generate. - /** Higher ranks are printed first. Members of the same rank are printed in the order they appear in the source file. */ + /** + * Higher ranks are printed first. Members of the same rank are printed in the order they appear in the source file. + * + * @return ordering within the generating {@code toString()}; higher numbers are printed first. + */ int rank() default 0; - /** Defaults to the field / method name of the annotated member. If the name equals the name of a default-included field, this member takes its place. */ + /** + * Defaults to the field / method name of the annotated member. + * If the name equals the name of a default-included field, this member takes its place. + * + * @return The name to show in the generated {@code toString()}. Also, if this annotation is on a method and the name matches an existing field, it replaces that field. + */ String name() default ""; } } diff --git a/src/core/lombok/experimental/FieldNameConstants.java b/src/core/lombok/experimental/FieldNameConstants.java index d6886890..da97a721 100644 --- a/src/core/lombok/experimental/FieldNameConstants.java +++ b/src/core/lombok/experimental/FieldNameConstants.java @@ -41,6 +41,8 @@ public @interface FieldNameConstants { /** * Only include fields and methods explicitly marked with {@code @FieldNameConstants.Include}. * Normally, all (non-static) fields are included by default. + * + * @return If {@code true}, don't include non-static fields automatically (default: {@code false}). */ boolean onlyExplicitlyIncluded() default false; -- cgit