From 0ab3e93caa2ebb63de2a42fc6d7c305f8c87ca19 Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Sat, 18 Mar 2023 22:40:04 -0700 Subject: [PATCH] Added links to wiki for Lowercase, Rot13, SwapCase, Trim, Uncapitalize and Uppercase --- README.md | 38 +++++++++---------- lib/src/main/java/rife/render/Lowercase.java | 1 + .../main/java/rife/render/RenderUtils.java | 3 +- lib/src/main/java/rife/render/Rot13.java | 1 + lib/src/main/java/rife/render/SwapCase.java | 1 + lib/src/main/java/rife/render/Trim.java | 1 + .../main/java/rife/render/Uncapitalize.java | 1 + lib/src/main/java/rife/render/Uppercase.java | 1 + 8 files changed, 27 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index b0613b2..1f96f6c 100644 --- a/README.md +++ b/README.md @@ -21,16 +21,16 @@ This project provides a collection of useful template renderers. ## Encoding Renderers -| Renderer | Description | -|:-------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------| -| [rife.render.EncodeBase64](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeBase64) | Encodes a template value to Base64 | -| [rife.render.EncodeHtml](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeHtml) | Encodes a template value to HTML | -| [rife.render.EncodeHtmlEntities](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeHtmlEntities0) | Encodes a template value to HTML decimal entities | -| [rife.render.EncodeJs](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeJs) | Encodes a template value to JavaScript/ECMAScript | -| [rife.render.EncodeJson](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeJson) | Encodes a template value to JSON | -| [rife.render.EncodeUnicode](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeUnicode) | Encodes a template value to Unicode escape codes | -| [rife.render.EncodeUrl](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeUrl) | URL-encodes a template value | -| [rife.render.EncodeXml](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeXml) | Encodes a template value to XML | +| Renderer | Description | +|:--------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------| +| [rife.render.EncodeBase64](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeBase64) | Encodes a template value to Base64 | +| [rife.render.EncodeHtml](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeHtml) | Encodes a template value to HTML | +| [rife.render.EncodeHtmlEntities](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeHtmlEntities) | Encodes a template value to HTML decimal entities | +| [rife.render.EncodeJs](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeJs) | Encodes a template value to JavaScript/ECMAScript | +| [rife.render.EncodeJson](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeJson) | Encodes a template value to JSON | +| [rife.render.EncodeUnicode](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeUnicode) | Encodes a template value to Unicode escape codes | +| [rife.render.EncodeUrl](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeUrl) | URL-encodes a template value | +| [rife.render.EncodeXml](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeXml) | Encodes a template value to XML | ## Format Renderers @@ -43,15 +43,15 @@ This project provides a collection of useful template renderers. ## Text Renderers -| Renderer | Description | -|:--------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------| -| [rife.render.Capitalize](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.Capitalize) | Capitalizes a template value | -| `rife.render.Lowercase` | Converts a template value to lowercase | -| `rife.render.Rot13` | Translates a template value to/from ROT13 | -| `rife.render.SwapCase` | Swap case of a template value | -| `rife.render.Trim` | Removes leading and trailing whitespace from a template value | -| `rife.render.Uncapitalize` | Un-capitalizes a template value | -| `rife.render.Uppercase` | Converts a template value to uppercase | +| Renderer | Description | +|:------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------| +| [rife.render.Capitalize](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.Capitalize) | Capitalizes a template value | +| [rife.render.Lowercase](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.Lowercase) | Converts a template value to lowercase | +| [rife.render.Rot13](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.Rot13) | Translates a template value to/from ROT13 | +| [rife.render.SwapCase](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.SwapCase) | Swap case of a template value | +| [rife.render.Trim](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.Trim) | Removes leading and trailing whitespace from a template value | +| [rife.render.Uncapitalize](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.Uncapitalize) | Un-capitalizes a template value | +| [rife.render.Uppercase](https://github.com/rife2/rife2-template-renderers/wiki/rife.render.Uppercase) | Converts a template value to uppercase | ## Documentation diff --git a/lib/src/main/java/rife/render/Lowercase.java b/lib/src/main/java/rife/render/Lowercase.java index 853c2c5..b5b40f3 100644 --- a/lib/src/main/java/rife/render/Lowercase.java +++ b/lib/src/main/java/rife/render/Lowercase.java @@ -32,6 +32,7 @@ import rife.tools.Localization; * * * @author Erik C. Thauvin + * @see rife.render.Lowercase * @since 1.0 */ public class Lowercase implements ValueRenderer { diff --git a/lib/src/main/java/rife/render/RenderUtils.java b/lib/src/main/java/rife/render/RenderUtils.java index 138bbb1..6692c3d 100644 --- a/lib/src/main/java/rife/render/RenderUtils.java +++ b/lib/src/main/java/rife/render/RenderUtils.java @@ -81,7 +81,8 @@ public final class RenderUtils { /** * Returns the last 4 digits a credit card number. The number must satisfy the Luhn algorithm. * Non-digits are stripped from the number. - *Th + * Th + * * @param src the credit card number * @return the last 4 digits of the credit card number or empty */ diff --git a/lib/src/main/java/rife/render/Rot13.java b/lib/src/main/java/rife/render/Rot13.java index 7dab950..4bca6db 100644 --- a/lib/src/main/java/rife/render/Rot13.java +++ b/lib/src/main/java/rife/render/Rot13.java @@ -31,6 +31,7 @@ import rife.template.ValueRenderer; * * * @author Erik C. Thauvin + * @see rife.render.Rot13 * @since 1.0 */ public class Rot13 implements ValueRenderer { diff --git a/lib/src/main/java/rife/render/SwapCase.java b/lib/src/main/java/rife/render/SwapCase.java index 787689f..270f1f6 100644 --- a/lib/src/main/java/rife/render/SwapCase.java +++ b/lib/src/main/java/rife/render/SwapCase.java @@ -31,6 +31,7 @@ import rife.template.ValueRenderer; * * * @author Erik C. Thauvin + * @see rife.render.SwapCase * @since 1.0 */ public class SwapCase implements ValueRenderer { diff --git a/lib/src/main/java/rife/render/Trim.java b/lib/src/main/java/rife/render/Trim.java index 220adda..00cbc9b 100644 --- a/lib/src/main/java/rife/render/Trim.java +++ b/lib/src/main/java/rife/render/Trim.java @@ -31,6 +31,7 @@ import rife.template.ValueRenderer; * * * @author Erik C. Thauvin + * @see rife.render.Trim * @since 1.0 */ public class Trim implements ValueRenderer { diff --git a/lib/src/main/java/rife/render/Uncapitalize.java b/lib/src/main/java/rife/render/Uncapitalize.java index 10ded1c..81c5bc4 100644 --- a/lib/src/main/java/rife/render/Uncapitalize.java +++ b/lib/src/main/java/rife/render/Uncapitalize.java @@ -32,6 +32,7 @@ import rife.tools.Localization; * * * @author Erik C. Thauvin + * @see rife.render.Uncapitalize * @since 1.0 */ public class Uncapitalize implements ValueRenderer { diff --git a/lib/src/main/java/rife/render/Uppercase.java b/lib/src/main/java/rife/render/Uppercase.java index 098e5f0..1add3f6 100644 --- a/lib/src/main/java/rife/render/Uppercase.java +++ b/lib/src/main/java/rife/render/Uppercase.java @@ -32,6 +32,7 @@ import rife.tools.Localization; * * * @author Erik C. Thauvin + * #see rife.render.Uppercase * @since 1.0 */ public class Uppercase implements ValueRenderer {