Reworked Javadoc generator options.v201209111818

3 files changed, 175 insertions, 153 deletions

diff --git a/jpa/plugins/org.eclipse.jpt.doc.isv/buildDoc.xml b/jpa/plugins/org.eclipse.jpt.doc.isv/buildDoc.xml
index 9ab69699af..f3ce7da86d 100644
--- a/jpa/plugins/org.eclipse.jpt.doc.isv/buildDoc.xml
+++ b/jpa/plugins/org.eclipse.jpt.doc.isv/buildDoc.xml
@@ -1,86 +1,106 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
-  Copyright (c) 2012 Oracle. All rights reserved.
-  This program and the accompanying materials are made available under the
-  terms of the Eclipse Public License v1.0, which accompanies this distribution
-  and is available at http://www.eclipse.org/legal/epl-v10.html.
-
-  Contributors:
-    Oracle - initial API and implementation
- -->
-
-<project name="JPT Doc ISV Build" default="all"  basedir="." >
-
-	<target name="init">
-		<available file="${basedir}/index" property="index.present"/>
-	</target>
-
-	<target name="all" depends="init" unless="index.present">
-		<!-- <antcall target="convertSchemaToHtml" /> -->
-		<antcall target="generateJavadoc" />
-<!--		<antcall target="build.index" /> /-->
-		<!--antcall target="createDocZip" /-->
-	</target>
-
-	<target name="build.index" description="Builds search index for the plug-in: org.eclipse.jpt.doc.isv." if="eclipse.running">
-		<help.buildHelpIndex manifest="${basedir}/plugin.xml" destination="${basedir}"/>
-	</target>
-
-	<target name="getJavadocPath">
-		<available file="${java.home}/../bin/javadoc.exe" property="javadoc" value="${java.home}/../bin/javadoc.exe"/>
-		<available file="${java.home}/../bin/javadoc" property="javadoc" value="${java.home}/../bin/javadoc" />
-	</target>
-
-
-	<target name="generateJavadoc" depends="getJavadocPath" if="javadoc">
-
-		<property name="optionsFile" value="jptOptions.tmp.txt" />
-		<copy file="jptOptions.txt" tofile="${optionsFile}" overwrite="true" />
-		
-		<condition property="argsListDelimiter" value=":">
-			<os family="unix" />
-		</condition>
-		<condition property="argsListDelimiter" value=";">
-			<os family="windows" />
-		</condition>
-
-		<replaceregexp file="${basedir}/${optionsFile}" flags="g" match="(\r\n?|\n);" replace="${argsListDelimiter}" />
-		<replace file="${basedir}/${optionsFile}" token="@rt@" value="${bootclasspath}" />
-
-
-		<!--scrub isv plugin directories of any preexisting doc content-->
-		<delete dir="index-files"/>
-		<delete dir="org"/>
-		<delete dir="resources"/>
-
-		<exec dir="." executable="${javadoc}" output="doc.bin.log">
-			<arg line="@${basedir}/${optionsFile} -J-Xmx1000M" />
-		</exec>
-	</target>
-
-	<target name="buildJptDoc" unless="jpt.index.present">
-		<ant antfile="buildDoc.xml" dir="../org.eclipse.jpt.doc.isv" />
-	</target>
-
-	<target name="createDocZip">
-		<zip zipfile="${basedir}/doc.zip"
-		basedir="${basedir}"
-		includes="schema.css, book.css, notices.html, about.html, concepts/**, guide/**, tips/**, reference/**, tasks/**, whatsNew/**, images/**"
-	/>
-	</target>
-
-</project>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+<?xml version="1.0" encoding="UTF-8"?>

+<!--

+  Copyright (c) 2012 Oracle. All rights reserved.

+  This program and the accompanying materials are made available under the

+  terms of the Eclipse Public License v1.0, which accompanies this distribution

+  and is available at http://www.eclipse.org/legal/epl-v10.html.

+

+  Contributors:

+    Oracle - initial API and implementation

+ -->

+

+<project name="JPT Doc ISV Build" default="all"  basedir="." >

+

+	<target name="init">

+		<available file="${basedir}/index" property="index.present"/>

+	</target>

+

+	<target name="all" depends="init" unless="index.present">

+		<!-- <antcall target="convertSchemaToHtml" /> -->

+		<antcall target="generateJavadoc" />

+<!--		<antcall target="build.index" /> /-->

+		<!--antcall target="createDocZip" /-->

+	</target>

+

+	<target name="build.index" description="Builds search index for the plug-in: org.eclipse.jpt.doc.isv." if="eclipse.running">

+		<help.buildHelpIndex manifest="${basedir}/plugin.xml" destination="${basedir}"/>

+	</target>

+

+	<target name="getJavadocPath">

+		<available file="${java.home}/../bin/javadoc.exe" property="javadoc" value="${java.home}/../bin/javadoc.exe"/>

+		<available file="${java.home}/../bin/javadoc" property="javadoc" value="${java.home}/../bin/javadoc" />

+	</target>

+

+

+	<target name="generateJavadoc" depends="getJavadocPath" if="javadoc">

+

+		<property name="optionsFile" value="jptOptions.tmp.txt" />

+		<copy file="jptOptions.txt" tofile="${optionsFile}" overwrite="true" />

+		

+		<condition property="argsListDelimiter" value=":">

+			<os family="unix" />

+		</condition>

+		<condition property="argsListDelimiter" value=";">

+			<os family="windows" />

+		</condition>

+

+		<replace file="${basedir}/${optionsFile}" token="@rt@" value="${bootclasspath}" />

+		

+		<replace 

+			file="${basedir}/${optionsFile}" 

+			propertyfile="${basedir}/jptCommon.properties">

+

+            <replacefilter

+                token="@commonSourcepath@"

+                property="common.sourcepath"/>

+            <replacefilter

+                token="@commonClasspath@"

+                property="common.classpath"/>

+		</replace>

+		

+		<echo message="common.sourcepath = ${common.sourcepath}" />

+		<echo message="common.classpath = ${common.classpath}" />

+		

+		<replaceregexp file="${basedir}/${optionsFile}" flags="g" match="(\r\n?|\n);" replace="${argsListDelimiter}" />

+

+<!--

+		<property name="commonSourcepath" file="commonSourcepath.txt" />

+		<replace file="${basedir}/${optionsFile}" token="@commonSourcepath@" value="${commonSourcepath}" />

+-->

+

+		<!--scrub isv plugin directories of any preexisting doc content-->

+		<delete dir="index-files"/>

+		<delete dir="org"/>

+		<delete dir="resources"/>

+

+		<exec dir="." executable="${javadoc}" output="doc.bin.log">

+			<arg line="@${basedir}/${optionsFile} -J-Xmx1000M" />

+		</exec>

+	</target>

+

+	<target name="buildJptDoc" unless="jpt.index.present">

+		<ant antfile="buildDoc.xml" dir="../org.eclipse.jpt.doc.isv" />

+	</target>

+

+	<target name="createDocZip">

+		<zip zipfile="${basedir}/doc.zip"

+		basedir="${basedir}"

+		includes="schema.css, book.css, notices.html, about.html, concepts/**, guide/**, tips/**, reference/**, tasks/**, whatsNew/**, images/**"

+	/>

+	</target>

+

+</project>

+

+

+

+

+

+

+

+

+

+

+

+

+

+

diff --git a/jpa/plugins/org.eclipse.jpt.doc.isv/jptCommon.properties b/jpa/plugins/org.eclipse.jpt.doc.isv/jptCommon.properties
new file mode 100644
index 0000000000..1f4c2f5fcf
--- /dev/null
+++ b/jpa/plugins/org.eclipse.jpt.doc.isv/jptCommon.properties
@@ -0,0 +1,39 @@
+common.sourcepath = ../org.eclipse.jpt.common.core/src;\
+								../org.eclipse.jpt.common.eclipselink.core/src;\
+								../org.eclipse.jpt.common.ui/src;\
+								../org.eclipse.jpt.common.utility/src
+
+common.classpath = ../org.eclipse.core.expressions/@dot;\
+								../org.eclipse.core.filebuffers/@dot;\
+								../org.eclipse.core.resources/@dot;\
+								../org.eclipse.core.runtime/@dot;\
+								../org.eclipse.debug.core/@dot;\
+								../org.eclipse.draw2d/@dot;\
+								../org.eclipse.emf.ecore.xmi/@dot;\
+								../org.eclipse.jdt.core/@dot;\
+								../org.eclipse.jdt.launching/@dot;\
+								../org.eclipse.jdt.ui/@dot;\
+								../org.eclipse.jface/@dot;\
+								../org.eclipse.jface.text/@dot;\
+								../org.eclipse.jem.util/@dot;\
+								../org.eclipse.jpt.common.core/@dot;\
+								../org.eclipse.jpt.common.utility/@dot;\
+								../org.eclipse.jst.common.project.facet.core/@dot;\
+								../org.eclipse.jst.common.project.facet.ui/@dot;\
+								../org.eclipse.jst.j2ee/@dot;\
+								../org.eclipse.jst.j2ee.core/@dot;\
+								../org.eclipse.pde.core/@dot;\
+								../org.eclipse.text/@dot;\
+								../org.eclipse.ui.ide/@dot;\
+								../org.eclipse.ui.navigator/@dot;\
+								../org.eclipse.ui.views.properties.tabbed/@dot;\
+								../org.eclipse.wst.common.emf/@dot;\
+								../org.eclipse.wst.common.emfworkbench.integration/@dot;\
+								../org.eclipse.wst.common.frameworks/@dot;\
+								../org.eclipse.wst.common.project.facet.core/@dot;\
+								../org.eclipse.wst.sse.core/@dot;\
+								../org.eclipse.wst.validation/@dot;\
+								../org.eclipse.wst.xml.core/@dot;\
+								../org.eclipse.help/@dot;\
+								../org.eclipse.help.ui/@dot
+
diff --git a/jpa/plugins/org.eclipse.jpt.doc.isv/jptOptions.txt b/jpa/plugins/org.eclipse.jpt.doc.isv/jptOptions.txt
index c8ede174aa..1ea0181a17 100644
--- a/jpa/plugins/org.eclipse.jpt.doc.isv/jptOptions.txt
+++ b/jpa/plugins/org.eclipse.jpt.doc.isv/jptOptions.txt
@@ -1,67 +1,30 @@
--quiet
--charset "utf-8"
--sourcepath "../org.eclipse.jpt.common.core/src
-;../org.eclipse.jpt.common.eclipselink.core/src
-;../org.eclipse.jpt.common.ui/src
-;../org.eclipse.jpt.common.utility/src"
--classpath @rt@
-;../org.eclipse.core.expressions/@dot
-;../org.eclipse.core.filebuffers/@dot
-;../org.eclipse.core.resources/@dot
-;../org.eclipse.core.runtime/@dot
-;../org.eclipse.debug.core/@dot
-;../org.eclipse.draw2d/@dot
-;../org.eclipse.emf.ecore.xmi/@dot
-;../org.eclipse.jdt.core/@dot
-;../org.eclipse.jdt.launching/@dot
-;../org.eclipse.jdt.ui/@dot
-;../org.eclipse.jface/@dot
-;../org.eclipse.jface.text/@dot
-;../org.eclipse.jem.util/@dot
-;../org.eclipse.jpt.common.core/@dot
-;../org.eclipse.jpt.common.utility/@dot
-;../org.eclipse.jst.common.project.facet.core/@dot
-;../org.eclipse.jst.common.project.facet.ui/@dot
-;../org.eclipse.jst.j2ee/@dot
-;../org.eclipse.jst.j2ee.core/@dot
-;../org.eclipse.pde.core/@dot
-;../org.eclipse.text/@dot
-;../org.eclipse.ui.ide/@dot
-;../org.eclipse.ui.navigator/@dot
-;../org.eclipse.ui.views.properties.tabbed/@dot
-;../org.eclipse.wst.common.emf/@dot
-;../org.eclipse.wst.common.emfworkbench.integration/@dot
-;../org.eclipse.wst.common.frameworks/@dot
-;../org.eclipse.wst.common.project.facet.core/@dot
-;../org.eclipse.wst.sse.core/@dot
-;../org.eclipse.wst.validation/@dot
-;../org.eclipse.wst.xml.core/@dot
-;../org.eclipse.help/@dot
-;../org.eclipse.help.ui/@dot
--breakiterator
--use
--splitIndex
-
--windowtitle "Dali Java Persistence Tools Doc"
--doctitle "Dali Provisional API"
--header "<b>Dali Provisional API</b><br>Release 3.2"
--bottom "Copyright (c) 2012 Oracle. All rights reserved."
--link http://java.sun.com/j2se/1.5/docs/api
-
-#JPT common API packages
-org.eclipse.jpt.common.core
-org.eclipse.jpt.common.core.libprov
-org.eclipse.jpt.common.core.libval
-org.eclipse.jpt.common.core.resource
-org.eclipse.jpt.common.core.utility
-org.eclipse.jpt.common.core.utility.jdt
-org.eclipse.jpt.common.eclipselink.core
-org.eclipse.jpt.common.ui
-org.eclipse.jpt.common.ui.jface
-org.eclipse.jpt.common.utility
-org.eclipse.jpt.common.utility.model
-org.eclipse.jpt.common.utility.model.event
-org.eclipse.jpt.common.utility.model.listener
-org.eclipse.jpt.common.utility.model.value
-org.eclipse.jpt.common.utility.synchronizers
-
+-quiet

+-charset "utf-8"

+-sourcepath "@commonSourcepath@"

+-classpath @rt@;@commonClasspath@

+-breakiterator

+-use

+-splitIndex

+

+-windowtitle "Dali Java Persistence Tools Doc"

+-doctitle "Dali Provisional API"

+-header "<b>Dali Provisional API</b><br>Release 3.2"

+-bottom "Copyright (c) 2012 Oracle. All rights reserved."

+-link http://docs.oracle.com/javase/6/docs/api/

+

+#JPT common API packages

+org.eclipse.jpt.common.core

+org.eclipse.jpt.common.core.libprov

+org.eclipse.jpt.common.core.libval

+org.eclipse.jpt.common.core.resource

+org.eclipse.jpt.common.core.utility

+org.eclipse.jpt.common.core.utility.jdt

+org.eclipse.jpt.common.eclipselink.core

+org.eclipse.jpt.common.ui

+org.eclipse.jpt.common.ui.jface

+org.eclipse.jpt.common.utility

+org.eclipse.jpt.common.utility.model

+org.eclipse.jpt.common.utility.model.event

+org.eclipse.jpt.common.utility.model.listener

+org.eclipse.jpt.common.utility.model.value

+org.eclipse.jpt.common.utility.synchronizers