Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'doc/org.eclipse.jet.doc/build')
-rw-r--r--doc/org.eclipse.jet.doc/build/antJavadoc.sh144
-rw-r--r--doc/org.eclipse.jet.doc/build/javadoc.xml.template96
-rw-r--r--doc/org.eclipse.jet.doc/build/overview.html43
3 files changed, 0 insertions, 283 deletions
diff --git a/doc/org.eclipse.jet.doc/build/antJavadoc.sh b/doc/org.eclipse.jet.doc/build/antJavadoc.sh
deleted file mode 100644
index 1cc0a2f..0000000
--- a/doc/org.eclipse.jet.doc/build/antJavadoc.sh
+++ /dev/null
@@ -1,144 +0,0 @@
-#!/bin/sh
-
-# BEGIN CUSTOMIZATIONS
-
-# The plugin name
-pluginName="org.eclipse.jet";
-
-# string labels for javadoc content
-windowTitle="JET Javadoc";
-groupTitle="JET";
-
-# files to exclude from javadoc process - use Ant syntax
-javadocExclusions="<exclude name=\"**/internal/**\"/> <exclude name=\"**/examples/**\"/> <exclude name=\"**/tests/**\"/>";
-javadocExclusions=$javadocExclusions" <exclude name=\"**/antsrc/org/eclipse/jet/**\"/> <exclude name=\"dataAccess/**\"/>";
-
-# END CUSTOMIZATIONS
-
-##########################################################################
-
-debug=0; if [ $debug -gt 0 ]; then echo "[antJd] debug: "$debug; fi
-
-if [ "x"$ANT_HOME = "x" ]; then export ANT_HOME=/opt/apache-ant-1.6; fi
-if [ "x"$JAVA_HOME = "x" ]; then export JAVA_HOME=/opt/ibm-java2-1.4; fi
-export PATH=${PATH}:${ANT_HOME}/bin
-
-# current directory - all but the name of this script, no trailing slash
-currentPath=$PWD"/"$0; currentPath=${currentPath%/*}; if [ $debug -gt 0 ]; then echo "[antJd] currentPath: "$currentPath; fi
-
-# path to $buildID/eclipse/plugins, no trailing slash
-pluginPath=${currentPath%/$pluginName*}; if [ $debug -gt 0 ]; then echo "[antJd] pluginName: "$pluginName; echo "[antJd] pluginPath: "$pluginPath; fi
-
-# ant script to create and then execute
-antScript=$currentPath"/javadoc.xml"; if [ $debug -gt 0 ]; then echo "[antJd] antScript: "$antScript; fi
-
-# The eclipse directory
-eclipseDir=`cd $1; echo $PWD`; if [ $debug -gt 0 ]; then echo "[antJd] eclipseDir: "$eclipseDir; fi
-
-# The destination directory
-destDir=$currentPath/../references/javadoc; mkdir -p $destDir; destDir=`cd $destDir; echo $PWD`; # resolve relative path
-if [ $debug -gt 0 ]; then echo "[antJd] destDir: "$destDir; fi
-
-hasToken=`grep -c "@plugin@" $antScript".template"`;
-if [ $hasToken -gt 0 ]; then
- srcDir=$pluginPath/$pluginName/src; if [ $debug -gt 0 ]; then echo "[antJd] srcDir: "$srcDir; fi
- if [ -d "$srcDir" ]; then
- if [ `find $srcDir -name "*.java" | grep -c .` -eq 0 ]; then # must unpack zips first
- if [ $debug -gt 0 ]; then echo "[antJd] Unpacking *src.zip"; fi
- for f in `find $srcDir -name "*src.zip"`; do
- if [ $debug -gt 1 ]; then echo "[antJd] Unpack $f"; fi
- unzip -q -d $srcDir $f;
- done
- fi
- if [ $debug -gt 0 ]; then echo "[antJd] *.java in srcDir: "; echo "-----------------"; echo `find $srcDir -type f -name '*.java'`; echo "-----------------"; fi
- packages=`find $srcDir -type f -name '*.java' -exec grep -e '^package .*;' {} \; | sed -e 's/^package *\(.*\);/\1/' | sed -e 's/[ ]*//g' | dos2unix | sort | uniq | xargs | sed -e 's/ /:/g'`;
- if [ $debug -gt 1 ]; then echo "[antJd] packages1: "$packages; fi
- packages=`echo $packages | sed -e 's/\//\\\\\\//g' | sed -e 's/\./\\\\\./g'`; # slash escape
- if [ $debug -gt 1 ]; then echo "[antJd] packages2: "$packages; fi
- sed -e "s/\@plugin\@/${packages}/g" $antScript.template > $antScript.template.tmp;
- else
- echo "[antJd] ERROR! "$srcDir" does not exist!";
- exit 1;
- fi
-else
- echo "[antJd] ERROR! "$currentPath"/javadoc.xml.template does not contain token @plugin@!";
- exit 1;
-fi
-
-# Finds plugins in the Workspace:
-pluginDirs=`find $pluginPath -name "${pluginName}*" -maxdepth 1 -type d -printf '%T@ %p\n' | sort -n | cut -f2 -d' '`;
-if [ $debug -gt 0 ]; then
- echo "[antJd] pluginDirs:";
- for pluginDir in $pluginDirs; do echo "[antJd] "$pluginDir; done
-fi
-
-### TODO?: missing emf/sdo/xsd plugins in $eclipseDir - need to copy them over or reference source so that all classes/packages (and thus @links) can be resolved
-
-# All the jars in the plugins directory
-classpath="."`find $eclipseDir/plugins -name "*.jar" -printf ":%p"`; if [ $debug -gt 0 ]; then echo "[antJd] classpath: "$classpath; fi
-
-# Calculates the packagesets and the calls to copyDocFiles
-packagesets="";
-copydocfiles="";
-for pluginDir in $pluginDirs; do
- pluginDir=`echo $pluginDir | sed -e 's/\/runtime$//g'`;
- srcDir=$pluginDir/src;
- if [ $debug -gt 0 ]; then echo "[antJd] srcDir: "$srcDir; fi
- if [ -d "$srcDir" ]; then
- # define what to include when javadoc'ing here:
- packagesets=$packagesets"<packageset dir=\"$srcDir\"> ";
- packagesets=$packagesets"<exclude name=\"$srcDir/**/doc-files/**\"/> ";
- packagesets=$packagesets""$javadocExclusions;
- packagesets=$packagesets"</packageset>";
- copydocfiles=$copydocfiles"<copyDocFiles pluginDir=\"$pluginDir\"/>";
- fi
-done
-if [ $debug -gt 0 ]; then
- echo "[antJd] packagesets:"; echo $packagesets;
- echo "[antJd] copydocfiles:"; echo $copydocfiles;
-fi
-
-# Finds the proper org.eclipse.platform.doc.isv jar
-docjar=`find $eclipseDir/plugins/ -name "org.eclipse.platform.doc.isv*.jar" -printf "%f"`; if [ $debug -gt 1 ]; then echo "[antJd] docjar: "$docjar; fi
-
-if [ -f $antScript.template ]; then
- true;
-else
- cp $antScript.template $antScript.template.tmp;
-fi
-
-# do replacements in template
-if [ $debug -gt 1 ]; then echo "[antJd] Replace @packagesets@ in the template ..."; fi
-packagesets=`echo $packagesets | sed -e 's/\//\\\\\\//g' | sed -e 's/\./\\\\\./g'`;
-sed -e "s/\@packagesets\@/${packagesets}/g" $antScript.template.tmp > $antScript.template.tmp2;
-
-if [ $debug -gt 1 ]; then echo "[antJd] Replace @copydocfiles@ in the template ..."; fi
-copydocfiles=`echo $copydocfiles | sed -e 's/\//\\\\\\//g' | sed -e 's/\./\\\\\./g'`;
-sed -e "s/\@copydocfiles\@/${copydocfiles}/g" $antScript.template.tmp2 > $antScript;
-
-#run ant to do javadoc build
-ant -f $antScript \
- -DdestDir="$destDir" \
- -Dclasspath="$classpath" \
- -DeclipseDir="$eclipseDir" \
- -Ddocjar="$docjar" \
- -DwindowTitle="$windowTitle" \
- -DgroupTitle="$groupTitle" \
- -Doverview="$currentPath/overview.html";
-
-# Clean up templates
-rm -f $antScript $antScript.template.tmp $antScript.template.tmp2;
-
-# Generate topics_Reference.xml (replacement for doclet).
-trXML=$currentPath"/../topics_Reference.xml";
-echo '<?xml version="1.0" encoding="UTF-8"?>' > $trXML;
-echo '<?NLS TYPE="org.eclipse.help.toc"?>' >> $trXML;
-echo '<toc label="Reference">' >> $trXML;
-echo ' <topic label="API Reference" href="references/javadoc/overview-summary.html">' >> $trXML;
-for packSum in `find $destDir -name "package-summary.html" | sort`; do
- path=${packSum%/package-summary.html}; path=${path#$destDir/}; # org/eclipse/xsd/ecore/importer/taskdefs
- label=${path//\//.}; # org.eclipse.xsd.ecore.importer.taskdefs
- echo ' <topic label="'$label'" href="references/javadoc/'$path'/package-summary.html" />' >> $trXML;
-done
-echo ' </topic>' >> $trXML;
-echo '</toc>' >> $trXML; \ No newline at end of file
diff --git a/doc/org.eclipse.jet.doc/build/javadoc.xml.template b/doc/org.eclipse.jet.doc/build/javadoc.xml.template
deleted file mode 100644
index 7eadaf1..0000000
--- a/doc/org.eclipse.jet.doc/build/javadoc.xml.template
+++ /dev/null
@@ -1,96 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project name="Plugin Javadoc" default="javadoc">
- <property name="destDir" value="doc"/>
- <property name="classpath" value="bin"/>
- <property name="overview" value="build/overview.html"/>
- <property name="eclipseDir" value="."/>
- <property name="docjar" value="org.eclipse.platform.doc.isv.jar"/>
-
- <!-- other properties that must be passed to this script include:
- windowTitle
- groupTitle
- -->
-
- <property environment="env"/>
- <property name="javaHome" value="${env.JAVA_HOME}"/>
-
- <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> -->
-
- <!-- TODO Enable linking to the platform javadoc -->
- <!-- <target name="javadoc" depends="extractPlatformJavadoc"> -->
-
- <target name="javadoc">
- <javadoc
- destdir="${destDir}"
- classpath="${classpath}"
- overview="${overview}"
-
- windowtitle="${windowTitle}"
- footer="Copyright 2006 IBM Corporation and others.&lt;br&gt; All Rights Reserved."
-
- access="protected"
- additionalparam="-breakiterator -tag model:X -tag generated:X -tag ordered:X"
- author="false"
- breakiterator="true"
- charset="UTF-8"
- docencoding="UTF-8"
- nodeprecated="false"
- nodeprecatedlist="false"
- noindex="false"
- nonavbar="false"
- notree="false"
- source="1.4"
- splitindex="true"
- use="true"
- version="true">
- <arg value="-J-Xmx256m"/>
-
- <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/"/> -->
-
- <tag name="ignore" description="ignore" enabled="false"/>
- <tag name="generated" description="ignore" enabled="false"/>
- <tag name="model" description="ignore" enabled="false"/>
- <tag name="modifiable" description="ignore" enabled="false"/>
- <tag name="extends" description="ignore" enabled="false"/>
- <tag name="implements" description="ignore" enabled="false"/>
- <tag name="ordered" description="ignore" enabled="false"/>
-
- <!-- If you add a @ plugin @ below, don't forget to update the antjavadoc.sh file -->
-
- <group title="${groupTitle}" packages="@plugin@"/>
-
- <!-- If you add a @ plugin @ above, don't forget to update the antjavadoc.sh file -->
-
- @packagesets@
-
- </javadoc>
-
- <!-- make sure the doc-files are copied -->
- <macrodef name="copyDocFiles">
- <attribute name="pluginDir"/>
- <sequential>
- <copy todir="${destDir}" failonerror="false">
- <fileset dir="@{pluginDir}/src" includes="**/doc-files/**"/>
- </copy>
- </sequential>
- </macrodef>
-
- @copydocfiles@
-
- </target>
-</project> \ No newline at end of file
diff --git a/doc/org.eclipse.jet.doc/build/overview.html b/doc/org.eclipse.jet.doc/build/overview.html
deleted file mode 100644
index 521e2ee..0000000
--- a/doc/org.eclipse.jet.doc/build/overview.html
+++ /dev/null
@@ -1,43 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<!--
-/**
- * <copyright>
- *
- * Copyright (c) 2005 IBM Corporation and others.
- * 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:
- * IBM - Initial API and implementation
- *
- * </copyright>
- *
- * $Id$
- */
--->
-</head>
-<meta http-equiv="Content-Type"
-content="text/html; charset=utf-8" />
-<body bgcolor="white">
-<!--
-This plug-in provides
-an <a href="org/eclipse/jet/helper/package-summary.html#details">API</a>
-for jet...
--->
-<!-- The summary links point here when the contents are "copied". -->
-<!--
-<a name="details"></a>
-Please refer to
-the
-<a href="org/eclipse/jet/helper/package-summary.html#details">org.eclipse.jet.helper</a>
-and
-<a href="org/eclipse/jet/parser/package-summary.html#details">org.eclipse.jet.parser</a>
-package documentation for API details.
--->
-</body>
-</html>

Back to the top