gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-03-01 14:22:32 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

JSDoc improvements

Browse Source
This commit is contained in:
zadam 2024-02-16 10:42:25 +01:00
parent 2d865576cf
commit 450b52f6da
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/services/backend_script_api.js
View File

@ -43,12 +43,16 @@ const optionsService = require('./options.js');
*/ */
function BackendScriptApi(currentNote, apiParams) { function BackendScriptApi(currentNote, apiParams) {
/** /**
* Note where the script started executing * Note where the script started executing (entrypoint).
* As an analogy, in C this would be the file which contains the main() function of the current process.
* @type {BNote} * @type {BNote}
*/ */
this.startNote = apiParams.startNote; this.startNote = apiParams.startNote;
/** /**
* Note where the script is currently executing. Don't mix this up with the concept of active note * Note where the script is currently executing. This comes into play when your script is spread in multiple code
* notes, the script starts in "startNote", but then through function calls may jump into another note (currentNote).
* A similar concept in C would be __FILE__
* Don't mix this up with the concept of active note.
* @type {BNote} * @type {BNote}
*/ */
this.currentNote = currentNote; this.currentNote = currentNote;