Add @event to events in monaco.d.ts

alexdima · alexdima · commit 54c152fd6d7e · 2016-10-23T09:24:23.000+02:00
diff --git a/src/vs/base/common/cancellation.ts b/src/vs/base/common/cancellation.ts
@@ -9,6 +9,10 @@ import Event, { Emitter } from 'vs/base/common/event';
 
 export interface CancellationToken {
 	isCancellationRequested: boolean;
+	/**
+	 * An event emitted when cancellation is requested
+	 * @event
+	 */
 	onCancellationRequested: Event<any>;
 }
 
diff --git a/src/vs/editor/browser/editorBrowser.ts b/src/vs/editor/browser/editorBrowser.ts
@@ -403,38 +403,47 @@ export interface IOverviewRuler {
 export interface ICodeEditor extends editorCommon.ICommonCodeEditor {
 	/**
 	 * An event emitted on a "mouseup".
+	 * @event
 	 */
 	onMouseUp(listener: (e: IEditorMouseEvent) => void): IDisposable;
 	/**
 	 * An event emitted on a "mousedown".
+	 * @event
 	 */
 	onMouseDown(listener: (e: IEditorMouseEvent) => void): IDisposable;
 	/**
 	 * An event emitted on a "contextmenu".
+	 * @event
 	 */
 	onContextMenu(listener: (e: IEditorMouseEvent) => void): IDisposable;
 	/**
 	 * An event emitted on a "mousemove".
+	 * @event
 	 */
 	onMouseMove(listener: (e: IEditorMouseEvent) => void): IDisposable;
 	/**
 	 * An event emitted on a "mouseleave".
+	 * @event
 	 */
 	onMouseLeave(listener: (e: IEditorMouseEvent) => void): IDisposable;
 	/**
 	 * An event emitted on a "keyup".
+	 * @event
 	 */
 	onKeyUp(listener: (e: IKeyboardEvent) => void): IDisposable;
 	/**
 	 * An event emitted on a "keydown".
+	 * @event
 	 */
 	onKeyDown(listener: (e: IKeyboardEvent) => void): IDisposable;
 	/**
 	 * An event emitted when the layout of the editor has changed.
+	 * @event
 	 */
 	onDidLayoutChange(listener: (e: editorCommon.EditorLayoutInfo) => void): IDisposable;
 	/**
 	 * An event emitted when the scroll in the editor has changed.
+	 * @event
 	 */
 	onDidScrollChange(listener: (e: editorCommon.IScrollEvent) => void): IDisposable;
 
diff --git a/src/vs/editor/browser/standalone/standaloneEditor.ts b/src/vs/editor/browser/standalone/standaloneEditor.ts
@@ -174,20 +174,23 @@ export function getModels(): IModel[] {
 
 /**
  * Emitted when a model is created.
+ * @event
  */
 export function onDidCreateModel(listener: (model: IModel) => void): IDisposable {
 	return StaticServices.modelService.get().onModelAdded(listener);
 }
 
 /**
  * Emitted right before a model is disposed.
+ * @event
  */
 export function onWillDisposeModel(listener: (model: IModel) => void): IDisposable {
 	return StaticServices.modelService.get().onModelRemoved(listener);
 }
 
 /**
  * Emitted when a different language is set to a model.
+ * @event
  */
 export function onDidChangeModelLanguage(listener: (e: { model: IModel; oldLanguage: string; }) => void): IDisposable {
 	return StaticServices.modelService.get().onModelModeChanged((e) => {
diff --git a/src/vs/editor/browser/standalone/standaloneLanguages.ts b/src/vs/editor/browser/standalone/standaloneLanguages.ts
@@ -42,6 +42,7 @@ export function getLanguages(): ILanguageExtensionPoint[] {
 
 /**
  * An event emitted when a language is first time needed (e.g. a model has it set).
+ * @event
  */
 export function onLanguage(languageId: string, callback: () => void): IDisposable {
 	let isDisposed = false;
diff --git a/src/vs/editor/common/editorCommon.ts b/src/vs/editor/common/editorCommon.ts
@@ -2185,26 +2185,32 @@ export interface IModel extends IReadOnlyModel, IEditableTextModel, ITextModelWi
 	 * @deprecated Please use `onDidChangeContent` instead.
 	 * An event emitted when the contents of the model have changed.
 	 * @internal
+	 * @event
 	 */
 	onDidChangeRawContent(listener: (e: IModelContentChangedEvent) => void): IDisposable;
 	/**
 	 * An event emitted when the contents of the model have changed.
+	 * @event
 	 */
 	onDidChangeContent(listener: (e: IModelContentChangedEvent2) => void): IDisposable;
 	/**
 	 * An event emitted when decorations of the model have changed.
+	 * @event
 	 */
 	onDidChangeDecorations(listener: (e: IModelDecorationsChangedEvent) => void): IDisposable;
 	/**
 	 * An event emitted when the model options have changed.
+	 * @event
 	 */
 	onDidChangeOptions(listener: (e: IModelOptionsChangedEvent) => void): IDisposable;
 	/**
 	 * An event emitted when the language associated with the model has changed.
+	 * @event
 	 */
 	onDidChangeMode(listener: (e: IModelModeChangedEvent) => void): IDisposable;
 	/**
 	 * An event emitted right before disposing the model.
+	 * @event
 	 */
 	onWillDispose(listener: () => void): IDisposable;
 
@@ -3504,34 +3510,42 @@ export interface IEditor {
 	 * @deprecated. Please use `onDidChangeModelContent` instead.
 	 * An event emitted when the content of the current model has changed.
 	 * @internal
+	 * @event
 	 */
 	onDidChangeModelRawContent(listener: (e: IModelContentChangedEvent) => void): IDisposable;
 	/**
 	 * An event emitted when the content of the current model has changed.
+	 * @event
 	 */
 	onDidChangeModelContent(listener: (e: IModelContentChangedEvent2) => void): IDisposable;
 	/**
 	 * An event emitted when the language of the current model has changed.
+	 * @event
 	 */
 	onDidChangeModelMode(listener: (e: IModelModeChangedEvent) => void): IDisposable;
 	/**
 	 * An event emitted when the options of the current model has changed.
+	 * @event
 	 */
 	onDidChangeModelOptions(listener: (e: IModelOptionsChangedEvent) => void): IDisposable;
 	/**
 	 * An event emitted when the configuration of the editor has changed. (e.g. `editor.updateOptions()`)
+	 * @event
 	 */
 	onDidChangeConfiguration(listener: (e: IConfigurationChangedEvent) => void): IDisposable;
 	/**
 	 * An event emitted when the cursor position has changed.
+	 * @event
 	 */
 	onDidChangeCursorPosition(listener: (e: ICursorPositionChangedEvent) => void): IDisposable;
 	/**
 	 * An event emitted when the cursor selection has changed.
+	 * @event
 	 */
 	onDidChangeCursorSelection(listener: (e: ICursorSelectionChangedEvent) => void): IDisposable;
 	/**
 	 * An event emitted when the editor has been disposed.
+	 * @event
 	 */
 	onDidDispose(listener: () => void): IDisposable;
 
@@ -3890,26 +3904,32 @@ export interface IDecorationOptions {
 export interface ICommonCodeEditor extends IEditor {
 	/**
 	 * An event emitted when the model of this editor has changed (e.g. `editor.setModel()`).
+	 * @event
 	 */
 	onDidChangeModel(listener: (e: IModelChangedEvent) => void): IDisposable;
 	/**
 	 * An event emitted when the decorations of the current model have changed.
+	 * @event
 	 */
 	onDidChangeModelDecorations(listener: (e: IModelDecorationsChangedEvent) => void): IDisposable;
 	/**
 	 * An event emitted when the text inside this editor gained focus (i.e. cursor blinking).
+	 * @event
 	 */
 	onDidFocusEditorText(listener: () => void): IDisposable;
 	/**
 	 * An event emitted when the text inside this editor lost focus.
+	 * @event
 	 */
 	onDidBlurEditorText(listener: () => void): IDisposable;
 	/**
 	 * An event emitted when the text inside this editor or an editor widget gained focus.
+	 * @event
 	 */
 	onDidFocusEditor(listener: () => void): IDisposable;
 	/**
 	 * An event emitted when the text inside this editor or an editor widget lost focus.
+	 * @event
 	 */
 	onDidBlurEditor(listener: () => void): IDisposable;
 
@@ -4068,6 +4088,7 @@ export interface ICommonCodeEditor extends IEditor {
 export interface ICommonDiffEditor extends IEditor {
 	/**
 	 * An event emitted when the diff information computed by this diff editor has been updated.
+	 * @event
 	 */
 	onDidUpdateDiff(listener: () => void): IDisposable;
 
diff --git a/src/vs/monaco.d.ts b/src/vs/monaco.d.ts

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,10 @@ import Event, { Emitter } from 'vs/base/common/event';`
`9`	`9`
`10`	`10`	`export interface CancellationToken {`
`11`	`11`	`isCancellationRequested: boolean;`
	`12`	`+ /**`
	`13`	`+ * An event emitted when cancellation is requested`
	`14`	`+ * @event`
	`15`	`+ */`
`12`	`16`	`onCancellationRequested: Event<any>;`
`13`	`17`	`}`
`14`	`18`