mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-29 11:13:34 +02:00
Code Issues Wiki Activity

[cleanup] Add API "since" Javadoc tags

Browse source
This commit is contained in:
Martin Oberhuber 2008-03-28 17:57:32 +00:00
parent 9b92fbe699
commit b91376bf09
3 changed files with 81 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
rse/plugins/org.eclipse.rse.services.dstore/.project
View file

@ -20,9 +20,15 @@
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>org.eclipse.pde.api.tools.apiAnalysisBuilder</name>
<arguments>
</arguments>
</buildCommand>
</buildSpec>
<natures>
<nature>org.eclipse.pde.PluginNature</nature>
<nature>org.eclipse.jdt.core.javanature</nature>
<nature>org.eclipse.pde.api.tools.apiAnalysisNature</nature>
</natures>
</projectDescription>

34
rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/IUniversalDataStoreConstants.java
View file

@ -13,8 +13,9 @@
*
* Contributors:
* 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) - [209593] [api] add support for "file permissions" and "owner" properties for unix files
* 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
* Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
*******************************************************************************/
package org.eclipse.rse.dstore.universal.miners;
@ -30,9 +31,33 @@ public interface IUniversalDataStoreConstants
/*
* 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$
/**
* 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$
/**
* 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$
/**
* 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$
@ -41,8 +66,8 @@ public interface IUniversalDataStoreConstants
//
public static final String MESSAGE_DESCRIPTOR = "universal.message"; //$NON-NLS-1$
public static final String UNIVERSAL_NODE_DESCRIPTOR = "universal.node"; //$NON-NLS-1$
public static final String UNIVERSAL_TEMP_DESCRIPTOR = "universal.temp"; //$NON-NLS-1$
public static final String UNIVERSAL_NODE_DESCRIPTOR = "universal.node"; //$NON-NLS-1$
public static final String UNIVERSAL_TEMP_DESCRIPTOR = "universal.temp"; //$NON-NLS-1$
public static final String UNIVERSAL_FILTER_DESCRIPTOR = "universal.FilterObject"; //$NON-NLS-1$
public static final String UNIVERSAL_FILE_DESCRIPTOR = "universal.FileObject"; //$NON-NLS-1$
public static final String UNIVERSAL_FOLDER_DESCRIPTOR = "universal.FolderObject"; //$NON-NLS-1$
@ -100,6 +125,7 @@ public interface IUniversalDataStoreConstants
// permissions commands
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$

21
rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/UniversalServerUtilities.java
View file

@ -11,22 +11,29 @@
* Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
*
* 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;
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 {
/**
* logInfo
*
* @param minerName
*
* @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)
{
@ -37,8 +44,8 @@ public class UniversalServerUtilities {
* logWarning
*
* @param minerName
*
* @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)
{
@ -49,10 +56,10 @@ public class UniversalServerUtilities {
* logError
*
* @param minerName
*
* @param message Message text to be logged.
*
* @param exception Exception that generated the error. Used to print a stack trace.
* @param exception Exception that generated the error. Used to print a
* stack trace.
* @since org.eclipse.rse.services.dstore 3.0
*/
public static void logError(String minerName, String message, Throwable exception, DataStore dataStore)
{
@ -63,8 +70,8 @@ public class UniversalServerUtilities {
* logDebugMessage
*
* @param minerName
*
* @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)
{