From 20e2505ca5014de83a7fffc1e16a19c4783ac706 Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Sun, 17 Jul 2016 18:04:31 -0700 Subject: [PATCH] Updated documentation. --- .idea/modules/semver.iml | 12 ++++++------ README.html | 1 + README.md | 2 ++ build.gradle | 2 +- 4 files changed, 10 insertions(+), 7 deletions(-) diff --git a/.idea/modules/semver.iml b/.idea/modules/semver.iml index 24fcd77..1615fa6 100644 --- a/.idea/modules/semver.iml +++ b/.idea/modules/semver.iml @@ -15,12 +15,12 @@ - - - - - - + + + + + + \ No newline at end of file diff --git a/README.html b/README.html index f72ba14..7a4c269 100644 --- a/README.html +++ b/README.html @@ -146,6 +146,7 @@ code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Inf public final static String PROJECT = "${project}"; }

The Velocity variables are automatically filled in by the processor.

+

Please also look at this example using java.time

Elements & Properties

The following annotation elements and properties are available:

diff --git a/README.md b/README.md index 3c8d0ca..719b7f4 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,8 @@ public final class ${className} { } ``` The Velocity variables are automatically filled in by the processor. + +Please also look at this [example](https://github.com/ethauvin/mobibot/blob/master/version.vm) using [`java.time`](https://docs.oracle.com/javase/8/docs/api/java/time/package-summary.html) ## Elements & Properties diff --git a/build.gradle b/build.gradle index 8192c45..7895e9a 100644 --- a/build.gradle +++ b/build.gradle @@ -205,7 +205,7 @@ task release(dependsOn: ['wrapper', 'clean', 'deploy']) << { task pandoc(type: Exec) { group = 'Documentation' - def pandoc_args = [] + def pandoc_args = ['--from', 'markdown_github', '--to', 'html5', '-s', '-c', 'github-pandoc.css', '-o', 'README.html', 'README.md'] if (Os.isFamily(Os.FAMILY_WINDOWS)) { commandLine(['cmd', '/c', 'pandoc'] + pandoc_args)