1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-29 11:55:40 +02:00

[cleanup] fix javadoc warnings

This commit is contained in:
Martin Oberhuber 2006-11-08 16:30:14 +00:00
parent 1dda85ab0d
commit 4477ea60b3

View file

@ -31,34 +31,33 @@ public interface ICommunicationsDiagnostic extends Runnable {
/** /**
* Setup for the diagnostic * Setup for the diagnostic
* *
* @param * @param id assign an ID for this diagnostic instance
* String id: assign an ID for this diagnostic instance * @param quiet true if user to be prompted for a dialog
* boolean quiet: true if user to be prompted for a dialog * @param server the host network name
* String server: the host network name * @param system the connection to be investigated
* IConnectorService system: the connection to be investigated * @param str1 optional string
* String str1, str2, str3: optional strings * @param str2 optional string
* @param str3 optional string
*/ */
public void setUp(String id, boolean quiet, String server, IConnectorService system, String str1, String str2, String str3); public void setUp(String id, boolean quiet, String server, IConnectorService system, String str1, String str2, String str3);
/** /**
* Log an error in the .log file * Log an error in the .log file
* *
* @param * @param text message text to be logged
* String text: message text to be logged
*/ */
public void logError(String text); public void logError(String text);
/** /**
* Check if network is down * Check if network is down
* @param None
* @return true or false
* *
* @return true or false
*/ */
public boolean isNetworkDown(); public boolean isNetworkDown();
/** /**
* Check if host server is still active * Check if host server is still active
* @param None *
* @return true or false * @return true or false
*/ */
public boolean isServerActive(); public boolean isServerActive();
@ -66,8 +65,7 @@ public interface ICommunicationsDiagnostic extends Runnable {
/** /**
* Dispaly a message dialog * Dispaly a message dialog
* *
* @param * @param id message to be displayed.
* int id: message to be displayed.
*/ */
public void displayMessage(String id); public void displayMessage(String id);