mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-04 06:45:43 +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-30 17:33:13 +00:00
parent a87be8f46d
commit 38da47261b
5 changed files with 25 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/filters/ISystemChangeFilterPaneEditPaneSupplier.java
View file

@ -1,5 +1,5 @@
/********************************************************************************
* Copyright (c) 2003, 2006 IBM Corporation. All rights reserved.
* Copyright (c) 2003, 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 to javadoc
********************************************************************************/
package org.eclipse.rse.ui.filters;
@ -20,9 +20,11 @@ import org.eclipse.swt.widgets.Shell;
/**
* The SystemChangeFilterPane class is used in both SystemChangeFilterDialog and
* in SystemChangeFilterPropertyPage. The pane relies on both of these to supply
* the edit pane (for historical reasons, so we don't break previous contracts).
* This interface is implemented by both classes, for supplying that edit pane.
* in SystemChangeFilterPropertyPage. The pane relies on both of these to supply
* the edit pane (for historical reasons, so we don't break previous contracts).
* This interface is implemented by both classes, for supplying that edit pane.
* @noimplement This interface is not intended to be implemented by clients.
* The standard implementations are included in the framework.
*/
public interface ISystemChangeFilterPaneEditPaneSupplier
{

12
rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/filters/SystemChangeFilterPane.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 to javadoc
*******************************************************************************/
package org.eclipse.rse.ui.filters;
@ -74,9 +74,11 @@ import org.eclipse.swt.widgets.Widget;
/**
* Since we have decided to allow the same editing in both the Change Filter dialog
* and the Properties page, we have to abstract the meat of the change filter dialog
* into a re-usable composite. That is what this is, and it is used by both the
* dialog and the property page.
* and the Properties page, we have to abstract the meat of the change filter dialog
* into a re-usable composite. That is what this is, and it is used by both the
* dialog and the property page.
* @noextend This class is not intended to be subclassed by clients.
* This class is complete and should be used as is.
*/
public class SystemChangeFilterPane extends SystemBaseForm
implements SelectionListener, ISystemFilterStringEditPaneListener, IMenuListener

3
rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/filters/SystemFilterPoolDialogInputs.java
View file

@ -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 javadoc
*******************************************************************************/
package org.eclipse.rse.ui.filters;
@ -28,6 +29,8 @@ import org.eclipse.rse.ui.filters.dialogs.SystemFilterDialogInputs;
/**
* A class capturing the attributes commonly needed by dialogs that
* work with filter pools.
* @noextend This class is not intended to be subclassed by clients.
* This class is complete and should be used as is.
*/
public class SystemFilterPoolDialogInputs extends SystemFilterDialogInputs
{

3
rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/filters/SystemFilterPoolDialogOutputs.java
View file

@ -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 javadoc
*******************************************************************************/
package org.eclipse.rse.ui.filters;
@ -25,6 +26,8 @@ import org.eclipse.rse.ui.dialogs.SystemSimpleContentElement;
/**
* A class capturing the attributes commonly returned by dialogs that
* work with filter pools.
* @noextend This class is not intended to be subclassed by clients.
* This class is complete and should be used as is.
*/
public class SystemFilterPoolDialogOutputs
{

7
rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/filters/SystemFilterUIHelpers.java
View file

@ -1,5 +1,5 @@
/********************************************************************************
* Copyright (c) 2002, 2007 IBM Corporation and others. All rights reserved.
* 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 http://www.eclipse.org/legal/epl-v10.html
@ -12,6 +12,7 @@
*
* Contributors:
* Martin Oberhuber (Wind River) - [186748] Move ISubSystemConfigurationAdapter from UI/rse.core.subsystems.util
* David Dykstal (IBM) - [226561] add API markup to javadoc
********************************************************************************/
package org.eclipse.rse.ui.filters;
@ -29,7 +30,9 @@ import org.eclipse.rse.ui.subsystems.ISubSystemConfigurationAdapter;
/**
*
* A set of utility methods for dealing with filter pools, models, etc.
* @noextend This class is not intended to be subclassed by clients.
* @noinstantiate This class is not intended to be instantiated by clients.
*/
public class SystemFilterUIHelpers
{