mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-13 03:55:22 +02:00
Code Issues Wiki Activity

[doc] Bring SD Docs to Eclipse Standard

Browse source
This commit is contained in:
Martin Oberhuber 2007-06-11 11:03:06 +00:00
parent f1fab01104
commit 40434e7cd0
10 changed files with 491 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
discovery/org.eclipse.tm.discovery.doc.isv/about.html Normal file
View file

@ -0,0 +1,28 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
<title>About</title>
</head>
<body lang="EN-US">
<h2>About This Content</h2>
<p>June 5, 2007</p>
<h3>License</h3>
<p>The Eclipse Foundation makes available all content in this plug-in (&quot;Content&quot;). Unless otherwise
indicated below, the Content is provided to you under the terms and conditions of the
Eclipse Public License Version 1.0 (&quot;EPL&quot;). 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, &quot;Program&quot; 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 (&quot;Redistributor&quot;) 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>

25
discovery/org.eclipse.tm.discovery.doc.isv/build.properties Normal file
View file

@ -0,0 +1,25 @@
###############################################################################
# Copyright (c) 2000, 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 Corporation - initial API and implementation
# Martin Oberhuber (Wind River) - Declare API provisional
###############################################################################
bin.includes = META-INF/,\
about.html,\
book.css,\
notices.html,\
plugin.properties,\
plugin.xml,\
schema.css,\
toc.xml,\
guide/,\
icons/,\
index/,\
reference/,\
provisional_api.html
customBuildCallbacks = customBuildCallbacks.xml

157
discovery/org.eclipse.tm.discovery.doc.isv/buildDoc.xml Normal file
View file

@ -0,0 +1,157 @@
<?xml version="1.0" encoding="UTF-8"?>
<project name="TM Service Discovery ISV Doc Build" default="all" basedir=".">
<property name="javadoc.link.location" value="${basedir}/javadoc.link.location"/>
<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>
<delete dir="${javadoc.link.location}" />
</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 Eclipse 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.compare*.jar"/>
<include name="**/org.eclipse.help*.jar"/>
<include name="**/org.eclipse.search*.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.junit*.jar"/>
<include name="**/org.junit*/**/*.jar"/>
<include name="**/com.ibm.icu*.jar"/>
<include name="**/org.eclipse.emf*.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="debug" message="Classpath is: ${javadoc.classpath}"/>
</target>
<target name="extractLinks">
<mkdir dir="${javadoc.link.location}"/>
<patternset id="package.list">
<include name="**/package-list"/>
</patternset>
<!-- We only need the package-list files out of these -->
<unzip dest="${javadoc.link.location}/platform/">
<patternset refid="package.list"/>
<fileset dir="${safeBaseLocation}/plugins">
<include name="org.eclipse.platform.doc.isv*.jar"/>
</fileset>
</unzip>
<unzip dest="${javadoc.link.location}/emf/">
<patternset refid="package.list"/>
<fileset dir="${safeBaseLocation}/plugins">
<include name="org.eclipse.emf.doc_*/doc.zip"/>
</fileset>
</unzip>
</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.tm.discovery.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}/temp.convert.txt" action="start" />
<pde.convertSchemaToHTML manifest="../org.eclipse.tm.discovery.engine/plugin.xml" destination="${dest}" />
<record name="${basedir}/temp.convert.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" />
<available file="/shared/dsdp/tm/ibm-java2-ppc64-50/bin/javadoc" property="javadoc" value="/shared/dsdp/tm/ibm-java2-ppc64-50/bin/javadoc" />
</target>
<target name="generateJavadoc" depends="getJavadocPath,extractLinks,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}" />
<replace file="${basedir}/${optionsFile}" token="@cp@" value="${javadoc.classpath}" />
<replace file="${basedir}/${optionsFile}" token="@baseLocation@" value="${safeBaseLocation}" />
<replace file="${basedir}/${optionsFile}" token="@javadoc.link.location@" value="${javadoc.link.location}" />
<!--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" resultproperty="javadocResult">
<arg line="@${basedir}/${optionsFile} -J-Xmx1000M" />
</exec>
<echo message="javadoc result = ${javadocResult}"/>
</target>
</project>

157
discovery/org.eclipse.tm.discovery.doc.isv/customBuildCallbacks.xml Normal file
View file

@ -0,0 +1,157 @@
<!-- ===================================================================== -->
<!-- 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">
<!-- ===================================================================== -->
<!-- Default target -->
<!-- ===================================================================== -->
<target name="noDefault">
<echo message="This file must be called with explicit targets" />
</target>
<!-- ===================================================================== -->
<!-- Steps to do before the target build.jars -->
<!-- Available parameters : -->
<!-- build.result.folder - folder to contain the build results -->
<!-- ===================================================================== -->
<target name="pre.build.jars">
</target>
<!-- ===================================================================== -->
<!-- Steps to do after the target build.jars -->
<!-- Available parameters : -->
<!-- build.result.folder - folder to contain the build results -->
<!-- ===================================================================== -->
<target name="post.build.jars">
<ant antfile="buildDoc.xml" />
</target>
<!-- ===================================================================== -->
<!-- Steps to do before the target build.sources -->
<!-- Available parameters : -->
<!-- build.result.folder - folder to contain the build results -->
<!-- ===================================================================== -->
<target name="pre.build.sources">
</target>
<!-- ===================================================================== -->
<!-- Steps to do after the target build.sources -->
<!-- Available parameters : -->
<!-- build.result.folder - folder to contain the build results -->
<!-- ===================================================================== -->
<target name="post.build.sources">
</target>
<!-- ===================================================================== -->
<!-- Steps to do before the compilation target <name> -->
<!-- Substitute "name" with the name of the compilation target, eg @dot -->
<!-- Available parameters : -->
<!-- source.foldern : n = 1 ... N, the source folders -->
<!-- target.folder : where the results of the compilation go -->
<!-- <name>.classpath : name = name of the compilation target. A -->
<!-- reference to the classpath structure. -->
<!-- ===================================================================== -->
<!--
<target name="pre.compileTarget.jar">
</target>
-->
<!-- ===================================================================== -->
<!-- Steps to do after compilation but before jaring -->
<!-- Substitute "name" with the name of the compilation target, eg @dot -->
<!-- Available parameters : -->
<!-- source.foldern : n = 1 ... N, the source folders -->
<!-- target.folder : where the results of the compilation go -->
<!-- <name>.classpath : name = name of the compilation target. A -->
<!-- reference to the classpath structure. -->
<!-- ===================================================================== -->
<!--
<target name="post.compile.compileTarget.jar">
</target>
-->
<!-- ===================================================================== -->
<!-- Steps to do after the compilation target <name> -->
<!-- Substitute "name" with the name of the compilation target, eg @dot -->
<!-- Available parameters : -->
<!-- jar.location - the location of the compilation results -->
<!-- <name>.classpath : name = name of the compilation target. A -->
<!-- reference to the classpath structure. -->
<!-- ===================================================================== -->
<!--
<target name="post.compileTarget.jar">
</target>
-->
<!-- ===================================================================== -->
<!-- Steps to do before the target gather.bin.parts -->
<!-- Available parameters : -->
<!-- base.dir - root of the project -->
<!-- build.result.folder - folder containing the build results -->
<!-- target.folder - destination folder -->
<!-- ===================================================================== -->
<target name="pre.gather.bin.parts">
</target>
<!-- ===================================================================== -->
<!-- Steps to do after the target gather.bin.parts -->
<!-- Available parameters : -->
<!-- base.dir - root of the project -->
<!-- build.result.folder - folder containing the build results -->
<!-- target.folder - destination folder -->
<!-- ===================================================================== -->
<target name="post.gather.bin.parts">
</target>
<!-- ===================================================================== -->
<!-- Steps to do before the target gather.sources -->
<!-- Available parameters : -->
<!-- destination.temp.folder - destination folder -->
<!-- ===================================================================== -->
<target name="pre.gather.sources">
</target>
<!-- ===================================================================== -->
<!-- Steps to do after the target gather.sources -->
<!-- Available parameters : -->
<!-- destination.temp.folder - destination folder -->
<!-- ===================================================================== -->
<target name="post.gather.sources">
</target>
<!-- ===================================================================== -->
<!-- Steps to do before the target gather.logs -->
<!-- Available parameters : -->
<!-- destination.temp.folder - destination folder -->
<!-- ===================================================================== -->
<target name="pre.gather.logs">
</target>
<!-- ===================================================================== -->
<!-- Steps to do after the target gather.logs -->
<!-- Available parameters : -->
<!-- destination.temp.folder - destination folder -->
<!-- ===================================================================== -->
<target name="post.gather.logs">
</target>
<!-- ===================================================================== -->
<!-- Steps to do before the target clean -->
<!-- Available parameters : -->
<!-- destination.temp.folder - destination folder -->
<!-- ===================================================================== -->
<target name="pre.clean">
</target>
<!-- ===================================================================== -->
<!-- Steps to do after the target clean -->
<!-- Available parameters : -->
<!-- plugin.destination - final destination of the build -->
<!-- build.result.folder - results of the compilation -->
<!-- temp.folder - temporary folder -->
<!-- ===================================================================== -->
<target name="post.clean">
</target>
</project>

22
discovery/org.eclipse.tm.discovery.doc.isv/notices.html Normal file
View file

@ -0,0 +1,22 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta name="copyright" content="Copyright (c) 2007 Symbian Software Ltd. and others. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<LINK REL="STYLESHEET" HREF="book.css" CHARSET="ISO-8859-1" TYPE="text/css">
<title>Legal Notices</title>
</head>
<body>
<h3>
<a NAME="Notices"></a>Notices</h3>
<p>
The material in this guide is Copyright (c) 2007 Symbian Software Ltd. and others.
</p>
<p>
<a href="about.html">Terms and conditions regarding the use of this guide.</a>
</p>
</body>
</html>

41
discovery/org.eclipse.tm.discovery.doc.isv/options.txt Normal file
View file

@ -0,0 +1,41 @@
-quiet
-encoding "iso-8859-1"
-charset "iso-8859-1"
-source 1.4
-sourcepath "../org.eclipse.tm.discovery.engine/src
;../org.eclipse.tm.discovery.model/src
;../org.eclipse.tm.discovery.model.edit/src
;../org.eclipse.tm.discovery.protocol.dnssd/src
;../org.eclipse.tm.discovery.transport.udp/src
;../org.eclipse.tm.discovery.view/src
;../org.eclipse.tm.discovery.wizard/src
;../org.eclipse.rse.discovery/src"
-d reference/api
-bootclasspath @rt@
-classpath @cp@
;../org.eclipse.rse.core/@dot
;../org.eclipse.rse.core/bin
;../org.eclipse.rse.ui/@dot
;../org.eclipse.rse.ui/bin
-breakiterator
-tag generated:X
-tag lastgen:X
-tag model:X
-tag ordered:X
-use
-splitIndex
-windowtitle "TM Service Discovery API Specification"
-doctitle "TM Service Discovery API Specification"
-header "<b>TM Service Discovery</b><br>Release 2.0"
-bottom "Copyright (c) 2007 Symbian Software Ltd. and others. All Rights Reserved."
-group "TM Service Discovery Core Plug-in Packages" "org.eclipse.tm.discovery.*"
-group "TM Service Discovery RSE Integration Plug-in Packages" "org.eclipse.rse.discovery"
-link http://java.sun.com/j2se/1.4.2/docs/api
-linkoffline ./../../../org.eclipse.platform.doc.isv/reference/api @javadoc.link.location@/platform/reference/api/
-linkoffline ./../../../org.eclipse.emf.doc/references/javadoc @javadoc.link.location@/emf/references/javadoc/
-linkoffline ./../../../org.eclipse.rse.doc.isv/reference/api ../org.eclipse.rse.doc.isv/reference/api
-link http://bundles.osgi.org/javadoc/r4
org.eclipse.tm.discovery.protocol
org.eclipse.tm.discovery.transport
org.eclipse.tm.discovery.model

4
discovery/org.eclipse.tm.discovery.doc.isv/plugin.properties
View file

@ -6,11 +6,11 @@
# http://www.eclipse.org/legal/epl-v10.html # http://www.eclipse.org/legal/epl-v10.html
# #
# Contributors: # Contributors:
# Javier Montalvo Orus - initial API and implementation # Javier Montalvo Orus (Symbian) - initial API and implementation
############################################################################### ###############################################################################
# NLS_MESSAGEFORMAT_NONE # NLS_MESSAGEFORMAT_NONE
# NLS_ENCODING=UTF-8 # NLS_ENCODING=UTF-8
pluginName=Service Discovery ISV Documentation pluginName=Target Management Service Discovery Developer Guide
providerName=Eclipse.org providerName=Eclipse.org

32
discovery/org.eclipse.tm.discovery.doc.isv/provisional_api.html Normal file
View file

@ -0,0 +1,32 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<title>TM Service Discovery API Status</title>
<meta name="copyright" content="Copyright (c) 2007 Symbian Software Ltd. and others. For full details see the LEGAL in the documentation book that contains this page." >
<link rel="stylesheet" type="text/css" HREF="book.css">
</head>
<body bgcolor="#ffffff">
<h1>TM Service Discovery API Status</h1>
<h2>Provisional API</h2>
<div class="p">
<p>Although Service Discovery API has been reviewed, we want to give the
Open Source Communitiy a chance to provide public
feedback and help further improving the APIs. Therefore,</p>
<p><b>As of Service Discovery 2.0, all API is considered provisional.</b></p>
<p>This means, that we reserve the right to change any API after
Service Discovery 2.0 in a not backward compatible way. All such API changes
will be voted on by committers on the <a href="https://dev.eclipse.org/mailman/listinfo/dsdp-tm-dev">
dsdp-tm-dev</a> developer mailing list, and documented in a migration guide
for future releases. We expect that with Community Feedback, we'll reach a
stable, hardened API for Service Discovery 3.0. Please give your feedback on
<a href="https://bugs.eclipse.org/bugs/">Eclipse Bugzilla</a>
under category DSDP, Product Target Management.</p>
</div>
</body>
</html>

19
discovery/org.eclipse.tm.discovery.doc.isv/reference/extension-points/index.html Normal file
View file

@ -0,0 +1,19 @@
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta name="copyright" content="Copyright (c) 2007 Symbian Software Ltd. and others. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Service Discovery Extension Points</title>
<link rel="stylesheet" type="text/css" HREF="../../book.css">
</head>
<body>
<h1>Service Discovery Extension Points</h1>
<p>The following extension points can be used to extend the capabilities of the
Service Discovery infrastructure: </p>
<ul>
<li><a href="org_eclipse_tm_discovery_engine_discoveryProtocol.html">org.eclipse.tm.discovery.engine.discoveryProtocol</a></li>
<li><a href="org_eclipse_tm_discovery_engine_discoveryTransport.html">org.eclipse.tm.discovery.engine.discoveryTransport</a></li>
</ul>
</body>
</html>

8
discovery/org.eclipse.tm.discovery.doc.isv/toc.xml
View file

@ -17,11 +17,19 @@
<topic label="Programmatically" href="guide/usage.html" /> <topic label="Programmatically" href="guide/usage.html" />
<topic label="Service Discovery View" href="guide/view.html" /> <topic label="Service Discovery View" href="guide/view.html" />
</topic> </topic>
<anchor id="sd_guide_additions"/>
</topic> </topic>
<topic label="Reference"> <topic label="Reference">
<topic label="Service Discovery API Reference" href="provisional_api.html">
<topic label="org.eclipse.tm.discovery.model" href="reference/api/org/eclipse/tm/discovery/model/package-summary.html" />
<topic label="org.eclipse.tm.discovery.protocol" href="reference/api/org/eclipse/tm/discovery/protocol/package-summary.html" />
<topic label="org.eclipse.tm.discovery.transport" href="reference/api/org/eclipse/tm/discovery/transport/package-summary.html" />
</topic>
<topic label="Extension Points Reference"> <topic label="Extension Points Reference">
<topic label="org.eclipse.tm.discovery.engine.discoveryProtocol" href="reference/extension-points/org_eclipse_tm_discovery_engine_discoveryProtocol.html" /> <topic label="org.eclipse.tm.discovery.engine.discoveryProtocol" href="reference/extension-points/org_eclipse_tm_discovery_engine_discoveryProtocol.html" />
<topic label="org.eclipse.tm.discovery.engine.discoveryTranport" href="reference/extension-points/org_eclipse_tm_discovery_engine_discoveryTransport.html" /> <topic label="org.eclipse.tm.discovery.engine.discoveryTranport" href="reference/extension-points/org_eclipse_tm_discovery_engine_discoveryTransport.html" />
</topic> </topic>
<anchor id="sd_ref_additions"/>
</topic> </topic>
<topic label="Legal" href="notices.html"/>
</toc> </toc>