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

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

13 files changed, 68 insertions, 29 deletions

diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferenceManager.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferenceManager.java
index 25ef6243e..4ae3e29c8 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferenceManager.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferenceManager.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 for noextend / noimplement where needed
  *******************************************************************************/
 
 package org.eclipse.rse.core.references;
@@ -48,11 +48,11 @@ package org.eclipse.rse.core.references;
  * and restore methods. If using MOF, and the containment of the manager class is modelled in
  * your own containing class, this will happen automatically when you use mof to save
  * your containing class instance.
+ * @noextend This interface is not intended to be extended by clients.
+ * The standard extensions are included in the framework.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The standard implementations are included in the framework.
  */
-/**
- * @lastgen interface SystemPersistableReferenceManager  {}
- */
-
 public interface IRSEBasePersistableReferenceManager {
 
 	/**
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferencedObject.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferencedObject.java
index 8c5c225cd..4aeebc8f7 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferencedObject.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferencedObject.java
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2002, 2006 IBM Corporation. All rights reserved.
+ * Copyright (c) 2002, 2008 IBM Corporation. All rights reserved.
  * This program and the accompanying materials are made available under the terms
  * of the Eclipse Public License v1.0 which accompanies this distribution, and is 
  * available at http://www.eclipse.org/legal/epl-v10.html
@@ -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 for noextend / noimplement where needed
  ********************************************************************************/
 
 package org.eclipse.rse.core.references;
@@ -37,6 +37,10 @@ package org.eclipse.rse.core.references;
  * <p>
  * This interface supplies the method to allow a referencing object to
  * query that unique name or key from this real object.
+ * @noextend This interface is not intended to be extended by clients.
+ * The standard extensions are included in the framework.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The standard implementations are included in the framework.
  */
 public interface IRSEBasePersistableReferencedObject extends IRSEBaseReferencedObject {
 
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferencingObject.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferencingObject.java
index a3d4bf88c..6b0adb2d0 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferencingObject.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferencingObject.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2002, 2007 IBM Corporation and others.
+ * Copyright (c) 2002, 2008 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -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 for noextend / noimplement where needed
  *******************************************************************************/
 
 package org.eclipse.rse.core.references;
@@ -36,6 +36,10 @@ package org.eclipse.rse.core.references;
  * from disk we then resolve that into a runtime reference to a real memory object.
  * <p>
  * This interface captures the methods to set and query that name or key.
+ * @noextend This interface is not intended to be extended by clients.
+ * The standard extensions are included in the framework.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The standard implementations are included in the framework.
  */
 public interface IRSEBasePersistableReferencingObject extends IRSEBaseReferencingObject {
 	/**
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBaseReferencedObject.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBaseReferencedObject.java
index 513edeb65..510645068 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBaseReferencedObject.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBaseReferencedObject.java
@@ -12,12 +12,17 @@
  * 
  * Contributors:
  * Martin Oberhuber (Wind River) - Cleanup Javadoc.
+ * David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed
  ********************************************************************************/
 
 package org.eclipse.rse.core.references;
 
 /**
  * Interface that any master object that is referenced must implement.
+ * @noextend This interface is not intended to be extended by clients.
+ * The standard extensions are included in the framework.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The standard implementations are included in the framework.
  */
 public interface IRSEBaseReferencedObject {
 	/**
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBaseReferencingObject.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBaseReferencingObject.java
index f70e5698d..77482a4f3 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBaseReferencingObject.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBaseReferencingObject.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2002, 2007 IBM Corporation and others.
+ * Copyright (c) 2002, 2008 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -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 for noextend / noimplement where needed
  *******************************************************************************/
 
 package org.eclipse.rse.core.references;
@@ -24,6 +24,10 @@ package org.eclipse.rse.core.references;
  * real object.
  * <p>
  * This interface captures the simple set of methods such a shadow must implement.
+ * @noextend This interface is not intended to be extended by clients.
+ * The standard extensions are included in the framework.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The standard implementations are included in the framework.
  */
 public interface IRSEBaseReferencingObject {
 	/**
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEPersistableReferencedObject.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEPersistableReferencedObject.java
index 39d1e0d65..92279e33d 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEPersistableReferencedObject.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEPersistableReferencedObject.java
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2002, 2006 IBM Corporation. All rights reserved.
+ * Copyright (c) 2002, 2008 IBM Corporation. All rights reserved.
  * This program and the accompanying materials are made available under the terms
  * of the Eclipse Public License v1.0 which accompanies this distribution, and is 
  * available at http://www.eclipse.org/legal/epl-v10.html
@@ -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 for noextend / noimplement where needed
  ********************************************************************************/
 
 package org.eclipse.rse.core.references;
@@ -19,6 +19,10 @@ package org.eclipse.rse.core.references;
 /**
  * This is an object that can have shadow (reference) objects, which simply
  * point to this object, and a copy of this object's unique name or key (for storing on disk).
+ * @noextend This interface is not intended to be extended by clients.
+ * The standard extensions are included in the framework.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The standard implementations are included in the framework.
  */
 
 public interface IRSEPersistableReferencedObject extends IRSEReferencedObject, IRSEBasePersistableReferencedObject {
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEPersistableReferencingObject.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEPersistableReferencingObject.java
index a227de7a2..2b8617130 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEPersistableReferencingObject.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEPersistableReferencingObject.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2002, 2007 IBM Corporation and others.
+ * Copyright (c) 2002, 2008 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -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 for noextend / noimplement where needed
  *******************************************************************************/
 
 package org.eclipse.rse.core.references;
@@ -34,11 +34,11 @@ package org.eclipse.rse.core.references;
  * and manage the saving/restoring of that list.
  * <p>
  * <b>YOU MUST OVERRIDE resolveReferencesAfterRestore IN YOUR REFERENCE MANAGER SUBCLASS</b>
+ * @noextend This interface is not intended to be extended by clients.
+ * The standard extensions are included in the framework.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The standard implementations are included in the framework.
  */
-/**
- * @lastgen interface SystemPersistableReferencingObject extends SystemReferencingObject {}
- */
-
 public interface IRSEPersistableReferencingObject extends IRSEReferencingObject, IRSEBasePersistableReferencingObject {
 
 	/**
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEReferencedObject.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEReferencedObject.java
index 5f1f1c098..25e190781 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEReferencedObject.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEReferencedObject.java
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2002, 2006 IBM Corporation. All rights reserved.
+ * Copyright (c) 2002, 2008 IBM Corporation. All rights reserved.
  * This program and the accompanying materials are made available under the terms
  * of the Eclipse Public License v1.0 which accompanies this distribution, and is 
  * available at http://www.eclipse.org/legal/epl-v10.html
@@ -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 for noextend / noimplement where needed
  ********************************************************************************/
 
 package org.eclipse.rse.core.references;
@@ -25,8 +25,11 @@ package org.eclipse.rse.core.references;
  * <p>
  * These references are not persistent. Persistent references are managed
  * by the subtype IRSEPersistableReferencedObject.
+ * @noextend This interface is not intended to be extended by clients.
+ * The standard extensions are included in the framework.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The standard implementations are included in the framework.
  */
-
 public interface IRSEReferencedObject extends IRSEBaseReferencedObject {
 
 }
\ No newline at end of file
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEReferencingObject.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEReferencingObject.java
index 1f5a708c0..13c3a266d 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEReferencingObject.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEReferencingObject.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2002, 2007 IBM Corporation and others.
+ * Copyright (c) 2002, 2008 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -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 for noextend / noimplement where needed
  *******************************************************************************/
 
 package org.eclipse.rse.core.references;
@@ -27,11 +27,11 @@ package org.eclipse.rse.core.references;
  * <p>
  * These references are not persistent. Persistent references are managed
  * by the subclass SystemPersistableReferencingObject.
+ * @noextend This interface is not intended to be extended by clients.
+ * The standard extensions are included in the framework.
+ * @noimplement This interface is not intended to be implemented by clients.
+ * The standard implementations are included in the framework.
  */
-/**
- * @lastgen interface SystemReferencingObject  {}
- */
-
 public interface IRSEReferencingObject extends IRSEBaseReferencingObject {
 
 }
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencedObject.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencedObject.java
index 5804f9404..e47775ee3 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencedObject.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencedObject.java
@@ -12,6 +12,7 @@
  * 
  * Contributors:
  * David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
+ * David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed
  ********************************************************************************/
 
 package org.eclipse.rse.core.references;
@@ -24,6 +25,8 @@ import org.eclipse.rse.core.model.RSEModelObject;
  * This type of class needs to support maintaining an in-memory list of
  * all who reference it so that list can be following on delete and
  * rename operations.
+ * @noextend This class is not intended to be subclassed by clients.
+ * The standard extensions are included in the framework.
  */
 public abstract class SystemReferencedObject extends RSEModelObject implements IRSEReferencedObject {
 
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencedObjectHelper.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencedObjectHelper.java
index 0b668223c..a3e6bc0a8 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencedObjectHelper.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencedObjectHelper.java
@@ -13,6 +13,7 @@
  * 
  * Contributors:
  * David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
+ * David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed
  *******************************************************************************/
 
 package org.eclipse.rse.core.references;
@@ -21,6 +22,10 @@ import java.util.Vector;
 
 /**
  * The class should be used by subclasses of {@link SystemReferencedObject} by instantiating it and delegating to it.
+ * @noextend This class is not intended to be subclassed by clients.
+ * The standard extensions are included in the framework.
+ * @noinstantiate This class is not intended to be instantiated by clients.
+ * The standard instances are created by the framework.
  */
 public class SystemReferencedObjectHelper {
 
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencingObject.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencingObject.java
index 964942f9c..42edfa143 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencingObject.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencingObject.java
@@ -13,6 +13,7 @@
  * Contributors:
  * Martin Oberhuber (Wind River) - [184095] Replace systemTypeName by IRSESystemType
  * David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
+ * David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed
  ********************************************************************************/
 
 package org.eclipse.rse.core.references;
@@ -27,6 +28,8 @@ import org.eclipse.rse.internal.core.RSECoreMessages;
  * object in multiple places. To enable that, it is necessary not to
  * use the same physical object in each UI representation as the UI
  * will only know how to update/refresh the first one it finds.
+ * @noextend This class is not intended to be subclassed by clients.
+ * The standard extensions are included in the framework.
  */
 public abstract class SystemReferencingObject extends RSEModelObject implements IRSEReferencingObject {
 	private SystemReferencingObjectHelper helper = null;
diff --git a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencingObjectHelper.java b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencingObjectHelper.java
index 9afa67f0c..bed7c5adb 100644
--- a/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencingObjectHelper.java
+++ b/rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencingObjectHelper.java
@@ -13,6 +13,7 @@
  * 
  * Contributors:
  * David Dykstal (IBM) - [224671] [api] org.eclipse.rse.core API leaks non-API types
+ * David Dykstal (IBM) - [226561] Add API markup for noextend / noimplement where needed
  *******************************************************************************/
 
 package org.eclipse.rse.core.references;
@@ -20,7 +21,10 @@ package org.eclipse.rse.core.references;
 
 /**
  * The class should be used by subclasses of {@link SystemReferencingObject} by instantiating it and delegating to it.
- * @noextend
+ * @noextend This class is not intended to be subclassed by clients.
+ * The standard extensions are included in the framework.
+ * @noinstantiate This class is not intended to be instantiated by clients.
+ * The standard instances are created by the framework.
  */
 public class SystemReferencingObjectHelper {