Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTran Le2012-08-28 18:01:49 -0400
committerTran Le2012-08-28 18:29:30 -0400
commit340318de33df661946a8a5cbecd9918b7fdc6551 (patch)
tree13b995d80202c23c43c8047b7cbb70d359088ac5 /org.eclipse.jpt.doc.isv
parent3f09be219e0653795d242d51ab08ec31d4057011 (diff)
downloadwebtools.dali-340318de33df661946a8a5cbecd9918b7fdc6551.tar.gz
webtools.dali-340318de33df661946a8a5cbecd9918b7fdc6551.tar.xz
webtools.dali-340318de33df661946a8a5cbecd9918b7fdc6551.zip
Added Javadoc generation.v201208282228
Diffstat (limited to 'org.eclipse.jpt.doc.isv')
-rw-r--r--org.eclipse.jpt.doc.isv/.project22
-rw-r--r--org.eclipse.jpt.doc.isv/META-INF/MANIFEST.MF8
-rw-r--r--org.eclipse.jpt.doc.isv/about.html34
-rw-r--r--org.eclipse.jpt.doc.isv/build.properties18
-rw-r--r--org.eclipse.jpt.doc.isv/buildDoc.xml86
-rw-r--r--org.eclipse.jpt.doc.isv/customBuildCallbacks.xml25
-rw-r--r--org.eclipse.jpt.doc.isv/jptOptions.txt67
-rw-r--r--org.eclipse.jpt.doc.isv/plugin.properties23
8 files changed, 283 insertions, 0 deletions
diff --git a/org.eclipse.jpt.doc.isv/.project b/org.eclipse.jpt.doc.isv/.project
new file mode 100644
index 0000000000..3b2d8a0926
--- /dev/null
+++ b/org.eclipse.jpt.doc.isv/.project
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+ <name>org.eclipse.jpt.doc.isv</name>
+ <comment></comment>
+ <projects>
+ </projects>
+ <buildSpec>
+ <buildCommand>
+ <name>org.eclipse.pde.ManifestBuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ <buildCommand>
+ <name>org.eclipse.pde.SchemaBuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ </buildSpec>
+ <natures>
+ <nature>org.eclipse.pde.PluginNature</nature>
+ </natures>
+</projectDescription>
diff --git a/org.eclipse.jpt.doc.isv/META-INF/MANIFEST.MF b/org.eclipse.jpt.doc.isv/META-INF/MANIFEST.MF
new file mode 100644
index 0000000000..26a26eea51
--- /dev/null
+++ b/org.eclipse.jpt.doc.isv/META-INF/MANIFEST.MF
@@ -0,0 +1,8 @@
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-Name: %pluginName
+Bundle-SymbolicName: org.eclipse.jpt.doc.isv; singleton:=true
+Bundle-Version: 3.3.0.qualifier
+Bundle-Vendor: %providerName
+Bundle-Localization: plugin
+Require-Bundle: org.eclipse.help;bundle-version="[3.4.0,4.0.0)"
diff --git a/org.eclipse.jpt.doc.isv/about.html b/org.eclipse.jpt.doc.isv/about.html
new file mode 100644
index 0000000000..be534ba44f
--- /dev/null
+++ b/org.eclipse.jpt.doc.isv/about.html
@@ -0,0 +1,34 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
+<HTML>
+
+<head>
+<title>About</title>
+<meta http-equiv=Content-Type content="text/html; charset=ISO-8859-1">
+</head>
+
+<BODY lang="EN-US">
+
+<H3>About This Content</H3>
+
+<P>May 02, 2008</P>
+
+<H3>License</H3>
+
+<P>The Eclipse Foundation makes available all content in this plug-in
+("Content"). Unless otherwise indicated below, the Content is provided to you
+under the terms and conditions of the Eclipse Public License Version 1.0
+("EPL"). A copy of the EPL is available at
+<A href="http://www.eclipse.org/org/documents/epl-v10.php">http://www.eclipse.org/org/documents/epl-v10.php</A>.
+For purposes of the EPL, "Program" will mean the Content.</P>
+
+<P>If you did not receive this Content directly from the Eclipse Foundation, the
+Content is being redistributed by another party ("Redistributor") and different
+terms and conditions may apply to your use of any object code in the Content.
+Check the Redistributor's license that was provided with the Content. If no such
+license exists, contact the Redistributor. Unless otherwise indicated below, the
+terms and conditions of the EPL still apply to any source code in the Content
+and such source code may be obtained at
+<A href="http://www.eclipse.org/">http://www.eclipse.org/</A>.</P>
+
+</BODY>
+</HTML>
diff --git a/org.eclipse.jpt.doc.isv/build.properties b/org.eclipse.jpt.doc.isv/build.properties
new file mode 100644
index 0000000000..3f7a92522e
--- /dev/null
+++ b/org.eclipse.jpt.doc.isv/build.properties
@@ -0,0 +1,18 @@
+################################################################################
+# 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
+################################################################################
+
+customBuildCallbacks=customBuildCallbacks.xml
+
+bin.includes = META-INF/,\
+ plugin.properties,\
+ about.html,\
+ build.properties,\
+ index*/
+generateSourceBundle=false
diff --git a/org.eclipse.jpt.doc.isv/buildDoc.xml b/org.eclipse.jpt.doc.isv/buildDoc.xml
new file mode 100644
index 0000000000..a58334d2b6
--- /dev/null
+++ b/org.eclipse.jpt.doc.isv/buildDoc.xml
@@ -0,0 +1,86 @@
+<?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>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/org.eclipse.jpt.doc.isv/customBuildCallbacks.xml b/org.eclipse.jpt.doc.isv/customBuildCallbacks.xml
new file mode 100644
index 0000000000..de63223625
--- /dev/null
+++ b/org.eclipse.jpt.doc.isv/customBuildCallbacks.xml
@@ -0,0 +1,25 @@
+<?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 -->
+
+<!-- ===================================================================== --> <!-- Custom targets called from a project's generated build.xml --> <!-- Set customBuildCallbacks=<path/to/this/file> in your build.properties.--> <!-- ===================================================================== --> <project name="Build specific targets and properties" default="noDefault">
+
+ <import file="${eclipse.pdebuild.templates}/plugins/customBuildCallbacks.xml" />
+
+ <target name="noDefault">
+ <echo message="This file must be called with explicit targets" />
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do before the target gather.bin.parts -->
+ <!-- Available parameters : --> <!-- build.result.folder - folder containing the build results --> <!-- target.folder - destination folder -->
+ <!-- destination.temp.folder - the directory plugins will be collected to -->
+ <!-- feature.directory - the directory containing the resulting feature -->
+ <!-- ===================================================================== -->
+ <target name="pre.gather.bin.parts">
+ <antcall target="build.index"/>
+ </target>
+
+ <target name="build.index" description="Builds search index for the plug-in: org.eclipse.jpt.doc.isv." if="eclipse.running">
+ <ant antfile="buildDoc.xml" />
+ </target>
+
+</project>
diff --git a/org.eclipse.jpt.doc.isv/jptOptions.txt b/org.eclipse.jpt.doc.isv/jptOptions.txt
new file mode 100644
index 0000000000..a4e4b719b6
--- /dev/null
+++ b/org.eclipse.jpt.doc.isv/jptOptions.txt
@@ -0,0 +1,67 @@
+-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
+
diff --git a/org.eclipse.jpt.doc.isv/plugin.properties b/org.eclipse.jpt.doc.isv/plugin.properties
new file mode 100644
index 0000000000..0b12648a46
--- /dev/null
+++ b/org.eclipse.jpt.doc.isv/plugin.properties
@@ -0,0 +1,23 @@
+###############################################################################
+# 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
+###############################################################################
+# ====================================================================
+# To code developer:
+# Do NOT change the properties between this line and the
+# "%%% END OF TRANSLATED PROPERTIES %%%" line.
+# Make a new property name, append to the end of the file and change
+# the code to use the new property.
+# ====================================================================
+
+# ====================================================================
+# %%% END OF TRANSLATED PROPERTIES %%%
+# ====================================================================
+
+pluginName = Dali Java Persistence Tools - Doc
+providerName = Eclipse Web Tools Platform

Back to the top