mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-08-10 09:45:39 +02:00
added comments
This commit is contained in:
parent
46c0442b85
commit
b73e485897
1 changed files with 28 additions and 1 deletions
|
@ -11,15 +11,42 @@
|
|||
package org.eclipse.cdt.codan.core.model;
|
||||
|
||||
/**
|
||||
* @author Alena
|
||||
* Problem Profile contains tree of categories and problems. Profiles can have
|
||||
* different categories and different problems set, problems with the same id
|
||||
* can have different severities/enablement in different profiles. To obtain
|
||||
* profile use class {@link CheckersRegisry#getResourceProfile,
|
||||
* CheckersRegisry#getDefaultProfile() or CheckersRegisry#getWorkspaceProfile()}
|
||||
* .
|
||||
*
|
||||
*/
|
||||
public interface IProblemProfile extends IProblemElement {
|
||||
/**
|
||||
* @return root category in profile
|
||||
*/
|
||||
IProblemCategory getRoot();
|
||||
|
||||
/**
|
||||
* Find and return problem by id
|
||||
*
|
||||
* @param id
|
||||
* - problem id
|
||||
* @return problem instance
|
||||
*/
|
||||
IProblem findProblem(String id);
|
||||
|
||||
/**
|
||||
* Find and return category by id
|
||||
*
|
||||
* @param id
|
||||
* - category id
|
||||
* @return category instance
|
||||
*/
|
||||
IProblemCategory findCategory(String id);
|
||||
|
||||
/**
|
||||
* Get all defined problems
|
||||
*
|
||||
* @return array of problems defined in profile
|
||||
*/
|
||||
IProblem[] getProblems();
|
||||
}
|
||||
|
|
Loading…
Add table
Reference in a new issue