[226561][apidoc] Add API markup to RSE Javadocs where extend / implement is allowed

https://bugs.eclipse.org/bugs/show_bug.cgi?id=226561

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/IRSECoreStatusCodes.java

@@ -6,6 +6,7 @@
  *
  * Contributors:
  * David Dykstal (IBM) - [225988] need API to mark persisted profiles as migrated
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *********************************************************************************/
 
 package org.eclipse.rse.core;
@@ -15,6 +16,8 @@ package org.eclipse.rse.core;
  * org.eclipse.rse.core
  *
  * @since org.eclipse.rse.core 3.0
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement this interface is not intended to be implemented by clients
  */
 public interface IRSECoreStatusCodes {
 

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/SystemResourceHelpers.java

@@ -12,7 +12,7 @@
  * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
  * 
  * Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.core;
@@ -35,6 +35,8 @@ import org.eclipse.core.runtime.IStatus;
 /**
  * A class with helper methods for working with the underlying Eclipse resources
  * needed for filters, filter pools and filter pool managers.
+ * @noextend This class is not intended to be subclassed by clients.
+ * @noinstantiate This class is not intended to be instantiated by clients.
  */
 public class SystemResourceHelpers implements FileFilter
 {

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilter.java

@@ -15,6 +15,7 @@
  * David Dykstal (IBM) - cleanup format and javadoc
  * Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
  * David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.core.filters;
@@ -29,6 +30,9 @@ import org.eclipse.rse.core.subsystems.ISubSystem;
  * Subsystems are responsible for interpreting the filters. Filters, in and
  * of themselves, provide no interpretation of themselves when applied
  * to the resources managed by a subsystem.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations already present in the framwork.
  */
 
 public interface ISystemFilter extends IRSEReferencedObject, ISystemFilterContainer, IRSEModelObject {

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainer.java

@@ -13,6 +13,7 @@
  * 
  * Contributors:
  * Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 package org.eclipse.rse.core.filters;
 
@@ -21,6 +22,9 @@ import org.eclipse.rse.core.model.IRSEPersistableContainer;
 /**
  * Filter containers are any objects that contain filters.
  * This includes filter pools and filters themselves.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
  */
 public interface ISystemFilterContainer extends IRSEPersistableContainer {
 	/**

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterContainerReference.java

@@ -12,7 +12,7 @@
  * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
  * 
  * Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.core.filters;
@@ -31,6 +31,9 @@ import org.eclipse.rse.core.subsystems.ISubSystem;
  * This interface captures those common methods, and both 
  * SystemFilterReference and SystemFilterPoolReference
  * implement this interface and hence these methods.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
  */
 public interface ISystemFilterContainerReference {
 	/**

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPool.java

@@ -14,6 +14,7 @@
  * Contributors:
  * David Dykstal (IBM) - cleanup - format and javadoc
  * Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.core.filters;
@@ -24,6 +25,9 @@ import org.eclipse.rse.core.references.IRSEPersistableReferencedObject;
 /**
  * This interface represents a system filter pool, which is a means of
  * grouping filters to be referenced together.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
  */
 public interface ISystemFilterPool extends IRSEPersistableReferencedObject, ISystemFilterContainer, IRSEModelObject {
 

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolManager.java

@@ -16,6 +16,7 @@
  * cleaned javadoc for renameSystemFilterPool
  * David Dykstal (IBM) - [222270] clean up interfaces in org.eclipse.rse.core.filters
  * Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.core.filters;
@@ -32,6 +33,7 @@ import org.eclipse.rse.core.model.ISystemProfile;
  * filter related activity through a single point like this, we can ensure that
  * all changes are saved to disk, and events are fired properly.
  * 
+ * @noextend This interface is not intended to be extended by clients.
  * @noimplement This interface is not intended to be implemented by clients.
  */
 public interface ISystemFilterPoolManager extends IRSEPersistableContainer {

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolManagerProvider.java

@@ -12,7 +12,7 @@
  * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
  * 
  * Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.core.filters;
@@ -32,6 +32,8 @@ import org.eclipse.core.runtime.IAdaptable;
  * in order to fire events to update its GUI. So this interface captures those 
  * callbacks that done to the provider for every interesting event. Should you 
  * not care about these, supply empty shells for these methods.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
  */
 public interface ISystemFilterPoolManagerProvider extends IAdaptable {
 

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReference.java

@@ -11,7 +11,7 @@
  * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
  * 
  * Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  ********************************************************************************/
 
 package org.eclipse.rse.core.filters;
@@ -24,6 +24,9 @@ import org.eclipse.rse.core.references.IRSEPersistableReferencingObject;
  * level, while subsystems contain references to one or more pools. A pool can be referenced
  * by multiple connections. Pools don't go away until explicitly deleted by the user, regardless
  * of their reference count.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
  */
 public interface ISystemFilterPoolReference extends IRSEPersistableReferencingObject, ISystemFilterContainerReference, IRSEModelObject {
 	/**

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReferenceManager.java

@@ -12,7 +12,7 @@
  * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
  * 
  * Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.core.filters;
@@ -25,6 +25,9 @@ import org.eclipse.rse.core.subsystems.ISubSystem;
  * a filter pool. This class builds on the parent class SystemPersistableReferenceManager,
  * offering convenience versions of the parent methods that are typed to the
  * classes in the filters framework.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
  */
 public interface ISystemFilterPoolReferenceManager extends IRSEBasePersistableReferenceManager {
 	/**

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolReferenceManagerProvider.java

@@ -12,7 +12,7 @@
  * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
  * 
  * Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.core.filters;
@@ -30,6 +30,9 @@ package org.eclipse.rse.core.filters;
  * in order to fire events to update its GUI. So this interface captures those 
  * callbacks that done to the provider for every interesting event. Should you 
  * not care about these, supply empty shells for these methods.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
  */
 public interface ISystemFilterPoolReferenceManagerProvider {
 	/**

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolSelectionValidator.java

@@ -12,7 +12,7 @@
  * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
  * 
  * Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.core.filters;
@@ -22,6 +22,7 @@ import org.eclipse.rse.services.clientserver.messages.SystemMessage;
 /**
  * An interface required if you wish to be called back by the 
  * system filter wizard, when the user selects a target filter pool.
+ * @noextend This interface is not intended to be extended by clients.
  */
 public interface ISystemFilterPoolSelectionValidator {
 

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolWrapper.java

@@ -12,7 +12,7 @@
  * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
  * 
  * Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.core.filters;
@@ -20,6 +20,7 @@ package org.eclipse.rse.core.filters;
 /**
  * The system filter wizard allows callers to pass a list of wrapper objects
  * for the user to select a filter pool.
+ * @noextend This interface is not intended to be extended by clients.
  */
 public interface ISystemFilterPoolWrapper {
 

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterPoolWrapperInformation.java

@@ -13,6 +13,7 @@
  * 
  * Contributors:
  * David McKnight   (IBM)        - [225506] [api][breaking] RSE UI leaks non-API types
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.core.filters;
@@ -26,6 +27,7 @@ package org.eclipse.rse.core.filters;
  * <p>
  * This is all encapsulated in this interface. There is also a class offered
  * that implements all this and is populated via setters.
+ * @noextend This interface is not intended to be extended by clients.
  */
 public interface ISystemFilterPoolWrapperInformation {
 

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterReference.java

@@ -12,7 +12,7 @@
  * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
  * 
  * Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.core.filters;
@@ -25,6 +25,9 @@ import org.eclipse.rse.core.subsystems.ISubSystem;
 /**
  * Represents a shadow or reference to a system filter.
  * Such references are only transient, not savable to disk.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
  */
 public interface ISystemFilterReference extends IRSEReferencingObject, ISystemFilterContainerReference, ISystemContainer {
 	/**

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterStartHere.java

@@ -8,12 +8,18 @@
  * Contributors:
  *     IBM Corporation - initial API and implementation
  * Martin Oberhuber (Wind River) - [cleanup] Add API "since" Javadoc tags
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 package org.eclipse.rse.core.filters;
 
 import org.eclipse.rse.core.model.ISystemProfile;
 import org.eclipse.rse.logging.Logger;
 
+/**
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
+ */
 public interface ISystemFilterStartHere {
 
 	/**

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterString.java

@@ -13,6 +13,7 @@
  * 
  * Contributors:
  * Martin Oberhuber (Wind River) - Cleanup Javadoc.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.core.filters;
@@ -27,6 +28,9 @@ import org.eclipse.rse.core.references.IRSEBaseReferencedObject;
  *  than a string, and its up to each consumer to know what to do with it. Generally,
  *  a filter string edit pane is designed to prompt the user for the contents of the 
  *  string in a domain-friendly way.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
  */
 public interface ISystemFilterString extends IRSEBaseReferencedObject, IAdaptable, IRSEModelObject {
 	/**

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/ISystemFilterStringReference.java

@@ -12,7 +12,7 @@
  * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
  * 
  * Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.core.filters;
@@ -22,6 +22,9 @@ import org.eclipse.rse.core.references.IRSEBaseReferencingObject;
 /**
  * Represents a reference to a filter string.
  * Needed so the UI can show the same filter string multiple times.
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The allowable implementations are already present in the framework.
  */
 public interface ISystemFilterStringReference extends IRSEBaseReferencingObject {
 	/**

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/SystemFilterReference.java

@@ -13,6 +13,7 @@
  * Contributors:
  * David Dykstal (IBM) - 142806: refactoring persistence framework
  * David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  ********************************************************************************/
 
 package org.eclipse.rse.core.filters;
@@ -44,9 +45,9 @@ import org.eclipse.rse.internal.core.filters.SystemFilterStringReference;
  *       if it is possible for the same filter to show up in different places in 
  *       the tree, then we must create shadows for each place it shows up.
  * </ol>
- */
+ * @noextend This class is not intended to be subclassed by clients.
-/**
+ * @noinstantiate This class is not intended to be instantiated by clients.
- * @lastgen class SystemFilterReferenceImpl extends SystemReferencingObjectImpl implements IAdaptable, SystemFilterReference, SystemReferencingObject {}
+ * Use the factory method {@link #createSystemFilterReference(ISubSystem, ISystemFilterContainerReference, ISystemFilter, boolean)}.
  */
 public class SystemFilterReference extends SystemReferencingObject implements IAdaptable, ISystemFilterReference {
 	private SystemFilterContainerReferenceCommonMethods containerHelper = null;

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/filters/SystemFilterUtil.java

@@ -6,6 +6,7 @@
  * 
  * Contributors:
  * David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *********************************************************************************/
 
 package org.eclipse.rse.core.filters;
@@ -14,7 +15,8 @@ import org.eclipse.rse.internal.core.filters.SystemFilterSimple;
 
 /**
  * Utilities to be used in the construction and manipulation of filters.
- * @noextend
+ * @noextend This interface is not intended to be extended by clients.
+ * @noinstantiate This class is not intended to be instantiated by clients.
  */
 public class SystemFilterUtil {
 	

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/logging/Logger.java

@@ -12,7 +12,7 @@
  * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
  * 
  * Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.logging;
@@ -71,6 +71,9 @@ import org.eclipse.rse.internal.logging.LogListener;
  *         }<br>
  * <br>
  * 
+ * @noextend This class is not intended to be subclassed by clients.
+ * @noinstantiate This class is not intended to be instantiated by clients.
+ * Use {@link LoggerFactory} to create instances.
  */
 public class Logger implements IPropertyChangeListener {
 	

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/logging/LoggerFactory.java

@@ -12,7 +12,7 @@
  * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
  * 
  * Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.logging;
@@ -26,6 +26,8 @@ import org.eclipse.core.runtime.Plugin;
  * Keep in mind that this factory class follows the singleton model.<br>
  * ie: once an instance of a Logger class for a given plugin is created, 
  * it will always be reused. 
+ * @noextend This class is not intended to be subclassed by clients.
+ * @noinstantiate This class is not intended to be instantiated by clients.
  */
 public class LoggerFactory {
 

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/RSEDOM.java

@@ -12,7 +12,7 @@
  * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
  * 
  * Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.persistence.dom;
@@ -22,6 +22,7 @@ import org.eclipse.rse.core.model.ISystemProfile;
 /**
  * This class is the root node of an RSE DOM.  Each
  * RSEDOM represents the properties of a profile to persist.
+ * @noextend This class is not intended to be subclassed by clients.
  */
 public class RSEDOM extends RSEDOMNode {
 

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/RSEDOMNode.java

@@ -12,7 +12,7 @@
  * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
  * 
  * Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.persistence.dom;
@@ -21,6 +21,9 @@ import java.io.Serializable;
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * @noextend This class is not intended to be subclassed by clients.
+ */
 public class RSEDOMNode implements Serializable {
 
 	private static final long serialVersionUID = 1L; // This should be updated if there is a schema change.

rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/persistence/dom/RSEDOMNodeAttribute.java

@@ -12,13 +12,16 @@
  * Emily Bruner, Mazen Faraj, Adrian Storisteanu, Li Ding, and Kent Hawley.
  * 
  * Contributors:
- * {Name} (company) - description of contribution.
+ * David Dykstal (IBM) - [226561] Add API markup to RSE Javadocs where extend / implement is allowed
  *******************************************************************************/
 
 package org.eclipse.rse.persistence.dom;
 
 import java.io.Serializable;
 
+/**
+ * @noextend This class is not intended to be subclassed by clients.
+ */
 public class RSEDOMNodeAttribute implements Serializable {
 	private static final long serialVersionUID = 1L;
 	private String _key;