mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-08 17:45:24 +02:00
Code Issues Wiki Activity

Fix warnings in dstore.doc.isv build

Browse source
This commit is contained in:
Martin Oberhuber 2006-07-27 13:30:47 +00:00
parent 1003ed6e14
commit 020e4a2dee
6 changed files with 209 additions and 130 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
rse/doc/org.eclipse.dstore.doc.isv/.cvsignore
View file

@ -1 +1,6 @@
bin bin
index
build.xml
temp.bin.log
temp.options.txt
temp.convert.txt

50
rse/doc/org.eclipse.dstore.doc.isv/aaa-how-to-add-things.txt
View file

@ -1,23 +1,29 @@
Last revised May 31, 2006 Last revised July 27, 2006
(This file is for information only; it is not included in the release.) (This file is for information only; it is not included in the release.)
To add new plug-ins you need to make changes in several places in See also
this doc plug-in: http://wiki.eclipse.org/index.php/How_to_add_things_to_the_Eclipse_doc
with the following exceptions:
1) options.txt - platformOptions.txt -> options.txt
- the plug-in's source folder(s) must be included on the -sourcepath - overview-platform.html -> /reference/misc/overview-rse.html
- code of required plug-ins must be added on the -classpath (the JAR(s)for non-JARed plug-ins and <plugin>/@dot for JARed plug-ins
- the API package names must be included in the (alphabetical) package list at the end of the file To add new plug-ins you need to make changes in several places in
- note that the @sep@ token is replaced during build by the appropriate separator character for the build platform. this doc plug-in:
2) buildDoc.xml 1) options.txt
- add a line in convertSchemaToHtml target to handle a new plug-ins extension point schemas - the plug-in's source folder(s) must be included on the -sourcepath
- code of required plug-ins must be added on the -classpath (the JAR(s)for non-JARed plug-ins and <plugin>/@dot for JARed plug-ins
Adding new extension points: - the API package names must be included in the (alphabetical) package list at the end of the file
- note that the @sep@ token is replaced during build by the appropriate separator character for the build platform.
1) reference/extension-points/index.html
- add a line for each extension point 2) buildDoc.xml
- add a line in convertSchemaToHtml target to handle a new plug-ins extension point schemas
2) topics_Reference.xml
- add a line for each extension point Adding new extension points:
1) reference/extension-points/index.html
- add a line for each extension point
2) topics_Reference.xml
- add a line for each extension point
- add a line for each API package - add a line for each API package

43
rse/doc/org.eclipse.dstore.doc.isv/build.properties
View file

@ -1,21 +1,22 @@
############################################################################### ###############################################################################
# Copyright (c) 2000, 2006 IBM Corporation and others. # Copyright (c) 2000, 2006 IBM Corporation and others.
# All rights reserved. This program and the accompanying materials # All rights reserved. This program and the accompanying materials
# are made available under the terms of the Eclipse Public License v1.0 # are made available under the terms of the Eclipse Public License v1.0
# which accompanies this distribution, and is available at # which accompanies this distribution, and is available at
# http://www.eclipse.org/legal/epl-v10.html # http://www.eclipse.org/legal/epl-v10.html
# #
# Contributors: # Contributors:
# IBM Corporation - initial API and implementation # IBM Corporation - initial API and implementation
############################################################################### ###############################################################################
bin.includes = META-INF/,\ bin.includes = META-INF/,\
about.html,\ about.html,\
book.css,\ book.css,\
notices.html,\ notices.html,\
plugin.properties,\ plugin.properties,\
plugin.xml,\ plugin.xml,\
toc.html,\ toc.html,\
toc.xml,\ toc.xml,\
guide/,\ guide/,\
reference/ index/,\
customBuildCallbacks = customBuildCallbacks.xml reference/
customBuildCallbacks = customBuildCallbacks.xml

197
rse/doc/org.eclipse.dstore.doc.isv/buildDoc.xml
View file

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

41
rse/doc/org.eclipse.dstore.doc.isv/options.txt
View file

@ -1,21 +1,22 @@
-charset "iso-8859-1" -charset "iso-8859-1"
-sourcepath "../org.eclipse.dstore.core/src@sep@../org.eclipse.dstore.extra/src" -sourcepath "../org.eclipse.dstore.core/src
-d reference/api ;../org.eclipse.dstore.extra/src"
-classpath @rt@ -d reference/api
-breakiterator -classpath @rt@
-use -breakiterator
-splitIndex -use
-windowtitle "Remote System Explorer DataStore API Specification" -splitIndex
-doctitle "Remote System Explorer DataStore API Specification" -windowtitle "Remote System Explorer DataStore API Specification"
-header "<b>Remote System Explorer DataStore</b><br>Release 1.0" -doctitle "Remote System Explorer DataStore API Specification"
-bottom '<font size="-1"><p><a href="{@docRoot}/../misc/api-usage-rules.html">Guidelines for using DataStore APIs</a>.</p></font>' -header "<b>Remote System Explorer DataStore</b><br>Release 1.0"
-link http://java.sun.com/j2se/1.4.2/docs/api -bottom '<font size="-1"><p><a href="{@docRoot}/../misc/api-usage-rules.html">Guidelines for using DataStore APIs</a>.</p></font>'
-linkoffline ../org.eclipse.rse.doc.isv/reference/api .. -link http://java.sun.com/j2se/1.4.2/docs/api
-linkoffline ../org.eclipse.rse.doc.isv/reference/api ..
org.eclipse.dstore.core.model
org.eclipse.dstore.core.client org.eclipse.dstore.core.model
org.eclipse.dstore.core.server org.eclipse.dstore.core.client
org.eclipse.dstore.core.util org.eclipse.dstore.core.server
org.eclipse.dstore.core.util.ssl org.eclipse.dstore.core.util
org.eclipse.dstore.core.java org.eclipse.dstore.core.util.ssl
org.eclipse.dstore.core.java
org.eclipse.dstore.core.miners.miner org.eclipse.dstore.core.miners.miner

1
rse/doc/org.eclipse.dstore.doc.isv/reference/.cvsignore Normal file
View file

@ -0,0 +1 @@
api