1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-13 12:05:21 +02:00

[cleanup] fix javadoc

This commit is contained in:
Martin Oberhuber 2007-04-02 19:08:09 +00:00
parent 45c9d7e84a
commit cd7ca5a088
2 changed files with 28 additions and 15 deletions

View file

@ -12,7 +12,7 @@
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley. * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
* *
* Contributors: * Contributors:
* {Name} (company) - description of contribution. * Martin Oberhuber (WindRiver) - [cleanup] Fix javadoc
*******************************************************************************/ *******************************************************************************/
package org.eclipse.rse.internal.subsystems.files.core.model; package org.eclipse.rse.internal.subsystems.files.core.model;
@ -78,48 +78,56 @@ public class RemotePath implements IRemotePath {
} }
/** /**
* @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#setProfileName(java.lang.String) * Set the profile name.
* @param profileName the profile name.
*/ */
protected void setProfileName(String profileName) { protected void setProfileName(String profileName) {
this.profileName = profileName; this.profileName = profileName;
} }
/** /**
* @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#setConnectionName(java.lang.String) * Set the connection name.
* @param connectionName the connection name.
*/ */
protected void setConnectionName(String connectionName) { protected void setConnectionName(String connectionName) {
this.connectionName = connectionName; this.connectionName = connectionName;
} }
/** /**
* @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#setAbsolutePath(java.lang.String) * Set the absolute path string below the connection.
* Interpretation of this string is up to the subsystem.
* @param absolutePath the absolute path string.
*/ */
protected void setAbsolutePath(String absolutePath) { protected void setAbsolutePath(String absolutePath) {
this.absolutePath = absolutePath; this.absolutePath = absolutePath;
} }
/** /*
* (non-Javadoc)
* @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#getProfileName() * @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#getProfileName()
*/ */
public String getProfileName() { public String getProfileName() {
return profileName; return profileName;
} }
/** /*
* (non-Javadoc)
* @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#getConnectionName() * @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#getConnectionName()
*/ */
public String getConnectionName() { public String getConnectionName() {
return connectionName; return connectionName;
} }
/** /*
* (non-Javadoc)
* @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#getAbsolutePath() * @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#getAbsolutePath()
*/ */
public String getAbsolutePath() { public String getAbsolutePath() {
return absolutePath; return absolutePath;
} }
/** /*
* (non-Javadoc)
* @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#getFullyQualifiedPath() * @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#getFullyQualifiedPath()
*/ */
public String getFullyQualifiedPath() { public String getFullyQualifiedPath() {
@ -132,7 +140,8 @@ public class RemotePath implements IRemotePath {
} }
} }
/** /*
* (non-Javadoc)
* @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#getFileExtension() * @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#getFileExtension()
*/ */
public String getFileExtension() { public String getFileExtension() {
@ -159,7 +168,8 @@ public class RemotePath implements IRemotePath {
} }
} }
/** /*
* (non-Javadoc)
* @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#addFileExtension(java.lang.String) * @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#addFileExtension(java.lang.String)
*/ */
public IRemotePath addFileExtension(String extension) { public IRemotePath addFileExtension(String extension) {
@ -177,8 +187,9 @@ public class RemotePath implements IRemotePath {
} }
} }
/** /*
* @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#removeFileExtension(java.lang.String) * (non-Javadoc)
* @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#removeFileExtension()
*/ */
public IRemotePath removeFileExtension() { public IRemotePath removeFileExtension() {
@ -202,14 +213,16 @@ public class RemotePath implements IRemotePath {
} }
} }
/** /*
* (non-Javadoc)
* @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#isVirtual() * @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#isVirtual()
*/ */
public boolean isVirtual() { public boolean isVirtual() {
return ArchiveHandlerManager.isVirtual(absolutePath); return ArchiveHandlerManager.isVirtual(absolutePath);
} }
/** /*
* (non-Javadoc)
* @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#toRemoteFile() * @see org.eclipse.rse.subsystems.files.core.model.IRemotePath#toRemoteFile()
*/ */
public IRemoteFile toRemoteFile() { public IRemoteFile toRemoteFile() {

View file

@ -72,7 +72,7 @@ public interface IRemotePath {
* defined as the string following the last period (".") character in the path. If this path ends * defined as the string following the last period (".") character in the path. If this path ends
* with a separator, i.e. '/' or '\\', or if it does not have an extension, then this path is returned. * with a separator, i.e. '/' or '\\', or if it does not have an extension, then this path is returned.
* The given extension should not include a leading ".". * The given extension should not include a leading ".".
* @param the new path. * @return path with the file extension removed.
*/ */
public IRemotePath removeFileExtension(); public IRemotePath removeFileExtension();