mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-03 23:25:26 +02:00
Code Issues Wiki Activity

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

Browse source 
https://bugs.eclipse.org/bugs/show_bug.cgi?id=226561
This commit is contained in:
David Dykstal 2008-04-23 18:49:40 +00:00
parent b2e93b069e
commit 833eafaa44
13 changed files with 68 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferenceManager.java
View file

@ -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 {
/**

8
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferencedObject.java
View file

@ -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 {

8
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBasePersistableReferencingObject.java
View file

@ -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 {
/**

5
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBaseReferencedObject.java
View file

@ -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 {
/**

8
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEBaseReferencingObject.java
View file

@ -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 {
/**

8
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEPersistableReferencedObject.java
View file

@ -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 {

12
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEPersistableReferencingObject.java
View file

@ -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 {
/**

9
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEReferencedObject.java
View file

@ -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 {
}

12
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/IRSEReferencingObject.java
View file

@ -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 {
}

3
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencedObject.java
View file

@ -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 {

5
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencedObjectHelper.java
View file

@ -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 {

3
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencingObject.java
View file

@ -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;

6
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/references/SystemReferencingObjectHelper.java
View file

@ -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 {