Skip to content

Add processScripts and includeMainForScripts GroovyDoc config params #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
keeganwitt wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Add processScripts and includeMainForScripts GroovyDoc config params #149

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 28 additions & 10 deletions src/main/java/org/codehaus/gmavenplus/mojo/AbstractGroovyDocMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,22 @@ public abstract class AbstractGroovyDocMojo extends AbstractGroovySourcesMojo {
@Parameter(defaultValue = "PROJECT_ONLY")
protected IncludeClasspath includeClasspath;

/**
* Whether to process Groovy Scripts.
*
* @since 1.8.2
*/
@Parameter(defaultValue = "true")
protected boolean processScripts;

/**
* Whether to include the implicit <code>public static void main</code> method for scripts.
*
* @since 1.8.2
*/
@Parameter(defaultValue = "true")
protected boolean includeMainForScripts;

/**
* Generates the GroovyDoc for the specified sources.
*
Expand Down Expand Up @@ -236,22 +252,24 @@ protected synchronized void doGroovyDocGeneration(final FileSet[] sourceDirector
*/
protected Properties setupProperties() {
Properties properties = new Properties();
properties.setProperty("windowTitle", windowTitle);
properties.setProperty("docTitle", docTitle);
properties.setProperty("footer", footer);
properties.setProperty("header", header);
properties.setProperty("author", Boolean.toString(displayAuthor));
properties.setProperty("overviewFile", overviewFile != null ? overviewFile.getAbsolutePath() : "");
properties.put("windowTitle", windowTitle);
properties.put("docTitle", docTitle);
properties.put("footer", footer);
properties.put("header", header);
properties.put("author", Boolean.toString(displayAuthor));
properties.put("overviewFile", overviewFile != null ? overviewFile.getAbsolutePath() : "");
properties.put("processScripts", Boolean.toString(processScripts));
properties.put("includeMainForScripts", Boolean.toString(includeMainForScripts));
try {
Scopes scopeVal = Scopes.valueOf(scope.toUpperCase());
if (scopeVal.equals(Scopes.PUBLIC)) {
properties.setProperty("publicScope", "true");
properties.put("publicScope", "true");
} else if (scopeVal.equals(Scopes.PROTECTED)) {
properties.setProperty("protectedScope", "true");
properties.put("protectedScope", "true");
} else if (scopeVal.equals(Scopes.PACKAGE)) {
properties.setProperty("packageScope", "true");
properties.put("packageScope", "true");
} else if (scopeVal.equals(Scopes.PRIVATE)) {
properties.setProperty("privateScope", "true");
properties.put("privateScope", "true");
}
} catch (IllegalArgumentException e) {
getLog().warn("Scope (" + scope + ") was not recognized. Skipping argument.");
Expand Down