Added jpt.common.ui to Javadoc.v201209120202

3 files changed, 196 insertions, 149 deletions

diff --git a/jpa/plugins/org.eclipse.jpt.doc.isv/buildDoc.xml b/jpa/plugins/org.eclipse.jpt.doc.isv/buildDoc.xml
index 4659e4f5dd..d7c7624f00 100644
--- a/jpa/plugins/org.eclipse.jpt.doc.isv/buildDoc.xml
+++ b/jpa/plugins/org.eclipse.jpt.doc.isv/buildDoc.xml
@@ -1,132 +1,155 @@
-<?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}" />

-

-		<antcall target="replaceJptCommonUtility" />

-		<antcall target="replaceJptCommonCore" />

-					

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

-

-<!--

-		<property name="commonCoreSourcepath" file="commonCoreSourcepath.txt" />

-		<replace file="${basedir}/${optionsFile}" token="@commonCoreSourcepath@" value="${commonCoreSourcepath}" />

--->

-

-		<!--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="replaceJptCommonUtility" if="optionsFile">

-		<replace 

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

-			propertyfile="${basedir}/jptCommonUtility.properties">

-

-            <replacefilter

-                token="@commonUtilitySourcepath@"

-                property="common.utility.sourcepath"/>

-            <replacefilter

-                token="@commonUtilityPackages@"

-                property="common.utility.packages"/>

-		</replace>

-		

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

-		<echo message="common.utility.packages = ${common.utility.packages}" />

-	</target>

-

-	<target name="replaceJptCommonCore" if="optionsFile">

-		<replace 

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

-			propertyfile="${basedir}/jptCommonCore.properties">

-

-            <replacefilter

-                token="@commonCoreSourcepath@"

-                property="common.core.sourcepath"/>

-            <replacefilter

-                token="@commonCoreClasspath@"

-                property="common.core.classpath"/>

-            <replacefilter

-                token="@commonCorePackages@"

-                property="common.core.packages"/>

-		</replace>

-		

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

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

-		<echo message="common.core.packages = ${common.core.packages}" />

-	</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}" />
+
+		<antcall target="replaceJptCommonUtility" />
+		<antcall target="replaceJptCommonCore" />
+		<antcall target="replaceJptCommonUi" />
+					
+		<replaceregexp file="${basedir}/${optionsFile}" flags="g" match="(\r\n?|\n);" replace="${argsListDelimiter}" />
+
+<!--
+		<property name="commonCoreSourcepath" file="commonCoreSourcepath.txt" />
+		<replace file="${basedir}/${optionsFile}" token="@commonCoreSourcepath@" value="${commonCoreSourcepath}" />
+-->
+
+		<!--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>
+
+	<!-- common packages -->
+	<target name="replaceJptCommonUtility" if="optionsFile">
+		<replace 
+			file="${basedir}/${optionsFile}" 
+			propertyfile="${basedir}/jptCommonUtility.properties">
+
+            <replacefilter
+                token="@commonUtilitySourcepath@"
+                property="common.utility.sourcepath"/>
+            <replacefilter
+                token="@commonUtilityPackages@"
+                property="common.utility.packages"/>
+		</replace>
+		
+		<echo message="common.utility.sourcepath = ${common.utility.sourcepath}" />
+		<echo message="common.utility.packages = ${common.utility.packages}" />
+	</target>
+
+	<target name="replaceJptCommonCore" if="optionsFile">
+		<replace 
+			file="${basedir}/${optionsFile}" 
+			propertyfile="${basedir}/jptCommonCore.properties">
+
+            <replacefilter
+                token="@commonCoreSourcepath@"
+                property="common.core.sourcepath"/>
+            <replacefilter
+                token="@commonCoreClasspath@"
+                property="common.core.classpath"/>
+            <replacefilter
+                token="@commonCorePackages@"
+                property="common.core.packages"/>
+		</replace>
+		
+		<echo message="common.core.sourcepath = ${common.core.sourcepath}" />
+		<echo message="common.core.classpath = ${common.core.classpath}" />
+		<echo message="common.core.packages = ${common.core.packages}" />
+	</target>
+
+	<target name="replaceJptCommonUi" if="optionsFile">
+		<replace 
+			file="${basedir}/${optionsFile}" 
+			propertyfile="${basedir}/jptCommonUi.properties">
+
+            <replacefilter
+                token="@commonUiSourcepath@"
+                property="common.ui.sourcepath"/>
+            <replacefilter
+                token="@commonUiClasspath@"
+                property="common.ui.classpath"/>
+            <replacefilter
+                token="@commonUiPackages@"
+                property="common.ui.packages"/>
+		</replace>
+		
+		<echo message="common.ui.sourcepath = ${common.ui.sourcepath}" />
+		<echo message="common.ui.classpath = ${common.ui.classpath}" />
+		<echo message="common.ui.packages = ${common.ui.packages}" />
+	</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/jptCommonUi.properties b/jpa/plugins/org.eclipse.jpt.doc.isv/jptCommonUi.properties
new file mode 100644
index 0000000000..c0a3d800c3
--- /dev/null
+++ b/jpa/plugins/org.eclipse.jpt.doc.isv/jptCommonUi.properties
@@ -0,0 +1,21 @@
+common.ui.sourcepath = ../org.eclipse.jpt.common.ui/src
+
+common.ui.classpath = ../org.eclipse.core.resources/@dot;\
+								../org.eclipse.draw2d/@dot;\
+								../org.eclipse.emf.ecore.xmi/@dot;\
+								../org.eclipse.jdt.core/@dot;\
+								../org.eclipse.jdt.ui/@dot;\
+								../org.eclipse.jface/@dot;\
+								../org.eclipse.jface.text/@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.ui.ide/@dot;\
+								../org.eclipse.ui.navigator/@dot;\
+								../org.eclipse.ui.views.properties.tabbed/@dot;\
+								../org.eclipse.wst.common.project.facet.ui/@dot
+
+common.ui.packages = org.eclipse.jpt.common.ui\
+								org.eclipse.jpt.common.ui.gen\
+								org.eclipse.jpt.common.ui.jface
diff --git a/jpa/plugins/org.eclipse.jpt.doc.isv/jptOptions.txt b/jpa/plugins/org.eclipse.jpt.doc.isv/jptOptions.txt
index f36c4bcad8..95e2202395 100644
--- a/jpa/plugins/org.eclipse.jpt.doc.isv/jptOptions.txt
+++ b/jpa/plugins/org.eclipse.jpt.doc.isv/jptOptions.txt
@@ -1,17 +1,20 @@
--quiet

--charset "utf-8"

--sourcepath "@commonUtilitySourcepath@;@commonCoreSourcepath@"

--classpath @rt@;@commonCoreClasspath@

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

-@commonUtilityPackages@

-@commonCorePackages@

+#No API: org.eclipse.jpt.common.eclipselink.core
+
+-quiet
+-charset "utf-8"
+-sourcepath "@commonUtilitySourcepath@;@commonCoreSourcepath@";@commonUiSourcepath@"
+-classpath @rt@;@commonCoreClasspath@;@commonUiClasspath@
+-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
+@commonUtilityPackages@
+@commonCorePackages@
+@commonUiPackages@