mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-08-29 19:23:38 +02:00
[cleanup] Add API "since" Javadoc tags
This commit is contained in:
parent
9b92fbe699
commit
b91376bf09
3 changed files with 81 additions and 42 deletions
|
@ -20,9 +20,15 @@
|
||||||
<arguments>
|
<arguments>
|
||||||
</arguments>
|
</arguments>
|
||||||
</buildCommand>
|
</buildCommand>
|
||||||
|
<buildCommand>
|
||||||
|
<name>org.eclipse.pde.api.tools.apiAnalysisBuilder</name>
|
||||||
|
<arguments>
|
||||||
|
</arguments>
|
||||||
|
</buildCommand>
|
||||||
</buildSpec>
|
</buildSpec>
|
||||||
<natures>
|
<natures>
|
||||||
<nature>org.eclipse.pde.PluginNature</nature>
|
<nature>org.eclipse.pde.PluginNature</nature>
|
||||||
<nature>org.eclipse.jdt.core.javanature</nature>
|
<nature>org.eclipse.jdt.core.javanature</nature>
|
||||||
|
<nature>org.eclipse.pde.api.tools.apiAnalysisNature</nature>
|
||||||
</natures>
|
</natures>
|
||||||
</projectDescription>
|
</projectDescription>
|
||||||
|
|
|
@ -15,6 +15,7 @@
|
||||||
* Martin Oberhuber (Wind River) - [183165] Do not implement constant interfaces
|
* Martin Oberhuber (Wind River) - [183165] Do not implement constant interfaces
|
||||||
* David McKnight (IBM) - [196624] dstore miner IDs should be String constants rather than dynamic lookup
|
* David McKnight (IBM) - [196624] dstore miner IDs should be String constants rather than dynamic lookup
|
||||||
* David McKnight (IBM) - [209593] [api] add support for "file permissions" and "owner" properties for unix files
|
* David McKnight (IBM) - [209593] [api] add support for "file permissions" and "owner" properties for unix files
|
||||||
|
* Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
|
||||||
*******************************************************************************/
|
*******************************************************************************/
|
||||||
|
|
||||||
package org.eclipse.rse.dstore.universal.miners;
|
package org.eclipse.rse.dstore.universal.miners;
|
||||||
|
@ -30,9 +31,33 @@ public interface IUniversalDataStoreConstants
|
||||||
/*
|
/*
|
||||||
* Miner IDs
|
* Miner IDs
|
||||||
*/
|
*/
|
||||||
|
/**
|
||||||
|
* Universal Filesystem miner ID. Value =
|
||||||
|
* "org.eclipse.rse.dstore.universal.miners.UniversalFileSystemMiner".
|
||||||
|
*
|
||||||
|
* @since org.eclipse.rse.services.dstore 3.0
|
||||||
|
*/
|
||||||
public static final String UNIVERSAL_FILESYSTEM_MINER_ID = "org.eclipse.rse.dstore.universal.miners.UniversalFileSystemMiner"; //$NON-NLS-1$
|
public static final String UNIVERSAL_FILESYSTEM_MINER_ID = "org.eclipse.rse.dstore.universal.miners.UniversalFileSystemMiner"; //$NON-NLS-1$
|
||||||
|
/**
|
||||||
|
* Universal Command miner ID. Value =
|
||||||
|
* "org.eclipse.rse.dstore.universal.miners.CommandMiner".
|
||||||
|
*
|
||||||
|
* @since org.eclipse.rse.services.dstore 3.0
|
||||||
|
*/
|
||||||
public static final String UNIVERSAL_COMMAND_MINER_ID = "org.eclipse.rse.dstore.universal.miners.CommandMiner"; //$NON-NLS-1$
|
public static final String UNIVERSAL_COMMAND_MINER_ID = "org.eclipse.rse.dstore.universal.miners.CommandMiner"; //$NON-NLS-1$
|
||||||
|
/**
|
||||||
|
* Universal Environment miner ID. Value =
|
||||||
|
* "org.eclipse.rse.dstore.universal.miners.EnvironmentMiner".
|
||||||
|
*
|
||||||
|
* @since org.eclipse.rse.services.dstore 3.0
|
||||||
|
*/
|
||||||
public static final String UNIVERSAL_ENVIRONMENT_MINER_ID = "org.eclipse.rse.dstore.universal.miners.EnvironmentMiner"; //$NON-NLS-1$
|
public static final String UNIVERSAL_ENVIRONMENT_MINER_ID = "org.eclipse.rse.dstore.universal.miners.EnvironmentMiner"; //$NON-NLS-1$
|
||||||
|
/**
|
||||||
|
* Universal Process miner ID. Value =
|
||||||
|
* "org.eclipse.rse.dstore.universal.miners.UniversalProcessMiner".
|
||||||
|
*
|
||||||
|
* @since org.eclipse.rse.services.dstore 3.0
|
||||||
|
*/
|
||||||
public static final String UNIVERSAL_PROCESS_MINER_ID = "org.eclipse.rse.dstore.universal.miners.UniversalProcessMiner"; //$NON-NLS-1$
|
public static final String UNIVERSAL_PROCESS_MINER_ID = "org.eclipse.rse.dstore.universal.miners.UniversalProcessMiner"; //$NON-NLS-1$
|
||||||
|
|
||||||
|
|
||||||
|
@ -100,6 +125,7 @@ public interface IUniversalDataStoreConstants
|
||||||
|
|
||||||
// permissions commands
|
// permissions commands
|
||||||
public static final String C_QUERY_FILE_PERMISSIONS = "C_QUERY_FILE_PERMISSIONS"; //$NON-NLS-1$
|
public static final String C_QUERY_FILE_PERMISSIONS = "C_QUERY_FILE_PERMISSIONS"; //$NON-NLS-1$
|
||||||
|
/** @since org.eclipse.rse.services.dstore 3.0 */
|
||||||
public static final String C_SET_FILE_PERMISSIONS = "C_SET_FILE_PERMISSIONS"; //$NON-NLS-1$
|
public static final String C_SET_FILE_PERMISSIONS = "C_SET_FILE_PERMISSIONS"; //$NON-NLS-1$
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -12,21 +12,28 @@
|
||||||
*
|
*
|
||||||
* Contributors:
|
* Contributors:
|
||||||
* Noriaki Takatsu (IBM) - [220126] [dstore][api][breaking] Single process server for multiple clients
|
* Noriaki Takatsu (IBM) - [220126] [dstore][api][breaking] Single process server for multiple clients
|
||||||
|
* Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
|
||||||
********************************************************************************/
|
********************************************************************************/
|
||||||
|
|
||||||
package org.eclipse.rse.dstore.universal.miners;
|
package org.eclipse.rse.dstore.universal.miners;
|
||||||
|
|
||||||
import org.eclipse.dstore.core.model.DataStore;
|
import org.eclipse.dstore.core.model.DataStore;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Utilities for dstore servers.
|
||||||
|
*
|
||||||
|
* @noextend This class is not intended to be subclassed by clients.
|
||||||
|
* @noinstantiate This class is not intended to be instantiated by clients.
|
||||||
|
*/
|
||||||
public class UniversalServerUtilities {
|
public class UniversalServerUtilities {
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* logInfo
|
* logInfo
|
||||||
*
|
*
|
||||||
* @param minerName
|
* @param minerName
|
||||||
*
|
*
|
||||||
* @param message Message text to be logged.
|
* @param message Message text to be logged.
|
||||||
|
* @since org.eclipse.rse.services.dstore 3.0
|
||||||
*/
|
*/
|
||||||
public static void logInfo(String minerName, String message, DataStore dataStore)
|
public static void logInfo(String minerName, String message, DataStore dataStore)
|
||||||
{
|
{
|
||||||
|
@ -37,8 +44,8 @@ public class UniversalServerUtilities {
|
||||||
* logWarning
|
* logWarning
|
||||||
*
|
*
|
||||||
* @param minerName
|
* @param minerName
|
||||||
*
|
|
||||||
* @param message Message text to be logged.
|
* @param message Message text to be logged.
|
||||||
|
* @since org.eclipse.rse.services.dstore 3.0
|
||||||
*/
|
*/
|
||||||
public static void logWarning(String minerName, String message, DataStore dataStore)
|
public static void logWarning(String minerName, String message, DataStore dataStore)
|
||||||
{
|
{
|
||||||
|
@ -49,10 +56,10 @@ public class UniversalServerUtilities {
|
||||||
* logError
|
* logError
|
||||||
*
|
*
|
||||||
* @param minerName
|
* @param minerName
|
||||||
*
|
|
||||||
* @param message Message text to be logged.
|
* @param message Message text to be logged.
|
||||||
*
|
* @param exception Exception that generated the error. Used to print a
|
||||||
* @param exception Exception that generated the error. Used to print a stack trace.
|
* stack trace.
|
||||||
|
* @since org.eclipse.rse.services.dstore 3.0
|
||||||
*/
|
*/
|
||||||
public static void logError(String minerName, String message, Throwable exception, DataStore dataStore)
|
public static void logError(String minerName, String message, Throwable exception, DataStore dataStore)
|
||||||
{
|
{
|
||||||
|
@ -63,8 +70,8 @@ public class UniversalServerUtilities {
|
||||||
* logDebugMessage
|
* logDebugMessage
|
||||||
*
|
*
|
||||||
* @param minerName
|
* @param minerName
|
||||||
*
|
|
||||||
* @param message Message text to be logged.
|
* @param message Message text to be logged.
|
||||||
|
* @since org.eclipse.rse.services.dstore 3.0
|
||||||
*/
|
*/
|
||||||
public static void logDebugMessage(String minerName, String message, DataStore dataStore)
|
public static void logDebugMessage(String minerName, String message, DataStore dataStore)
|
||||||
{
|
{
|
||||||
|
|
Loading…
Add table
Reference in a new issue