midsuit
/
core-jgi
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

IDEMPIERE-3943 - automated javadoc generation

This commit is contained in:
Murilo Habermann Torquato 2019-04-08 11:43:02 -03:00
parent 570003bd92
commit 1fec05345d
13 changed files with 228 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.hgignore
View File

@ -94,3 +94,6 @@ server.product.*\.launch
^RemoteSystemsTempFiles
^fitnesse/FitNesseRoot/FitLibraryWeb/[^/]+\.zip$
^org\.idempiere\.javadoc/API$

6
org.idempiere.javadoc/.classpath Normal file
View File

@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<classpath>
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
<classpathentry kind="output" path="target/classes"/>
</classpath>

34
org.idempiere.javadoc/.project Normal file
View File

@ -0,0 +1,34 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>com.codeandme.tycho.help</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
<buildCommand>
<name>org.eclipse.jdt.core.javabuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>org.eclipse.pde.ManifestBuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>org.eclipse.pde.SchemaBuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>org.eclipse.m2e.core.maven2Builder</name>
<arguments>
</arguments>
</buildCommand>
</buildSpec>
<natures>
<nature>org.eclipse.m2e.core.maven2Nature</nature>
<nature>org.eclipse.pde.PluginNature</nature>
<nature>org.eclipse.jdt.core.javanature</nature>
</natures>
</projectDescription>

2
org.idempiere.javadoc/.settings/org.eclipse.core.resources.prefs Normal file
View File

@ -0,0 +1,2 @@
eclipse.preferences.version=1
encoding/<project>=UTF-8

2
org.idempiere.javadoc/.settings/org.eclipse.jdt.core.prefs Normal file
View File

@ -0,0 +1,2 @@
eclipse.preferences.version=1
org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled

4
org.idempiere.javadoc/.settings/org.eclipse.m2e.core.prefs Normal file
View File

@ -0,0 +1,4 @@
activeProfiles=
eclipse.preferences.version=1
resolveWorkspaceProjects=true
version=1

6
org.idempiere.javadoc/META-INF/MANIFEST.MF Normal file
View File

@ -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

34
org.idempiere.javadoc/build.properties Normal file
View File

@ -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/

12
org.idempiere.javadoc/doc/overview.html Normal file
View File

@ -0,0 +1,12 @@
<html>
<head>
<title>Documentation Overview</title>
</head>
<body>
<p>iDempiere Open Source ERP &amp; CRM Application</p>
<p><a href="constant-values.html"><b>Constants</b></a></p>
<p>Please check <a href="http://www.idempiere.org" target="_blank">http://www.idempiere.org</a>
for updates</p>
</body>
</html>

121
org.idempiere.javadoc/pom.xml Normal file
View File

@ -0,0 +1,121 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<artifactId>org.idempiere.javadoc</artifactId>
<packaging>eclipse-plugin</packaging>
<parent>
<groupId>org.idempiere</groupId>
<artifactId>org.idempiere.parent</artifactId>
<version>6.2.0-SNAPSHOT</version>
<relativePath>../org.idempiere.parent/pom.xml</relativePath>
</parent>
<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>build-helper-maven-plugin</artifactId>
<version>3.0.0</version>
<executions>
<execution>
<id>parse-version</id>
<goals>
<goal>parse-version</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.eclipse.tycho.extras</groupId>
<artifactId>tycho-document-bundle-plugin</artifactId>
<version>${tycho.extras.version}</version>
<executions>
<execution>
<id>eclipse-javadoc</id>
<goals>
<goal>javadoc</goal>
</goals>
<configuration>
<outputDirectory>${project.basedir}/API</outputDirectory>
<skipTocGen>true</skipTocGen>
<javadocOptions>
<ignoreError>true</ignoreError>
<encoding>UTF-8</encoding>
<excludes>
<exclude>br.com.caelum.*</exclude>
<exclude>br.inf.portalfiscal.*</exclude>
<exclude>bsh*</exclude>
<exclude>com.google.*</exclude>
<exclude>com.jgoodies.*</exclude>
<exclude>com.thoughtworks.*</exclude>
<exclude>fi.jawsy.jawwa.zk.atmosphere</exclude>
<exclude>it.sauronsoftware.cron4j</exclude>
<exclude>javax.*</exclude>
<exclude>net.miginfocom.*</exclude>
<exclude>okhttp3*</exclude>
<exclude>okio*</exclude>
<exclude>org.jdesktop.*</exclude>
<exclude>org.jrimum.*</exclude>
<exclude>org.jsoup*</exclude>
<exclude>org.netbeans.*</exclude>
<exclude>org.zkforge.*</exclude>
<exclude>org.zkoss.*</exclude>
<exclude>test*</exclude>
<exclude>org.eclipse.*</exclude>
<exclude>org.compiere.css</exclude>
<exclude>org.compiere.images</exclude>
<exclude>org.apache.*</exclude>
<exclude>metainfo.zk</exclude>
<exclude>web*</exclude>
<exclude>org.idempiere.adInterface.x10*</exclude>
<exclude>action.images*</exclude>
<exclude>google.*</exclude>
<exclude>jsinterop.*</exclude>
<exclude>org.checkerframework.*</exclude>
<exclude>org.codehaus.*</exclude>
<exclude>org.kohsuke.*</exclude>
</excludes>
<additionalArguments>
<!-- needed by Java 11 compatibility and compiling at doc generation
(same as used on start-server.sh) -->
<additionalArgument>--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</additionalArgument>
<additionalArgument>-Xdoclint:none</additionalArgument>
<additionalArgument>-use</additionalArgument>
<additionalArgument>-author</additionalArgument>
<additionalArgument>-breakiterator</additionalArgument>
<additionalArgument>-version</additionalArgument>
<additionalArgument>-link
https://docs.oracle.com/en/java/javase/11/docs/api/</additionalArgument>
<additionalArgument>-splitindex</additionalArgument>
<additionalArgument>-overview
${project.basedir}/doc/overview.html</additionalArgument>
<additionalArgument>-windowtitle "iDempiere ${parsedVersion.majorVersion}.${parsedVersion.minorVersion} API Documentation"</additionalArgument>
<additionalArgument>-doctitle "iDempiere ${parsedVersion.majorVersion}.${parsedVersion.minorVersion} API Documentation"</additionalArgument>
<additionalArgument>-header "iDempiere ${parsedVersion.majorVersion}.${parsedVersion.minorVersion}"</additionalArgument>
<additionalArgument>-bottom "iDempiere ${parsedVersion.majorVersion}.${parsedVersion.minorVersion}"</additionalArgument>
<additionalArgument>--no-module-directories</additionalArgument>
</additionalArguments>
</javadocOptions>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>

2
org.idempiere.p2.targetplatform/org.idempiere.p2.targetplatform.target
View File

@ -623,8 +623,6 @@
<unit id="org.xbill.dns.source" version="2.0.8.v201112050911"/>
<unit id="org.xmlpull" version="1.1.3.4_v201201052148"/>
<unit id="org.yaml.snakeyaml" version="1.14.0.v201604211500"/>
<unit id="osgi.enterprise" version="4.2.0.v201108120515"/>
<unit id="osgi.enterprise.source" version="4.2.0.v201108120515"/>
<unit id="scannotation" version="1.0.2.v201205170710"/>
<unit id="scannotation.source" version="1.0.2.v201205170710"/>
<repository location="http://download.eclipse.org/tools/orbit/downloads/drops/R20181128170323/repository"/>

2
org.idempiere.parent/pom.xml
View File

@ -30,7 +30,7 @@
<idempiere-equinox-repository-id>eclipse-photon-201810</idempiere-equinox-repository-id>
<idempiere-orbit-url>http://download.eclipse.org/tools/orbit/downloads/drops/R20181128170323/repository</idempiere-orbit-url>
<idempiere-orbit-repository-id>orbit-photon-R20181128170323</idempiere-orbit-repository-id>
<url.file.srv>https://raw.githubusercontent.com/idempiere/binary.file/master</url.file.srv>
<url.file.srv>http://jfrog.devcoffee.com.br/mirror/binary.file/</url.file.srv>
<extra.ui.install>org.eclipse.equinox.p2.director, org.idempiere.equinox.p2.director.feature.feature.group, org.idempiere.fitnesse.feature.feature.group</extra.ui.install>
<idempiere.product.id>org.adempiere.server.product</idempiere.product.id>
<codehaus.plexus>2.8.5</codehaus.plexus>

3
pom.xml
View File

@ -69,6 +69,9 @@
<module>org.idempiere.zk-feature</module>
<module>org.idempiere.webservices.client-feature</module>
<module>org.idempiere.p2</module>
<!-- Comment the line below if you don want or need
javadoc creation for each build -->
<module>org.idempiere.javadoc</module>
<module>${idempiere.target}</module>
</modules>