diff options
Diffstat (limited to 'plugins/org.eclipse.emf.cdo.doc')
27 files changed, 626 insertions, 0 deletions
diff --git a/plugins/org.eclipse.emf.cdo.doc/.classpath b/plugins/org.eclipse.emf.cdo.doc/.classpath new file mode 100644 index 0000000000..138dcf9172 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/.classpath @@ -0,0 +1,7 @@ +<?xml version="1.0" encoding="UTF-8"?> +<classpath> + <classpathentry kind="src" path=""/> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/> + <classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/> + <classpathentry kind="output" path=""/> +</classpath> diff --git a/plugins/org.eclipse.emf.cdo.doc/.cvsignore b/plugins/org.eclipse.emf.cdo.doc/.cvsignore new file mode 100644 index 0000000000..a32fe23c60 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/.cvsignore @@ -0,0 +1,2 @@ +bin +*.jar
\ No newline at end of file diff --git a/plugins/org.eclipse.emf.cdo.doc/.project b/plugins/org.eclipse.emf.cdo.doc/.project new file mode 100644 index 0000000000..9b22cef109 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/.project @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>org.eclipse.emf.cdo.doc</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.jdt.core.javanature</nature> + <nature>org.eclipse.pde.PluginNature</nature> + </natures> +</projectDescription> diff --git a/plugins/org.eclipse.emf.cdo.doc/META-INF/MANIFEST.MF b/plugins/org.eclipse.emf.cdo.doc/META-INF/MANIFEST.MF new file mode 100644 index 0000000000..2696e5d65e --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/META-INF/MANIFEST.MF @@ -0,0 +1,9 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: %Plugin.name +Bundle-SymbolicName: org.eclipse.emf.cdo.doc; singleton:=true +Bundle-Version: 1.0.0.qualifier +Bundle-Vendor: %Provider.name +Bundle-Localization: plugin +Require-Bundle: org.eclipse.help +Eclipse-LazyStart: true diff --git a/plugins/org.eclipse.emf.cdo.doc/about.html b/plugins/org.eclipse.emf.cdo.doc/about.html new file mode 100644 index 0000000000..373f38777d --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/about.html @@ -0,0 +1,42 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html> + + <head> + + <meta content="text/html; charset=ISO-8859-1" + http-equiv="Content-Type"/> + + <title>About</title> + + </head> + + <body lang="EN-US"> + + <h2>About This Content</h2> + + <p>Januaray 22, 2006</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/legal/epl-v10.html"> + http://www.eclipse.org/legal/epl-v10.html</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.</p> + + </body> + +</html> + diff --git a/plugins/org.eclipse.emf.cdo.doc/about.ini b/plugins/org.eclipse.emf.cdo.doc/about.ini new file mode 100644 index 0000000000..a9f0f292f7 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/about.ini @@ -0,0 +1,15 @@ +# about.ini +# contains information about a feature +# java.io.Properties file (ISO 8859-1 with "\" escapes) +# "%key" are externalized strings defined in about.properties +# This file does not need to be translated. + +# Property "aboutText" contains blurb for "About" dialog (translated) +aboutText=%featureText + +# Property "featureImage" contains path to feature image (32x32) +featureImage=eclipse32.gif + +# Property "appName" contains name of the application (translated) +appName=%featureName + diff --git a/plugins/org.eclipse.emf.cdo.doc/about.mappings b/plugins/org.eclipse.emf.cdo.doc/about.mappings new file mode 100644 index 0000000000..7d795dc23a --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/about.mappings @@ -0,0 +1,5 @@ +# This file contains fill-ins for about.properties +# java.io.Properties file (ISO 8859-1 with "\" escapes) +# This file does not need to be translated. + +0=@build@ diff --git a/plugins/org.eclipse.emf.cdo.doc/about.properties b/plugins/org.eclipse.emf.cdo.doc/about.properties new file mode 100644 index 0000000000..d2b1873ce8 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/about.properties @@ -0,0 +1,46 @@ +# /** +# * <copyright> +# * +# * Copyright (c) 2002-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: +# */ + +# NLS_MESSAGEFORMAT_VAR + +# ============================================================================== +# Do not change the properties between this line and the last line containing: +# %%% END OF TRANSLATED PROPERTIES %%% +# Instead, either redefine an existing property, or create a new property, +# append it to the end of the file, and change the code to use the new name. +# ============================================================================== + +# about.properties +# contains externalized strings for about.ini +# java.io.Properties file (ISO 8859-1 with "\" escapes) +# fill-ins are supplied by about.mappings +# This file should be translated. + +featureName=Eclipse Modeling Framework Technology CDO Documentation + +featureText=Eclipse Modeling Framework Technology CDO Documentation\n\ +Version: {featureVersion}\n\ +Build id: {0}\n\ +\n\ +(c) Copyright Eclipse contributors and others. 2005. All rights reserved.\n\ +\n\ +Visit http://www.eclipse.org/emft + +# ============================================================================== +# %%% END OF TRANSLATED PROPERTIES %%% +# The above properties have been shipped for translation. +# ============================================================================== diff --git a/plugins/org.eclipse.emf.cdo.doc/build.properties b/plugins/org.eclipse.emf.cdo.doc/build.properties new file mode 100644 index 0000000000..cd5731b804 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/build.properties @@ -0,0 +1,2 @@ +# NLS_MESSAGEFORMAT_VAR +custom = true diff --git a/plugins/org.eclipse.emf.cdo.doc/build.xml b/plugins/org.eclipse.emf.cdo.doc/build.xml new file mode 100644 index 0000000000..cc1f420a18 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/build.xml @@ -0,0 +1,137 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project name="org.eclipse.emf.cdo.doc" default="build.jars" basedir="."> + + <!-- 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.emf.cdo"/> + <property name="docPlugin" value="org.eclipse.emf.cdo.doc"/> + + <property name="filesToInclude" value="META-INF/,about.*,eclipse*.gif,eclipse*.png,eclipse_lg.gif,plugin.*,doc.zip,toc.xml,index/**"/> + + <!-- Compiler settings. --> + <property name="javacFailOnError" value="false"/> + <property name="javacDebugInfo" value="on"/> + <property name="javacVerbose" value="true"/> + <property name="compilerArg" value=""/> + + <echo message="Set javacSource and javacTarget = 1.5"/> + <property name="javacSource" value="1.5" /> + <property name="javacTarget" value="1.5" /> + + <path id="bc"> + <fileset dir="${java.home}/lib"> + <include name="*.jar" /> + </fileset> + </path> + <property name="bootclasspath" refid="bc" /> + + <!-- new 060508 to make build work when using JDK1.5 source/target --> + <echo message="Set J2SE-1.5 = ${bootclasspath}"/> + <property name="J2SE-1.5" value="${bootclasspath}"/> + <condition property="bundleBootClasspath" value="${J2SE-1.5}"><isset property="J2SE-1.5"/></condition> + <condition property="bundleJavacSource" value="1.5"><isset property="J2SE-1.5"/></condition> + <condition property="bundleJavacTarget" value="1.5"><isset property="J2SE-1.5"/></condition> + + <property name="basews" value="${ws}"/> + <property name="baseos" value="${os}"/> + <property name="basearch" value="${arch}"/> + <property name="basenl" value="${nl}"/> + + <target name="init" depends="properties"> + <condition property="pluginTemp" value="${buildTempFolder}/plugins"> + <isset property="buildTempFolder"/> + </condition> + <property name="pluginTemp" value="${basedir}"/> + <condition property="build.result.folder" value="${pluginTemp}/${docPlugin}"> + <isset property="buildTempFolder"/> + </condition> + <property name="build.result.folder" value="${basedir}"/> + <property name="temp.folder" value="${basedir}/temp.folder"/> + <property name="plugin.destination" value="${basedir}"/> + </target> + + <target name="properties" if="eclipse.running"> + <property name="build.compiler" value="org.eclipse.jdt.core.JDTCompilerAdapter"/> + </target> + + <target name="build.update.jar" depends="init" description="Build the plug-in: ${plugin} for an update site."> + <delete dir="${temp.folder}"/> + <mkdir dir="${temp.folder}"/> + <antcall target="build.jars"/> + <antcall target="gather.bin.parts"> + <param name="destination.temp.folder" value="${temp.folder}/"/> + </antcall> + <zip destfile="${plugin.destination}/${docPlugin}_${pluginVersion}.${forceContextQualifier}.jar" basedir="${temp.folder}/${docPlugin}_${pluginVersion}.${forceContextQualifier}" filesonly="false" whenempty="skip" update="false"/> + <delete dir="${temp.folder}"/> + </target> + + <target name="build.jars" depends="init" description="Build all the jars for the plug-in: ${docPlugin}."> + <!-- Execute a shell script that will create an ant javadoc script and then run it for us --> + <exec executable="sh"> + <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="**/impl,**/impl/**"/> + <zipfileset dir="images" prefix="images"/> + <zipfileset dir="tutorials" prefix="tutorials"/> + </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> + + <target name="gather.bin.parts" depends="init" if="destination.temp.folder"> + <mkdir dir="${destination.temp.folder}/${docPlugin}_${pluginVersion}.${forceContextQualifier}"/> + <copy todir="${destination.temp.folder}/${docPlugin}_${pluginVersion}.${forceContextQualifier}" failonerror="true" overwrite="false"> + <fileset dir="${basedir}" includes="${filesToInclude}"/> + </copy> + <eclipse.versionReplacer + path="${destination.temp.folder}/${docPlugin}_${pluginVersion}.${forceContextQualifier}" + version="${pluginVersion}.${forceContextQualifier}"/> + </target> + + <target name="build.zips" depends="init"> + </target> + + <target name="gather.sources" depends="init" if="destination.temp.folder"> + </target> + + <target name="gather.logs" depends="init" if="destination.temp.folder"> + </target> + + <target name="clean" depends="init" description="Clean the plug-in: ${docPlugin} of all the zips, jars and logs created."> + <delete file="${plugin.destination}/${docPlugin}_${pluginVersion}.${forceContextQualifier}.jar"/> + <delete file="${plugin.destination}/${docPlugin}_${pluginVersion}.${forceContextQualifier}.zip"/> + <delete dir="${temp.folder}"/> + </target> + + <target name="zip.plugin" depends="init" description="Create a zip containing all the elements for the plug-in: ${docPlugin}."> + <delete dir="${temp.folder}"/> + <mkdir dir="${temp.folder}"/> + <antcall target="build.jars"/> + <antcall target="build.sources"/> + <antcall target="gather.bin.parts"> + <param name="destination.temp.folder" value="${temp.folder}/"/> + </antcall> + <antcall target="gather.sources"> + <param name="destination.temp.folder" value="${temp.folder}/"/> + </antcall> + <delete> + <fileset dir="${temp.folder}" includes="**/*.bin.log" /> + </delete> + <zip destfile="${plugin.destination}/${docPlugin}_${pluginVersion}.${forceContextQualifier}.zip" basedir="${temp.folder}" filesonly="true" whenempty="skip" update="false"/> + <delete dir="${temp.folder}"/> + </target> + +</project> diff --git a/plugins/org.eclipse.emf.cdo.doc/build/antJavadoc.sh b/plugins/org.eclipse.emf.cdo.doc/build/antJavadoc.sh new file mode 100644 index 0000000000..951912b392 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/build/antJavadoc.sh @@ -0,0 +1,132 @@ +#!/bin/sh + +# BEGIN CUSTOMIZATIONS + +# The plugin name +pluginName="org.eclipse.emf.cdo"; + +# string labels for javadoc content +windowTitle="CDO Javadoc"; +groupTitle="CDO"; + +# files to exclude from javadoc process - use Ant syntax +javadocExclusions="<exclude name=\"**/internal/**\"/> <exclude name=\"**/examples/**\"/> <exclude name=\"**/tests/**\"/>"; + +# use 1.5 +export JAVA_HOME=/opt/sun-java2-5.0 + +# 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.source/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 + cat $antScript.template | sed -e "s/\@plugin\@/$packages/g" > $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; diff --git a/plugins/org.eclipse.emf.cdo.doc/build/javadoc.xml.template b/plugins/org.eclipse.emf.cdo.doc/build/javadoc.xml.template new file mode 100644 index 0000000000..f79c09c351 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/build/javadoc.xml.template @@ -0,0 +1,96 @@ +<?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.<br> 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.5" + splitindex="true" + use="true" + version="true"> + <arg value="-J-Xmx180m"/> + + <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/plugins/org.eclipse.emf.cdo.doc/build/overview.html b/plugins/org.eclipse.emf.cdo.doc/build/overview.html new file mode 100644 index 0000000000..2c3275ed97 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/build/overview.html @@ -0,0 +1,43 @@ +<!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: overview.html,v 1.1 2006-05-29 21:09:30 nickb Exp $ + */ +--> +</head> +<meta http-equiv="Content-Type" +content="text/html; charset=utf-8" /> +<body bgcolor="white"> +<!-- +This plug-in provides +an <a href="org/eclipse/cdo/helper/package-summary.html#details">API</a> +for cdo. +--> +<!-- The summary links point here when the contents are "copied". --> +<!-- +<a name="details"></a> +Please refer to +the +<a href="org/eclipse/cdo/helper/package-summary.html#details">org.eclipse.emf.cdo.helper</a> +and +<a href="org/eclipse/cdo/parser/package-summary.html#details">org.eclipse.emf.cdo.parser</a> +package documentation for API details. +--> +</body> +</html> diff --git a/plugins/org.eclipse.emf.cdo.doc/eclipse.gif b/plugins/org.eclipse.emf.cdo.doc/eclipse.gif Binary files differnew file mode 100644 index 0000000000..bdc2912bfd --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/eclipse.gif diff --git a/plugins/org.eclipse.emf.cdo.doc/eclipse.png b/plugins/org.eclipse.emf.cdo.doc/eclipse.png Binary files differnew file mode 100644 index 0000000000..73975241eb --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/eclipse.png diff --git a/plugins/org.eclipse.emf.cdo.doc/eclipse24.gif b/plugins/org.eclipse.emf.cdo.doc/eclipse24.gif Binary files differnew file mode 100644 index 0000000000..fbb1d47c06 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/eclipse24.gif diff --git a/plugins/org.eclipse.emf.cdo.doc/eclipse32.gif b/plugins/org.eclipse.emf.cdo.doc/eclipse32.gif Binary files differnew file mode 100644 index 0000000000..e6ad7ccd75 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/eclipse32.gif diff --git a/plugins/org.eclipse.emf.cdo.doc/eclipse32.png b/plugins/org.eclipse.emf.cdo.doc/eclipse32.png Binary files differnew file mode 100644 index 0000000000..568fac1d05 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/eclipse32.png diff --git a/plugins/org.eclipse.emf.cdo.doc/eclipse48.gif b/plugins/org.eclipse.emf.cdo.doc/eclipse48.gif Binary files differnew file mode 100644 index 0000000000..501ab99e41 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/eclipse48.gif diff --git a/plugins/org.eclipse.emf.cdo.doc/eclipse48.png b/plugins/org.eclipse.emf.cdo.doc/eclipse48.png Binary files differnew file mode 100644 index 0000000000..b60ab3ccc9 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/eclipse48.png diff --git a/plugins/org.eclipse.emf.cdo.doc/eclipse_lg.gif b/plugins/org.eclipse.emf.cdo.doc/eclipse_lg.gif Binary files differnew file mode 100644 index 0000000000..bf8b872e3d --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/eclipse_lg.gif diff --git a/plugins/org.eclipse.emf.cdo.doc/images/.cvsignore b/plugins/org.eclipse.emf.cdo.doc/images/.cvsignore new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/images/.cvsignore diff --git a/plugins/org.eclipse.emf.cdo.doc/plugin.properties b/plugins/org.eclipse.emf.cdo.doc/plugin.properties new file mode 100644 index 0000000000..48bd46b713 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/plugin.properties @@ -0,0 +1,33 @@ +# /** +# * <copyright> +# * +# * Copyright (c) 2002-2004 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: +# */ + +# NLS_MESSAGEFORMAT_VAR + +# ============================================================================== +# Do not change the properties between this line and the last line containing: +# %%% END OF TRANSLATED PROPERTIES %%% +# Instead, either redefine an existing property, or create a new property, +# append it to the end of the file, and change the code to use the new name. +# ============================================================================== + +Plugin.name=Eclipse Modeling Framework Technology CDO Documentation +Provider.name=Eclipse.org + +# ============================================================================== +# %%% END OF TRANSLATED PROPERTIES %%% +# The above properties have been shipped for translation. +# ============================================================================== diff --git a/plugins/org.eclipse.emf.cdo.doc/plugin.xml b/plugins/org.eclipse.emf.cdo.doc/plugin.xml new file mode 100644 index 0000000000..0587b451fa --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/plugin.xml @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="UTF-8"?> +<?eclipse version="3.0"?> +<!-- +/** + * <copyright> + * + * Copyright (c) 2004-2006 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: + */ +--> +<plugin> + <extension + point="org.eclipse.help.toc"> + <toc file="toc.xml" primary="true"/> + <index path="index"/> + </extension> +</plugin> + diff --git a/plugins/org.eclipse.emf.cdo.doc/references/.cvsignore b/plugins/org.eclipse.emf.cdo.doc/references/.cvsignore new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/references/.cvsignore diff --git a/plugins/org.eclipse.emf.cdo.doc/toc.xml b/plugins/org.eclipse.emf.cdo.doc/toc.xml new file mode 100644 index 0000000000..224049aba0 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/toc.xml @@ -0,0 +1,6 @@ +<?xml version="1.0" encoding="UTF-8"?> +<?NLS TYPE="org.eclipse.help.toc"?> + +<toc label="CDO Table of Contents"> + <topic label="Javadoc" href="references/javadoc/index.html"/> +</toc> diff --git a/plugins/org.eclipse.emf.cdo.doc/tutorials/.cvsignore b/plugins/org.eclipse.emf.cdo.doc/tutorials/.cvsignore new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/plugins/org.eclipse.emf.cdo.doc/tutorials/.cvsignore |