added examples to API

redhat-developer · Jul 19, 2020 · 4abec54 · 4abec54
1 parent ff705bf
commit 4abec54
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/extension.ts b/src/extension.ts
@@ -41,6 +41,13 @@ export interface XMLFileAssociation {
 /**
  * Interface for APIs exposed from the extension.
  * 
+ * @remarks
+ * A sample code to use these APIs are as following:
+ * const ext = await vscode.extensions.getExtension('redhat.vscode-xml').activate();
+ * ext.addXMLCatalogs(...);
+ * ext.removeXMLCatalogs(...);
+ * ext.addXMLFileAssociations(...);
+ * ext.removeXMLFileAssociations(...);
  */
 export interface XMLExtensionApi {
   /**