mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-29 19:45:01 +02:00
Code Issues Wiki Activity

bug 388755: Cosmetics - avoid syntax warnings in comments

Browse source
This commit is contained in:
Andrew Gvozdev 2012-09-05 16:20:33 -04:00
parent 8fb2b6a3c6
commit 887ec0b8a1
1 changed files with 18 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/EFSExtensionProvider.java
View file

@ -20,24 +20,24 @@ import org.eclipse.core.runtime.URIUtil;
/** /**
* Abstract class providing the basis for supplementary support classes that can extract meaningful * Abstract class providing the basis for supplementary support classes that can extract meaningful
* information from and provide useful operations on EFS filesystems. This allows for operations that can * information from and provide useful operations on EFS file-systems. This allows for operations that can
* operate on virtual EFS filesystems (where IFileStores are just links to other IFileStores), or that operate * operate on virtual EFS file-systems (where IFileStores are just links to other IFileStores), or that operate
* on the physical file backed by an IFileStore, without having to know the implementation details of a given * on the physical file backed by an IFileStore, without having to know the implementation details of a given
* EFS filesystem. * EFS file-system.
* *
* Provides a default implementation that assumes that URIs for the given filesystem map directly to resources * Provides a default implementation that assumes that URIs for the given file-system map directly to resources
* in the physical filesystem, and that the path component of the URI is a direct representation of the * in the physical file-system, and that the path component of the URI is a direct representation of the
* absolute path to the file in the physical filesystem. * absolute path to the file in the physical file-system.
* *
* Clients wishing to support a filesystem with different behaviour should extend this class and override its * Clients wishing to support a file-system with different behavior should extend this class and override its
* methods where appropriate. * methods where appropriate.
* *
* Clients should not typically call methods on this class or its descendants directly. Instead, they should * Clients should not typically call methods on this class or its descendants directly. Instead, they should
* call the appropriate method in FileSystemUtilityManager so that said manager can properly route calls to * call the appropriate method in FileSystemUtilityManager so that said manager can properly route calls to
* the proper utility, depending on the filesystem. * the proper utility, depending on the file-system.
* *
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as part of a work in progress. There * <strong>EXPERIMENTAL</strong>. This class or interface has been added to CDT 7.0 as part of a work in progress.
* is no guarantee that this API will work or that it will remain the same. Please do not use this API without * There is no guarantee that this API will work or that it will remain the same. Please do not use this API without
* consulting with the CDT team. * consulting with the CDT team.
* *
* @author crecoskie * @author crecoskie
@ -68,8 +68,8 @@ public abstract class EFSExtensionProvider {
} }
/** /**
* In the case of a virtual filesystem, where URIs in the given filesystem are just soft links in EFS to * In the case of a virtual file-system, where URIs in the given file-system are just soft links in EFS to
* URIs in other filesystems, returns the URI that this URI links to. If the filesystem is not virtual, * URIs in other file-systems, returns the URI that this URI links to. If the file-system is not virtual,
* then this method acts as an identity mapping. * then this method acts as an identity mapping.
* *
* @param locationURI * @param locationURI
@ -87,7 +87,7 @@ public abstract class EFSExtensionProvider {
* The default implementation places the path in the path field of the URI, ensuring that there is a leading slash. * The default implementation places the path in the path field of the URI, ensuring that there is a leading slash.
* It also determines whether or not to convert backslashes in the provided path based on whether or not the * It also determines whether or not to convert backslashes in the provided path based on whether or not the
* local operating system's file separator is a backslash, thus ensuring proper behaviour for URIs corresponding * local operating system's file separator is a backslash, thus ensuring proper behaviour for URIs corresponding
* to the local filesystem. * to the local file-system.
* *
* @param locationOnSameFilesystem * @param locationOnSameFilesystem
* @param path An absolute path. * @param path An absolute path.
@ -121,14 +121,14 @@ public abstract class EFSExtensionProvider {
} }
/** /**
* For filesystems that map the path to a physical file in one filesystem (say on a remote machine) to * For file-systems that map the path to a physical file in one file-system (say on a remote machine) to
* another path (say, on the local machine), this method returns the path that the store maps to. I.e., it * another path (say, on the local machine), this method returns the path that the store maps to. I.e., it
* returns the path that the path returned by getPathFromURI(URI locationURI) maps to. If there is no such * returns the path that the path returned by getPathFromURI(URI locationURI) maps to. If there is no such
* mapping, then an identity mapping of the paths is assumed. * mapping, then an identity mapping of the paths is assumed.
* *
* Typically if a filesystem maps one filesytem to another, it will place the mapped path in the path * Typically if a file-system maps one file-system to another, it will place the mapped path in the path
* field of its URIs (which the default implementation assumes), but this is not guaranteed to be so for * field of its URIs (which the default implementation assumes), but this is not guaranteed to be so for
* all filesystem implementations. * all file-system implementations.
* *
* @return String representing the path, or <code>null</code> on error. * @return String representing the path, or <code>null</code> on error.
*/ */
@ -137,8 +137,8 @@ public abstract class EFSExtensionProvider {
} }
/** /**
* Returns true if the given URI is part of a virtual filesystem and thus points to another underlying * Returns true if the given URI is part of a virtual file-system and thus points to another underlying
* URI. Returns false otherwise. By default, filesystems are assumed to be non-virtual. * URI. Returns false otherwise. By default, file-systems are assumed to be non-virtual.
* *
* @param locationURI * @param locationURI
* @return boolean * @return boolean