diff --git a/rse/doc/org.eclipse.rse.doc.isv/build.properties b/rse/doc/org.eclipse.rse.doc.isv/build.properties index 78ff0ead757..b34ce515a34 100755 --- a/rse/doc/org.eclipse.rse.doc.isv/build.properties +++ b/rse/doc/org.eclipse.rse.doc.isv/build.properties @@ -1,28 +1,29 @@ -############################################################################### -# 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 -############################################################################### -bin.includes = META-INF/,\ - about.html,\ - book.css,\ - schema.css,\ - notices.html,\ - plugin.properties,\ - plugin.xml,\ - toc.xml,\ - topics_Guide.xml,\ - topics_Questions.xml,\ - topics_Reference.xml,\ - topics_Samples.xml,\ - guide/,\ - reference/,\ - questions/,\ - icons/,\ - samples/ -customBuildCallbacks = customBuildCallbacks.xml +############################################################################### +# 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 +############################################################################### +bin.includes = META-INF/,\ + about.html,\ + book.css,\ + notices.html,\ + plugin.properties,\ + plugin.xml,\ + schema.css,\ + toc.xml,\ + topics_Guide.xml,\ + topics_Questions.xml,\ + topics_Reference.xml,\ + topics_Samples.xml,\ + guide/,\ + icons/,\ + index/,\ + questions/,\ + reference/,\ + samples/ +customBuildCallbacks = customBuildCallbacks.xml diff --git a/rse/doc/org.eclipse.rse.doc.isv/buildDoc.xml b/rse/doc/org.eclipse.rse.doc.isv/buildDoc.xml index eeb9e96d5a4..ff79984024d 100755 --- a/rse/doc/org.eclipse.rse.doc.isv/buildDoc.xml +++ b/rse/doc/org.eclipse.rse.doc.isv/buildDoc.xml @@ -27,6 +27,10 @@ + + + + @@ -46,6 +50,7 @@ + diff --git a/rse/doc/org.eclipse.rse.doc.isv/options.txt b/rse/doc/org.eclipse.rse.doc.isv/options.txt index e1711735b3c..90b6c2ba5ba 100755 --- a/rse/doc/org.eclipse.rse.doc.isv/options.txt +++ b/rse/doc/org.eclipse.rse.doc.isv/options.txt @@ -11,7 +11,9 @@ ;../org.eclipse.rse.logging/src ;../org.eclipse.rse.processes.ui/src ;../org.eclipse.rse.services/src +;../org.eclipse.rse.services/clientserver ;../org.eclipse.rse.services.dstore/src +;../org.eclipse.rse.services.dstore/miners ;../org.eclipse.rse.services.files.ftp/src ;../org.eclipse.rse.services.local/src ;../org.eclipse.rse.services.ssh/src @@ -37,7 +39,15 @@ ;../org.eclipse.rse.ui/systems" -d reference/api -classpath @rt@ +;../org.eclipse.dstore.core/@dot +;../org.eclipse.dstore.core/bin +;../org.eclipse.dstore.extra/@dot +;../org.eclipse.dstore.extra/bin -breakiterator +-tag generated:X +-tag lastgen:X +-tag model:X +-tag ordered:X -use -splitIndex -windowtitle "RSE API Specification" @@ -48,6 +58,7 @@ -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 +-linkoffline ./../../../org.eclipse.dstore.doc.isv/reference/api ../org.eclipse.dstore.doc.isv/reference/api -link http://bundles.osgi.org/javadoc/r4 org.eclipse.rse.connectorservice.dstore diff --git a/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/actions/SystemDownloadConflictAction.java b/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/actions/SystemDownloadConflictAction.java index d600e3899d2..e3213c6f96e 100644 --- a/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/actions/SystemDownloadConflictAction.java +++ b/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/actions/SystemDownloadConflictAction.java @@ -69,7 +69,7 @@ public class SystemDownloadConflictAction extends SystemBaseAction implements Ru /** * Return whether the user decided to keep the local cached file - * @returns the whether the user decided to keep the local cached file + * @return the whether the user decided to keep the local cached file */ public boolean keepLocal() { @@ -235,7 +235,7 @@ public class SystemDownloadConflictAction extends SystemBaseAction implements Ru /** * Returns the dialog used to prompt a user on how to resolve a conflict. - * @returns the dialog + * @return the dialog */ protected DownloadConflictDialog getConflictDialog() { diff --git a/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/SystemEditableRemoteFile.java b/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/SystemEditableRemoteFile.java index 071ccb6e188..ce96f7101d0 100644 --- a/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/SystemEditableRemoteFile.java +++ b/rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/SystemEditableRemoteFile.java @@ -461,7 +461,7 @@ public class SystemEditableRemoteFile implements ISystemEditableRemoteObject, IP /** * Download the file. * @param the progress monitor - * @returns true if the operation was successful. false if the user cancels. + * @return true if the operation was successful. false if the user cancels. */ public boolean download(IProgressMonitor monitor) throws Exception { diff --git a/rse/plugins/org.eclipse.rse.logging/src/org/eclipse/rse/logging/performance/PerformanceLogger.java b/rse/plugins/org.eclipse.rse.logging/src/org/eclipse/rse/logging/performance/PerformanceLogger.java index 137a040d76b..099361c0971 100644 --- a/rse/plugins/org.eclipse.rse.logging/src/org/eclipse/rse/logging/performance/PerformanceLogger.java +++ b/rse/plugins/org.eclipse.rse.logging/src/org/eclipse/rse/logging/performance/PerformanceLogger.java @@ -168,7 +168,7 @@ public class PerformanceLogger { } /* public static String register(String comp_id) : registering a component using default - * @parm + * @param * - comp_id: Component to be registered * @return * compont comp_id registered with no product info @@ -178,7 +178,7 @@ public class PerformanceLogger { } /* public static String register(String feature, String version) : method for registering a component using default - * @parm + * @param * - feature: Identifier for Product Feature attribute in XML * - version: Identifier for Product Version attribute in XML * @return @@ -192,7 +192,7 @@ public class PerformanceLogger { /** * public static String register(String comp_id, String feature, String version) : Registering a component - * @parm + * @param * - comp_id: Component to be registered * - feature: Identifier for Product Feature attribute in XML * - version: Identifier for Product Version attribute in XML @@ -242,7 +242,7 @@ public class PerformanceLogger { /** * public static void deRegister(String key): De-register a component - * @parm + * @param * key : component to be removed * @return * component identified by key removed @@ -296,7 +296,7 @@ public class PerformanceLogger { /** * public static long start(String comp_id): start timer for component comp_id using default TaskID - * @parm : + * @param : * comp_id : component registered previously by register(comp_id,..) * @return * - started time in milliseconds. @@ -309,7 +309,7 @@ public class PerformanceLogger { /** * public long start(String comp_id, String call_id): start the timer for registered component comp_id - * @parm + * @param * comp_id is the registered component * call_id is the "CallID" attribute value for the XML tag "Task" * @return diff --git a/rse/plugins/org.eclipse.rse.subsystems.shells.ssh/src/org/eclipse/rse/subsystems/shells/ssh/SshShellSubSystemConfiguration.java b/rse/plugins/org.eclipse.rse.subsystems.shells.ssh/src/org/eclipse/rse/subsystems/shells/ssh/SshShellSubSystemConfiguration.java index b99a8838dad..3d56cab7aaa 100644 --- a/rse/plugins/org.eclipse.rse.subsystems.shells.ssh/src/org/eclipse/rse/subsystems/shells/ssh/SshShellSubSystemConfiguration.java +++ b/rse/plugins/org.eclipse.rse.subsystems.shells.ssh/src/org/eclipse/rse/subsystems/shells/ssh/SshShellSubSystemConfiguration.java @@ -51,7 +51,7 @@ public class SshShellSubSystemConfiguration extends /** * Instantiate and return an instance of OUR subystem. * Do not populate it yet though! - * @see org.eclipse.rse.core.subsystems.impl.SubSystemFactoryImpl#createSubSystemInternal(Host) + * @see org.eclipse.rse.core.subsystems.SubSystemConfiguration#createSubSystemInternal(IHost) */ public ISubSystem createSubSystemInternal(IHost host) { diff --git a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/messages/SystemMessageDialog.java b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/messages/SystemMessageDialog.java index 95c795ea4a1..0ab102d7840 100644 --- a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/messages/SystemMessageDialog.java +++ b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/messages/SystemMessageDialog.java @@ -462,7 +462,7 @@ public class SystemMessageDialog extends ErrorDialog implements Listener { /** * opens the dialog with Yes, No, Cancel Details for an Inquiry/Question message * throws an IndicatorException if the indicator is not Inquiry - * @returns IDialogConstants.YES_ID or NO_ID + * @return IDialogConstants.YES_ID or NO_ID */ public int openYesNoCancel() { diff --git a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemEditableRemoteObject.java b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemEditableRemoteObject.java index aedb522c257..fa8355e2ecb 100644 --- a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemEditableRemoteObject.java +++ b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemEditableRemoteObject.java @@ -64,14 +64,14 @@ public interface ISystemEditableRemoteObject /** * Download the file. * @param the progress monitor - * @returns true if the operation was successful. false if the user cancels. + * @return true if the operation was successful. false if the user cancels. */ public boolean download(IProgressMonitor monitor) throws Exception; /** * Saves the local file and uploads it to the host immediately, rather than, in response to a resource change * event. - * @returns true if the operation was successful. false if the upload fails. + * @return true if the operation was successful. false if the upload fails. */ public boolean doImmediateSaveAndUpload(); diff --git a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemViewDropDestination.java b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemViewDropDestination.java index 569c54d8623..68f2a83d21e 100644 --- a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemViewDropDestination.java +++ b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemViewDropDestination.java @@ -27,8 +27,8 @@ public interface ISystemViewDropDestination /** * ask source adapter if it supports drop of its type on this target - * @parm resource (type) in question - * @returns true if copy/move/drop is supported + * @param resource (type) in question + * @return true if copy/move/drop is supported */ public boolean supportDropDestination(Object target); } \ No newline at end of file diff --git a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/search/SystemSearchViewContentProvider.java b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/search/SystemSearchViewContentProvider.java index a2bb2dbdd0b..a7d63c3fd14 100644 --- a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/search/SystemSearchViewContentProvider.java +++ b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/search/SystemSearchViewContentProvider.java @@ -166,7 +166,7 @@ public class SystemSearchViewContentProvider implements ITreeContentProvider { } /** * Set the ViewPart of this provider - * @parm ViewPart of this provider + * @param ViewPart of this provider */ public void setViewPart(ViewPart viewPart) { diff --git a/rse/plugins/org.eclipse.rse.ui/filters/org/eclipse/rse/filters/ISystemFilterPoolManager.java b/rse/plugins/org.eclipse.rse.ui/filters/org/eclipse/rse/filters/ISystemFilterPoolManager.java index ec07717e5b4..769f2036199 100644 --- a/rse/plugins/org.eclipse.rse.ui/filters/org/eclipse/rse/filters/ISystemFilterPoolManager.java +++ b/rse/plugins/org.eclipse.rse.ui/filters/org/eclipse/rse/filters/ISystemFilterPoolManager.java @@ -232,7 +232,7 @@ public interface ISystemFilterPoolManager extends IRSEPersistableContainer /** * Pre-test if we are going to run into any trouble renaming any of the files or folders * used to persist a filter pool. - * @returns true if everything seems ok, false if a file/folder is in use. + * @return true if everything seems ok, false if a file/folder is in use. */ public boolean preTestRenameFilterPool(ISystemFilterPool pool) throws Exception; /** diff --git a/rse/plugins/org.eclipse.rse.ui/filters/org/eclipse/rse/internal/filters/SystemFilterPoolManager.java b/rse/plugins/org.eclipse.rse.ui/filters/org/eclipse/rse/internal/filters/SystemFilterPoolManager.java index e76128e96eb..d9934aaecdc 100644 --- a/rse/plugins/org.eclipse.rse.ui/filters/org/eclipse/rse/internal/filters/SystemFilterPoolManager.java +++ b/rse/plugins/org.eclipse.rse.ui/filters/org/eclipse/rse/internal/filters/SystemFilterPoolManager.java @@ -729,7 +729,7 @@ public class SystemFilterPoolManager implements ISystemFilterPoolManager /** * Pre-test if we are going to run into any trouble renaming any of the files or folders * used to persist a filter pool. - * @returns true if everything seems ok, false if a file/folder is in use. + * @return true if everything seems ok, false if a file/folder is in use. */ public boolean preTestRenameFilterPool(ISystemFilterPool pool) throws Exception { diff --git a/rse/plugins/org.eclipse.rse.ui/systems/org/eclipse/rse/core/SystemBasePlugin.java b/rse/plugins/org.eclipse.rse.ui/systems/org/eclipse/rse/core/SystemBasePlugin.java index db01364bfb6..618dca64e0a 100644 --- a/rse/plugins/org.eclipse.rse.ui/systems/org/eclipse/rse/core/SystemBasePlugin.java +++ b/rse/plugins/org.eclipse.rse.ui/systems/org/eclipse/rse/core/SystemBasePlugin.java @@ -798,7 +798,7 @@ public abstract class SystemBasePlugin extends AbstractUIPlugin * Retrieve an image descriptor in this plugin's directory tree given its file name. The * file name should be qualified relative to this plugin's bundle. * For example "icons/myicon.gif" - * @parm imagePath the path name to the image relative to this bundle + * @param imagePath the path name to the image relative to this bundle * @return the image descriptor */ public ImageDescriptor getPluginImage(String imagePath) { @@ -811,7 +811,7 @@ public abstract class SystemBasePlugin extends AbstractUIPlugin * Thus, image resources retrieved in this way need not be disposed by the * caller. * - * @parm key the id of the image to retrieve. + * @param key the id of the image to retrieve. * @return the Image resource for this id. */ public Image getImage(String key) @@ -833,7 +833,7 @@ public abstract class SystemBasePlugin extends AbstractUIPlugin /** * Returns the image descriptor that has been registered to this id. - * @parm key the id of the image descriptor to retrieve + * @param key the id of the image descriptor to retrieve * @return an ImageDescriptor */ public ImageDescriptor getImageDescriptor(String key) {