aboutsummaryrefslogtreecommitdiff
path: root/ext/js/data/anki-note-builder.js
diff options
context:
space:
mode:
Diffstat (limited to 'ext/js/data/anki-note-builder.js')
-rw-r--r--ext/js/data/anki-note-builder.js28
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,