1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-14 04:25:21 +02:00

[cleanup] improve documentation of new SubSystemProxyComparator

This commit is contained in:
Martin Oberhuber 2006-08-18 07:45:26 +00:00
parent c0d3e5773d
commit ab48d5ac32
2 changed files with 20 additions and 9 deletions

View file

@ -37,6 +37,11 @@ subsystems.
</annotation> </annotation>
<element name="extension"> <element name="extension">
<annotation>
<documentation>
(no description available)
</documentation>
</annotation>
<complexType> <complexType>
<sequence> <sequence>
<element ref="configuration" minOccurs="1" maxOccurs="unbounded"/> <element ref="configuration" minOccurs="1" maxOccurs="unbounded"/>
@ -75,8 +80,8 @@ subsystems.
<attribute name="id" type="string" use="required"> <attribute name="id" type="string" use="required">
<annotation> <annotation>
<documentation> <documentation>
A unique ID for this subsystem configuration. This will be used as a folder name for A unique ID for this subsystem configuration. This will be used by persistency
information contained by the subsystem configuration, or by any of its subsystems. as a folder name for information contained by the subsystem configuration, or by any of its subsystems.
</documentation> </documentation>
</annotation> </annotation>
</attribute> </attribute>
@ -107,24 +112,27 @@ a path to the icon&apos;s .gif file, relative to your plugin directory.
<attribute name="class" type="string" use="required"> <attribute name="class" type="string" use="required">
<annotation> <annotation>
<documentation> <documentation>
A class that implements &lt;samp&gt;org.eclipse.rse.core.subsystems.SubSystemConfiguration&lt;/samp&gt; A class that implements &lt;samp&gt;org.eclipse.rse.core.subsystems.ISubSystemConfiguration&lt;/samp&gt;.
It is recommended to extend &lt;samp&gt;org.eclipse.rse.core.subsystems.SubSystemConfiguration&lt;/samp&gt; or &lt;samp&gt;org.eclipse.rse.core.servicesubsystem.ServiceSubSystemConfiguration&lt;/samp&gt;.
</documentation> </documentation>
<appInfo>
<meta.attribute kind="java" basedOn="org.eclipse.rse.core.subsystems.SubSystemConfiguration:org.eclipse.rse.core.subsystems.ISubSystemConfiguration"/>
</appInfo>
</annotation> </annotation>
</attribute> </attribute>
<attribute name="name" type="string" use="required"> <attribute name="name" type="string" use="required">
<annotation> <annotation>
<documentation> <documentation>
Translatable name for subsystems created by this configuration. These appear immediately Translatable name for subsystems created by this configuration.
under a connection when the connection is expanded in the Remote Systems view of the These appear immediately under a connection when the connection is expanded in the Remote Systems view of the Remote System Explorer perspective.
Remote System Explorer perspective.
</documentation> </documentation>
</annotation> </annotation>
</attribute> </attribute>
<attribute name="description" type="string" use="required"> <attribute name="description" type="string" use="required">
<annotation> <annotation>
<documentation> <documentation>
Translatable description for subsystems created by this configuration. These appear in configuration Translatable description for subsystems created by this configuration.
and properties pages for subsystems. These appear in configuration and properties pages for subsystems.
</documentation> </documentation>
</annotation> </annotation>
</attribute> </attribute>
@ -167,7 +175,9 @@ category of &quot;database&quot;.
<attribute name="priority" type="string"> <attribute name="priority" type="string">
<annotation> <annotation>
<documentation> <documentation>
This optional attribute determines the order in which subsystems appear in the New Connection wizard and RSE views. The lower the number, the higher the priority. This optional attribute determines the order in which subsystems appear in the New Connection wizard and RSE views. Integer values are allowed. Subsystems with lower number will appear first in the RSE tree. Subsystems that do not define the priority attribute will be appended last to the list of subsystems.
Note that ServiceSubSystems that share the same service should always use the same priority, since their service implementation can change at runtime. The following priorities are used by the predefined subsystems: files=100, processes=200, shells=300.
</documentation> </documentation>
</annotation> </annotation>
</attribute> </attribute>

View file

@ -14,6 +14,7 @@ public class SubSystemConfigurationProxyComparator implements Comparator {
/** /**
* Compares priorities of subsystem configuration proxies. * Compares priorities of subsystem configuration proxies.
* @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
*/ */
public int compare(Object o1, Object o2) { public int compare(Object o1, Object o2) {