diff --git a/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/CommandMiner.java b/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/CommandMiner.java index 873e1a47f41..fadabd27689 100644 --- a/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/CommandMiner.java +++ b/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/CommandMiner.java @@ -17,6 +17,7 @@ * David McKnight (IBM) - [196624] dstore miner IDs should be String constants rather than dynamic lookup * Noriaki Takatsu (IBM) - [220126] [dstore][api][breaking] Single process server for multiple clients * Noriaki Takatsu (IBM) - [230399] [multithread] changes to stop CommandMiner threads when clients disconnect + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed *******************************************************************************/ package org.eclipse.rse.dstore.universal.miners; @@ -42,6 +43,9 @@ import org.eclipse.rse.internal.dstore.universal.miners.command.patterns.Pattern /** * The CommandMiner provides the ability to run remote interactive shell * commands via the DataStore. + * + * @noinstantiate This class is not intended to be instantiated by clients. + * @noextend This class is not intended to be subclassed by clients. */ public class CommandMiner extends Miner { diff --git a/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/EnvironmentMiner.java b/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/EnvironmentMiner.java index 80c3f6b1778..5e786d0db7d 100644 --- a/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/EnvironmentMiner.java +++ b/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/EnvironmentMiner.java @@ -17,6 +17,7 @@ * Noriaki Takatsu (IBM) - [220126] [dstore][api][breaking] Single process server for multiple clients * David McKnight (IBM) [224906] [dstore] changes for getting properties and doing exit due to single-process capability * Noriaki Takatsu (IBM) - [226237] [dstore] Move the place where the ServerLogger instance is made + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed *******************************************************************************/ package org.eclipse.rse.dstore.universal.miners; @@ -28,12 +29,17 @@ import java.util.ArrayList; import java.util.List; import org.eclipse.dstore.core.miners.Miner; -import org.eclipse.dstore.core.model.Client; import org.eclipse.dstore.core.model.DE; import org.eclipse.dstore.core.model.DataElement; -import org.eclipse.dstore.core.server.ServerLogger; - +/** + * The environment miner provides access to the environment variables + * on a remote system and allows the store environment variables to be altered + * for use in other miners that launch shells. + * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. + */ public class EnvironmentMiner extends Miner { private DataElement _system; diff --git a/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/UniversalFileSystemMiner.java b/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/UniversalFileSystemMiner.java index 72a407cb4e7..9597c9919df 100644 --- a/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/UniversalFileSystemMiner.java +++ b/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/UniversalFileSystemMiner.java @@ -34,6 +34,7 @@ * 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 * Martin Oberhuber (Wind River) - [199854][api] Improve error reporting for archive handlers + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed *******************************************************************************/ package org.eclipse.rse.dstore.universal.miners; @@ -79,6 +80,12 @@ import org.eclipse.rse.services.clientserver.archiveutils.VirtualChild; import org.eclipse.rse.services.clientserver.java.ClassFileUtil; import org.eclipse.rse.services.clientserver.messages.SystemMessageException; +/** + * This miner allows for remote file browsing and management. + * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. + */ public class UniversalFileSystemMiner extends Miner { private DataElement deUFSnode; diff --git a/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/UniversalProcessMiner.java b/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/UniversalProcessMiner.java index 1dc5cb81ab2..87996b5f235 100644 --- a/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/UniversalProcessMiner.java +++ b/rse/plugins/org.eclipse.rse.services.dstore/miners/org/eclipse/rse/dstore/universal/miners/UniversalProcessMiner.java @@ -15,6 +15,7 @@ * David McKnight (IBM) - [196624] dstore miner IDs should be String constants rather than dynamic lookup * Noriaki Takatsu (IBM) - [220126] [dstore][api][breaking] Single process server for multiple clients * David McKnight (IBM) [224906] [dstore] changes for getting properties and doing exit due to single-process capability + * David McKnight (IBM) - [226561] [apidoc] Add API markup to RSE Javadocs where extend / implement is allowed *******************************************************************************/ package org.eclipse.rse.dstore.universal.miners; @@ -44,6 +45,9 @@ import org.eclipse.rse.services.clientserver.processes.handlers.UniversalServerP /** * Miner for getting process information from a remote system. * @author mjberger + * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public class UniversalProcessMiner extends Miner {