mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-04-23 22:52:11 +02:00
Remove @noreference from getResourceProfileWorkingCopy since it's used
externally.
This commit is contained in:
parent
9fa581109a
commit
f85b0e8f4c
1 changed files with 17 additions and 18 deletions
|
@ -1,32 +1,31 @@
|
||||||
/*******************************************************************************
|
/*******************************************************************************
|
||||||
* Copyright (c) 2009, 2010 Alena Laskavaia
|
* Copyright (c) 2009, 2010 Alena Laskavaia and others.
|
||||||
* All rights reserved. This program and the accompanying materials
|
* All rights reserved. This program and the accompanying materials
|
||||||
* are made available under the terms of the Eclipse Public License v1.0
|
* are made available under the terms of the Eclipse Public License v1.0
|
||||||
* which accompanies this distribution, and is available at
|
* which accompanies this distribution, and is available at
|
||||||
* http://www.eclipse.org/legal/epl-v10.html
|
* http://www.eclipse.org/legal/epl-v10.html
|
||||||
*
|
*
|
||||||
* Contributors:
|
* Contributors:
|
||||||
* Alena Laskavaia - initial API and implementation
|
* Alena Laskavaia - initial API and implementation
|
||||||
*******************************************************************************/
|
*******************************************************************************/
|
||||||
package org.eclipse.cdt.codan.core.model;
|
package org.eclipse.cdt.codan.core.model;
|
||||||
|
|
||||||
|
import org.eclipse.core.resources.IResource;
|
||||||
|
|
||||||
import java.util.Collection;
|
import java.util.Collection;
|
||||||
import java.util.Iterator;
|
import java.util.Iterator;
|
||||||
|
|
||||||
import org.eclipse.core.resources.IResource;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This interface an API to add/remove checker and problems programmatically,
|
* This interface an API to add/remove checker and problems programmatically,
|
||||||
* get problem profiles and change problem default settings
|
* get problem profiles and change problem default settings
|
||||||
*
|
*
|
||||||
* @noextend This interface is not intended to be extended by clients.
|
* @noextend This interface is not intended to be extended by clients.
|
||||||
* @noimplement This interface is not intended to be implemented by clients.
|
* @noimplement This interface is not intended to be implemented by clients.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
public interface ICheckersRegistry extends Iterable<IChecker> {
|
public interface ICheckersRegistry extends Iterable<IChecker> {
|
||||||
/**
|
/**
|
||||||
* Iterator for registered checkers
|
* Iterator for registered checkers
|
||||||
*
|
*
|
||||||
* @return iterator for registered checkers
|
* @return iterator for registered checkers
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
|
@ -34,7 +33,7 @@ public interface ICheckersRegistry extends Iterable<IChecker> {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Add a checker
|
* Add a checker
|
||||||
*
|
*
|
||||||
* @param checker instance
|
* @param checker instance
|
||||||
*/
|
*/
|
||||||
public void addChecker(IChecker checker);
|
public void addChecker(IChecker checker);
|
||||||
|
@ -42,7 +41,7 @@ public interface ICheckersRegistry extends Iterable<IChecker> {
|
||||||
/**
|
/**
|
||||||
* Add problem p into a category defined by a category id into default
|
* Add problem p into a category defined by a category id into default
|
||||||
* profile, category must exists in default profile
|
* profile, category must exists in default profile
|
||||||
*
|
*
|
||||||
* @param p
|
* @param p
|
||||||
* - problem
|
* - problem
|
||||||
* @param categoryId
|
* @param categoryId
|
||||||
|
@ -54,7 +53,7 @@ public interface ICheckersRegistry extends Iterable<IChecker> {
|
||||||
* Add subcategory category into parent category with the id of
|
* Add subcategory category into parent category with the id of
|
||||||
* parentCategoryId, if parent does not exist in the default profile or it
|
* parentCategoryId, if parent does not exist in the default profile or it
|
||||||
* is a null - it will be added to the root
|
* is a null - it will be added to the root
|
||||||
*
|
*
|
||||||
* @param category
|
* @param category
|
||||||
* - new category
|
* - new category
|
||||||
* @param parentCategoryId
|
* @param parentCategoryId
|
||||||
|
@ -66,7 +65,7 @@ public interface ICheckersRegistry extends Iterable<IChecker> {
|
||||||
* Add problem reference to a checker, i.e. claim that checker can produce
|
* Add problem reference to a checker, i.e. claim that checker can produce
|
||||||
* this problem. If checker does not claim any problems it cannot be
|
* this problem. If checker does not claim any problems it cannot be
|
||||||
* enabled.
|
* enabled.
|
||||||
*
|
*
|
||||||
* @param c
|
* @param c
|
||||||
* - checker
|
* - checker
|
||||||
* @param p
|
* @param p
|
||||||
|
@ -76,7 +75,7 @@ public interface ICheckersRegistry extends Iterable<IChecker> {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return collection of problem that this checker can produce
|
* Return collection of problem that this checker can produce
|
||||||
*
|
*
|
||||||
* @param checker
|
* @param checker
|
||||||
* @return collection of problems
|
* @return collection of problems
|
||||||
*/
|
*/
|
||||||
|
@ -85,14 +84,14 @@ public interface ICheckersRegistry extends Iterable<IChecker> {
|
||||||
/**
|
/**
|
||||||
* Default profile is kind of "Installation Default".
|
* Default profile is kind of "Installation Default".
|
||||||
* Always the same, comes from defaults in checker extensions or APIs added
|
* Always the same, comes from defaults in checker extensions or APIs added
|
||||||
*
|
*
|
||||||
* @return default profile
|
* @return default profile
|
||||||
*/
|
*/
|
||||||
public IProblemProfile getDefaultProfile();
|
public IProblemProfile getDefaultProfile();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get workspace profile. User can change setting for workspace profile.
|
* Get workspace profile. User can change setting for workspace profile.
|
||||||
*
|
*
|
||||||
* @return workspace profile
|
* @return workspace profile
|
||||||
*/
|
*/
|
||||||
public IProblemProfile getWorkspaceProfile();
|
public IProblemProfile getWorkspaceProfile();
|
||||||
|
@ -100,7 +99,7 @@ public interface ICheckersRegistry extends Iterable<IChecker> {
|
||||||
/**
|
/**
|
||||||
* Get resource profile. For example given project can have different
|
* Get resource profile. For example given project can have different
|
||||||
* profile than a workspace.
|
* profile than a workspace.
|
||||||
*
|
*
|
||||||
* @param element
|
* @param element
|
||||||
* - resource
|
* - resource
|
||||||
* @return resource profile
|
* @return resource profile
|
||||||
|
@ -114,16 +113,16 @@ public interface ICheckersRegistry extends Iterable<IChecker> {
|
||||||
* getResourceProfile. You have to save your changes after updating a
|
* getResourceProfile. You have to save your changes after updating a
|
||||||
* working copy, using {@link #updateProfile(IResource, IProblemProfile)}
|
* working copy, using {@link #updateProfile(IResource, IProblemProfile)}
|
||||||
* method.
|
* method.
|
||||||
*
|
*
|
||||||
* @noreference This method is not intended to be referenced by clients.
|
|
||||||
* @param element
|
* @param element
|
||||||
* @return resource profile
|
* @return resource profile
|
||||||
|
* @since 2.1
|
||||||
*/
|
*/
|
||||||
public IProblemProfile getResourceProfileWorkingCopy(IResource element);
|
public IProblemProfile getResourceProfileWorkingCopy(IResource element);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set profile for resource.
|
* Set profile for resource.
|
||||||
*
|
*
|
||||||
* @noreference This method is not intended to be referenced by clients.
|
* @noreference This method is not intended to be referenced by clients.
|
||||||
* @param resource
|
* @param resource
|
||||||
* - resource
|
* - resource
|
||||||
|
|
Loading…
Add table
Reference in a new issue