more doc

microsoft · Dec 12, 2019 · 608ac23 · 608ac23
1 parent be49cd0
commit 608ac23
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/vs/editor/common/services/resourceConfiguration.ts b/src/vs/editor/common/services/resourceConfiguration.ts
@@ -12,12 +12,17 @@ import { createDecorator } from 'vs/platform/instantiation/common/instantiation'
 export const IResourceConfigurationService = createDecorator<IResourceConfigurationService>('resourceConfigurationService');
 
 export interface IResourceConfigurationChangeEvent {
+
  /**
  * All affected keys. Also includes language overrides and keys changed under language overrides.
  */
  readonly affectedKeys: string[];
+
  /**
  * Returns `true` if the given section has changed for the given resource.
+ *
+ * Example: To check if the configuration section has changed for a given resource use `e.affectsConfiguration(resource, section)`.
+ *
  * @param resource Resource for which the configuration has to be checked.
  * @param section Section of the configuration
  */