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

[226773] [apidoc] Improve SimpleSystemMessage Javadocs

Browse source
This commit is contained in:
Martin Oberhuber 2008-04-22 15:03:21 +00:00
parent ad15cc0be7
commit 9358c748de
1 changed files with 117 additions and 84 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

111
rse/plugins/org.eclipse.rse.services/clientserver/org/eclipse/rse/services/clientserver/messages/SimpleSystemMessage.java
View file

@ -28,13 +28,17 @@ public class SimpleSystemMessage extends SystemMessage {
private String _messageId; private String _messageId;
/** /**
* Constructor for messages that use explicit strings and severities rather than * Constructor for messages that use explicit Strings and severities.
* parsing a message file. This is part of the work to migrate away from the message
* file stuff.
* *
* Clients can use either globally unique RSE message IDs or plugin-specific local IDs. * This allows using the RSE Messaging Framework based on simple String
* messages and IDs, rather than using XML Message files from
* {@link SystemMessageFile} along with the
* <code>org.eclipse.rse.ui.SystemBasePlugin#loadMessageFile()</code> and
* <code>org.eclipse.rse.ui.SystemBasePlugin#getMessage()</code> methods.
* *
* RSE-global message IDs are of the form: RSE&lt;subcomponent&gt;&lt;number&gt; * Clients can use either globally unique RSE message IDs or plugin-specific
* local IDs. RSE-global message IDs are of the form:
* RSE&lt;subcomponent&gt;&lt;number&gt;
* *
* The subcomponent is a single character: * The subcomponent is a single character:
* <ul> * <ul>
@ -46,11 +50,13 @@ public class SimpleSystemMessage extends SystemMessage {
* *
* The number is a four digit number. * The number is a four digit number.
* *
* Plugin-specific local IDs need only be unique strings within a plugin that are not prefixed by "RSE". * Plugin-specific local IDs need only be unique strings within a plugin
* The relative IDs are qualified by the specified plugin ID. * that are not prefixed by "RSE". The relative IDs are qualified by the
* specified plugin ID.
* *
* @param pluginId the id of the originating plugin * @param pluginId the id of the originating plugin
* @param messageId the RSE-global unique ID or plugin-specific local ID of the message * @param messageId the RSE-global unique ID or plugin-specific local ID of
* the message
* @param severity using IStatus severities * @param severity using IStatus severities
* @param msg the message text * @param msg the message text
*/ */
@ -59,13 +65,17 @@ public class SimpleSystemMessage extends SystemMessage {
} }
/** /**
* Constructor for messages that use explicit strings and severities rather than * Constructor for messages that use explicit Strings and severities.
* parsing a message file. This is part of the work to migrate away from the message
* file stuff.
* *
* Clients can use either globally unique RSE message IDs or plugin-specific local IDs. * This allows using the RSE Messaging Framework based on simple String
* messages and IDs, rather than using XML Message files from
* {@link SystemMessageFile} along with the
* <code>org.eclipse.rse.ui.SystemBasePlugin#loadMessageFile()</code> and
* <code>org.eclipse.rse.ui.SystemBasePlugin#getMessage()</code> methods.
* *
* RSE-global message IDs are of the form: RSE&lt;subcomponent&gt;&lt;number&gt; * Clients can use either globally unique RSE message IDs or plugin-specific
* local IDs. RSE-global message IDs are of the form:
* RSE&lt;subcomponent&gt;&lt;number&gt;
* *
* The subcomponent is a single character: * The subcomponent is a single character:
* <ul> * <ul>
@ -77,11 +87,13 @@ public class SimpleSystemMessage extends SystemMessage {
* *
* The number is a four digit number. * The number is a four digit number.
* *
* Plugin-specific local IDs need only be unique strings within a plugin that are not prefixed by "RSE". * Plugin-specific local IDs need only be unique strings within a plugin
* The relative IDs are qualified by the specified plugin ID. * that are not prefixed by "RSE". The relative IDs are qualified by the
* specified plugin ID.
* *
* @param pluginId the id of the originating plugin * @param pluginId the id of the originating plugin
* @param messageId the RSE-global unique ID or plugin-specific local ID of the message * @param messageId the RSE-global unique ID or plugin-specific local ID of
* the message
* @param severity using IStatus severities * @param severity using IStatus severities
* @param msg the message text * @param msg the message text
* @param msgDetails the message details * @param msgDetails the message details
@ -94,13 +106,17 @@ public class SimpleSystemMessage extends SystemMessage {
} }
/** /**
* Constructor for messages that use explicit strings and severities rather than * Constructor for messages that use explicit Strings and severities.
* parsing a message file. This is part of the work to migrate away from the message
* file stuff.
* *
* Clients can use either globally unique RSE message IDs or plugin-specific local IDs. * This allows using the RSE Messaging Framework based on simple String
* messages and IDs, rather than using XML Message files from
* {@link SystemMessageFile} along with the
* <code>org.eclipse.rse.ui.SystemBasePlugin#loadMessageFile()</code> and
* <code>org.eclipse.rse.ui.SystemBasePlugin#getMessage()</code> methods.
* *
* RSE-global message IDs are of the form: RSE&lt;subcomponent&gt;&lt;number&gt; * Clients can use either globally unique RSE message IDs or plugin-specific
* local IDs. RSE-global message IDs are of the form:
* RSE&lt;subcomponent&gt;&lt;number&gt;
* *
* The subcomponent is a single character: * The subcomponent is a single character:
* <ul> * <ul>
@ -112,12 +128,14 @@ public class SimpleSystemMessage extends SystemMessage {
* *
* The number is a four digit number. * The number is a four digit number.
* *
* Plugin-specific local IDs need only be unique strings within a plugin that are not prefixed by "RSE". * Plugin-specific local IDs need only be unique strings within a plugin
* The relative IDs are qualified by the specified plugin ID. * that are not prefixed by "RSE". The relative IDs are qualified by the
* specified plugin ID.
* *
* *
* @param pluginId the id of the originating plugin * @param pluginId the id of the originating plugin
* @param messageId the RSE-global unique ID or plugin-specific local ID of the message * @param messageId the RSE-global unique ID or plugin-specific local ID of
* the message
* @param severity using IStatus severities * @param severity using IStatus severities
* @param msg the message text * @param msg the message text
* @param e an exception to convert into details * @param e an exception to convert into details
@ -129,12 +147,17 @@ public class SimpleSystemMessage extends SystemMessage {
} }
/** /**
* Constructor for messages that use explicit strings and severities rather than * Constructor for messages that use explicit Strings and severities.
* parsing a message file. This is part of the work to migrate away from the message
* file stuff.
* *
* This constructor does not supply a message id. It is preferred that a message id is used since * This allows using the RSE Messaging Framework based on simple String
* it allows easier identification of a unique message. * messages and IDs, rather than using XML Message files from
* {@link SystemMessageFile} along with the
* <code>org.eclipse.rse.ui.SystemBasePlugin#loadMessageFile()</code> and
* <code>org.eclipse.rse.ui.SystemBasePlugin#getMessage()</code> methods.
*
* This constructor does not supply a message id. It is preferred that a
* message id is used since it allows easier identification of a unique
* message.
* *
* @param pluginId the id of the originating plugin * @param pluginId the id of the originating plugin
* @param severity using IStatus severities * @param severity using IStatus severities
@ -145,12 +168,17 @@ public class SimpleSystemMessage extends SystemMessage {
} }
/** /**
* Constructor for messages that use explicit strings and severities rather than * Constructor for messages that use explicit Strings and severities.
* parsing a message file. This is part of the work to migrate away from the message
* file stuff.
* *
* This constructor does not supply a message id. It is preferred that a message id is used since * This allows using the RSE Messaging Framework based on simple String
* it allows easier identification of a unique message. * messages and IDs, rather than using XML Message files from
* {@link SystemMessageFile} along with the
* <code>org.eclipse.rse.ui.SystemBasePlugin#loadMessageFile()</code> and
* <code>org.eclipse.rse.ui.SystemBasePlugin#getMessage()</code> methods.
*
* This constructor does not supply a message id. It is preferred that a
* message id is used since it allows easier identification of a unique
* message.
* *
* @param pluginId the id of the originating plugin * @param pluginId the id of the originating plugin
* @param severity using IStatus severities * @param severity using IStatus severities
@ -164,12 +192,17 @@ public class SimpleSystemMessage extends SystemMessage {
} }
/** /**
* Constructor for messages that use explicit strings and severities rather than * Constructor for messages that use explicit Strings and severities.
* parsing a message file. This is part of the work to migrate away from the message
* file stuff.
* *
* This constructor does not supply a message id. It is preferred that a message id is used since * This allows using the RSE Messaging Framework based on simple String
* it allows easier identification of a unique message. * messages and IDs, rather than using XML Message files from
* {@link SystemMessageFile} along with the
* <code>org.eclipse.rse.ui.SystemBasePlugin#loadMessageFile()</code> and
* <code>org.eclipse.rse.ui.SystemBasePlugin#getMessage()</code> methods.
*
* This constructor does not supply a message id. It is preferred that a
* message id is used since it allows easier identification of a unique
* message.
* *
* @param pluginId the id of the originating plugin * @param pluginId the id of the originating plugin
* @param severity using IStatus severities * @param severity using IStatus severities