mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-08-29 11:13:34 +02:00
[226773] [apidoc] Improve SimpleSystemMessage Javadocs
This commit is contained in:
Martin Oberhuber
parent
ad15cc0be7
commit
9358c748de
1 changed files with 117 additions and 84 deletions
|
|
@ -28,13 +28,17 @@ public class SimpleSystemMessage extends SystemMessage {
|
|||
private String _messageId;
|
||||
|
||||
/**
|
||||
* Constructor for messages that use explicit strings and severities rather than
|
||||
* parsing a message file. This is part of the work to migrate away from the message
|
||||
* file stuff.
|
||||
* Constructor for messages that use explicit Strings and severities.
|
||||
*
|
||||
* 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<subcomponent><number>
|
||||
* Clients can use either globally unique RSE message IDs or plugin-specific
|
||||
* local IDs. RSE-global message IDs are of the form:
|
||||
* RSE<subcomponent><number>
|
||||
*
|
||||
* The subcomponent is a single character:
|
||||
* <ul>
|
||||
|
|
@ -46,11 +50,13 @@ public class SimpleSystemMessage extends SystemMessage {
|
|||
*
|
||||
* 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".
|
||||
* The relative IDs are qualified by the specified plugin ID.
|
||||
* Plugin-specific local IDs need only be unique strings within a plugin
|
||||
* 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 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 msg the message text
|
||||
*/
|
||||
|
|
@ -59,13 +65,17 @@ public class SimpleSystemMessage extends SystemMessage {
|
|||
}
|
||||
|
||||
/**
|
||||
* Constructor for messages that use explicit strings and severities rather than
|
||||
* parsing a message file. This is part of the work to migrate away from the message
|
||||
* file stuff.
|
||||
* Constructor for messages that use explicit Strings and severities.
|
||||
*
|
||||
* 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<subcomponent><number>
|
||||
* Clients can use either globally unique RSE message IDs or plugin-specific
|
||||
* local IDs. RSE-global message IDs are of the form:
|
||||
* RSE<subcomponent><number>
|
||||
*
|
||||
* The subcomponent is a single character:
|
||||
* <ul>
|
||||
|
|
@ -77,11 +87,13 @@ public class SimpleSystemMessage extends SystemMessage {
|
|||
*
|
||||
* 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".
|
||||
* The relative IDs are qualified by the specified plugin ID.
|
||||
* Plugin-specific local IDs need only be unique strings within a plugin
|
||||
* 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 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 msg the message text
|
||||
* @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
|
||||
* parsing a message file. This is part of the work to migrate away from the message
|
||||
* file stuff.
|
||||
* Constructor for messages that use explicit Strings and severities.
|
||||
*
|
||||
* 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<subcomponent><number>
|
||||
* Clients can use either globally unique RSE message IDs or plugin-specific
|
||||
* local IDs. RSE-global message IDs are of the form:
|
||||
* RSE<subcomponent><number>
|
||||
*
|
||||
* The subcomponent is a single character:
|
||||
* <ul>
|
||||
|
|
@ -112,12 +128,14 @@ public class SimpleSystemMessage extends SystemMessage {
|
|||
*
|
||||
* 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".
|
||||
* The relative IDs are qualified by the specified plugin ID.
|
||||
* Plugin-specific local IDs need only be unique strings within a plugin
|
||||
* 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 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 msg the message text
|
||||
* @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
|
||||
* parsing a message file. This is part of the work to migrate away from the message
|
||||
* file stuff.
|
||||
* Constructor for messages that use explicit Strings and severities.
|
||||
*
|
||||
* 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.
|
||||
* 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.
|
||||
*
|
||||
* 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 severity using IStatus severities
|
||||
|
|
@ -145,12 +168,17 @@ public class SimpleSystemMessage extends SystemMessage {
|
|||
}
|
||||
|
||||
/**
|
||||
* Constructor for messages that use explicit strings and severities rather than
|
||||
* parsing a message file. This is part of the work to migrate away from the message
|
||||
* file stuff.
|
||||
* Constructor for messages that use explicit Strings and severities.
|
||||
*
|
||||
* 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.
|
||||
* 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.
|
||||
*
|
||||
* 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 severity using IStatus severities
|
||||
|
|
@ -164,12 +192,17 @@ public class SimpleSystemMessage extends SystemMessage {
|
|||
}
|
||||
|
||||
/**
|
||||
* Constructor for messages that use explicit strings and severities rather than
|
||||
* parsing a message file. This is part of the work to migrate away from the message
|
||||
* file stuff.
|
||||
* Constructor for messages that use explicit Strings and severities.
|
||||
*
|
||||
* 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.
|
||||
* 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.
|
||||
*
|
||||
* 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 severity using IStatus severities
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue