1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-10 09:45:39 +02:00

added comments

This commit is contained in:
Alena Laskavaia 2009-05-09 01:54:38 +00:00
parent 46c0442b85
commit b73e485897

View file

@ -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();
}