Update comment.

This commit is contained in:
Anders Starcke Henriksen
2023-10-13 16:28:14 +02:00
parent d5388576b5
commit e8e6c6bbc7

View File

@@ -43,14 +43,24 @@ export class LanguageContextStore extends DisposableObject {
);
}
// shouldInclude should return true if the given language should be included.
// That means that either the given language is selected or the "All" option is selected.
/**
* This returns true if the given language should be included.
*
* That means that either the given language is selected or the "All" option is selected.
*
* @param language a query language or undefined if the language is unknown.
*/
public shouldInclude(language: QueryLanguage | undefined): boolean {
return this.languageFilter === "All" || this.languageFilter === language;
}
// isSelectedLanguage returns true if the given language is selected. If no language
// is given then it returns true if the "All" option is selected.
/**
* This returns true if the given language is selected.
*
* If no language is given then it returns true if the "All" option is selected.
*
* @param language a query language or undefined.
*/
public isSelectedLanguage(language: QueryLanguage | undefined): boolean {
return (
(this.languageFilter === "All" && language === undefined) ||