From 1fec05345d72ad28a96f8d0602342f0a541e6496 Mon Sep 17 00:00:00 2001 From: Murilo Habermann Torquato Date: Mon, 8 Apr 2019 11:43:02 -0300 Subject: [PATCH] IDEMPIERE-3943 - automated javadoc generation --- .hgignore | 3 + org.idempiere.javadoc/.classpath | 6 + org.idempiere.javadoc/.project | 34 +++++ .../org.eclipse.core.resources.prefs | 2 + .../.settings/org.eclipse.jdt.core.prefs | 2 + .../.settings/org.eclipse.m2e.core.prefs | 4 + org.idempiere.javadoc/META-INF/MANIFEST.MF | 6 + org.idempiere.javadoc/build.properties | 34 +++++ org.idempiere.javadoc/doc/overview.html | 12 ++ org.idempiere.javadoc/pom.xml | 121 ++++++++++++++++++ .../org.idempiere.p2.targetplatform.target | 2 - org.idempiere.parent/pom.xml | 2 +- pom.xml | 3 + 13 files changed, 228 insertions(+), 3 deletions(-) create mode 100644 org.idempiere.javadoc/.classpath create mode 100644 org.idempiere.javadoc/.project create mode 100644 org.idempiere.javadoc/.settings/org.eclipse.core.resources.prefs create mode 100644 org.idempiere.javadoc/.settings/org.eclipse.jdt.core.prefs create mode 100644 org.idempiere.javadoc/.settings/org.eclipse.m2e.core.prefs create mode 100644 org.idempiere.javadoc/META-INF/MANIFEST.MF create mode 100644 org.idempiere.javadoc/build.properties create mode 100644 org.idempiere.javadoc/doc/overview.html create mode 100644 org.idempiere.javadoc/pom.xml diff --git a/.hgignore b/.hgignore index 31dc9e41f1..de7f67c6d0 100644 --- a/.hgignore +++ b/.hgignore @@ -94,3 +94,6 @@ server.product.*\.launch ^RemoteSystemsTempFiles ^fitnesse/FitNesseRoot/FitLibraryWeb/[^/]+\.zip$ + +^org\.idempiere\.javadoc/API$ + diff --git a/org.idempiere.javadoc/.classpath b/org.idempiere.javadoc/.classpath new file mode 100644 index 0000000000..a9f4be7877 --- /dev/null +++ b/org.idempiere.javadoc/.classpath @@ -0,0 +1,6 @@ + + + + + + diff --git a/org.idempiere.javadoc/.project b/org.idempiere.javadoc/.project new file mode 100644 index 0000000000..dba5f148b7 --- /dev/null +++ b/org.idempiere.javadoc/.project @@ -0,0 +1,34 @@ + + + com.codeandme.tycho.help + + + + + + org.eclipse.jdt.core.javabuilder + + + + + org.eclipse.pde.ManifestBuilder + + + + + org.eclipse.pde.SchemaBuilder + + + + + org.eclipse.m2e.core.maven2Builder + + + + + + org.eclipse.m2e.core.maven2Nature + org.eclipse.pde.PluginNature + org.eclipse.jdt.core.javanature + + diff --git a/org.idempiere.javadoc/.settings/org.eclipse.core.resources.prefs b/org.idempiere.javadoc/.settings/org.eclipse.core.resources.prefs new file mode 100644 index 0000000000..99f26c0203 --- /dev/null +++ b/org.idempiere.javadoc/.settings/org.eclipse.core.resources.prefs @@ -0,0 +1,2 @@ +eclipse.preferences.version=1 +encoding/=UTF-8 diff --git a/org.idempiere.javadoc/.settings/org.eclipse.jdt.core.prefs b/org.idempiere.javadoc/.settings/org.eclipse.jdt.core.prefs new file mode 100644 index 0000000000..8e3baab53e --- /dev/null +++ b/org.idempiere.javadoc/.settings/org.eclipse.jdt.core.prefs @@ -0,0 +1,2 @@ +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled diff --git a/org.idempiere.javadoc/.settings/org.eclipse.m2e.core.prefs b/org.idempiere.javadoc/.settings/org.eclipse.m2e.core.prefs new file mode 100644 index 0000000000..f897a7f1cb --- /dev/null +++ b/org.idempiere.javadoc/.settings/org.eclipse.m2e.core.prefs @@ -0,0 +1,4 @@ +activeProfiles= +eclipse.preferences.version=1 +resolveWorkspaceProjects=true +version=1 diff --git a/org.idempiere.javadoc/META-INF/MANIFEST.MF b/org.idempiere.javadoc/META-INF/MANIFEST.MF new file mode 100644 index 0000000000..8c73942666 --- /dev/null +++ b/org.idempiere.javadoc/META-INF/MANIFEST.MF @@ -0,0 +1,6 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: iDempiere Javadoc Generator +Bundle-SymbolicName: org.idempiere.javadoc;singleton:=true +Bundle-Version: 6.2.0.qualifier +Bundle-Vendor: iDempiere Community diff --git a/org.idempiere.javadoc/build.properties b/org.idempiere.javadoc/build.properties new file mode 100644 index 0000000000..fbdc0e9337 --- /dev/null +++ b/org.idempiere.javadoc/build.properties @@ -0,0 +1,34 @@ +bin.includes = META-INF/,\ + . +# for javadoc API generation: comma separated list of plug-ins +jars.extra.classpath = platform:/plugin/org.adempiere.base/,\ + platform:/plugin/org.adempiere.base.callout/,\ + platform:/plugin/org.adempiere.base.process/,\ + platform:/plugin/org.adempiere.eclipse.equinox.http.servlet/,\ + platform:/plugin/org.adempiere.eclipse.equinox.http.servletbridge/,\ + platform:/plugin/org.adempiere.eclipse.equinox.servletbridge/,\ + platform:/plugin/org.adempiere.extend/,\ + platform:/plugin/org.adempiere.install/,\ + platform:/plugin/org.adempiere.payment.processor/,\ + platform:/plugin/org.adempiere.pipo/,\ + platform:/plugin/org.adempiere.pipo.handlers/,\ + platform:/plugin/org.adempiere.plugin.utils/,\ + platform:/plugin/org.adempiere.replication/,\ + platform:/plugin/org.adempiere.replication.server/,\ + platform:/plugin/org.adempiere.report.jasper/,\ + platform:/plugin/org.adempiere.server/src/main/server/,\ + platform:/plugin/org.adempiere.server/src/main/servlet/,\ + platform:/plugin/org.adempiere.server/src/main/home/,\ + platform:/plugin/org.adempiere.ui/,\ + platform:/plugin/org.adempiere.ui.swing/,\ + platform:/plugin/org.adempiere.ui.zk/,\ + platform:/plugin/org.adempiere.webstore/,\ + platform:/plugin/org.adempiere.webstore.resource/,\ + platform:/plugin/org.adempiere.webstore.servlet/,\ + platform:/plugin/org.apache.ecs/,\ + platform:/plugin/org.compiere.db.oracle.provider/,\ + platform:/plugin/org.compiere.db.postgresql.provider/,\ + platform:/plugin/org.idempiere.felix.webconsole/,\ + platform:/plugin/org.idempiere.hazelcast.service/,\ + platform:/plugin/org.idempiere.webservices/,\ + platform:/plugin/org.idempiere.zk.extra/ diff --git a/org.idempiere.javadoc/doc/overview.html b/org.idempiere.javadoc/doc/overview.html new file mode 100644 index 0000000000..d4780f7cc1 --- /dev/null +++ b/org.idempiere.javadoc/doc/overview.html @@ -0,0 +1,12 @@ + + +Documentation Overview + + + +

iDempiere Open Source ERP & CRM Application

+

Constants

+

Please check http://www.idempiere.org + for updates

+ + \ No newline at end of file diff --git a/org.idempiere.javadoc/pom.xml b/org.idempiere.javadoc/pom.xml new file mode 100644 index 0000000000..1d4a6d3c86 --- /dev/null +++ b/org.idempiere.javadoc/pom.xml @@ -0,0 +1,121 @@ + + 4.0.0 + org.idempiere.javadoc + eclipse-plugin + + + org.idempiere + org.idempiere.parent + 6.2.0-SNAPSHOT + ../org.idempiere.parent/pom.xml + + + + + + org.codehaus.mojo + build-helper-maven-plugin + 3.0.0 + + + parse-version + + parse-version + + + + + + org.eclipse.tycho.extras + tycho-document-bundle-plugin + ${tycho.extras.version} + + + eclipse-javadoc + + javadoc + + + ${project.basedir}/API + true + + true + UTF-8 + + br.com.caelum.* + br.inf.portalfiscal.* + bsh* + com.google.* + com.jgoodies.* + com.thoughtworks.* + fi.jawsy.jawwa.zk.atmosphere + it.sauronsoftware.cron4j + javax.* + net.miginfocom.* + okhttp3* + okio* + org.jdesktop.* + org.jrimum.* + org.jsoup* + org.netbeans.* + org.zkforge.* + org.zkoss.* + test* + org.eclipse.* + org.compiere.css + org.compiere.images + org.apache.* + metainfo.zk + web* + org.idempiere.adInterface.x10* + action.images* + google.* + jsinterop.* + org.checkerframework.* + org.codehaus.* + org.kohsuke.* + + + + --add-exports + java.desktop/sun.awt=ALL-UNNAMED --add-exports + java.sql.rowset/com.sun.rowset=ALL-UNNAMED --add-exports + java.naming/com.sun.jndi.ldap=ALL-UNNAMED --add-exports + java.base/sun.security.tools.keytool=ALL-UNNAMED + --add-modules=ALL-SYSTEM --add-modules java.se --add-opens + java.base/java.lang=ALL-UNNAMED --add-opens + java.base/java.nio=ALL-UNNAMED --add-opens + java.base/sun.nio.ch=ALL-UNNAMED --add-opens + java.management/sun.management=ALL-UNNAMED --add-opens + jdk.management/com.sun.management.internal=ALL-UNNAMED + --add-exports java.base/jdk.internal.ref=ALL-UNNAMED + --add-exports java.desktop/sun.awt=ALL-UNNAMED --add-exports + java.sql.rowset/com.sun.rowset=ALL-UNNAMED --add-exports + java.naming/com.sun.jndi.ldap=ALL-UNNAMED + -Xdoclint:none + -use + -author + -breakiterator + -version + -link + https://docs.oracle.com/en/java/javase/11/docs/api/ + -splitindex + -overview + ${project.basedir}/doc/overview.html + -windowtitle "iDempiere ${parsedVersion.majorVersion}.${parsedVersion.minorVersion} API Documentation" + -doctitle "iDempiere ${parsedVersion.majorVersion}.${parsedVersion.minorVersion} API Documentation" + -header "iDempiere ${parsedVersion.majorVersion}.${parsedVersion.minorVersion}" + -bottom "iDempiere ${parsedVersion.majorVersion}.${parsedVersion.minorVersion}" + --no-module-directories + + + + + + + + + \ No newline at end of file diff --git a/org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target b/org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target index 013f435439..a7624aef7d 100644 --- a/org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target +++ b/org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target @@ -623,8 +623,6 @@ - - diff --git a/org.idempiere.parent/pom.xml b/org.idempiere.parent/pom.xml index dc4902ae03..626764248b 100644 --- a/org.idempiere.parent/pom.xml +++ b/org.idempiere.parent/pom.xml @@ -30,7 +30,7 @@ eclipse-photon-201810 http://download.eclipse.org/tools/orbit/downloads/drops/R20181128170323/repository orbit-photon-R20181128170323 - https://raw.githubusercontent.com/idempiere/binary.file/master + http://jfrog.devcoffee.com.br/mirror/binary.file/ org.eclipse.equinox.p2.director, org.idempiere.equinox.p2.director.feature.feature.group, org.idempiere.fitnesse.feature.feature.group org.adempiere.server.product 2.8.5 diff --git a/pom.xml b/pom.xml index 007902fa51..263f6e02bd 100644 --- a/pom.xml +++ b/pom.xml @@ -69,6 +69,9 @@ org.idempiere.zk-feature org.idempiere.webservices.client-feature org.idempiere.p2 + + org.idempiere.javadoc ${idempiere.target}