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

[cleanup] logger javadoc

Browse source
This commit is contained in:
David Dykstal 2006-08-17 13:40:33 +00:00
parent 00edba06f7
commit 140cb9a9fe
2 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
rse/plugins/org.eclipse.rse.logging/src/org/eclipse/rse/logging/Logger.java
View file

@ -131,8 +131,9 @@ public class Logger implements IPropertyChangeListener {
/** /**
* Log an Error message with an exception. Note that the message should already * Log an Error message with an exception. Note that the message should already
* be localized to proper local.<br> * be localized to proper locale.
* ie: Resource.getString() should already have been called * @param message the message to log.
* @param ex the exception that caused the condition, may be null.
*/ */
public synchronized void logError(String message, Throwable ex) { public synchronized void logError(String message, Throwable ex) {
if (debug_level >= IRemoteSystemsLogging.LOG_ERROR) { if (debug_level >= IRemoteSystemsLogging.LOG_ERROR) {

7
rse/plugins/org.eclipse.rse.logging/src/org/eclipse/rse/logging/LoggerFactory.java
View file

@ -33,6 +33,8 @@ public class LoggerFactory {
/** /**
* Returns the Logger instance for a given plugin. There is only * Returns the Logger instance for a given plugin. There is only
* one instance of the Logger class per plugin. * one instance of the Logger class per plugin.
* @param plugin the plugin for which to find or create the log
* @return the logger for that plugin
*/ */
public static Logger getLogger(Plugin plugin) { public static Logger getLogger(Plugin plugin) {
Logger logger = (Logger) pluginTable.get(plugin); Logger logger = (Logger) pluginTable.get(plugin);
@ -44,8 +46,9 @@ public class LoggerFactory {
} }
/** /**
* Frees resources used by the Logger instance for the given plugin.<br> * Frees resources used by the Logger instance for the given plugin.
* This methods must be called as part of the the plugin shutdown life cycle. * This method must be called as part of the the plugin shutdown life cycle.
* @param plugin the plugin for which to free logging resources
*/ */
public static void freeLogger(Plugin plugin) { public static void freeLogger(Plugin plugin) {
Logger logger = (Logger) pluginTable.get(plugin); Logger logger = (Logger) pluginTable.get(plugin);