summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorpelder2006-05-24 09:50:00 (EDT)
committer pelder2006-05-24 09:50:00 (EDT)
commit75968e4219657e3fe37ef965869442978739149f (patch)
tree7d6441c7ba1a3c23a845011a6fedcc2b236adc5c
parent7a63c073f1f5e2e22eb3bf87cdcdb56cb4edc94e (diff)
downloadorg.eclipse.jet-75968e4219657e3fe37ef965869442978739149f.zip
org.eclipse.jet-75968e4219657e3fe37ef965869442978739149f.tar.gz
org.eclipse.jet-75968e4219657e3fe37ef965869442978739149f.tar.bz2
[143440] Enable Javadoc indexing
-rw-r--r--doc/org.eclipse.jet.doc/build.xml23
-rw-r--r--doc/org.eclipse.jet.doc/build/javadoc.xml.template39
-rw-r--r--doc/org.eclipse.jet.doc/plugin.xml9
3 files changed, 46 insertions, 25 deletions
diff --git a/doc/org.eclipse.jet.doc/build.xml b/doc/org.eclipse.jet.doc/build.xml
index 48f5ce4..5ea97f7 100644
--- a/doc/org.eclipse.jet.doc/build.xml
+++ b/doc/org.eclipse.jet.doc/build.xml
@@ -3,11 +3,11 @@
<!-- Plug-in version. This is a HACK. Do not forget to update. -->
<property name="pluginVersion" value="1.0.0"/>
-
+
<property name="plugin" value="org.eclipse.jet"/>
<property name="docPlugin" value="org.eclipse.jet.doc"/>
- <property name="filesToInclude" value="META-INF/,about.*,eclipse*.gif,eclipse*.png,eclipse_lg.gif,plugin.*,doc.zip,toc*.xml,index/**"/>
+ <property name="filesToInclude" value="META-INF/**,about.*,eclipse*.gif,eclipse*.png,eclipse_lg.gif,plugin.*,doc.zip,toc*.xml,topics_*.xml,index/**"/>
<!-- Compiler settings. -->
<property name="javacFailOnError" value="false"/>
@@ -66,22 +66,31 @@
<arg value="build/antJavadoc.sh"/>
<arg value="${eclipse.home}/../eclipse"/>
</exec>
-
+
<antcall target="build.index"/>
-
+
<!-- Zip up all of the documentation artifacts - references(including javadoc), images, tutorials, etc. -->
<zip destfile="doc.zip" compress="true">
<!-- Add new folders for documentation zip here. -->
- <zipfileset dir="references" prefix="references" excludes="**/internal,**/internal/**,**/*.internal.*,**/*.internal.*/**"/>
<zipfileset dir="images" prefix="images"/>
+ <zipfileset dir="gettingStarted" prefix="gettingStarted"/>
+ <zipfileset dir="tasks" prefix="tasks"/>
+ <zipfileset dir="concepts" prefix="concepts"/>
+ <zipfileset dir="references" prefix="references" excludes="**/internal,**/internal/**,**/*.internal.*,**/*.internal.*/**"/>
<zipfileset dir="tutorials" prefix="tutorials"/>
+ <fileset dir="." id="id">
+ <include name="book.css" />
+ <include name="notices.html" />
+ <include name="about.html"/>
+ </fileset>
+
</zip>
</target>
-
+
<target name="build.index" depends="init" description="Builds search index for the plug-in" if="eclipse.running">
<help.buildHelpIndex manifest="plugin.xml" destination="."/>
</target>
-
+
<target name="build.sources" depends="init">
</target>
diff --git a/doc/org.eclipse.jet.doc/build/javadoc.xml.template b/doc/org.eclipse.jet.doc/build/javadoc.xml.template
index e90d31a..946f9d6 100644
--- a/doc/org.eclipse.jet.doc/build/javadoc.xml.template
+++ b/doc/org.eclipse.jet.doc/build/javadoc.xml.template
@@ -17,22 +17,20 @@
<property name="javadoc.link.location" value="${eclipseDir}/javadoc"/>
<available property="platformJavadocExists" file="${javadoc.link.location}/platform/"/>
- <!-- TODO Enable linking to the platform javadoc -->
- <!-- <target name="extractPlatformJavadoc" unless="platformJavadocExists">
- <exec executable="find">
- <arg value="${eclipseDir}/.."/>
- <arg value="-type"/>
- <arg value="d"/>
- <arg value="-name"/>
- <arg value="javadoc"/>
- </exec>
- <unzip src="${eclipseDir}/@docjar@" dest="${javadoc.link.location}/platform/"/>
- </target> -->
+ <target name="extractPlatformJavadoc" unless="platformJavadocExists">
+ <unzip src="${eclipseDir}/plugins/org.eclipse.platform.doc.isv.jar" dest="${javadoc.link.location}/platform/"/>
+ </target>
- <!-- TODO Enable linking to the platform javadoc -->
- <!-- <target name="javadoc" depends="extractPlatformJavadoc"> -->
-
- <target name="javadoc">
+ <target name="javadoc" depends="extractPlatformJavadoc">
+ <echo message="Get Doclet and compile it with JDK1.4 for use with javadoc"/>
+ <cvs cvsRoot=":pserver:anonymous@dev.eclipse.org:/cvsroot/tools"
+ package="org.eclipse.emf.releng.build/org.eclipse.emf.build"
+ reallyquiet="yes"/>
+ <delete dir="org.eclipse.emf.releng.build/org.eclipse.emf.build/src/CVS"/>
+ <move todir="."><fileset dir="org.eclipse.emf.releng.build/org.eclipse.emf.build/src"/></move>
+
+ <!-- requires JDK1.4 for compilation -->
+ <javac srcdir="org/eclipse/emf/build/doclet" classpath=".:${java.home}/../lib/tools.jar" failonerror="true"/>
<javadoc
destdir="${destDir}"
classpath="${classpath}"
@@ -56,11 +54,16 @@
splitindex="true"
use="true"
version="true">
- <arg value="-J-Xmx180m"/>
+ <arg value="-J-Xmx256m"/>
+
+ <doclet name="org.eclipse.emf.build.doclet.Doclet" path="org/eclipse/emf/build/doclet/Doclet">
+ <param name="-tocFilename" value="../topics_Reference.xml"/>
+ <param name="-tocRefPrefix" value="references/javadoc/"/>
+ <param name="-tocTitle" value="API Reference"/>
+ </doclet>
<link offline="true" href="http://java.sun.com/j2se/1.4/docs/api/" packagelistLoc="${javaHome}/docs/api/"/>
- <!-- TODO Enable link to platform documentation -->
- <!-- <link offline="true" href="/help/topic/org.eclipse.platform.doc.isv/reference/api/" packagelistLoc="${javadoc.link.location}/platform/reference/api/"/> -->
+ <link offline="true" href="/help/topic/org.eclipse.platform.doc.isv/reference/api/" packagelistLoc="${javadoc.link.location}/platform/reference/api/"/>
<tag name="ignore" description="ignore" enabled="false"/>
<tag name="generated" description="ignore" enabled="false"/>
diff --git a/doc/org.eclipse.jet.doc/plugin.xml b/doc/org.eclipse.jet.doc/plugin.xml
index c77dde7..539e91a 100644
--- a/doc/org.eclipse.jet.doc/plugin.xml
+++ b/doc/org.eclipse.jet.doc/plugin.xml
@@ -38,5 +38,14 @@
<toc
file="tocExtensionPointiReference.xml"
primary="false"/>
+ <toc file="topics_Reference.xml" />
</extension>
+
+ <!-- ============================= -->
+ <!-- Define Javadoc locations -->
+ <!-- ============================= -->
+ <extension point="org.eclipse.pde.core.javadoc">
+ <javadoc path="references/javadoc"> <!-- defaults to reference/api -->
+ </javadoc>
+ </extension>
</plugin>