API docs build

This commit is contained in:
zadam
2023-09-06 09:25:00 +02:00
parent 90fc4b8293
commit 40971afe4f
21 changed files with 488 additions and 139 deletions

View File

@@ -62,7 +62,7 @@ import shortcutService from "./shortcuts.js";
* @constructor
*/
function FrontendScriptApi(startNote, currentNote, originEntity = null, $container = null) {
/**
/**
* Container of all the rendered script content
* @type {jQuery}
* */
@@ -79,7 +79,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
* @type {FNote}
*/
this.currentNote = currentNote;
/**
/**
* Entity whose event triggered this execution
* @type {object|null}
*/
@@ -359,6 +359,8 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
* @param {boolean} [params.showNotePath=false] - show also whole note's path as part of the link
* @param {boolean} [params.showNoteIcon=false] - show also note icon before the title
* @param {string} [params.title] - custom link tile with note's title as default
* @param {string} [params.title=] - custom link tile with note's title as default
* @returns {jQuery} - jQuery element with the link (wrapped in <span>)
*/
this.createLink = linkService.createLink;