add some JSDoc to the code

This commit is contained in:
lxsang
2020-06-10 11:15:01 +02:00
parent edbffeb2b8
commit 6365081f56
22 changed files with 1562 additions and 370 deletions

View File

@ -58,11 +58,11 @@ namespace OS {
*
*
* @protected
* @param {(string | FormatedString)} m
* @param {(string | FormattedString)} m
* @returns {void}
* @memberof BaseExtension
*/
protected notify(m: string | FormatedString): void {
protected notify(m: string | FormattedString): void {
return this.app.notify(m);
}
@ -70,12 +70,12 @@ namespace OS {
*
*
* @protected
* @param {(string | FormatedString)} m
* @param {(string | FormattedString)} m
* @param {Error} e
* @returns {void}
* @memberof BaseExtension
*/
protected error(m: string | FormatedString, e: Error): void {
protected error(m: string | FormattedString, e: Error): void {
return this.app.error(m, e);
}

View File

@ -978,7 +978,7 @@ namespace OS {
* @class CMDMenu
*/
class CMDMenu {
text: string | FormatedString;
text: string | FormattedString;
private shortcut: string;
nodes: GenericObject<any>[];
parent: CMDMenu;
@ -990,11 +990,11 @@ namespace OS {
/**
*Creates an instance of CMDMenu.
* @param {(string | FormatedString)} text
* @param {(string | FormattedString)} text
* @param {string} [shortcut]
* @memberof CMDMenu
*/
constructor(text: string | FormatedString, shortcut?: string) {
constructor(text: string | FormattedString, shortcut?: string) {
this.text = text;
this.shortcut = shortcut;
this.nodes = [];