mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-09 18:15:23 +02:00
Code Issues Wiki Activity

Improve Javadoc as discussed in committer meeting 20070515

Browse source
This commit is contained in:
Martin Oberhuber 2007-05-15 20:04:59 +00:00
parent 426bb8bfd1
commit eb490366e0
1 changed files with 14 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSESystemType.java
View file

@ -164,12 +164,19 @@ public interface IRSESystemType extends IAdaptable {
* System type Property Key (value: "isWindows") indicating whether * System type Property Key (value: "isWindows") indicating whether
* a system type is declared in plugin.xml to refers to a Windows * a system type is declared in plugin.xml to refers to a Windows
* system. * system.
* On a Windows system, the following properties are expected: * <p>
* This is an "aggregate" property consisting of several smaller
* properties like isCaseSensitive. In the future, we'll want more
* fine granular properties to check against. On a Windows system,
* the following properties are expected:
* <ul> * <ul>
* <li>File system is not case sensitive</li> * <li>File system is not case sensitive</li>
* <li>File system has root drives</li> * <li>File system has root drives</li>
* <li>Symbolic links are not supported</li> * <li>Symbolic links are not supported</li>
* <li>"cmd" is used as the default shell</li> * <li>"cmd" is used as the default shell, meaning that %envVar% refers to environment variables</li>
* <li>Path separator is backslash (\)</li>
* <li>Line end character is CRLF</li>
* <li>Valid characters in file names and paths as known on Windows</li>
* </ul> * </ul>
* @see #testProperty(String, boolean) * @see #testProperty(String, boolean)
*/ */
@ -240,7 +247,7 @@ public interface IRSESystemType extends IAdaptable {
* This is a shortcut for * This is a shortcut for
* <pre> * <pre>
* getId().equals(SYSTEMTYPE_LOCAL_ID) || * getId().equals(SYSTEMTYPE_LOCAL_ID) ||
* || getProperty(PROPERTY_IS_LOCAL, false) * || testProperty(PROPERTY_IS_LOCAL, true)
* </pre> * </pre>
* See {@link #PROPERTY_IS_LOCAL} for properties expected on * See {@link #PROPERTY_IS_LOCAL} for properties expected on
* a Local system. * a Local system.
@ -255,10 +262,12 @@ public interface IRSESystemType extends IAdaptable {
* <pre> * <pre>
* getId().equals(SYSTEMTYPE_WINDOWS_ID) * getId().equals(SYSTEMTYPE_WINDOWS_ID)
* || isLocal() && System.getProperty("os.name").toLowerCase().startsWith("win") * || isLocal() && System.getProperty("os.name").toLowerCase().startsWith("win")
* || getProperty(PROPERTY_IS_WINDOWS, false) * || testProperty(PROPERTY_IS_WINDOWS, true)
* </pre> * </pre>
* See {@link #PROPERTY_IS_WINDOWS} for properties expected on * See {@link #PROPERTY_IS_WINDOWS} for properties expected on
* a Windows system. * a Windows system. This is an "aggregate" property consisting
* of several smaller properties like isCaseSensitive. In the
* future, we'll want more fine granular properties to check against.
* Extenders (contributors of custom system types) may override. * Extenders (contributors of custom system types) may override.
* @return true if the system type refers to a Windows system. * @return true if the system type refers to a Windows system.
*/ */