From f7e88bd594b14dc2c0d6f3c286874afb365fe80f Mon Sep 17 00:00:00 2001 From: tugcekucukoglu Date: Wed, 1 Nov 2023 09:52:05 +0300 Subject: [PATCH] Slot apidoc updates --- api-generator/build-apidoc.js | 6 +++++- doc/common/apidoc/index.json | 32 ++++++++++++++++---------------- 2 files changed, 21 insertions(+), 17 deletions(-) diff --git a/api-generator/build-apidoc.js b/api-generator/build-apidoc.js index 00d5490d4..3a9d1413e 100644 --- a/api-generator/build-apidoc.js +++ b/api-generator/build-apidoc.js @@ -398,7 +398,11 @@ if (project) { functionParameters += `${param.name}: ${param.type?.name}`; }); - type += `\t ${child.name}: (${functionParameters}) ⇒ ${child.type?.declaration?.signatures[0]?.type?.name}, // ${child.type?.declaration?.signatures[0]?.comment.summary[0]?.text}\n`; + if (child.type?.declaration?.signatures[0]?.comment?.getTag('@deprecated')?.content[0]?.text) { + type += `\t ${child.name}: (${functionParameters}) ⇒ ${child.type?.declaration?.signatures[0]?.type?.name}, // ${child.type?.declaration?.signatures[0]?.comment.summary[0]?.text}\n`; + } else { + type += `\t ${child.name}: (${functionParameters}) ⇒ ${child.type?.declaration?.signatures[0]?.type?.name}, // ${child.type?.declaration?.signatures[0]?.comment.summary[0]?.text}\n`; + } } else { const childType = child.type.elementType ? child.type.elementType.name : child.type.name; diff --git a/doc/common/apidoc/index.json b/doc/common/apidoc/index.json index 5446fab77..152fb49ac 100644 --- a/doc/common/apidoc/index.json +++ b/doc/common/apidoc/index.json @@ -3966,7 +3966,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t class: string, // Style class of the icon.\n \t index: number, // Index of the token.\n \t onClick: (event: Event, index: number) ⇒ void, // Remove token icon function.\n\t removeCallback: (event: Event, index: number) ⇒ void, // Remove token icon function.\n}" + "type": "{\n \t class: string, // Style class of the icon.\n \t index: number, // Index of the token.\n \t onClick: (event: Event, index: number) ⇒ void, // Remove token icon function.\n\t removeCallback: (event: Event, index: number) ⇒ void, // Remove token icon function.\n}" } ], "returnType": "VNode[]", @@ -11154,7 +11154,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t onClick: (event: Event) ⇒ void, // Remove icon click event\n\t onKeydown: (event: Event) ⇒ void, // Remove icon keydown event\n\t removeCallback: (event: Event) ⇒ void, // Remove icon click event\n\t keydownCallback: (event: Event) ⇒ void, // Remove icon keydown event\n}", + "type": "{\n \t onClick: (event: Event) ⇒ void, // Remove icon click event\n\t onKeydown: (event: Event) ⇒ void, // Remove icon keydown event\n\t removeCallback: (event: Event) ⇒ void, // Remove icon click event\n\t keydownCallback: (event: Event) ⇒ void, // Remove icon keydown event\n}", "description": "remove icon slot's params." } ], @@ -11649,7 +11649,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t class: string, // Style class of the icon.\n \t index: number, // Index of the token.\n \t onClick: (event: Event, index: number) ⇒ void, // Remove token icon function.\n\t removeCallback: (event: Event, index: number) ⇒ void, // Remove token icon function.\n}", + "type": "{\n \t class: string, // Style class of the icon.\n \t index: number, // Index of the token.\n \t onClick: (event: Event, index: number) ⇒ void, // Remove token icon function.\n\t removeCallback: (event: Event, index: number) ⇒ void, // Remove token icon function.\n}", "description": "remove token icon slot's params." } ], @@ -16132,7 +16132,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t message: any, // Message of the component\n \t onClose: () ⇒ void, // Close dialog function.\n\t onAccept: () ⇒ void, // Accept function of the component\n\t onReject: () ⇒ void, // Reject function of the component\n\t closeCallback: () ⇒ void, // Close dialog function.\n\t acceptCallback: () ⇒ void, // Accept function of the component\n\t rejectCallback: () ⇒ void, // Reject function of the component\n}", + "type": "{\n \t message: any, // Message of the component\n \t onClose: () ⇒ void, // Close dialog function.\n\t onAccept: () ⇒ void, // Accept function of the component\n\t onReject: () ⇒ void, // Reject function of the component\n\t closeCallback: () ⇒ void, // Close dialog function.\n\t acceptCallback: () ⇒ void, // Accept function of the component\n\t rejectCallback: () ⇒ void, // Reject function of the component\n}", "description": "container slot's params." } ], @@ -16476,7 +16476,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t message: any, // Message of the component\n \t onAccept: () ⇒ void, // Accept function of the component\n\t onReject: () ⇒ void, // Reject function of the component\n\t acceptCallback: () ⇒ void, // Accept function of the component\n\t rejectCallback: () ⇒ void, // Reject function of the component\n}", + "type": "{\n \t message: any, // Message of the component\n \t onAccept: () ⇒ void, // Accept function of the component\n\t onReject: () ⇒ void, // Reject function of the component\n\t acceptCallback: () ⇒ void, // Accept function of the component\n\t rejectCallback: () ⇒ void, // Reject function of the component\n}", "description": "container slot's params." } ], @@ -21813,7 +21813,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t onClose: () ⇒ void, // Close dialog function.\n\t onMaximize: (event: Event) ⇒ void, // Maximize/minimize dialog function.\n\t closeCallback: () ⇒ void, // Close dialog function.\n\t maximizeCallback: (event: Event) ⇒ void, // Maximize/minimize dialog function.\n}", + "type": "{\n \t onClose: () ⇒ void, // Close dialog function.\n\t onMaximize: (event: Event) ⇒ void, // Maximize/minimize dialog function.\n\t closeCallback: () ⇒ void, // Close dialog function.\n\t maximizeCallback: (event: Event) ⇒ void, // Maximize/minimize dialog function.\n}", "description": "container slot's params." } ], @@ -23677,7 +23677,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t class: any, // Style class of the clear icon\n \t onClick: (event: Event) ⇒ void, // Clear icon click function.\n\t clearCallback: (event: Event) ⇒ void, // Clear icon click function.\n}", + "type": "{\n \t class: any, // Style class of the clear icon\n \t onClick: (event: Event) ⇒ void, // Clear icon click function.\n\t clearCallback: (event: Event) ⇒ void, // Clear icon click function.\n}", "description": "clear icon slot's params." } ], @@ -27713,7 +27713,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t class: any, // Style class of the image element.\n \t style: any, // Style of the image element.\n \t onError: () ⇒ void, // Image error function.\n\t errorCallback: () ⇒ void, // Preview click function.\n}", + "type": "{\n \t class: any, // Style class of the image element.\n \t style: any, // Style of the image element.\n \t onError: () ⇒ void, // Image error function.\n\t errorCallback: () ⇒ void, // Preview click function.\n}", "description": "image slot's params." } ], @@ -27726,7 +27726,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t class: any, // Style class of the preview image element.\n \t style: any, // Style of the preview image element.\n \t onClick: () ⇒ void, // Preview click function.\n\t previewCallback: () ⇒ void, // Preview click function.\n}", + "type": "{\n \t class: any, // Style class of the preview image element.\n \t style: any, // Style of the preview image element.\n \t onClick: () ⇒ void, // Preview click function.\n\t previewCallback: () ⇒ void, // Preview click function.\n}", "description": "preview slot's params." } ], @@ -33627,7 +33627,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t onClose: () ⇒ void, // Close message function.\n\t closeCallback: () ⇒ void, // Close message function.\n}", + "type": "{\n \t onClose: () ⇒ void, // Close message function.\n\t closeCallback: () ⇒ void, // Close message function.\n}", "description": "container slot's params." } ], @@ -34836,7 +34836,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t class: string, // Style class of the loading icon.\n \t item: any, // Item of the token.\n \t onClick: (event: Event, item: any) ⇒ void, // Remove token icon function.\n\t removeCallback: (event: Event, item: any) ⇒ void, // Remove token icon function.\n}", + "type": "{\n \t class: string, // Style class of the loading icon.\n \t item: any, // Item of the token.\n \t onClick: (event: Event, item: any) ⇒ void, // Remove token icon function.\n\t removeCallback: (event: Event, item: any) ⇒ void, // Remove token icon function.\n}", "description": "removetokenicon slot's params." } ], @@ -39042,7 +39042,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t onClick: () ⇒ void, // Hide icon click event\n\t toggleCallback: () ⇒ void, // Hide icon click event\n}", + "type": "{\n \t onClick: () ⇒ void, // Hide icon click event\n\t toggleCallback: () ⇒ void, // Hide icon click event\n}", "description": "hideicon slot's params." } ], @@ -39055,7 +39055,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t onClick: () ⇒ void, // Hide icon click event\n\t toggleCallback: () ⇒ void, // Hide icon click event\n}", + "type": "{\n \t onClick: () ⇒ void, // Hide icon click event\n\t toggleCallback: () ⇒ void, // Hide icon click event\n}", "description": "showicon slot's params." } ], @@ -43422,7 +43422,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t onClose: () ⇒ void, // Close sidebar function.\n\t closeCallback: () ⇒ void, // Close sidebar function.\n}", + "type": "{\n \t onClose: () ⇒ void, // Close sidebar function.\n\t closeCallback: () ⇒ void, // Close sidebar function.\n}", "description": "container slot's params." } ], @@ -44617,7 +44617,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t onClick: (event: Event) ⇒ void, // Button click function\n\t toggleCallback: (event: Event) ⇒ void, // Button click function\n}", + "type": "{\n \t onClick: (event: Event) ⇒ void, // Button click function\n\t toggleCallback: (event: Event) ⇒ void, // Button click function\n}", "description": "button slot's params." } ], @@ -50098,7 +50098,7 @@ { "name": "scope", "optional": false, - "type": "{\n \t message: any, // Message of the component\n \t onClose: () ⇒ void, // Close toast function\n\t closeCallback: () ⇒ void, // Close sidebar function.\n}", + "type": "{\n \t message: any, // Message of the component\n \t onClose: () ⇒ void, // Close toast function\n\t closeCallback: () ⇒ void, // Close sidebar function.\n}", "description": "container slot's params." } ],