1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-04 07:35:24 +02:00

RSE isv docs: Fix references to Platform docs

This commit is contained in:
Martin Oberhuber 2006-07-27 10:54:27 +00:00
parent d6411f56ef
commit ef6166eb54
4 changed files with 292 additions and 197 deletions

View file

@ -1,5 +1,6 @@
api
bin
index
build.xml
rseconvert.txt
temp.bin.log
temp.options.txt

View file

@ -1,70 +1,127 @@
<?xml version="1.0" encoding="UTF-8"?>
<project name="RSE ISV Doc 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" />
</target>
<target name="build.index" description="Builds search index for the plug-in: org.eclipse.rse.doc.isv" if="eclipse.running">
<help.buildHelpIndex manifest="${basedir}/plugin.xml" destination="${basedir}" />
</target>
<target name="convertSchemaToHtml" if="eclipse.running">
<property name="dest" value="reference/extension-points" />
<record name="${basedir}/rseconvert.txt" action="start" />
<pde.convertSchemaToHTML manifest="../org.eclipse.rse.core/plugin.xml" destination="${dest}" />
<pde.convertSchemaToHTML manifest="../org.eclipse.rse.ui/plugin.xml" destination="${dest}" />
<record name="${basedir}/rseconvert.txt" action="stop" />
</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" />
<available file="/usr/bin/javadoc" property="javadoc" value="/usr/bin/javadoc" />
</target>
<target name="generateJavadoc" depends="getJavadocPath" if="javadoc">
<!--scrub isv plugin directories of any preexisting api doc content-->
<delete dir="reference/api" />
<mkdir dir="reference/api" />
<condition property="sep" value=":">
<os family="unix" />
</condition>
<condition property="sep" value=";">
<os family="windows" />
</condition>
<echo message="sep = ${sep}"/>
<echo message="javadoc = ${javadoc}"/>
<copy file="options.txt" tofile="temp.options.txt" />
<replace file="${basedir}/temp.options.txt" token="@sep@" value="${sep}" />
<replace file="${basedir}/temp.options.txt" token="@rt@" value="${bootclasspath}" />
<exec dir="." executable="${javadoc}" output="temp.bin.log">
<arg line="@${basedir}/temp.options.txt -J-Xmx1000M" />
</exec>
</target>
</project>
<?xml version="1.0" encoding="UTF-8"?>
<project name="RSE ISV Doc Build" default="all" basedir=".">
<target name="init">
<available file="${basedir}/index" property="index.present" />
<path id="path_bootclasspath">
<fileset dir="${java.home}/lib">
<include name="*.jar"/>
</fileset>
</path>
<property name="bootclasspath" refid="path_bootclasspath"/>
<condition property="safeBaseLocation"
value="${baseLocation}"
else="${eclipse.home}">
<isset property="baseLocation"/>
</condition>
</target>
<target name="computeClasspath" unless="javadoc.classpath">
<!-- Construct the javadoc classpath and store it in a property. -->
<echo level="info" message="Computing classpath ..."/>
<!-- Add platform dependencies required by your plug-in here.
Note that this pattern expects GMF and its dependencies to have
been installed into the platform directory structure, as is
the case during the build. -->
<patternset id="platform.classpath.pattern">
<include name="**/org.eclipse.core*.jar"/>
<include name="**/org.eclipse.core*/**/*.jar"/>
<include name="**/org.eclipse.swt*.jar"/>
<include name="**/org.eclipse.swt*/**/*.jar"/>
<include name="**/org.eclipse.ui*.jar"/>
<include name="**/org.eclipse.ui*/**/*.jar"/>
<include name="**/org.eclipse.update*.jar"/>
<include name="**/org.eclipse.update*/**/*.jar"/>
<include name="**/org.eclipse.osgi*.jar"/>
<include name="**/org.eclipse.osgi*/**/*.jar"/>
<include name="**/org.eclipse.equinox*.jar"/>
<include name="**/org.eclipse.equinox*/**/*.jar"/>
<include name="**/org.eclipse.jface*.jar"/>
<include name="**/org.eclipse.jface*/**/*.jar"/>
<include name="**/org.eclipse.text*.jar"/>
<include name="**/org.eclipse.text*/**/*.jar"/>
<include name="**/org.eclipse.team*.jar"/>
<include name="**/org.eclipse.team*/**/*.jar"/>
<include name="**/org.junit*.jar"/>
<include name="**/org.junit*/**/*.jar"/>
<include name="**/com.ibm.icu*.jar"/>
</patternset>
<pathconvert property="javadoc.classpath">
<path>
<fileset dir="${safeBaseLocation}">
<patternset refid="platform.classpath.pattern"/>
</fileset>
</path>
</pathconvert>
<echo level="info" message="Done computing classpath."/>
<echo level="info" message="Bootclasspath is: ${bootclasspath}"/>
<echo level="info" message="Classpath is: ${javadoc.classpath}"/>
</target>
<target name="all" depends="init" unless="index.present">
<antcall target="convertSchemaToHtml" />
<antcall target="generateJavadoc" />
<antcall target="build.index" />
</target>
<target name="build.index" description="Builds search index for the plug-in: org.eclipse.rse.doc.isv" if="eclipse.running">
<help.buildHelpIndex manifest="${basedir}/plugin.xml" destination="${basedir}" />
</target>
<target name="convertSchemaToHtml" if="eclipse.running">
<property name="dest" value="reference/extension-points" />
<record name="${basedir}/rseconvert.txt" action="start" />
<pde.convertSchemaToHTML manifest="../org.eclipse.rse.core/plugin.xml" destination="${dest}" />
<pde.convertSchemaToHTML manifest="../org.eclipse.rse.ui/plugin.xml" destination="${dest}" />
<record name="${basedir}/rseconvert.txt" action="stop" />
</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" />
<available file="/usr/bin/javadoc" property="javadoc" value="/usr/bin/javadoc" />
</target>
<target name="generateJavadoc" depends="getJavadocPath,computeClasspath" if="javadoc">
<property name="optionsFile" value="temp.options.txt" />
<copy file="options.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}${argsListDelimiter}${javadoc.classpath}" />
<replace file="${basedir}/${optionsFile}" token="@baseLocation@" value="${safeBaseLocation}" />
<!--scrub isv plugin directories of any preexisting api doc content-->
<delete dir="reference/api" />
<mkdir dir="reference/api" />
<echo message="sep = ${argsListDelimiter}"/>
<echo message="javadoc = ${javadoc}"/>
<exec dir="." executable="${javadoc}" output="temp.bin.log">
<arg line="@${basedir}/${optionsFile} -J-Xmx1000M" />
</exec>
</target>
</project>

View file

@ -1,126 +1,162 @@
-charset "iso-8859-1"
-sourcepath "../org.eclipse.rse.connectorservice.dstore/src@sep@../org.eclipse.rse.connectorservice.local/src@sep@../org.eclipse.rse.connectorservice.ssh/src@sep@../org.eclipse.rse.core/src@sep@../org.eclipse.rse.dstore.security/src@sep@../org.eclipse.rse.eclipse.filesystem/src@sep@../org.eclipse.rse.files.ui/src@sep@../org.eclipse.rse.logging/src@sep@../org.eclipse.rse.processes.ui/src@sep@../org.eclipse.rse.services/src@sep@../org.eclipse.rse.services.dstore/src@sep@../org.eclipse.rse.services.files.ftp/src@sep@../org.eclipse.rse.services.local/src@sep@../org.eclipse.rse.services.ssh/src@sep@../org.eclipse.rse.shells.ui/src@sep@../org.eclipse.rse.subsystems.files.core/src@sep@../org.eclipse.rse.subsystems.files.dstore/src@sep@../org.eclipse.rse.subsystems.files.ftp/src@sep@../org.eclipse.rse.subsystems.files.local/src@sep@../org.eclipse.rse.subsystems.files.ssh/src@sep@../org.eclipse.rse.subsystems.processes.core/src@sep@../org.eclipse.rse.subsystems.processes.dstore/src@sep@../org.eclipse.rse.subsystems.processes.local/src@sep@../org.eclipse.rse.subsystems.shells.core/src@sep@../org.eclipse.rse.subsystems.shells.dstore/src@sep@../org.eclipse.rse.subsystems.shells.local/src@sep@../org.eclipse.rse.subsystems.shells.ssh/src@sep@../org.eclipse.rse.ui/filters@sep@../org.eclipse.rse.ui/persistence@sep@../org.eclipse.rse.ui/references@sep@../org.eclipse.rse.ui/model@sep@../org.eclipse.rse.ui/UI@sep@../org.eclipse.rse.ui/subsystems@sep@../org.eclipse.rse.ui/systems@sep@"
-d reference/api
-classpath @rt@
-breakiterator
-use
-splitIndex
-windowtitle "RSE API Specification"
-doctitle "RSE API Specification"
-header "<b>RSE</b><br>Release 1.0"
-bottom "Copyright (c) IBM Corporation and others 2000, 2006. All Rights Reserved."
-group "RSE Core Plug-in Packages" "org.eclipse.rse.core;org.eclipse.rse.core.*"
-group "RSE UI Plug-in Packages" "org.eclipse.rse.ui;org.eclipse.rse.ui.*"
-link http://java.sun.com/j2se/1.5/docs/api
-linkoffline ./../../../org.eclipse.platform.doc.isv/reference/api ../org.eclipse.platform.doc.isv/reference/api
org.eclipse.rse.connectorservice.dstore
org.eclipse.rse.connectorservice.dstore.util
org.eclipse.rse.connectorservice.local
org.eclipse.rse.connectorservice.ssh
org.eclipse.rse.core
org.eclipse.rse.dstore.security
org.eclipse.rse.dstore.security.preference
org.eclipse.rse.dstore.security.util
org.eclipse.rse.dstore.security.widgets
org.eclipse.rse.dstore.security.wizards
org.eclipse.rse.eclipse.filesystem
org.eclipse.rse.eclipse.filesystem.ui.actions
org.eclipse.rse.files.ui
org.eclipse.rse.files.ui.actions
org.eclipse.rse.files.ui.compare
org.eclipse.rse.files.ui.dialogs
org.eclipse.rse.files.ui.propertypages
org.eclipse.rse.files.ui.resources
org.eclipse.rse.files.ui.search
org.eclipse.rse.files.ui.view
org.eclipse.rse.files.ui.widgets
org.eclipse.rse.files.ui.wizards
org.eclipse.rse.logging
org.eclipse.rse.logging.performance
org.eclipse.rse.processes.ui
org.eclipse.rse.processes.ui.actions
org.eclipse.rse.processes.ui.dialogs
org.eclipse.rse.processes.ui.propertypages
org.eclipse.rse.processes.ui.view
org.eclipse.rse.services
org.eclipse.rse.services.files
org.eclipse.rse.services.processes
org.eclipse.rse.services.search
org.eclipse.rse.services.shells
org.eclipse.rse.services.dstore
org.eclipse.rse.services.dstore.files
org.eclipse.rse.services.dstore.processes
org.eclipse.rse.services.dstore.rmtservice
org.eclipse.rse.services.dstore.search
org.eclipse.rse.services.dstore.shells
org.eclipse.rse.services.dstore.util
org.eclipse.rse.services.files.ftp
org.eclipse.rse.services.local
org.eclipse.rse.services.local.files
org.eclipse.rse.services.local.processes
org.eclipse.rse.services.local.search
org.eclipse.rse.services.local.shells
org.eclipse.rse.services.ssh
org.eclipse.rse.shells.ui
org.eclipse.rse.shells.ui.actions
org.eclipse.rse.shells.ui.propertypages
org.eclipse.rse.shells.ui.view
org.eclipse.rse.subsystems.files.core
org.eclipse.rse.subsystems.files.core.model
org.eclipse.rse.subsystems.files.core.servicesubsystem
org.eclipse.rse.subsystems.files.core.subsystems
org.eclipse.rse.subsystems.files.core.util
org.eclipse.rse.subsystems.files.dstore
org.eclipse.rse.subsystems.files.dstore.model
org.eclipse.rse.subsystems.files.dstore.old
org.eclipse.rse.subsystems.files.dstore.subsystem
org.eclipse.rse.subsystems.files.ftp
org.eclipse.rse.subsystems.files.ftp.connectorservice
org.eclipse.rse.subsystems.files.ftp.model
org.eclipse.rse.subsystems.files.local
org.eclipse.rse.subsystems.files.local.model
org.eclipse.rse.subsystems.files.ssh
org.eclipse.rse.subsystems.processes.core
org.eclipse.rse.subsystems.processes.core.subsystem
org.eclipse.rse.subsystems.processes.core.subsystem.impl
org.eclipse.rse.subsystems.processes.servicesubsystem
org.eclipse.rse.subsystems.processes.dstore
org.eclipse.rse.subsystems.processes.local
org.eclipse.rse.subsystems.shells.core
org.eclipse.rse.subsystems.shells.core.model
org.eclipse.rse.subsystems.shells.core.subsystems
org.eclipse.rse.subsystems.shells.core.subsystems.servicesubsystem
org.eclipse.rse.subsystems.shells.dstore
org.eclipse.rse.subsystems.shells.dstore.model
org.eclipse.rse.subsystems.shells.local
org.eclipse.rse.subsystems.shells.local.model
org.eclipse.rse.subsystems.shells.ssh
org.eclipse.rse.filters
org.eclipse.rse.persistence
org.eclipse.rse.persistence.dom
org.eclipse.rse.references
org.eclipse.rse.model
org.eclipse.rse.ui
org.eclipse.rse.ui.actions
org.eclipse.rse.ui.dialogs
org.eclipse.rse.ui.filters
org.eclipse.rse.ui.filters.actions
org.eclipse.rse.ui.filters.dialogs
org.eclipse.rse.ui.messages
org.eclipse.rse.ui.open
org.eclipse.rse.ui.operations
org.eclipse.rse.ui.validators
org.eclipse.rse.ui.view
org.eclipse.rse.ui.view.monitor
org.eclipse.rse.ui.view.scratchpad
org.eclipse.rse.ui.view.search
org.eclipse.rse.ui.view.team
org.eclipse.rse.ui.widgets
org.eclipse.rse.ui.widgets.services
org.eclipse.rse.ui.wizards
org.eclipse.rse.core.servicesubsystem
org.eclipse.rse.core.subsystems
org.eclipse.rse.core.subsystems.util
org.eclipse.rse.core
org.eclipse.rse.core.comm
-quiet
-encoding "iso-8859-1"
-charset "iso-8859-1"
-sourcepath "../org.eclipse.rse.connectorservice.dstore/src
;../org.eclipse.rse.connectorservice.local/src
;../org.eclipse.rse.connectorservice.ssh/src
;../org.eclipse.rse.core/src
;../org.eclipse.rse.dstore.security/src
;../org.eclipse.rse.eclipse.filesystem/src
;../org.eclipse.rse.files.ui/src
;../org.eclipse.rse.logging/src
;../org.eclipse.rse.processes.ui/src
;../org.eclipse.rse.services/src
;../org.eclipse.rse.services.dstore/src
;../org.eclipse.rse.services.files.ftp/src
;../org.eclipse.rse.services.local/src
;../org.eclipse.rse.services.ssh/src
;../org.eclipse.rse.shells.ui/src
;../org.eclipse.rse.subsystems.files.core/src
;../org.eclipse.rse.subsystems.files.dstore/src
;../org.eclipse.rse.subsystems.files.ftp/src
;../org.eclipse.rse.subsystems.files.local/src
;../org.eclipse.rse.subsystems.files.ssh/src
;../org.eclipse.rse.subsystems.processes.core/src
;../org.eclipse.rse.subsystems.processes.dstore/src
;../org.eclipse.rse.subsystems.processes.local/src
;../org.eclipse.rse.subsystems.shells.core/src
;../org.eclipse.rse.subsystems.shells.dstore/src
;../org.eclipse.rse.subsystems.shells.local/src
;../org.eclipse.rse.subsystems.shells.ssh/src
;../org.eclipse.rse.ui/filters
;../org.eclipse.rse.ui/persistence
;../org.eclipse.rse.ui/references
;../org.eclipse.rse.ui/model
;../org.eclipse.rse.ui/UI
;../org.eclipse.rse.ui/subsystems
;../org.eclipse.rse.ui/systems"
-d reference/api
-classpath @rt@
-breakiterator
-use
-splitIndex
-windowtitle "RSE API Specification"
-doctitle "RSE API Specification"
-header "<b>RSE</b><br>Release 1.0"
-bottom "Copyright (c) IBM Corporation and others 2000, 2006. All Rights Reserved."
-group "RSE Core Plug-in Packages" "org.eclipse.rse.core;org.eclipse.rse.core.*"
-group "RSE UI Plug-in Packages" "org.eclipse.rse.ui;org.eclipse.rse.ui.*"
-link http://java.sun.com/j2se/1.5/docs/api
-linkoffline ./../../../org.eclipse.platform.doc.isv/reference/api ../org.eclipse.platform.doc.isv/reference/api
-link http://bundles.osgi.org/javadoc/r4
org.eclipse.rse.connectorservice.dstore
org.eclipse.rse.connectorservice.dstore.util
org.eclipse.rse.connectorservice.local
org.eclipse.rse.connectorservice.ssh
org.eclipse.rse.core
org.eclipse.rse.dstore.security
org.eclipse.rse.dstore.security.preference
org.eclipse.rse.dstore.security.util
org.eclipse.rse.dstore.security.widgets
org.eclipse.rse.dstore.security.wizards
org.eclipse.rse.eclipse.filesystem
org.eclipse.rse.eclipse.filesystem.ui.actions
org.eclipse.rse.files.ui
org.eclipse.rse.files.ui.actions
org.eclipse.rse.files.ui.compare
org.eclipse.rse.files.ui.dialogs
org.eclipse.rse.files.ui.propertypages
org.eclipse.rse.files.ui.resources
org.eclipse.rse.files.ui.search
org.eclipse.rse.files.ui.view
org.eclipse.rse.files.ui.widgets
org.eclipse.rse.files.ui.wizards
org.eclipse.rse.logging
org.eclipse.rse.logging.performance
org.eclipse.rse.processes.ui
org.eclipse.rse.processes.ui.actions
org.eclipse.rse.processes.ui.dialogs
org.eclipse.rse.processes.ui.propertypages
org.eclipse.rse.processes.ui.view
org.eclipse.rse.services
org.eclipse.rse.services.files
org.eclipse.rse.services.processes
org.eclipse.rse.services.search
org.eclipse.rse.services.shells
org.eclipse.rse.services.dstore
org.eclipse.rse.services.dstore.files
org.eclipse.rse.services.dstore.processes
org.eclipse.rse.services.dstore.rmtservice
org.eclipse.rse.services.dstore.search
org.eclipse.rse.services.dstore.shells
org.eclipse.rse.services.dstore.util
org.eclipse.rse.services.files.ftp
org.eclipse.rse.services.local
org.eclipse.rse.services.local.files
org.eclipse.rse.services.local.processes
org.eclipse.rse.services.local.search
org.eclipse.rse.services.local.shells
org.eclipse.rse.services.ssh
org.eclipse.rse.shells.ui
org.eclipse.rse.shells.ui.actions
org.eclipse.rse.shells.ui.propertypages
org.eclipse.rse.shells.ui.view
org.eclipse.rse.subsystems.files.core
org.eclipse.rse.subsystems.files.core.model
org.eclipse.rse.subsystems.files.core.servicesubsystem
org.eclipse.rse.subsystems.files.core.subsystems
org.eclipse.rse.subsystems.files.core.util
org.eclipse.rse.subsystems.files.dstore
org.eclipse.rse.subsystems.files.dstore.model
org.eclipse.rse.subsystems.files.dstore.old
org.eclipse.rse.subsystems.files.dstore.subsystem
org.eclipse.rse.subsystems.files.ftp
org.eclipse.rse.subsystems.files.ftp.connectorservice
org.eclipse.rse.subsystems.files.ftp.model
org.eclipse.rse.subsystems.files.local
org.eclipse.rse.subsystems.files.local.model
org.eclipse.rse.subsystems.files.ssh
org.eclipse.rse.subsystems.processes.core
org.eclipse.rse.subsystems.processes.core.subsystem
org.eclipse.rse.subsystems.processes.core.subsystem.impl
org.eclipse.rse.subsystems.processes.servicesubsystem
org.eclipse.rse.subsystems.processes.dstore
org.eclipse.rse.subsystems.processes.local
org.eclipse.rse.subsystems.shells.core
org.eclipse.rse.subsystems.shells.core.model
org.eclipse.rse.subsystems.shells.core.subsystems
org.eclipse.rse.subsystems.shells.core.subsystems.servicesubsystem
org.eclipse.rse.subsystems.shells.dstore
org.eclipse.rse.subsystems.shells.dstore.model
org.eclipse.rse.subsystems.shells.local
org.eclipse.rse.subsystems.shells.local.model
org.eclipse.rse.subsystems.shells.ssh
org.eclipse.rse.filters
org.eclipse.rse.persistence
org.eclipse.rse.persistence.dom
org.eclipse.rse.references
org.eclipse.rse.model
org.eclipse.rse.ui
org.eclipse.rse.ui.actions
org.eclipse.rse.ui.dialogs
org.eclipse.rse.ui.filters
org.eclipse.rse.ui.filters.actions
org.eclipse.rse.ui.filters.dialogs
org.eclipse.rse.ui.messages
org.eclipse.rse.ui.open
org.eclipse.rse.ui.operations
org.eclipse.rse.ui.validators
org.eclipse.rse.ui.view
org.eclipse.rse.ui.view.monitor
org.eclipse.rse.ui.view.scratchpad
org.eclipse.rse.ui.view.search
org.eclipse.rse.ui.view.team
org.eclipse.rse.ui.widgets
org.eclipse.rse.ui.widgets.services
org.eclipse.rse.ui.wizards
org.eclipse.rse.core.servicesubsystem
org.eclipse.rse.core.subsystems
org.eclipse.rse.core.subsystems.util
org.eclipse.rse.core
org.eclipse.rse.core.comm

View file

@ -0,0 +1 @@
api