platform: update javadoc for FeedbackDescriptionProvider

This commit is contained in:
nik
2019-03-20 16:44:55 +03:00
parent 97cd86d54c
commit 059d08dd95
@@ -9,7 +9,8 @@ import com.intellij.openapi.project.Project
*/
interface FeedbackDescriptionProvider {
/**
* Return additional details which should be appended to the description of a created issue.
* Return additional details which should be appended to the description of a created issue. It's important to return `null` if your plugin
* isn't relevant for the passed `project` to avoid polluting created reports with unrelated data.
*/
fun getDescription(project: Project?): String?
}