You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by jl...@apache.org on 2020/08/12 13:58:02 UTC
[ofbiz-framework] branch release18.12 updated: Improved: Add a
title to Javadoc overview (OFBIZ-)
This is an automated email from the ASF dual-hosted git repository.
jleroux pushed a commit to branch release18.12
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
The following commit(s) were added to refs/heads/release18.12 by this push:
new 26d150f Improved: Add a title to Javadoc overview (OFBIZ-)
26d150f is described below
commit 26d150f709e093d3ac780e605bf5778b751759a0
Author: Jacques Le Roux <ja...@les7arts.com>
AuthorDate: Wed Aug 12 15:41:25 2020 +0200
Improved: Add a title to Javadoc overview (OFBIZ-)
We can add a global version heading using the Gradle title Javadoc option:
https://docs.gradle.org/current/dsl/org.gradle.api.tasks.javadoc.Javadoc.html
Relates to https://markmail.org/message/t3svau3udlwaa7mq
---
build.gradle | 29 ++++++++++++++++-------------
1 file changed, 16 insertions(+), 13 deletions(-)
diff --git a/build.gradle b/build.gradle
index 1f3713c..6aa4992 100644
--- a/build.gradle
+++ b/build.gradle
@@ -54,19 +54,22 @@ if (project.hasProperty('jvmArgs')) {
}
ext.ofbizMainClass = 'org.apache.ofbiz.base.start.Start'
-javadoc.failOnError = true
-javadoc.options {
- source '8'
- encoding "UTF-8"
- charSet "UTF-8"
- // Those external Javadoc links should correspond to the actual
- // versions declared in the "dependencies" block.
- links(
- "https://docs.oracle.com/javase/8/docs/api",
- "https://docs.oracle.com/javaee/7/api",
- "http://docs.groovy-lang.org/docs/groovy-2.4.13/html/api",
- "https://commons.apache.org/proper/commons-cli/apidocs"
- )
+javadoc {
+ title='OFBiz R18.12 API'
+ failOnError = true
+ options {
+ source '8'
+ encoding "UTF-8"
+ charSet "UTF-8"
+ // Those external Javadoc links should correspond to the actual
+ // versions declared in the "dependencies" block.
+ links(
+ "https://docs.oracle.com/javase/8/docs/api",
+ "https://docs.oracle.com/javaee/7/api",
+ "http://docs.groovy-lang.org/docs/groovy-2.4.13/html/api",
+ "https://commons.apache.org/proper/commons-cli/apidocs"
+ )
+ }
}
// Checks OFBiz Java coding conventions.
checkstyle {