diff options
| author | Soroush Nejad <sardabir@gmail.com> | 2019-10-07 10:59:35 +0200 |
|---|---|---|
| committer | Soroush Nejad <sardabir@gmail.com> | 2019-10-07 10:59:35 +0200 |
| commit | 1e617ccfb51855736e27cd618afc092a70832983 (patch) | |
| tree | b6a82afa126ef5ef8ff2a230fdd6e2a9c7060a6c /website/templates/features | |
| parent | 04f21a249dd2f582a27c16da67aebc4df3d2c383 (diff) | |
| download | lombok-1e617ccfb51855736e27cd618afc092a70832983.tar.gz lombok-1e617ccfb51855736e27cd618afc092a70832983.tar.bz2 lombok-1e617ccfb51855736e27cd618afc092a70832983.zip | |
Add documentation for Tolerate
Diffstat (limited to 'website/templates/features')
| -rw-r--r-- | website/templates/features/experimental/Tolerate.html | 34 | ||||
| -rw-r--r-- | website/templates/features/experimental/index.html | 6 |
2 files changed, 39 insertions, 1 deletions
diff --git a/website/templates/features/experimental/Tolerate.html b/website/templates/features/experimental/Tolerate.html new file mode 100644 index 00000000..09610069 --- /dev/null +++ b/website/templates/features/experimental/Tolerate.html @@ -0,0 +1,34 @@ +<#import "../_features.html" as f> + + <@f.scaffold title="@Tolerate" logline="Skip, jump, and forget! Skip a method or constructor."> + <@f.history> + <p> + <code>@Tolerate</code> was introduced as feature in lombok v1.14.2<br /> + </p> + </@f.history> + + <@f.experimental> + <ul> + <li> + Not used that much. + </li> + <li> + Difficult to support for edge cases, such as recursive delegation. + </li> + </ul> + </@f.experimental> + + <@f.overview> + <p> + Any method or constructor can be annotated with <code>@Tolerate</code> and lombok will skip it when + considering whether or not to generate a method or constructor. This is useful if the types of the + parameters of your method do not clash with what lombok would generate. + </p> + <p> + Put on any method or constructor to make lombok pretend it doesn't exist,i.e., to generate a method + which would otherwise be skipped due to possible conflicts. + </p> + </@f.overview> + + <@f.snippets name="experimental/Tolerate" /> + </@f.scaffold>
\ No newline at end of file diff --git a/website/templates/features/experimental/index.html b/website/templates/features/experimental/index.html index 960f4b1a..9ed3f546 100644 --- a/website/templates/features/experimental/index.html +++ b/website/templates/features/experimental/index.html @@ -9,7 +9,7 @@ </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> @@ -67,6 +67,10 @@ <@main.feature title="@SuperBuilder" href="SuperBuilder"> Bob now knows his ancestors: Builders with fields from superclasses, too. </@main.feature> + + <@main.feature title="@Tolerate" href="Tolerate"> + Skip, jump, and forget! Skip a method or constructor. + </@main.feature> </div> <@f.confKeys> |