1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-21 15:23:59 +02:00

[releng][cleanup] Fix @since tags according to API Tooling

This commit is contained in:
Martin Oberhuber 2008-06-04 09:31:55 +00:00
parent ad994314e3
commit 7eedb21637

View file

@ -21,7 +21,7 @@
* David McKnight (IBM) [224906] [dstore] changes for getting properties and doing exit due to single-process capability * David McKnight (IBM) [224906] [dstore] changes for getting properties and doing exit due to single-process capability
* David McKnight (IBM) - [225507][api][breaking] RSE dstore API leaks non-API types * David McKnight (IBM) - [225507][api][breaking] RSE dstore API leaks non-API types
* David McKnight (IBM) - [227881] [dstore][threaded] There is no chance to set client object for getUserPreferencesDirectory() * David McKnight (IBM) - [227881] [dstore][threaded] There is no chance to set client object for getUserPreferencesDirectory()
* Norikai Takatsu (IBM) - [228156] [dstore] DataElementRemover thread doesn't terminate after a client disconnects the server * Noriaki Takatsu (IBM) - [228156] [dstore] DataElementRemover thread doesn't terminate after a client disconnects the server
* David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed
* David McKnight (IBM) - [231639] [dstore] in single-process multi-client mode tracing shouldn't start until the client is set * David McKnight (IBM) - [231639] [dstore] in single-process multi-client mode tracing shouldn't start until the client is set
*******************************************************************************/ *******************************************************************************/
@ -330,10 +330,10 @@ public final class DataStore
return false; return false;
} }
/** /**
* Specifies the security properties of this DataStore. * Specifies the security properties of this DataStore. These properties
* These properties indicate whether or not to use ssl, * indicate whether or not to use SSL, the keystore location and password.
* the keystore location and password. *
* @param properties * @param properties the properties to set
*/ */
public void setSSLProperties(ISSLProperties properties) public void setSSLProperties(ISSLProperties properties)
{ {
@ -2166,7 +2166,8 @@ public final class DataStore
/** /**
* Adds a preference change listener to the DataStore * Adds a preference change listener to the DataStore
* @param listener *
* @param listener the listener to add
* @since 3.0 * @since 3.0
*/ */
public void addDataStorePreferenceListener(IDataStorePreferenceListener listener){ public void addDataStorePreferenceListener(IDataStorePreferenceListener listener){
@ -2175,7 +2176,8 @@ public final class DataStore
/** /**
* Removes a specific preference change listener from the Datastore * Removes a specific preference change listener from the Datastore
* @param listener *
* @param listener the listener to remove
* @since 3.0 * @since 3.0
*/ */
public void removeDataStorePreferenceListener(IDataStorePreferenceListener listener){ public void removeDataStorePreferenceListener(IDataStorePreferenceListener listener){
@ -4372,11 +4374,17 @@ public final class DataStore
referenceTag = tag; referenceTag = tag;
} }
/**
* @since 3.0
*/
public int printTree(String indent, DataElement root) public int printTree(String indent, DataElement root)
{ {
return printTree(indent, 0, root); return printTree(indent, 0, root);
} }
/**
* @since 3.0
*/
public int printTree(String indent, int number, DataElement root) public int printTree(String indent, int number, DataElement root)
{ {
int total = number; int total = number;
@ -4403,9 +4411,11 @@ public final class DataStore
} }
/** /**
* Indicates that the datastore should transfer a DataElement's buffer attribute * Indicates that the datastore should transfer a DataElement's buffer
* in the communication layer * attribute in the communication layer
*
* @param flag true if the DataElement buffer attribute should be transfered * @param flag true if the DataElement buffer attribute should be transfered
* @since 3.0
*/ */
public void setGenerateBuffer(boolean flag) public void setGenerateBuffer(boolean flag)
{ {
@ -4422,16 +4432,17 @@ public final class DataStore
} }
/** /**
* This method is used to set the Client object for each user. * This method is used to set the Client object for each user. The _client
* The _client variable is null until setClient() is called. After * variable is null until setClient() is called. After _client is set, it
* _client is set, it can not be changed. * can not be changed.
* *
* This method should only be called once to associate a particular * This method should only be called once to associate a particular client
* client with a DataStore. By default, the client for the user of * with a DataStore. By default, the client for the user of the DataStore
* the DataStore process is set but, when there is an ISystemService, * process is set but, when there is an ISystemService, the daemon sets the
* the daemon sets the client. * client.
* *
* @param client the object of the Client class * @param client the object of the Client class
* @since 3.0
*/ */
public void setClient(Client client) public void setClient(Client client)
{ {
@ -4464,6 +4475,7 @@ public final class DataStore
* This method is used to get the object of the Client stored for each user. * This method is used to get the object of the Client stored for each user.
* *
* @return the object of the Client stored for each user * @return the object of the Client stored for each user
* @since 3.0
*/ */
public Client getClient() public Client getClient()
{ {