diff options
Diffstat (limited to 'website/templates/features')
| -rw-r--r-- | website/templates/features/GetterSetter.html | 2 | ||||
| -rw-r--r-- | website/templates/features/_features.html | 20 | ||||
| -rw-r--r-- | website/templates/features/configuration.html | 10 | ||||
| -rw-r--r-- | website/templates/features/constructor.html | 2 | ||||
| -rw-r--r-- | website/templates/features/delombok.html | 8 | ||||
| -rw-r--r-- | website/templates/features/experimental/FieldDefaults.html | 2 | ||||
| -rw-r--r-- | website/templates/features/experimental/index.html | 4 | ||||
| -rw-r--r-- | website/templates/features/index.html | 12 |
8 files changed, 35 insertions, 25 deletions
diff --git a/website/templates/features/GetterSetter.html b/website/templates/features/GetterSetter.html index 7ceaa3ba..1baa5bd0 100644 --- a/website/templates/features/GetterSetter.html +++ b/website/templates/features/GetterSetter.html @@ -62,7 +62,7 @@ </p><p> You can annotate a class with a <code>@Getter</code> or <code>@Setter</code> annotation. Doing so is equivalent to annotating all non-static fields in that class with that annotation. <code>@Getter</code>/<code>@Setter</code> annotations on fields take precedence over the ones on classes. </p><p> - Using the <code>AccessLevel.NONE</code> access level simply generates nothing. It's useful only in combination with <a href="features/Data"><code>@Data</code></a> or a class-wide <code>@Getter</code> or <code>@Setter</code>. + Using the <code>AccessLevel.NONE</code> access level simply generates nothing. It's useful only in combination with <a href="/features/Data"><code>@Data</code></a> or a class-wide <code>@Getter</code> or <code>@Setter</code>. </p><p> <code>@Getter</code> can also be used on enums. <code>@Setter</code> can't, not for a technical reason, but for a pragmatic one: Setters on enums are an extremely bad idea. </p> diff --git a/website/templates/features/_features.html b/website/templates/features/_features.html index c0c63a76..dcee152c 100644 --- a/website/templates/features/_features.html +++ b/website/templates/features/_features.html @@ -14,14 +14,14 @@ <#macro overview> <div class="row"> - <h3>Overview</h3> + <@main.h3 title="Overview" /> <#nested> </div> </#macro> <#macro experimental> <div class="row"> - <h3>Experimental</h3> + <@main.h3 title="Experimental" /> Experimental because: <#nested> @@ -30,14 +30,14 @@ <#macro snippets name> <div class="row container-fluid"> - <div class="col-lg-6"> - <h3>With Lombok</h3> + <div class="snippet-col first-snippet"> + <@main.h3 title="With Lombok" /> <div class="snippet">${usages.pre(name)?no_esc}</div> </div> <div class="sep"></div> - <div class="col-lg-6"> - <h3>Vanilla Java</h3> + <div class="snippet-col second-snippet"> + <@main.h3 title="Vanilla Java" /> <div class="snippet">${usages.post(name)?no_esc}</div> </div> @@ -46,7 +46,7 @@ <#macro confKeys> <div class="row"> - <h3>Supported configuration keys:</h3> + <@main.h3 title="Supported configuration keys:" /> <dl> <#nested> </dl> @@ -55,7 +55,7 @@ <#macro smallPrint> <div class="row"> - <h3>Small print</h3> + <@main.h3 title="Small print" /> <div class="smallprint"> <#nested> @@ -68,9 +68,9 @@ <div class="page-header top5" id="featureContent"> <div class="row text-center"> <div class="header-group"> - <h1>${title}</h1> + <@main.h1 title="${title}" /> - <h3>${logline?no_esc}</h3> + <@main.h3 title="${logline?no_esc}" /> </div> </div> <#nested> diff --git a/website/templates/features/configuration.html b/website/templates/features/configuration.html index 642332a0..4f861287 100644 --- a/website/templates/features/configuration.html +++ b/website/templates/features/configuration.html @@ -70,7 +70,7 @@ </@f.overview> <@f.featureSection> - <h3>Global config keys</h3> + <@f.main.h3 title="Global config keys" /> <p> To stop lombok from looking at parent directories for more configuration files, the special key: @@ -79,10 +79,12 @@ </div> can be included. We suggest you put this in the root of your workspace directory. </p><p> - Lombok normally adds <code>@javax.annotation.Generated</code> annotations to all generated nodes where possible. You can stop this with: + Lombok can add <code>@javax.annotation.Generated</code> annotations to all generated nodes where possible. You can enable this with: <div class="snippet example"> - <code>lombok.addJavaxGeneratedAnnotation = false</code> + <code>lombok.addJavaxGeneratedAnnotation = true</code> </div> + We advise against this; JDK9 breaks this annotation, and it's unlikely to ever get fixed.<br /> + <em>NB:</em> Until Lombok v2.0.0, this setting defaulted to <code>true</code>. </p><p> Lombok can be configured to add <code>@lombok.Generated</code> annotations to all generated nodes where possible; useful for JaCoCo (which has built in support), or other style checkers and code coverage tools: @@ -98,7 +100,7 @@ </@f.featureSection> <@f.featureSection> - <h3>Config keys that can affect any source file</h3> + <@f.main.h3 title="Config keys that can affect any source file" /> <p> These config keys can make lombok affect source files even if they have 0 lombok annotations in them.<br /> diff --git a/website/templates/features/constructor.html b/website/templates/features/constructor.html index 6a12fa2a..716efe5a 100644 --- a/website/templates/features/constructor.html +++ b/website/templates/features/constructor.html @@ -7,7 +7,7 @@ <p> This set of 3 annotations generate a constructor that will accept 1 parameter for certain fields, and simply assigns this parameter to the field. </p><p> - <code>@NoArgsConstructor</code> will generate a constructor with no parameters. If this is not possible (because of final fields), a compiler error will result instead, unless <code>@NoArgsConstructor(force = true</code> is used, then all final fields are initialized with <code>0</code> / <code>false</code> / <code>null</code>. For fields with constraints, such as <code>@NonNull</code> fields, <em>no</em> check is generated,so be aware that these constraints will generally not be fulfilled until those fields are properly initialized later. Certain java constructs, such as hibernate and the Service Provider Interface require a no-args constructor. This annotation is useful primarily in combination with either <code>@Data</code> or one of the other constructor generating annotations. + <code>@NoArgsConstructor</code> will generate a constructor with no parameters. If this is not possible (because of final fields), a compiler error will result instead, unless <code>@NoArgsConstructor(force = true)</code> is used, then all final fields are initialized with <code>0</code> / <code>false</code> / <code>null</code>. For fields with constraints, such as <code>@NonNull</code> fields, <em>no</em> check is generated,so be aware that these constraints will generally not be fulfilled until those fields are properly initialized later. Certain java constructs, such as hibernate and the Service Provider Interface require a no-args constructor. This annotation is useful primarily in combination with either <code>@Data</code> or one of the other constructor generating annotations. </p><p> <code>@RequiredArgsConstructor</code> generates a constructor with 1 parameter for each field that requires special handling. All non-initialized <code>final</code> fields get a parameter, as well as any fields that are marked as <code>@NonNull</code> that aren't initialized where they are declared. For those fields marked with <code>@NonNull</code>, an explicit null check is also generated. The constructor will throw a <code>NullPointerException</code> if any of the parameters intended for the fields marked with <code>@NonNull</code> contain <code>null</code>. The order of the parameters match the order in which the fields appear in your class. </p><p> diff --git a/website/templates/features/delombok.html b/website/templates/features/delombok.html index fc9dfddc..6f41fc46 100644 --- a/website/templates/features/delombok.html +++ b/website/templates/features/delombok.html @@ -13,7 +13,7 @@ Delombok's output format can be configured with command line options (use <code>--format-help</code> for a complete list). A few such options are automatically scanned from input if possible (such as indent). If delombok's formatting is not conforming to your preferred code style, have a look! </p> - <h3>Running delombok on the command line</h3> + <@f.main.h3 title="Running delombok on the command line" /> <p> Delombok is included in <code>lombok.jar</code>. To use it, all you need to run on the command line is: @@ -28,7 +28,7 @@ </div> </p> - <h3>Running delombok in ant</h3> + <@f.main.h3 title="Running delombok in ant" /> <p> <code>lombok.jar</code> includes an ant task which can apply delombok for you. For example, to create javadoc for your project, your <code>build.xml</code> file would look something like: @@ -45,13 +45,13 @@ Instead of a <code>from</code> attribute, you can also nest <code><fileset></code> nodes. </p> - <h3>Running delombok in maven</h3> + <@f.main.h3 title="Running delombok in maven" /> <p> Anthony Whitford has written a <a href="https://github.com/awhitford/lombok.maven">maven plugin</a> for delomboking your source code. </p> - <h3>Limitations</h3> + <@f.main.h3 title="Limitations" /> <p> Delombok tries to preserve your code as much as it can, but comments may move around a little bit, especially comments that are in the middle of a syntax node. For example, any comments appearing in the middle of a list of method modifiers, such as <code>public /*comment*/ static ...</code> will move towards the front of the list of modifiers. In practice, any java source parsing tool will not be affected.<br /> diff --git a/website/templates/features/experimental/FieldDefaults.html b/website/templates/features/experimental/FieldDefaults.html index 0d4cda9e..c0d3db96 100644 --- a/website/templates/features/experimental/FieldDefaults.html +++ b/website/templates/features/experimental/FieldDefaults.html @@ -38,7 +38,7 @@ </dt><dd> Lombok will flag any usage of <code>@FieldDefaults</code> as a warning or error if configured. </dd><dt> - <code>lombok.fieldDefautls.defaultPrivate</code> = [<code>true</code> | <code>false</code>] (default: false) + <code>lombok.fieldDefaults.defaultPrivate</code> = [<code>true</code> | <code>false</code>] (default: false) </dt><dd> (Since 1.16.8) If set to <code>true</code>, <em>every</em> field in <em>every</em> class or enum anywhere in the sources being compiled will be marked as <code>private</code> unless it has an explicit access modifier or the <code>@PackagePrivate</code> annotation, or an explicit <code>@FieldDefaults</code> annotation is present to override this config key. </dd><dt> diff --git a/website/templates/features/experimental/index.html b/website/templates/features/experimental/index.html index 11d48485..dbd2f93c 100644 --- a/website/templates/features/experimental/index.html +++ b/website/templates/features/experimental/index.html @@ -4,9 +4,11 @@ <@main.scaffold> <div class="page-header top5"> <div class="row text-center"> - <h1>Lombok experimental features</h1> + <@main.h1 title="Lombok experimental features" /> </div> <div class="row"> + The <a href="/api/">Lombok javadoc</a> is available, but we advise these pages. + <p> Experimental features are available in your normal lombok installation, but are not as robustly supported as lombok's main features. In particular, experimental features: <ul> diff --git a/website/templates/features/index.html b/website/templates/features/index.html index da3db634..73b5dce8 100644 --- a/website/templates/features/index.html +++ b/website/templates/features/index.html @@ -3,9 +3,11 @@ <@main.scaffold> <div class="page-header top5"> <div class="row text-center"> - <h1>Lombok features.</h1> + <@main.h1 title="Lombok features" /> </div> <div class="row"> + The <a href="/api/">Lombok javadoc</a> is available, but we advise these pages. + <@main.feature title="val" href="val"> Finally! Hassle-free final local variables. </@main.feature> @@ -66,10 +68,14 @@ <@main.feature title="@Log" href="log"> Captain's Log, stardate 24435.7: "What was that line again?" </@main.feature> + + <@main.feature title="experimental" href="/features/experimental/all"> + Head to the lab: The new stuff we're working on. + </@main.feature> </div> <div class="row"> - <h1>Configuration system</h1> + <@main.h1 title="Configuration system" /> <div class="text-center"> Lombok, made to order: <a href="configuration">Configure lombok features</a> in one place for your entire project or even your workspace. @@ -77,7 +83,7 @@ </div> <div class="row"> - <h1 class="text-center">Running delombok</h1> + <@main.h1 title="Running delombok" /> <div> Delombok copies your source files to another directory, replacing all lombok annotations with their desugared form. So, it'll turn <code>@Getter</code> back into the actual getter. It then removes the annotation. This is useful for all sorts of reasons; you can check out what's happening under the hood, if the unthinkable happens and you want to stop using lombok, you can easily remove all traces of it in your source, and you can use delombok to preprocess your source files for source-level tools such as javadoc and GWT. More information about how to run delombok, including instructions for build tools can be found at the <a href="delombok">delombok page</a>. |