[build-cleanup] Remove ant javadoc targets from src-core,src-trl,src-wad
authorStefan Hühner <stefan.huehner@openbravo.com>
Sun, 09 Jul 2017 14:12:15 +0200
changeset 32767 8a37ee35c54f
parent 32766 0e8f0e82bcd9
child 32768 76ea5b1d9df4
[build-cleanup] Remove ant javadoc targets from src-core,src-trl,src-wad

This removes the following ant calls from main build.xml file:
- core.docs, wad.docs, trl.docs

Javadoc for all three items is included in main ant generate.java.doc target
already. src-wad + src-trl as very tied to Openbravo so not useful outside
of Openbravo project. src-core in theory could be used outside, but that will
be very hard, was never an official feature, and no known user is known.

Also each of the 3 target had matching eclipse .launch files which are also
removed as not useful with the ant targets.

Note:
The rm call to remove the docs subfolder where javadoc would be generated is
left in the files to cleanup any earlier created folder or javadoc.
build.xml
src-core/build.xml
src-core/core.docs.launch
src-trl/build.xml
src-trl/trl.docs.launch
src-wad/build.xml
src-wad/wad.docs.launch
--- a/build.xml	Thu Sep 21 14:53:58 2017 +0200
+++ b/build.xml	Sun Jul 09 14:12:15 2017 +0200
@@ -31,13 +31,10 @@
 eclipse.compile.complete: refer to eclipse.compile.complete target of src.
 compile.src: refer to compile.src target of src.
 war: refer to build.war target of src.
-core.docs: refer to doc target of src-core.
 core.lib: refer to build target of src-core.
 eclipse.wad.lib: refer to sqlc target of src-wad.
-wad.docs: refer to doc target of src-wad.
 wad.lib: refer to build target of src-wad.
 eclipse.trl.lib: refer to sqlc target of src-trl.
-trl.docs: refer to doc target of src-trl.
 trl.lib: refer to build target of src-trl.
 database.lib: refer to jar target of src-db.
 clean: refer to clean target of src.
@@ -650,10 +647,6 @@
     <ant dir="${base.src}" target="build.war" inheritAll="true" inheritRefs="true" />
   </target>
 
-  <target name="core.docs" depends="init">
-    <ant dir="${base.src.core}" target="doc" inheritAll="true" inheritRefs="true" />
-  </target>
-
   <target name="core.lib" depends="init">
     <ant dir="${base.src.core}" target="build" inheritAll="true" inheritRefs="true" />
     <antcall target="copy.core.lib" />
@@ -669,10 +662,6 @@
     <eclipse.incrementalBuild project="OpenbravoWAD" kind="full" />
   </target>
 
-  <target name="wad.docs" depends="init">
-    <ant dir="${base.src.wad}" target="doc" inheritAll="true" inheritRefs="true" />
-  </target>
-
   <target name="wad.lib" depends="init">
     <ant dir="${base.src.wad}" target="build" inheritAll="true" inheritRefs="true" />
   </target>
@@ -683,10 +672,6 @@
     <eclipse.incrementalBuild project="OpenbravoTrl" kind="full" />
   </target>
 
-  <target name="trl.docs" depends="init">
-    <ant dir="${base.src.trl}" target="doc" inheritAll="true" inheritRefs="true" />
-  </target>
-
   <target name="trl.lib" depends="init">
     <ant dir="${base.src.trl}" target="build" inheritAll="true" inheritRefs="true" />
   </target>
--- a/src-core/build.xml	Thu Sep 21 14:53:58 2017 +0200
+++ b/src-core/build.xml	Sun Jul 09 14:12:15 2017 +0200
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <!--
 ************************************************************************************
-* Copyright (C) 2001-2016 Openbravo S.L.U.
+* Copyright (C) 2001-2017 Openbravo S.L.U.
 * Licensed under the Apache Software License version 2.0
 * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to  in writing,  software  distributed
@@ -18,8 +18,7 @@
 clean: removes all the files and folders.
 compile: compile the java files of the project.
 build.jar: generates the jar file in the lib folder.
-build: compile the project and generates the jar and doc.
-doc: generates the api for the project.
+build: compile the project and generates the jar
 -->
 <project default="compile" basedir="." name="openbravo-core">
   <property name="build.core" value="${basedir}/build/classes"/>
@@ -34,7 +33,6 @@
 
   <target name="init">
     <mkdir dir="${build.core}"/>
-    <mkdir dir="${build.core.docs}"/>
   </target>
 
   <target name="clean">
@@ -64,18 +62,4 @@
 <target name="build" depends="compile, build.jar">
 </target>
 
-<target name="doc" depends="init" description="Generate api">
-  <javadoc packagenames="org.openbravo.*" 
-    sourcepath="${build.core.src}"
-    destdir="${build.core.docs}"
-    author="true"
-    version="true"
-    use="true"
-    docencoding="UTF-8"
-    encoding="UTF-8"
-    failonerror="false"
-    windowtitle="${ant.project.name}">
-    <classpath refid="core.class.path"/>
-  </javadoc>
-</target>
 </project>
--- a/src-core/core.docs.launch	Thu Sep 21 14:53:58 2017 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,22 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<launchConfiguration type="org.eclipse.ant.AntLaunchConfigurationType">
-<stringAttribute key="org.eclipse.ant.ui.ATTR_BUILD_SCOPE" value="${none}"/>
-<booleanAttribute key="org.eclipse.ant.ui.DEFAULT_VM_INSTALL" value="false"/>
-<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
-<listEntry value="/openbravo/build.xml"/>
-</listAttribute>
-<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
-<listEntry value="1"/>
-</listAttribute>
-<booleanAttribute key="org.eclipse.debug.core.appendEnvironmentVariables" value="true"/>
-<listAttribute key="org.eclipse.debug.ui.favoriteGroups">
-<listEntry value="org.eclipse.ui.externaltools.launchGroup"/>
-</listAttribute>
-<stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
-<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="openbravo"/>
-<stringAttribute key="org.eclipse.jdt.launching.SOURCE_PATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
-<stringAttribute key="org.eclipse.ui.externaltools.ATTR_ANT_TARGETS" value="core.docs,"/>
-<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/openbravo/build.xml}"/>
-<stringAttribute key="org.eclipse.ui.externaltools.ATTR_WORKING_DIRECTORY" value="${workspace_loc:/openbravo}"/>
-<stringAttribute key="process_factory_id" value="org.eclipse.ant.ui.remoteAntProcessFactory"/>
-</launchConfiguration>
--- a/src-trl/build.xml	Thu Sep 21 14:53:58 2017 +0200
+++ b/src-trl/build.xml	Sun Jul 09 14:12:15 2017 +0200
@@ -12,7 +12,7 @@
  * under the License. 
  * The Original Code is Openbravo ERP. 
  * The Initial Developer of the Original Code is Openbravo SLU 
- * All portions are Copyright (C) 2001-2011 Openbravo SLU 
+ * All portions are Copyright (C) 2001-2017 Openbravo SLU 
  * All Rights Reserved. 
  * Contributor(s):  ______________________________________.
  ************************************************************************
@@ -26,8 +26,7 @@
 compileSqlc: compile the java files generated from xsql's files.
 compile: compile the java files of the project.
 build.jar: generates the jar file in the lib folder.
-build: compile the project, including the xsql's files and generates the jar and doc.
-doc: generates the api for the project.
+build: compile the project, including the xsql's files and generates the jar
 -->
 <project default="compile" basedir="." name="openbravo-trl">
   <property name="build.trl" value="${basedir}/build/classes"/>
@@ -45,7 +44,6 @@
   <target name="init">
     <mkdir dir="${build.trl}"/>
     <mkdir dir="${build.trl.sqlc}"/>
-    <mkdir dir="${build.trl.docs}"/>
   </target>
   
   <target name="clean">
@@ -92,18 +90,4 @@
   <target name="build" depends="compile, build.jar">
   </target>
   
-  <target name="doc" depends="init" description="Generate api">
-    <javadoc packagenames="org.openbravo.*" 
-           sourcepath="${build.trl.sqlc}/src:${build.trl.src}"
-           destdir="${build.trl.docs}"
-           author="true"
-           version="true"
-           use="true"
-           docencoding="UTF-8"
-           encoding="UTF-8"
-           failonerror="false"
-           windowtitle="${ant.project.name}">
-      <classpath refid="trl.class.path"/>
-    </javadoc>
-  </target>
 </project>
--- a/src-trl/trl.docs.launch	Thu Sep 21 14:53:58 2017 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,22 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<launchConfiguration type="org.eclipse.ant.AntLaunchConfigurationType">
-<stringAttribute key="process_factory_id" value="org.eclipse.ant.ui.remoteAntProcessFactory"/>
-<booleanAttribute key="org.eclipse.ant.ui.DEFAULT_VM_INSTALL" value="false"/>
-<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
-<listEntry value="1"/>
-</listAttribute>
-<booleanAttribute key="editedByExternalToolsMainTab" value="true"/>
-<listAttribute key="org.eclipse.debug.ui.favoriteGroups">
-<listEntry value="org.eclipse.ui.externaltools.launchGroup"/>
-</listAttribute>
-<booleanAttribute key="org.eclipse.debug.core.appendEnvironmentVariables" value="true"/>
-<stringAttribute key="org.eclipse.ant.ui.ATTR_BUILD_SCOPE" value="${none}"/>
-<stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
-<stringAttribute key="org.eclipse.ui.externaltools.ATTR_ANT_TARGETS" value="trl.docs,"/>
-<stringAttribute key="org.eclipse.jdt.launching.SOURCE_PATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
-<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="openbravo"/>
-<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
-<listEntry value="/openbravo/build.xml"/>
-</listAttribute>
-<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/openbravo/build.xml}"/>
-</launchConfiguration>
--- a/src-wad/build.xml	Thu Sep 21 14:53:58 2017 +0200
+++ b/src-wad/build.xml	Sun Jul 09 14:12:15 2017 +0200
@@ -13,7 +13,7 @@
  * and  limitations under the License. 
  * The Original Code is Openbravo ERP. 
  * The Initial Developer of the Original Code is Openbravo SLU 
- * All portions are Copyright (C) 2005-2014 Openbravo SLU 
+ * All portions are Copyright (C) 2005-2017 Openbravo SLU 
  * All Rights Reserved. 
  * Contributor(s): Openbravo S.L.U.
  ************************************************************************
@@ -27,8 +27,7 @@
 compileSqlc: compile the java files generated from xsql's files.
 compile: compile the java files of the project.
 build.jar: generates the jar file in the lib folder.
-build: compile the project, including the xsql's files and generates the jar and doc.
-doc: generates the api for the project.
+build: compile the project, including the xsql's files and generates the jar
 -->
 <project name="openbravo-wad" default="compile" basedir=".">
   <property name="build.wad" value="${basedir}/build/classes" />
@@ -46,7 +45,6 @@
 
   <target name="init">
     <mkdir dir="${build.wad}" />
-    <mkdir dir="${build.wad.docs}" />
     <mkdir dir="${build.wad.sqlc}" />
   </target>
 
@@ -123,9 +121,4 @@
   <target name="build" depends="compile, build.jar">
   </target>
 
-  <target name="doc" depends="init" description="Generate api">
-    <javadoc packagenames="org.openbravo.*" sourcepath="${build.wad.sqlc}/src:${build.wad.src}" destdir="${build.wad.docs}" author="true" version="true" use="true" docencoding="UTF-8" encoding="UTF-8" failonerror="false" windowtitle="${ant.project.name}">
-      <classpath refid="wad.class.path" />
-    </javadoc>
-  </target>
 </project>
--- a/src-wad/wad.docs.launch	Thu Sep 21 14:53:58 2017 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,22 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<launchConfiguration type="org.eclipse.ant.AntLaunchConfigurationType">
-<stringAttribute key="process_factory_id" value="org.eclipse.ant.ui.remoteAntProcessFactory"/>
-<booleanAttribute key="org.eclipse.ant.ui.DEFAULT_VM_INSTALL" value="false"/>
-<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
-<listEntry value="1"/>
-</listAttribute>
-<booleanAttribute key="editedByExternalToolsMainTab" value="true"/>
-<listAttribute key="org.eclipse.debug.ui.favoriteGroups">
-<listEntry value="org.eclipse.ui.externaltools.launchGroup"/>
-</listAttribute>
-<booleanAttribute key="org.eclipse.debug.core.appendEnvironmentVariables" value="true"/>
-<stringAttribute key="org.eclipse.ant.ui.ATTR_BUILD_SCOPE" value="${none}"/>
-<stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
-<stringAttribute key="org.eclipse.ui.externaltools.ATTR_ANT_TARGETS" value="wad.docs,"/>
-<stringAttribute key="org.eclipse.jdt.launching.SOURCE_PATH_PROVIDER" value="org.eclipse.ant.ui.AntClasspathProvider"/>
-<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="openbravo"/>
-<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_PATHS">
-<listEntry value="/openbravo/build.xml"/>
-</listAttribute>
-<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/openbravo/build.xml}"/>
-</launchConfiguration>