From 5a3882f3881d4dd9f04925e5eb43355a8dbcd889 Mon Sep 17 00:00:00 2001 From: zadam Date: Thu, 22 Dec 2022 14:59:20 +0100 Subject: [PATCH] fixed comments --- docs/frontend_api/FrontendScriptApi.html | 91 ++++++++++--------- .../services_frontend_script_api.js.html | 1 + .../app/services/frontend_script_api.js | 1 + src/services/special_notes.js | 6 +- 4 files changed, 50 insertions(+), 49 deletions(-) diff --git a/docs/frontend_api/FrontendScriptApi.html b/docs/frontend_api/FrontendScriptApi.html index 83f1f1a75..2c0ad3896 100644 --- a/docs/frontend_api/FrontendScriptApi.html +++ b/docs/frontend_api/FrontendScriptApi.html @@ -1301,7 +1301,8 @@ -
Deprecated:
+
Deprecated:
@@ -1315,7 +1316,7 @@
Source:
@@ -1452,7 +1453,7 @@
Source:
@@ -1591,7 +1592,7 @@
Source:
@@ -1799,7 +1800,7 @@
Source:
@@ -2163,7 +2164,7 @@
Source:
@@ -2296,7 +2297,7 @@
Source:
@@ -2406,7 +2407,7 @@
Source:
@@ -2512,7 +2513,7 @@
Source:
@@ -2618,7 +2619,7 @@
Source:
@@ -2728,7 +2729,7 @@
Source:
@@ -2839,7 +2840,7 @@ implementation of actual widget type.
Source:
@@ -2943,7 +2944,7 @@ implementation of actual widget type.
Source:
@@ -3051,7 +3052,7 @@ implementation of actual widget type.
Source:
@@ -3219,7 +3220,7 @@ implementation of actual widget type.
Source:
@@ -3356,7 +3357,7 @@ implementation of actual widget type.
Source:
@@ -3513,7 +3514,7 @@ implementation of actual widget type.
Source:
@@ -3668,7 +3669,7 @@ implementation of actual widget type.
Source:
@@ -3775,7 +3776,7 @@ if some action needs to happen on only one specific instance.
Source:
@@ -3930,7 +3931,7 @@ if some action needs to happen on only one specific instance.
Source:
@@ -4086,7 +4087,7 @@ if some action needs to happen on only one specific instance.
Source:
@@ -4287,7 +4288,7 @@ otherwise (by e.g. createNoteLink())
Source:
@@ -4393,7 +4394,7 @@ otherwise (by e.g. createNoteLink())
Source:
@@ -4548,7 +4549,7 @@ otherwise (by e.g. createNoteLink())
Source:
@@ -4703,7 +4704,7 @@ otherwise (by e.g. createNoteLink())
Source:
@@ -4853,7 +4854,7 @@ otherwise (by e.g. createNoteLink())
Source:
@@ -5342,7 +5343,7 @@ otherwise (by e.g. createNoteLink())
Source:
@@ -5450,7 +5451,7 @@ otherwise (by e.g. createNoteLink())
Source:
@@ -5606,7 +5607,7 @@ otherwise (by e.g. createNoteLink())
Source:
@@ -5762,7 +5763,7 @@ otherwise (by e.g. createNoteLink())
Source:
@@ -5899,7 +5900,7 @@ otherwise (by e.g. createNoteLink())
Source:
@@ -6053,7 +6054,7 @@ otherwise (by e.g. createNoteLink())
Source:
@@ -6139,7 +6140,7 @@ otherwise (by e.g. createNoteLink())
Source:
@@ -6276,7 +6277,7 @@ otherwise (by e.g. createNoteLink())
Source:
@@ -6437,7 +6438,7 @@ Internally this serializes the anonymous function into string and sends it to ba
Source:
@@ -6545,7 +6546,7 @@ Internally this serializes the anonymous function into string and sends it to ba
Source:
@@ -6683,7 +6684,7 @@ Internally this serializes the anonymous function into string and sends it to ba
Source:
@@ -6839,7 +6840,7 @@ Internally this serializes the anonymous function into string and sends it to ba
Source:
@@ -6994,7 +6995,7 @@ Internally this serializes the anonymous function into string and sends it to ba
Source:
@@ -7145,7 +7146,7 @@ Internally this serializes the anonymous function into string and sends it to ba
Source:
@@ -7282,7 +7283,7 @@ Internally this serializes the anonymous function into string and sends it to ba
Source:
@@ -7419,7 +7420,7 @@ Internally this serializes the anonymous function into string and sends it to ba
Source:
@@ -7579,7 +7580,7 @@ Internally this serializes the anonymous function into string and sends it to ba
Source:
@@ -7739,7 +7740,7 @@ Internally this serializes the anonymous function into string and sends it to ba
Source:
@@ -7831,7 +7832,7 @@ Typical use case is when new note has been created, we should wait until it is s
Source:
diff --git a/docs/frontend_api/services_frontend_script_api.js.html b/docs/frontend_api/services_frontend_script_api.js.html index 488f338be..4c186fa99 100644 --- a/docs/frontend_api/services_frontend_script_api.js.html +++ b/docs/frontend_api/services_frontend_script_api.js.html @@ -147,6 +147,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain * Adds a new launcher to the launchbar. If the launcher (id) already exists, it will be updated. * * @deprecated you can now create/modify launchers in the top-left Menu -> Configure Launchbar + * for special needs there's also backend API's createOrUpdateLauncher() * @param {AddButtonToToolbarOptions} opts */ this.addButtonToToolbar = async opts => { diff --git a/src/public/app/services/frontend_script_api.js b/src/public/app/services/frontend_script_api.js index 4792810db..14b714ba2 100644 --- a/src/public/app/services/frontend_script_api.js +++ b/src/public/app/services/frontend_script_api.js @@ -119,6 +119,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain * Adds a new launcher to the launchbar. If the launcher (id) already exists, it will be updated. * * @deprecated you can now create/modify launchers in the top-left Menu -> Configure Launchbar + * for special needs there's also backend API's createOrUpdateLauncher() * @param {AddButtonToToolbarOptions} opts */ this.addButtonToToolbar = async opts => { diff --git a/src/services/special_notes.js b/src/services/special_notes.js index dbaf2ce54..e75a33621 100644 --- a/src/services/special_notes.js +++ b/src/services/special_notes.js @@ -234,10 +234,8 @@ function resetLauncher(noteId) { * Previously, the launchbar was fixed and the only way to add buttons was through this API, so a lot of buttons have been * created just to fill this user hole. * - * Another use case would be for script-packages (of which only few exists) which could this way register automatically - * into the launchbar. For such use cases this might be a usable replacement, but it should look a bit differently: - * - launcher should be added into the available shortcuts, not visible. Part of the reasoning is that adding them to visible - * could mess up the layout - e.g. the sync status being below. + * Another use case was for script-packages (e.g. demo Task manager) which could this way register automatically/easily + * into the launchbar - for this it's recommended to use backend API's createOrUpdateLauncher() */ function createOrUpdateScriptLauncherFromApi(opts) { if (opts.id && !/^[a-z0-9]+$/i.test(opts.id)) {