From 1e3effa6ea7e96f634545952c8443d84937a62da Mon Sep 17 00:00:00 2001 From: Markus Schorn Date: Wed, 4 Feb 2009 09:44:08 +0000 Subject: [PATCH] API tags for org.eclipse.cdt.core.dom.*, bug 260830. --- .../cdt/core/dom/parser/IExtensionToken.java | 4 +++- .../parser/IScannerExtensionConfiguration.java | 3 ++- .../cdt/core/dom/parser/ISourceCodeParser.java | 15 +++------------ .../parser/c/ICParserExtensionConfiguration.java | 3 ++- .../cpp/ICPPParserExtensionConfiguration.java | 3 ++- .../eclipse/cdt/core/dom/rewrite/ASTRewrite.java | 8 +++----- .../core/dom/rewrite/ITrackedNodePosition.java | 6 ++---- 7 files changed, 17 insertions(+), 25 deletions(-) diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/IExtensionToken.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/IExtensionToken.java index fc440a2e784..41ffb5a180b 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/IExtensionToken.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/IExtensionToken.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007 Wind River Systems, Inc. and others. + * Copyright (c) 2007, 2009 Wind River Systems, Inc. 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 @@ -25,6 +25,8 @@ import org.eclipse.cdt.core.parser.IToken; *

* * @since 4.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 IExtensionToken { diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/IScannerExtensionConfiguration.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/IScannerExtensionConfiguration.java index 2f70e1ad471..b1ea765ba77 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/IScannerExtensionConfiguration.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/IScannerExtensionConfiguration.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2008 IBM Corporation and others. + * Copyright (c) 2004, 2009 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 @@ -21,6 +21,7 @@ import org.eclipse.cdt.core.parser.util.CharArrayIntMap; * * @noimplement This interface is not intended to be implemented by clients. Clients can subclass * {@link AbstractScannerExtensionConfiguration}, instead. + * @noextend This interface is not intended to be extended by clients. */ public interface IScannerExtensionConfiguration { diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/ISourceCodeParser.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/ISourceCodeParser.java index d2dcd59c37b..8aea48ea608 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/ISourceCodeParser.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/ISourceCodeParser.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2005, 2008 IBM Corporation and others. + * Copyright (c) 2005, 2009 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 @@ -16,17 +16,8 @@ import org.eclipse.cdt.core.parser.ParseError; /** * Interface for an AST source code parser. - *

- * This interface is not intended to be implemented directly. - *

- *

- * EXPERIMENTAL. This class or interface has been added as - * part of a work in progress. There is no guarantee that this API will work or - * that it will remain the same. Please do not use this API without consulting - * with the CDT team. - *

- * - * @author jcamelon + * @noextend This interface is not intended to be extended by clients. + * @noimplement This interface is not intended to be implemented by clients. */ public interface ISourceCodeParser { diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/c/ICParserExtensionConfiguration.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/c/ICParserExtensionConfiguration.java index 40293173c67..568b37bc9cf 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/c/ICParserExtensionConfiguration.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/c/ICParserExtensionConfiguration.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2002, 2008 IBM Corporation and others. + * Copyright (c) 2002, 2009 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 @@ -20,6 +20,7 @@ import org.eclipse.cdt.core.dom.parser.IBuiltinBindingsProvider; * * @noimplement This interface is not intended to be implemented by clients. * Clients can subclass {@link AbstractCParserExtensionConfiguration} instead. + * @noextend This interface is not intended to be extended by clients. * * @see "http://gcc.gnu.org/onlinedocs/gcc/C-Extensions.html" * @since 4.0 diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/cpp/ICPPParserExtensionConfiguration.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/cpp/ICPPParserExtensionConfiguration.java index 7ea49ee2e18..53779093bb4 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/cpp/ICPPParserExtensionConfiguration.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/parser/cpp/ICPPParserExtensionConfiguration.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2002, 2008 IBM Corporation and others. + * Copyright (c) 2002, 2009 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 @@ -21,6 +21,7 @@ import org.eclipse.cdt.core.dom.parser.IScannerExtensionConfiguration; * * @noimplement This interface is not intended to be implemented by clients. * Clients can subclass {@link AbstractCPPParserExtensionConfiguration} instead. + * @noextend This interface is not intended to be extended by clients. * * @see "http://gcc.gnu.org/onlinedocs/gcc/C-Extensions.html" * @see "http://gcc.gnu.org/onlinedocs/gcc/C_002b_002b-Extensions.html" diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/rewrite/ASTRewrite.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/rewrite/ASTRewrite.java index 0bc21187b61..7e20633a449 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/rewrite/ASTRewrite.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/rewrite/ASTRewrite.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007, 2008 Wind River Systems, Inc. and others. + * Copyright (c) 2007, 2009 Wind River Systems, Inc. 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 @@ -41,6 +41,7 @@ import org.eclipse.text.edits.TextEditGroup; * consulting with the CDT team. *

* @since 5.0 + * @noinstantiate This class is not intended to be instantiated by clients. */ public final class ASTRewrite { @@ -55,10 +56,7 @@ public final class ASTRewrite { private final ASTModificationStore fModificationStore; private final ASTModification fParentMod; - /** - * @noreference This constructor is not intended to be referenced by clients. - */ - public ASTRewrite(IASTNode root, ASTModificationStore modStore, ASTModification parentMod) { + private ASTRewrite(IASTNode root, ASTModificationStore modStore, ASTModification parentMod) { fRoot= root; fModificationStore= modStore; fParentMod= parentMod; diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/rewrite/ITrackedNodePosition.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/rewrite/ITrackedNodePosition.java index 4c53a365d7a..d9d2a9ff374 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/rewrite/ITrackedNodePosition.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/rewrite/ITrackedNodePosition.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2008 IBM Corporation and others. + * Copyright (c) 2004, 2009 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 @@ -14,12 +14,10 @@ package org.eclipse.cdt.core.dom.rewrite; /** * A tracked node position is returned when a rewrite change is * requested to be tracked. - *

- * This interface is not intended to be implemented by clients. - *

* * @since 5.1 * @noimplement This interface is not intended to be implemented by clients. + * @noextend This interface is not intended to be extended by clients. */ public interface ITrackedNodePosition {