diff --git a/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/ICheckersRegistry.java b/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/ICheckersRegistry.java index 675f5447ced..110e2342cb8 100644 --- a/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/ICheckersRegistry.java +++ b/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/ICheckersRegistry.java @@ -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 * 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 * * Contributors: - * Alena Laskavaia - initial API and implementation + * Alena Laskavaia - initial API and implementation *******************************************************************************/ package org.eclipse.cdt.codan.core.model; +import org.eclipse.core.resources.IResource; + import java.util.Collection; import java.util.Iterator; -import org.eclipse.core.resources.IResource; - /** * This interface an API to add/remove checker and problems programmatically, * get problem profiles and change problem default settings - * + * * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. - * */ public interface ICheckersRegistry extends Iterable { /** * Iterator for registered checkers - * + * * @return iterator for registered checkers */ @Override @@ -34,7 +33,7 @@ public interface ICheckersRegistry extends Iterable { /** * Add a checker - * + * * @param checker instance */ public void addChecker(IChecker checker); @@ -42,7 +41,7 @@ public interface ICheckersRegistry extends Iterable { /** * Add problem p into a category defined by a category id into default * profile, category must exists in default profile - * + * * @param p * - problem * @param categoryId @@ -54,7 +53,7 @@ public interface ICheckersRegistry extends Iterable { * Add subcategory category into parent category with the id of * parentCategoryId, if parent does not exist in the default profile or it * is a null - it will be added to the root - * + * * @param category * - new category * @param parentCategoryId @@ -66,7 +65,7 @@ public interface ICheckersRegistry extends Iterable { * 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 * enabled. - * + * * @param c * - checker * @param p @@ -76,7 +75,7 @@ public interface ICheckersRegistry extends Iterable { /** * Return collection of problem that this checker can produce - * + * * @param checker * @return collection of problems */ @@ -85,14 +84,14 @@ public interface ICheckersRegistry extends Iterable { /** * Default profile is kind of "Installation Default". * Always the same, comes from defaults in checker extensions or APIs added - * + * * @return default profile */ public IProblemProfile getDefaultProfile(); /** * Get workspace profile. User can change setting for workspace profile. - * + * * @return workspace profile */ public IProblemProfile getWorkspaceProfile(); @@ -100,7 +99,7 @@ public interface ICheckersRegistry extends Iterable { /** * Get resource profile. For example given project can have different * profile than a workspace. - * + * * @param element * - resource * @return resource profile @@ -114,16 +113,16 @@ public interface ICheckersRegistry extends Iterable { * getResourceProfile. You have to save your changes after updating a * working copy, using {@link #updateProfile(IResource, IProblemProfile)} * method. - * - * @noreference This method is not intended to be referenced by clients. + * * @param element * @return resource profile + * @since 2.1 */ public IProblemProfile getResourceProfileWorkingCopy(IResource element); /** * Set profile for resource. - * + * * @noreference This method is not intended to be referenced by clients. * @param resource * - resource