Added more links to the wiki documentation

This commit is contained in:
Erik C. Thauvin 2023-03-18 12:24:25 -07:00
parent a3063eee07
commit b27b0965af
13 changed files with 57 additions and 41 deletions

View file

@ -33,6 +33,7 @@ import java.time.ZonedDateTime;
* </pre>
*
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.BeatTime">rife.render.BeatTime</a>
* @since 1.0
*/
public class BeatTime implements ValueRenderer {

View file

@ -32,6 +32,7 @@ import rife.tools.Localization;
* </pre>
*
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.Capitalize">rife.render.Capitalize</a>
* @since 1.0
*/
public class Capitalize implements ValueRenderer {

View file

@ -35,6 +35,7 @@ import java.time.format.DateTimeFormatter;
* </pre>
*
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.DateIso">rife.render.DateIso</a>
* @since 1.0
*/
public class DateIso implements ValueRenderer {

View file

@ -39,6 +39,7 @@ import java.util.Properties;
* </pre>
*
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.DateTimeIso">rife.render.DateTimeIso</a>
* @since 1.0
*/
public class DateTimeIso implements ValueRenderer {

View file

@ -35,6 +35,7 @@ import java.time.format.DateTimeFormatter;
* </pre>
*
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.DateTimeRfc2822">rife.render.DateTimeRfc2822</a>
* @since 1.0
*/
public class DateTimeRfc2822 implements ValueRenderer {

View file

@ -34,6 +34,7 @@ import java.nio.charset.StandardCharsets;
* </pre>
*
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.EncodeBase64">rife.render.EncodeBase64</a>
* @see StringUtils#encodeBase64(byte[])
* @since 1.0
*/

View file

@ -123,10 +123,10 @@ public final class RenderUtils {
/**
* Returns the plural form of a word, if count &gt; 1.
*
* @param count the count.
* @param word the singular word.
* @param plural the plural word.
* @return the singular or plural string.
* @param count the count
* @param word the singular word
* @param plural the plural word
* @return the singular or plural String
*/
public static String plural(final long count, final String word, final String plural) {
if (count > 1) {
@ -307,8 +307,8 @@ public final class RenderUtils {
/**
* Returns the formatted server uptime.
*
* @param uptime the uptime in milliseconds.
* @param properties the format properties.
* @param uptime the uptime in milliseconds
* @param properties the format properties
* @return The formatted uptime.
*/
public static String uptime(long uptime, Properties properties) {

View file

@ -33,6 +33,7 @@ import rife.template.ValueRenderer;
* </pre>
*
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.ShortenUrl">rife.render.ShortenUrl</a>
* @since 1.0
*/
public class ShortenUrl implements ValueRenderer {

View file

@ -35,6 +35,7 @@ import java.time.format.DateTimeFormatter;
* </pre>
*
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.TimeIso">rife.render.TimeIso</a>
* @since 1.0
*/
public class TimeIso implements ValueRenderer {

View file

@ -28,8 +28,15 @@ import java.util.Properties;
/**
* Renders the server uptime.
*
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.Uptime">rife.render.Uptime</a>
* <p>Usage:</p>
*
* <pre>
* &lt;!--v render:rife.render.Uptime/--&gt;
* {{v render:rife.render.Uptime/}}
* </pre>
*
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.render.Uptime">rife.render.Uptime</a>
* @since 1.0
*/
public class Uptime implements ValueRenderer {

View file

@ -35,6 +35,7 @@ import java.time.format.DateTimeFormatter;
* </pre>
*
* @author <a href="https://erik.thauvin.net/">Erik C. Thauvin</a>
* @see <a href="https://github.com/rife2/rife2-template-renderers/wiki/rife.rennder.Year">rife.render.Year</a>
* @since 1.0
*/
public class Year implements ValueRenderer {

View file

@ -1,3 +1,3 @@
<!--v render:rife.render.DateTimeIso-->
tz=UTC
<!--/v-->
<!--/v-->