You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@groovy.apache.org by pa...@apache.org on 2015/09/30 08:51:10 UTC
[2/2] incubator-groovy git commit: GROOVY-7612: GroovyDoc should
allow timestamp/version stamp info (hidden info embedded in HTML) to be
omitted
GROOVY-7612: GroovyDoc should allow timestamp/version stamp info (hidden info embedded in HTML) to be omitted
Project: http://git-wip-us.apache.org/repos/asf/incubator-groovy/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-groovy/commit/b52f63c4
Tree: http://git-wip-us.apache.org/repos/asf/incubator-groovy/tree/b52f63c4
Diff: http://git-wip-us.apache.org/repos/asf/incubator-groovy/diff/b52f63c4
Branch: refs/heads/master
Commit: b52f63c4c4e6f1c05a1129811874976f99003a81
Parents: 623a99e
Author: Paul King <pa...@asert.com.au>
Authored: Wed Sep 30 16:50:14 2015 +1000
Committer: Paul King <pa...@asert.com.au>
Committed: Wed Sep 30 16:50:14 2015 +1000
----------------------------------------------------------------------
.../main/groovy/org/codehaus/groovy/tools/groovydoc/Main.groovy | 4 ++++
.../org/codehaus/groovy/tools/groovydoc/Main.properties | 4 +++-
.../groovydoc/gstringTemplates/classLevel/classDocName.html | 2 +-
.../groovydoc/gstringTemplates/topLevel/deprecated-list.html | 2 +-
.../tools/groovydoc/gstringTemplates/topLevel/help-doc.html | 2 +-
.../tools/groovydoc/gstringTemplates/topLevel/index-all.html | 2 +-
6 files changed, 11 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/b52f63c4/subprojects/groovy-groovydoc/src/main/groovy/org/codehaus/groovy/tools/groovydoc/Main.groovy
----------------------------------------------------------------------
diff --git a/subprojects/groovy-groovydoc/src/main/groovy/org/codehaus/groovy/tools/groovydoc/Main.groovy b/subprojects/groovy-groovydoc/src/main/groovy/org/codehaus/groovy/tools/groovydoc/Main.groovy
index 3d6cf6c..200b103 100644
--- a/subprojects/groovy-groovydoc/src/main/groovy/org/codehaus/groovy/tools/groovydoc/Main.groovy
+++ b/subprojects/groovy-groovydoc/src/main/groovy/org/codehaus/groovy/tools/groovydoc/Main.groovy
@@ -44,6 +44,7 @@ class Main {
private static Boolean noScripts
private static Boolean noMainForScripts
private static Boolean noTimestamp
+ private static Boolean noVersionStamp
private static Boolean privateScope
private static Boolean packageScope
private static Boolean publicScope
@@ -73,6 +74,7 @@ class Main {
cli.noscripts(messages['cli.option.noscripts.description'])
cli.nomainforscripts(messages['cli.option.nomainforscripts.description'])
cli.notimestamp(messages['cli.option.notimestamp.description'])
+ cli.noversionstamp(messages['cli.option.noversionstamp.description'])
cli.overview(args:1, argName: 'file', messages['cli.option.overview.description'])
cli.public(messages['cli.option.public.description'])
cli.protected(messages['cli.option.protected.description'])
@@ -126,6 +128,7 @@ class Main {
noScripts = Boolean.valueOf(options.noscripts) ?: false
noMainForScripts = Boolean.valueOf(options.nomainforscripts) ?: false
noTimestamp = Boolean.valueOf(options.notimestamp) ?: false
+ noVersionStamp = Boolean.valueOf(options.noversionstamp) ?: false
packageScope = Boolean.valueOf(options.package) ?: false
privateScope = Boolean.valueOf(options.private) ?: false
protectedScope = Boolean.valueOf(options.protected) ?: false
@@ -195,6 +198,7 @@ class Main {
properties.put("processScripts", (!noScripts).toString())
properties.put("includeMainForScripts", (!noMainForScripts).toString())
properties.put("timestamp", (!noTimestamp).toString())
+ properties.put("versionStamp", (!noVersionStamp).toString())
properties.put("overviewFile", overviewFile?.absolutePath ?: "")
def links = new ArrayList<LinkArgument>();
http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/b52f63c4/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/Main.properties
----------------------------------------------------------------------
diff --git a/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/Main.properties b/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/Main.properties
index 3bc8da2..6c72823 100644
--- a/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/Main.properties
+++ b/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/Main.properties
@@ -55,7 +55,9 @@ cli.option.noscripts.description=Don't process Groovy Scripts
cli.option.nomainforscripts.description=Don't include the implicit 'public static void main' method for scripts
-cli.option.notimestamp.description=Don't include hidden timestamp
+cli.option.notimestamp.description=Don't include timestamp within hidden comment in generated HTML
+
+cli.option.noversionstamp.description=Don't include Groovy version within hidden comment in generated HTML
cli.option.public.description=Show only public classes and members
http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/b52f63c4/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/classLevel/classDocName.html
----------------------------------------------------------------------
diff --git a/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/classLevel/classDocName.html b/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/classLevel/classDocName.html
index 84c0a6d..046b014 100644
--- a/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/classLevel/classDocName.html
+++ b/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/classLevel/classDocName.html
@@ -85,7 +85,7 @@
%>
<html>
<head>
- <!-- Generated by groovydoc (${GroovySystem.version})<% if (props.timestamp == 'true') { %> on ${new Date()}<% } %> -->
+ <!-- Generated by groovydoc<% if (props.versionStamp != 'false') { %> (${GroovySystem.version})<% } %><% if (props.timestamp != 'false') { %> on ${new Date()}<% } %> -->
<title>${title}</title>
<meta name="date" content="${new Date().format('yyyy-MM-dd')}">
<meta http-equiv="Content-Type" content="text/html; charset=${props.charset}">
http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/b52f63c4/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/topLevel/deprecated-list.html
----------------------------------------------------------------------
diff --git a/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/topLevel/deprecated-list.html b/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/topLevel/deprecated-list.html
index ccdd24e..cd0a9ae 100644
--- a/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/topLevel/deprecated-list.html
+++ b/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/topLevel/deprecated-list.html
@@ -81,7 +81,7 @@ def nameFromParams = { n -> n.name() + '(' + n.parameters().collect{ param -> pa
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=${props.charset}">
- <!-- Generated by groovydoc (${GroovySystem.version})<% if (props.timestamp == 'true') { %> on ${new Date()}<% } %> -->
+ <!-- Generated by groovydoc<% if (props.versionStamp != 'false') { %> (${GroovySystem.version})<% } %><% if (props.timestamp != 'false') { %> on ${new Date()}<% } %> -->
<title>${title}</title>
<meta name="date" content="${new Date().format('yyyy-MM-dd')}">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/b52f63c4/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/topLevel/help-doc.html
----------------------------------------------------------------------
diff --git a/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/topLevel/help-doc.html b/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/topLevel/help-doc.html
index e48e026..e865fe5 100644
--- a/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/topLevel/help-doc.html
+++ b/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/topLevel/help-doc.html
@@ -24,7 +24,7 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=${props.charset}">
- <!-- Generated by groovydoc (${GroovySystem.version})<% if (props.timestamp == 'true') { %> on ${new Date()}<% } %> -->
+ <!-- Generated by groovydoc<% if (props.versionStamp != 'false') { %> (${GroovySystem.version})<% } %><% if (props.timestamp != 'false') { %> on ${new Date()}<% } %> -->
<title>${title}</title>
<link href="groovy.ico" type="image/x-icon" rel="shortcut icon">
<link href="groovy.ico" type="image/x-icon" rel="icon">
http://git-wip-us.apache.org/repos/asf/incubator-groovy/blob/b52f63c4/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/topLevel/index-all.html
----------------------------------------------------------------------
diff --git a/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/topLevel/index-all.html b/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/topLevel/index-all.html
index bf136ce..9f2be33 100644
--- a/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/topLevel/index-all.html
+++ b/subprojects/groovy-groovydoc/src/main/resources/org/codehaus/groovy/tools/groovydoc/gstringTemplates/topLevel/index-all.html
@@ -38,7 +38,7 @@ def nameFromParams = { n -> n.name() + '(' + n.parameters().collect{ param -> pa
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=${props.charset}">
- <!-- Generated by groovydoc (${GroovySystem.version})<% if (props.timestamp == 'true') { %> on ${new Date()}<% } %> -->
+ <!-- Generated by groovydoc<% if (props.versionStamp != 'false') { %> (${GroovySystem.version})<% } %><% if (props.timestamp != 'false') { %> on ${new Date()}<% } %> -->
<title>${title}</title>
<meta name="date" content="${new Date().format('yyyy-MM-dd')}">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">