diff options
author | Cashew <52880648+Scrub1492@users.noreply.github.com> | 2023-12-19 14:22:22 +0900 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-12-19 05:22:22 +0000 |
commit | 5f96276fda93dcad39f2165fd3c8d890aa5f9be5 (patch) | |
tree | 1437c9298afa0ecd41414446043fe799026e8c79 /ext/js/data/anki-note-builder.js | |
parent | 7b93055f2e3d79729195fbd515cdccbf538c9376 (diff) |
update JSDoc comments (#387)
* lesen-tan initial commit
* update README.md
* tidy up code
* opt for Map<K, V> instead of Object
* Document dev/*
* add docs for deinflector.js
* update deinflector example
* Annotate
* Revert "Merge branch 'development' of https://github.com/Scrub1492/lesen-tan into development"
This reverts commit b92348f702bc031b36f24462adfa940d17f9ecdd, reversing
changes made to 3255e6d963281af3533dcf1e893df39032d29fec.
* Lint error fix
* Lint error fix
* update JSDoc comments
---------
Co-authored-by: Darius Jahandarie <djahandarie@gmail.com>
Diffstat (limited to 'ext/js/data/anki-note-builder.js')
-rw-r--r-- | ext/js/data/anki-note-builder.js | 28 |
1 files changed, 0 insertions, 28 deletions
diff --git a/ext/js/data/anki-note-builder.js b/ext/js/data/anki-note-builder.js index 80cc210a..9240c1d8 100644 --- a/ext/js/data/anki-note-builder.js +++ b/ext/js/data/anki-note-builder.js @@ -22,16 +22,10 @@ import {TemplateRendererProxy} from '../templates/template-renderer-proxy.js'; import {yomitan} from '../yomitan.js'; import {AnkiUtil} from './anki-util.js'; -/** - * Anki Note Builder Class. - */ export class AnkiNoteBuilder { /** * Initiate an instance of AnkiNoteBuilder. * @param {{japaneseUtil: import('../language/sandbox/japanese-util.js').JapaneseUtil}} details - * @example - * const japaneseUtil = new JapaneseUtil(null); - * const ankiNoteBuilder = new AnkiNoteBuilder({japaneseUtil}); */ constructor({japaneseUtil}) { /** @type {import('../language/sandbox/japanese-util.js').JapaneseUtil} */ @@ -47,30 +41,8 @@ export class AnkiNoteBuilder { } /** - * Creates an Anki note. * @param {import('anki-note-builder').CreateNoteDetails} details * @returns {Promise<import('anki-note-builder').CreateNoteResult>} - * @example - * const ankiNoteBuilder = new AnkiNoteBuilder({japaneseUtil}); - * const details = { - * dictionaryEntry, - * mode: 'test', - * context, - * template, - * deckName: 'deckName', - * modelName: 'modelName', - * fields, - * tags: ['yomitan'], - * checkForDuplicates: true, - * duplicateScope: 'collection', - * duplicateScopeCheckAllModels: false, - * resultOutputMode: mode, - * glossaryLayoutMode: 'default', - * compactTags: false, - * requirements: [], - * mediaOptions: null - * }; - * const {note: {fields: noteFields}, errors} = await ankiNoteBuilder.createNote(details); */ async createNote({ dictionaryEntry, |