obsidian-plugin/rifts-obsidian-laboratory_anki-integration
1
0
Fork 0
mirror of https://github.com/rifts-obsidian-laboratory/anki-integration.git synced 2026-07-22 05:42:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Code Review - Commented AddNoteFromCodeblockModal's method behavior with JSDoc

Browse source
This commit is contained in:
Noah Boos 2025-04-22 17:37:07 +02:00
parent 7d578778fd
commit e62bf2dba0
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/modals/AddNoteFromCodeblockModal.ts
View file

@ -196,6 +196,12 @@ export class AddNoteFromCodeblockModal extends Modal {
}
}
/**
* onOpen() async equivalent allowing asynchronous operations.
* @param {DropdownComponent} deckSelector - Dropdown component that allows the user to select a deck.
* @param {DropdownComponent} modelSelector - Dropdown component that allows the user to select a model.
* @param {HTMLDivElement} inputContainer - Speaking for itself.
*/
async onOpenAsync(deckSelector: DropdownComponent, modelSelector: DropdownComponent, inputContainer: HTMLDivElement): Promise<void> {
/**
* @type {Object} codeblockParameters
@ -210,6 +216,13 @@ export class AddNoteFromCodeblockModal extends Modal {
await AutoGenerateFields(this, modelSelector, inputContainer, codeblockParameters);
}
/**
* Return the note's parameters defined in the codeblock.
* @description Method that :
* - retrieve the first codeblock using "AnkiIntegration" as its language in the open and currently active file in the instance of Obsidian.
* - extract each lines following a "key: value;" or "key: "value";" and push it an object that is returned by the function.
* @return {Object} codeblockParameters
*/
async GetCodeBlockParameters() {
/**
* @type {TFile} activeFileData