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 some obvious javadoc warnings (733 remaining)

Browse source
This commit is contained in:
Martin Oberhuber 2006-07-27 12:16:36 +00:00
parent 7a2be0808b
commit 06b4d2269c
14 changed files with 66 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
rse/doc/org.eclipse.rse.doc.isv/build.properties
View file

@ -1,28 +1,29 @@
############################################################################### ###############################################################################
# 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,\
schema.css,\ notices.html,\
notices.html,\ plugin.properties,\
plugin.properties,\ plugin.xml,\
plugin.xml,\ schema.css,\
toc.xml,\ toc.xml,\
topics_Guide.xml,\ topics_Guide.xml,\
topics_Questions.xml,\ topics_Questions.xml,\
topics_Reference.xml,\ topics_Reference.xml,\
topics_Samples.xml,\ topics_Samples.xml,\
guide/,\ guide/,\
reference/,\ icons/,\
questions/,\ index/,\
icons/,\ questions/,\
samples/ reference/,\
customBuildCallbacks = customBuildCallbacks.xml samples/
customBuildCallbacks = customBuildCallbacks.xml

5
rse/doc/org.eclipse.rse.doc.isv/buildDoc.xml
View file

@ -27,6 +27,10 @@
<patternset id="platform.classpath.pattern"> <patternset id="platform.classpath.pattern">
<include name="**/org.eclipse.core*.jar"/> <include name="**/org.eclipse.core*.jar"/>
<include name="**/org.eclipse.core*/**/*.jar"/> <include name="**/org.eclipse.core*/**/*.jar"/>
<include name="**/org.eclipse.compare*.jar"/>
<include name="**/org.eclipse.debug.core*.jar"/>
<include name="**/org.eclipse.debug.ui*.jar"/>
<include name="**/org.eclipse.search*.jar"/>
<include name="**/org.eclipse.swt*.jar"/> <include name="**/org.eclipse.swt*.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"/>
@ -46,6 +50,7 @@
<include name="**/org.junit*.jar"/> <include name="**/org.junit*.jar"/>
<include name="**/org.junit*/**/*.jar"/> <include name="**/org.junit*/**/*.jar"/>
<include name="**/com.ibm.icu*.jar"/> <include name="**/com.ibm.icu*.jar"/>
<include name="**/com.jcraft.jsch*.jar"/>
</patternset> </patternset>
<pathconvert property="javadoc.classpath"> <pathconvert property="javadoc.classpath">

11
rse/doc/org.eclipse.rse.doc.isv/options.txt
View file

@ -11,7 +11,9 @@
;../org.eclipse.rse.logging/src ;../org.eclipse.rse.logging/src
;../org.eclipse.rse.processes.ui/src ;../org.eclipse.rse.processes.ui/src
;../org.eclipse.rse.services/src ;../org.eclipse.rse.services/src
;../org.eclipse.rse.services/clientserver
;../org.eclipse.rse.services.dstore/src ;../org.eclipse.rse.services.dstore/src
;../org.eclipse.rse.services.dstore/miners
;../org.eclipse.rse.services.files.ftp/src ;../org.eclipse.rse.services.files.ftp/src
;../org.eclipse.rse.services.local/src ;../org.eclipse.rse.services.local/src
;../org.eclipse.rse.services.ssh/src ;../org.eclipse.rse.services.ssh/src
@ -37,7 +39,15 @@
;../org.eclipse.rse.ui/systems" ;../org.eclipse.rse.ui/systems"
-d reference/api -d reference/api
-classpath @rt@ -classpath @rt@
;../org.eclipse.dstore.core/@dot
;../org.eclipse.dstore.core/bin
;../org.eclipse.dstore.extra/@dot
;../org.eclipse.dstore.extra/bin
-breakiterator -breakiterator
-tag generated:X
-tag lastgen:X
-tag model:X
-tag ordered:X
-use -use
-splitIndex -splitIndex
-windowtitle "RSE API Specification" -windowtitle "RSE API Specification"
@ -48,6 +58,7 @@
-group "RSE UI Plug-in Packages" "org.eclipse.rse.ui;org.eclipse.rse.ui.*" -group "RSE UI Plug-in Packages" "org.eclipse.rse.ui;org.eclipse.rse.ui.*"
-link http://java.sun.com/j2se/1.5/docs/api -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.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 -link http://bundles.osgi.org/javadoc/r4
org.eclipse.rse.connectorservice.dstore org.eclipse.rse.connectorservice.dstore

4
rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/actions/SystemDownloadConflictAction.java
View file

@ -69,7 +69,7 @@ public class SystemDownloadConflictAction extends SystemBaseAction implements Ru
/** /**
* Return whether the user decided to keep the local cached file * 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() 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 used to prompt a user on how to resolve a conflict.
* @returns the dialog * @return the dialog
*/ */
protected DownloadConflictDialog getConflictDialog() protected DownloadConflictDialog getConflictDialog()
{ {

2
rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/resources/SystemEditableRemoteFile.java
View file

@ -461,7 +461,7 @@ public class SystemEditableRemoteFile implements ISystemEditableRemoteObject, IP
/** /**
* Download the file. * Download the file.
* @param the progress monitor * @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 public boolean download(IProgressMonitor monitor) throws Exception
{ {

12
rse/plugins/org.eclipse.rse.logging/src/org/eclipse/rse/logging/performance/PerformanceLogger.java
View file

@ -168,7 +168,7 @@ public class PerformanceLogger {
} }
/* public static String register(String comp_id) : registering a component using default /* public static String register(String comp_id) : registering a component using default
* @parm * @param
* - comp_id: Component to be registered * - comp_id: Component to be registered
* @return * @return
* compont comp_id registered with no product info * 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 /* 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 * - feature: Identifier for Product Feature attribute in XML
* - version: Identifier for Product Version attribute in XML * - version: Identifier for Product Version attribute in XML
* @return * @return
@ -192,7 +192,7 @@ public class PerformanceLogger {
/** /**
* public static String register(String comp_id, String feature, String version) : Registering a component * public static String register(String comp_id, String feature, String version) : Registering a component
* @parm * @param
* - comp_id: Component to be registered * - comp_id: Component to be registered
* - feature: Identifier for Product Feature attribute in XML * - feature: Identifier for Product Feature attribute in XML
* - version: Identifier for Product Version 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 * public static void deRegister(String key): De-register a component
* @parm * @param
* key : component to be removed * key : component to be removed
* @return * @return
* component identified by key removed * 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 * 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,..) * comp_id : component registered previously by register(comp_id,..)
* @return * @return
* - started time in milliseconds. * - 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 * 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 * comp_id is the registered component
* call_id is the "CallID" attribute value for the XML tag "Task" * call_id is the "CallID" attribute value for the XML tag "Task"
* @return * @return

2
rse/plugins/org.eclipse.rse.subsystems.shells.ssh/src/org/eclipse/rse/subsystems/shells/ssh/SshShellSubSystemConfiguration.java
View file

@ -51,7 +51,7 @@ public class SshShellSubSystemConfiguration extends
/** /**
* Instantiate and return an instance of OUR subystem. * Instantiate and return an instance of OUR subystem.
* Do not populate it yet though! * 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) public ISubSystem createSubSystemInternal(IHost host)
{ {

2
rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/messages/SystemMessageDialog.java
View file

@ -462,7 +462,7 @@ public class SystemMessageDialog extends ErrorDialog implements Listener {
/** /**
* opens the dialog with Yes, No, Cancel Details for an Inquiry/Question message * opens the dialog with Yes, No, Cancel Details for an Inquiry/Question message
* throws an IndicatorException if the indicator is not Inquiry * 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() public int openYesNoCancel()
{ {

4
rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemEditableRemoteObject.java
View file

@ -64,14 +64,14 @@ public interface ISystemEditableRemoteObject
/** /**
* Download the file. * Download the file.
* @param the progress monitor * @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; 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 * Saves the local file and uploads it to the host immediately, rather than, in response to a resource change
* event. * 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(); public boolean doImmediateSaveAndUpload();

4
rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/ISystemViewDropDestination.java
View file

@ -27,8 +27,8 @@ public interface ISystemViewDropDestination
/** /**
* ask source adapter if it supports drop of its type on this target * ask source adapter if it supports drop of its type on this target
* @parm resource (type) in question * @param resource (type) in question
* @returns true if copy/move/drop is supported * @return true if copy/move/drop is supported
*/ */
public boolean supportDropDestination(Object target); public boolean supportDropDestination(Object target);
} }

2
rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/search/SystemSearchViewContentProvider.java
View file

@ -166,7 +166,7 @@ public class SystemSearchViewContentProvider implements ITreeContentProvider {
} }
/** /**
* Set the ViewPart of this provider * Set the ViewPart of this provider
* @parm ViewPart of this provider * @param ViewPart of this provider
*/ */
public void setViewPart(ViewPart viewPart) public void setViewPart(ViewPart viewPart)
{ {

2
rse/plugins/org.eclipse.rse.ui/filters/org/eclipse/rse/filters/ISystemFilterPoolManager.java
View file

@ -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 * Pre-test if we are going to run into any trouble renaming any of the files or folders
* used to persist a filter pool. * 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; public boolean preTestRenameFilterPool(ISystemFilterPool pool) throws Exception;
/** /**

2
rse/plugins/org.eclipse.rse.ui/filters/org/eclipse/rse/internal/filters/SystemFilterPoolManager.java
View file

@ -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 * Pre-test if we are going to run into any trouble renaming any of the files or folders
* used to persist a filter pool. * 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 public boolean preTestRenameFilterPool(ISystemFilterPool pool) throws Exception
{ {

6
rse/plugins/org.eclipse.rse.ui/systems/org/eclipse/rse/core/SystemBasePlugin.java
View file

@ -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 * 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. * file name should be qualified relative to this plugin's bundle.
* For example "icons/myicon.gif" * 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 * @return the image descriptor
*/ */
public ImageDescriptor getPluginImage(String imagePath) { 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 * Thus, image resources retrieved in this way need not be disposed by the
* caller. * 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. * @return the Image resource for this id.
*/ */
public Image getImage(String key) 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. * 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 * @return an ImageDescriptor
*/ */
public ImageDescriptor getImageDescriptor(String key) { public ImageDescriptor getImageDescriptor(String key) {