obsidian-typings 4.109.0 → 4.110.0

package/dist/cjs/implementations.d.cts

@@ -67,9 +67,17 @@ export declare class HighlightOutline extends Outline {
 	constructor(outlines: unknown, box: unknown, lastPoint: any);
 	/** The last point of the highlight used for directional calculations. */
 	lastPoint: unknown;
-	/** The bounding box of the highlight outline. */
+	/**
+	 * The bounding box of the highlight outline.
+	 *
+	 * @returns The bounding box, or null.
+	 */
 	get box(): Object | null;
-	/** CSS class names applied when outlining this highlight. */
+	/**
+	 * CSS class names applied when outlining this highlight.
+	 *
+	 * @returns The class names for outlining.
+	 */
 	get classNamesForOutlining(): string[];
 	/**
 	 * Serialize the outlines into the PDF page coordinate system.
@@ -105,7 +113,11 @@ export declare class HighlightOutliner {
 	 *   the last point of the boxes.
 	 */
 	constructor(boxes: Array<Object>, borderWidth?: number, innerMargin?: number, isLTR?: boolean);
-	/** Compute and return the highlight outlines for the given boxes. */
+	/**
+	 * Compute and return the highlight outlines for the given boxes.
+	 *
+	 * @returns The computed highlight outlines.
+	 */
 	getOutlines(): HighlightOutline;
 }
 /**
@@ -122,26 +134,59 @@ export declare class Outline {
 	 * @returns The bounding box of the outline.
 	 */
 	get box(): Object | null;
-	/** Serialize the outline into the PDF page coordinate system. */
+	/**
+	 * Serialize the outline into the PDF page coordinate system.
+	 *
+	 * @param bbox - The bounding box as bottom-left and top-right coordinates.
+	 * @param rotation - The page rotation in degrees.
+	 */
 	serialize(bbox: [
 		blX: string,
 		blY: string,
 		trX: string,
 		trY: string
 	], rotation: number): void;
-	/** Normalize a point relative to the page with the given rotation. */
+	/**
+	 * Normalize a point relative to the page with the given rotation.
+	 *
+	 * @returns The normalized point coordinates.
+	 */
 	static _normalizePagePoint(x: unknown, y: unknown, rotation: unknown): unknown[];
-	/** Normalize a point relative to a parent element with the given dimensions and rotation. */
+	/**
+	 * Normalize a point relative to a parent element with the given dimensions and rotation.
+	 *
+	 * @returns The normalized point coordinates.
+	 */
 	static _normalizePoint(x: unknown, y: unknown, parentWidth: unknown, parentHeight: unknown, rotation: unknown): number[];
-	/** Rescale coordinates by translation and scale factors. */
+	/**
+	 * Rescale coordinates by translation and scale factors.
+	 *
+	 * @returns The rescaled coordinates.
+	 */
 	static _rescale(src: unknown, tx: unknown, ty: unknown, sx: unknown, sy: unknown, dest: unknown): unknown;
-	/** Rescale and swap coordinates by translation and scale factors. */
+	/**
+	 * Rescale and swap coordinates by translation and scale factors.
+	 *
+	 * @returns The rescaled and swapped coordinates.
+	 */
 	static _rescaleAndSwap(src: unknown, tx: unknown, ty: unknown, sx: unknown, sy: unknown, dest: unknown): unknown;
-	/** Translate coordinates by the given offsets. */
+	/**
+	 * Translate coordinates by the given offsets.
+	 *
+	 * @returns The translated coordinates.
+	 */
 	static _translate(src: unknown, tx: unknown, ty: unknown, dest: unknown): unknown;
-	/** Create cubic bezier control points between two endpoints. */
+	/**
+	 * Create cubic bezier control points between two endpoints.
+	 *
+	 * @returns The bezier control point coordinates.
+	 */
 	static createBezierPoints(x1: unknown, y1: unknown, x2: unknown, y2: unknown, x3: unknown, y3: unknown): number[];
-	/** Round a number to the configured SVG precision. */
+	/**
+	 * Round a number to the configured SVG precision.
+	 *
+	 * @returns The rounded number.
+	 */
 	static svgRound(x: unknown): number;
 	/**
 	 * Converts the outline to an SVG path.
@@ -530,9 +575,17 @@ export interface AbstractFileTreeItem<T extends TAbstractFile> extends TreeItem
 	rendered: boolean;
 	/** Reference to the file explorer view containing this item. */
 	view: FileExplorerView;
-	/** Get the display title for this tree item. */
+	/**
+	 * Get the display title for this tree item.
+	 *
+	 * @returns The display title.
+	 */
 	getTitle(): string;
-	/** Whether the full timestamp is shown for this item. */
+	/**
+	 * Whether the full timestamp is shown for this item.
+	 *
+	 * @returns Whether the full timestamp is shown.
+	 */
 	isFullTimeShown(): boolean;
 	/** Called when this item is rendered to the DOM. */
 	onRender(): void;
@@ -587,18 +640,21 @@ export interface AbstractSearchComponent {
 	 * Switch to the next inputElement.
 	 *
 	 * @param event - The keyboard event that triggered the input switch.
+	 * @returns The result of switching to the next input.
 	 */
 	goToNextInput(event: KeyboardEvent): unknown;
 	/**
 	 * Invokes findNextOrReplace.
 	 *
 	 * @param event - The keyboard event that triggered the action.
+	 * @returns The result of the enter action.
 	 */
 	onEnter(event: KeyboardEvent): unknown;
 	/**
 	 * Invokes findPrevious.
 	 *
 	 * @param event - The keyboard event that triggered the action.
+	 * @returns The result of the shift-enter action.
 	 */
 	onShiftEnter(event: KeyboardEvent): unknown;
 }
@@ -682,6 +738,8 @@ export interface AliasesPropertyWidgetComponent extends PropertyWidgetComponentB
 export interface AllPropertiesView extends ItemView {
 	/**
 	 * Try to rename the file.
+	 *
+	 * @returns A promise that resolves when the rename is complete.
 	 */
 	acceptRename(): Promise<void>;
 	/**
@@ -694,9 +752,16 @@ export interface AllPropertiesView extends ItemView {
 	exitRename(): void;
 	/**
 	 * Get the current view type.
+	 *
+	 * @returns The all properties view type.
 	 */
 	getViewType(): typeof ViewType.AllProperties;
-	/** Check whether the given object is a property item. */
+	/**
+	 * Check whether the given object is a property item.
+	 *
+	 * @param e - The object to check.
+	 * @returns Whether the object is a property item.
+	 */
 	isItem(e: unknown): boolean;
 	/**
 	 * Select the item in focus if pressed 'Enter'.
@@ -714,7 +779,11 @@ export interface AllPropertiesView extends ItemView {
 	 * Toggles the visibility of the search.
 	 */
 	onToggleShowSearch(): void;
-	/** Set the visibility of the search filter. */
+	/**
+	 * Set the visibility of the search filter.
+	 *
+	 * @param e - Whether to show the search filter.
+	 */
 	setShowSearch(e: boolean): void;
 	/**
 	 * Updates the sort order and sort by it.
@@ -726,7 +795,12 @@ export interface AllPropertiesView extends ItemView {
 	 * Shows the search and focus is.
 	 */
 	showSearch(): void;
-	/** Begin inline renaming of a property. */
+	/**
+	 * Begin inline renaming of a property.
+	 *
+	 * @param e - The property item to rename.
+	 * @returns The result of the rename operation.
+	 */
 	startRename(e: unknown): Promise<unknown>;
 	/** Refresh the properties list. */
 	update(): void;
@@ -1206,9 +1280,17 @@ export interface AudioRecorderPluginInstance extends InternalPluginInstance<Audi
 	 * @returns Whether microphone permission is granted.
 	 */
 	checkPermission(): Promise<boolean>;
-	/** Initiate the audio recording flow. */
+	/**
+	 * Initiate the audio recording flow.
+	 *
+	 * @returns A promise that resolves when the recording flow completes.
+	 */
 	onRecordAudio(): Promise<void>;
-	/** Start a new audio recording session. */
+	/**
+	 * Start a new audio recording session.
+	 *
+	 * @returns A promise that resolves when recording has started.
+	 */
 	onStartRecording(): Promise<void>;
 	/** Stop the current audio recording session. */
 	onStopRecording(): void;
@@ -1216,6 +1298,7 @@ export interface AudioRecorderPluginInstance extends InternalPluginInstance<Audi
 	 * Save the recorded audio buffer to a file in the vault.
 	 *
 	 * @param audioBuffer - The recorded audio data.
+	 * @returns A promise that resolves when the recording is saved.
 	 */
 	saveRecording(audioBuffer: ArrayBuffer): Promise<void>;
 	/**
@@ -1325,7 +1408,11 @@ export interface BacklinkComponent extends Component {
 	unlinkedHeaderEl: HTMLDivElement;
 	/** Queue of files to process for unlinked mention computation. */
 	unlinkedQueue: null;
-	/** Add a link from an unlinked mention to the target file. */
+	/**
+	 * Add a link from an unlinked mention to the target file.
+	 *
+	 * @returns The result of adding the link.
+	 */
 	addLinkFunction(arg1: unknown, arg2: unknown, arg3: unknown): unknown;
 	/**
 	 * Get the current state of the backlink component.
@@ -1405,7 +1492,11 @@ export interface BacklinkComponent extends Component {
 	 * @returns The recomputation result.
 	 */
 	recomputeUnlinked(arg1: unknown): unknown;
-	/** Set whether the backlink section is collapsed. */
+	/**
+	 * Set whether the backlink section is collapsed.
+	 *
+	 * @returns The result of setting backlink collapsed state.
+	 */
 	setBacklinkCollapsed(arg1: unknown, arg2: unknown): Promise<unknown>;
 	/**
 	 * Set whether all results are collapsed.
@@ -1419,7 +1510,11 @@ export interface BacklinkComponent extends Component {
 	 * @returns The result of setting extra context.
 	 */
 	setExtraContext(arg1: unknown): unknown;
-	/** Set the collapsed state of a specific section. */
+	/**
+	 * Set the collapsed state of a specific section.
+	 *
+	 * @returns The result of setting the section collapsed state.
+	 */
 	setSectionCollapsed(arg1: unknown, arg2: unknown, arg3: unknown, arg4: unknown): Promise<unknown>;
 	/**
 	 * Set the visibility of the search filter.
@@ -1433,9 +1528,17 @@ export interface BacklinkComponent extends Component {
 	 * @returns The result of setting sort order.
 	 */
 	setSortOrder(arg1: unknown): unknown;
-	/** Restore the component from a saved state. */
+	/**
+	 * Restore the component from a saved state.
+	 *
+	 * @returns The result of restoring the state.
+	 */
 	setState(arg1: unknown): Promise<unknown>;
-	/** Set whether the unlinked mentions section is collapsed. */
+	/**
+	 * Set whether the unlinked mentions section is collapsed.
+	 *
+	 * @returns The result of setting unlinked collapsed state.
+	 */
 	setUnlinkedCollapsed(arg1: unknown, arg2: unknown): Promise<unknown>;
 	/** Cancel the current backlink search computation. */
 	stopBacklinkSearch(): void;
@@ -1463,7 +1566,11 @@ export interface BacklinkComponent extends Component {
 	 * @returns The update result.
 	 */
 	update(): unknown;
-	/** Update the tooltip text of a section header. */
+	/**
+	 * Update the tooltip text of a section header.
+	 *
+	 * @returns The result of updating the header tooltip.
+	 */
 	updateHeaderTooltip(arg1: unknown, arg2: unknown): unknown;
 	/**
 	 * Refresh the search filter and recompute filtered results.
@@ -1504,9 +1611,14 @@ export interface BacklinkPluginInstance extends InternalPluginInstance<BacklinkP
 	 *
 	 * @param app - The app instance.
 	 * @param plugin - The backlink plugin registration.
+	 * @returns A promise that resolves when the plugin is enabled.
 	 */
 	onEnable(app: App, plugin: BacklinkPlugin): Promise<void>;
-	/** Handle external settings file changes and reload configuration. */
+	/**
+	 * Handle external settings file changes and reload configuration.
+	 *
+	 * @returns A promise that resolves when the settings are reloaded.
+	 */
 	onExternalSettingsChange(): Promise<void>;
 	/**
 	 * Add backlink-related items to a file context menu.
@@ -1707,7 +1819,7 @@ export interface BasesControl {
 	 * Render to.
 	 *
 	 * @param containerEl - The container element.
-	 * @param t - The data to render.
+	 * @param renderContext - The render context.
 	 */
 	renderTo(containerEl: HTMLElement, renderContext: RenderContext): void;
 }
@@ -2058,10 +2170,16 @@ export interface BasesFunction {
 	returnType: string;
 	/**
 	 * Applies the function.
+	 *
+	 * @param args - The arguments to apply.
+	 * @returns The result of applying the function.
 	 */
 	apply(...args: unknown[]): unknown;
 	/**
 	 * Serializes the function.
+	 *
+	 * @param args - The arguments to serialize.
+	 * @returns The serialized function string.
 	 */
 	serialize(...args: unknown[]): string;
 }
@@ -2075,7 +2193,7 @@ export interface BasesFunctionArg {
 	/**
 	 * Whether to include custom types.
 	 */
-	include_custom_types?: boolean;
+	includeCustomTypes?: boolean;
 	/**
 	 * The name of the argument.
 	 */
@@ -2440,6 +2558,7 @@ export interface BasesPluginInstance extends InternalPluginInstance<BasesPlugin>
 	 * Creates and embeds a base.
 	 *
 	 * @param editor - The editor to embed the base into.
+	 * @returns A promise that resolves when the base is created and embedded.
 	 */
 	createAndEmbedBase(editor: Editor): Promise<void>;
 	/**
@@ -2533,18 +2652,27 @@ export interface BasesProperty {
 	unrecognizedData: object;
 	/**
 	 * Gets the display name.
+	 *
+	 * @returns The display name.
 	 */
 	getDisplayName(): string;
 	/**
 	 * Migrates the display name.
+	 *
+	 * @param getDisplayName - The display name to migrate.
+	 * @returns The migrated display name.
 	 */
 	migrateDisplayName(getDisplayName: string): string;
 	/**
 	 * Serializes the property.
+	 *
+	 * @returns The serialized property data.
 	 */
 	serialize(): object;
 	/**
 	 * Sets the display name.
+	 *
+	 * @param displayName - The display name to set.
 	 */
 	setDisplayName(displayName: string): void;
 }
@@ -2787,6 +2915,8 @@ export interface BasesView extends TextFileView {
 	query: BasesQuery;
 	/**
 	 * Get view type.
+	 *
+	 * @returns The bases view type.
 	 */
 	getViewType(): typeof ViewType.Bases;
 	/**
@@ -2799,10 +2929,14 @@ export interface BasesView extends TextFileView {
 	onViewChanged(): void;
 	/**
 	 * Receives the sync state.
+	 *
+	 * @param fileView - The file view to receive the sync state from.
 	 */
 	receiveSyncState(fileView: FileView): void;
 	/**
 	 * Saves the query.
+	 *
+	 * @param query - The query to save.
 	 */
 	saveQuery(query: BasesQuery): void;
 	/**
@@ -3019,9 +3153,14 @@ export interface BookmarksPluginInstance extends InternalPluginInstance<Bookmark
 	 *
 	 * @param app - The app instance.
 	 * @param plugin - The bookmarks plugin registration.
+	 * @returns A promise that resolves when the plugin is enabled.
 	 */
 	onEnable(app: App, plugin: BookmarksPlugin): Promise<void>;
-	/** Handle external settings file changes and reload configuration. */
+	/**
+	 * Handle external settings file changes and reload configuration.
+	 *
+	 * @returns A promise that resolves when the settings are reloaded.
+	 */
 	onExternalSettingsChange(): Promise<void>;
 	/**
 	 * Add bookmark-related items to a file context menu.
@@ -3077,6 +3216,7 @@ export interface BookmarksPluginInstance extends InternalPluginInstance<Bookmark
 	 * @param item - The bookmark item to open.
 	 * @param newLeaf - Where to open the bookmark.
 	 * @param newLeaf2 - Optional secondary pane type.
+	 * @returns A promise that resolves when the bookmark is opened.
 	 */
 	openBookmark(item: BookmarkItem, newLeaf: PaneType | boolean, newLeaf2?: PaneType | boolean): Promise<void>;
 	/**
@@ -3085,6 +3225,7 @@ export interface BookmarksPluginInstance extends InternalPluginInstance<Bookmark
 	 * @param item - The bookmark item to open.
 	 * @param leaf - The target workspace leaf.
 	 * @param newLeaf - Optional pane type override.
+	 * @returns A promise that resolves when the bookmark is opened in the leaf.
 	 */
 	openBookmarkInLeaf(item: BookmarkItem, leaf: WorkspaceLeaf, newLeaf?: PaneType | boolean): Promise<void>;
 	/**
@@ -3092,6 +3233,7 @@ export interface BookmarksPluginInstance extends InternalPluginInstance<Bookmark
 	 *
 	 * @param items - The bookmark items to open.
 	 * @param newLeaf - Optional pane type for opening.
+	 * @returns A promise that resolves when all bookmarks are opened.
 	 */
 	openBookmarks(items: BookmarkItem[], newLeaf?: PaneType | boolean): Promise<void>;
 	/** Rebuild the internal bookmark lookup caches. */
@@ -3113,7 +3255,13 @@ export interface BookmarksPluginInstance extends InternalPluginInstance<Bookmark
  * @unofficial
  */
 export interface BookmarksPluginViews extends Record<string, ViewCreator> {
-	/** Create a bookmarks view in the given workspace leaf. */
+	/**
+	 * Create a bookmarks view in the given workspace leaf.
+	 *
+	 * @param left - The workspace leaf to create the bookmarks view in.
+	 * @returns The created bookmarks view.
+	 * @unofficial
+	 */
 	bookmarks(left: WorkspaceLeaf): BookmarksView;
 }
 /**
@@ -3175,6 +3323,8 @@ export interface BookmarksView extends ItemView {
 	getNodeId(e: unknown): string;
 	/**
 	 * Get the current view type.
+	 *
+	 * @returns The bookmarks view type.
 	 */
 	getViewType(): typeof ViewType.Bookmarks;
 	/**
@@ -3200,6 +3350,7 @@ export interface BookmarksView extends ItemView {
 	 * Called when delete is requested.
 	 *
 	 * @param event - The event triggered this function.
+	 * @returns The result of the delete operation.
 	 */
 	onDeleteSelectedItems(event: unknown): unknown;
 	/**
@@ -5225,6 +5376,7 @@ export interface CapacitorAdapterFs {
 	 *
 	 * @param realPath - Real file system path.
 	 * @param data - Text data to append.
+	 * @returns A promise that resolves when the data is appended.
 	 */
 	append(realPath: string, data: string): Promise<void>;
 	/**
@@ -5232,12 +5384,14 @@ export interface CapacitorAdapterFs {
 	 *
 	 * @param realPath - Source file path.
 	 * @param newRealPath - Destination file path.
+	 * @returns A promise that resolves when the file is copied.
 	 */
 	copy(realPath: string, newRealPath: string): Promise<void>;
 	/**
 	 * Delete a file at the given path.
 	 *
 	 * @param realPath - File path to delete.
+	 * @returns A promise that resolves when the file is deleted.
 	 */
 	delete(realPath: string): Promise<void>;
 	/**
@@ -5261,18 +5415,24 @@ export interface CapacitorAdapterFs {
 	 * @returns URI string.
 	 */
 	getUri(realPath: string): string;
-	/** Initialize the file system adapter. */
+	/**
+	 * Initialize the file system adapter.
+	 *
+	 * @returns A promise that resolves when the adapter is initialized.
+	 */
 	init(): Promise<void>;
 	/**
 	 * Create a directory at the given path.
 	 *
 	 * @param realPath - Directory path to create.
+	 * @returns A promise that resolves when the directory is created.
 	 */
 	mkdir(realPath: string): Promise<void>;
 	/**
 	 * Open a file using the native platform handler.
 	 *
 	 * @param realPath - File path to open.
+	 * @returns A promise that resolves when the file is opened.
 	 */
 	open(realPath: string): Promise<void>;
 	/**
@@ -5301,12 +5461,14 @@ export interface CapacitorAdapterFs {
 	 *
 	 * @param realPath - Current file path.
 	 * @param newRealPath - New file path.
+	 * @returns A promise that resolves when the file is renamed.
 	 */
 	rename(realPath: string, newRealPath: string): Promise<void>;
 	/**
 	 * Remove a directory.
 	 *
 	 * @param realPath - Directory path to remove.
+	 * @returns A promise that resolves when the directory is removed.
 	 */
 	rmdir(realPath: string): Promise<void>;
 	/**
@@ -5315,6 +5477,7 @@ export interface CapacitorAdapterFs {
 	 * @param realPath - File path.
 	 * @param ctime - Creation time in milliseconds.
 	 * @param mtime - Modification time in milliseconds.
+	 * @returns A promise that resolves when the times are set.
 	 */
 	setTimes(realPath: string, ctime: number, mtime: number): Promise<void>;
 	/**
@@ -5328,18 +5491,21 @@ export interface CapacitorAdapterFs {
 	 * Move a file to the system trash.
 	 *
 	 * @param realPath - File path to trash.
+	 * @returns A promise that resolves when the file is trashed.
 	 */
 	trash(realPath: string): Promise<void>;
 	/**
 	 * Verify and download an iCloud file if it is not yet available locally.
 	 *
 	 * @param realPath - File path to verify.
+	 * @returns A promise that resolves when the iCloud file is verified.
 	 */
 	verifyIcloud(realPath: string): Promise<void>;
 	/**
 	 * Start watching a path for file system changes.
 	 *
 	 * @param realPath - Path to watch.
+	 * @returns A promise that resolves when the watcher is started.
 	 */
 	watch(realPath: string): Promise<void>;
 	/**
@@ -5354,6 +5520,7 @@ export interface CapacitorAdapterFs {
 	 *
 	 * @param realPath - File path to write to.
 	 * @param data - Text data to write.
+	 * @returns A promise that resolves when the file is written.
 	 */
 	write(realPath: string, data: string): Promise<void>;
 	/**
@@ -5361,6 +5528,7 @@ export interface CapacitorAdapterFs {
 	 *
 	 * @param realPath - File path to write to.
 	 * @param data - Binary data to write.
+	 * @returns A promise that resolves when the file is written.
 	 */
 	writeBinary(realPath: string, data: ArrayBuffer): Promise<void>;
 	/**
@@ -5368,6 +5536,7 @@ export interface CapacitorAdapterFs {
 	 *
 	 * @param realPath - File path to write to.
 	 * @param data - Binary data to write.
+	 * @returns A promise that resolves when the file is written.
 	 */
 	writeBinaryInternal(realPath: string, data: ArrayBuffer): Promise<void>;
 }
@@ -5490,12 +5659,14 @@ export interface ClipboardManager {
 	 *
 	 * @param file - File to embed.
 	 * @param replace - Whether to replace the current selection.
+	 * @returns A promise that resolves when the embed is inserted.
 	 */
 	insertAttachmentEmbed(file: TAbstractFile, replace: boolean): Promise<void>;
 	/**
 	 * Insert files from drop-event into the editor.
 	 *
 	 * @param importedAttachments - Attachments to insert.
+	 * @returns A promise that resolves when all files are inserted.
 	 */
 	insertFiles(importedAttachments: ImportedAttachment[]): Promise<void>;
 	/**
@@ -5505,6 +5676,7 @@ export interface ClipboardManager {
 	 * @param extension - File extension.
 	 * @param data - Binary data of the attachment.
 	 * @param replace - Whether to replace the current selection.
+	 * @returns A promise that resolves when the attachment is saved.
 	 * @remark Invokes insertAttachmentEmbed.
 	 */
 	saveAttachment(name: string, extension: string, data: ArrayBuffer, replace: boolean): Promise<void>;
@@ -6250,15 +6422,36 @@ export interface CommandPalettePluginInstance extends InternalPluginInstance<Com
 	plugin: CommandPalettePlugin;
 	/** List of recently used command IDs. */
 	recentCommands: string[];
-	/** Get the list of available commands for the palette. */
+	/**
+	 * Get the list of available commands for the palette.
+	 *
+	 * @returns The available commands.
+	 */
 	getCommands(): Command[];
-	/** Handle external settings file changes and reload configuration. */
+	/**
+	 * Handle external settings file changes and reload configuration.
+	 *
+	 * @returns A promise that resolves when the settings are reloaded.
+	 */
 	onExternalSettingsChange(): Promise<void>;
-	/** Called when the command palette is opened. */
+	/**
+	 * Called when the command palette is opened.
+	 *
+	 * @returns Whether the command palette was successfully opened.
+	 */
 	onOpen(): boolean;
-	/** Callback invoked to open the command palette. */
+	/**
+	 * Callback invoked to open the command palette.
+	 *
+	 * @returns Whether the callback was successfully executed.
+	 */
 	openCallback(): boolean;
-	/** Save the command palette settings. */
+	/**
+	 * Save the command palette settings.
+	 *
+	 * @param plugin - The command palette plugin to save settings for.
+	 * @unofficial
+	 */
 	saveSettings(plugin: CommandPalettePlugin): void;
 }
 /**
@@ -6294,22 +6487,27 @@ export interface Commands {
 	 * Execute a command by reference.
 	 *
 	 * @param command - Command to execute.
+	 * @returns Whether the command was successfully executed.
 	 */
 	executeCommand(command: Command): boolean;
 	/**
 	 * Execute a command by ID.
 	 *
 	 * @param commandId - ID of command to execute.
+	 * @returns Whether the command was successfully executed.
 	 */
 	executeCommandById(commandId: string): boolean;
 	/**
 	 * Find a command by ID.
 	 *
 	 * @param commandId - ID of command to find.
+	 * @returns The command, or undefined if not found.
 	 */
 	findCommand(commandId: string): Command | undefined;
 	/**
 	 * Lists **all** commands, both with and without editor callback.
+	 *
+	 * @returns All registered commands.
 	 */
 	listCommands(): Command[];
 	/**
@@ -6349,7 +6547,12 @@ export interface ConcatFunction extends BasesFunction {
  * @unofficial
  */
 export interface ConstructorBase<Args extends unknown[], Instance> {
-	/** Construct a new instance with the given arguments. */
+	/**
+	 * Construct a new instance with the given arguments.
+	 *
+	 * @param args - The constructor arguments.
+	 * @returns The constructed instance.
+	 */
 	new (...args: Args): Instance;
 	/** Prototype of the constructed instances. */
 	prototype: Instance;
@@ -6607,6 +6810,7 @@ export interface CustomCSS extends Component {
 	 * dummy manifest for the theme.
 	 *
 	 * @param options - Options for installing the theme.
+	 * @returns A promise that resolves when the legacy theme is installed.
 	 * @remark Name will be used as the folder name for the theme.
 	 */
 	installLegacyTheme(options: InstallThemeOptions): Promise<void>;
@@ -6615,6 +6819,7 @@ export interface CustomCSS extends Component {
 	 *
 	 * @param options - Options for installing the theme.
 	 * @param version - Version to install.
+	 * @returns A promise that resolves when the theme is installed.
 	 */
 	installTheme(options: InstallThemeOptions, version: string): Promise<void>;
 	/**
@@ -6624,13 +6829,29 @@ export interface CustomCSS extends Component {
 	 * @returns Whether the theme is installed.
 	 */
 	isThemeInstalled(themeName: string): boolean;
-	/** Load and apply CSS from the given source. */
+	/**
+	 * Load and apply CSS from the given source.
+	 *
+	 * @returns The result of loading CSS.
+	 */
 	loadCss(arg1: unknown): Promise<unknown>;
-	/** Load stored CustomCSS configuration data. */
+	/**
+	 * Load stored CustomCSS configuration data.
+	 *
+	 * @returns The loaded configuration data.
+	 */
 	loadData(): unknown;
-	/** Load and apply all enabled CSS snippets. */
+	/**
+	 * Load and apply all enabled CSS snippets.
+	 *
+	 * @returns The result of loading snippets.
+	 */
 	loadSnippets(): unknown;
-	/** Load and apply a specific theme. */
+	/**
+	 * Load and apply a specific theme.
+	 *
+	 * @returns The result of loading the theme.
+	 */
 	loadTheme(arg1: unknown): unknown;
 	/** Lifecycle hook called when the component is loaded. */
 	onload(): void;
@@ -6648,6 +6869,7 @@ export interface CustomCSS extends Component {
 	 * Remove a theme by theme name.
 	 *
 	 * @param themeName - Name of the theme to remove.
+	 * @returns A promise that resolves when the theme is removed.
 	 */
 	removeTheme(themeName: string): Promise<void>;
 	/**
@@ -6746,12 +6968,14 @@ export interface DailyNotesPluginInstance extends InternalPluginInstance<DailyNo
 	 * Navigate to the next existing daily note after the given timestamp.
 	 *
 	 * @param timestamp - The reference timestamp.
+	 * @returns A promise that resolves when navigation is complete.
 	 */
 	gotoNextExisting(timestamp: number): Promise<void>;
 	/**
 	 * Navigate to the previous existing daily note before the given timestamp.
 	 *
 	 * @param timestamp - The reference timestamp.
+	 * @returns A promise that resolves when navigation is complete.
 	 */
 	gotoPreviousExisting(timestamp: number): Promise<void>;
 	/**
@@ -6760,12 +6984,17 @@ export interface DailyNotesPluginInstance extends InternalPluginInstance<DailyNo
 	 * @param callback - The callback to invoke for each daily note.
 	 */
 	iterateDailyNotes(callback: (file: TFile, timestamp: number) => void): void;
-	/** Handle external settings file changes and reload configuration. */
+	/**
+	 * Handle external settings file changes and reload configuration.
+	 *
+	 * @returns A promise that resolves when the settings are reloaded.
+	 */
 	onExternalSettingsChange(): Promise<void>;
 	/**
 	 * Handle the open daily note command event.
 	 *
 	 * @param evt - The triggering event.
+	 * @returns A promise that resolves when the daily note is opened.
 	 */
 	onOpenDailyNote(evt: Event): Promise<void>;
 }
@@ -7023,7 +7252,7 @@ export interface DomEventsHandlers {
 	 *
 	 * @param evt - The mouse event.
 	 * @param targetEl - The target element.
-	 * @param linkText - The link text.
+	 * @param tag - The tag text.
 	 * @returns The result of handling the tag click.
 	 */
 	onTagClick(evt: MouseEvent, targetEl: HTMLElement, tag: string): unknown;
@@ -8016,14 +8245,20 @@ export interface EmbeddedEditorView extends Component {
 	useIframe: boolean;
 	/**
 	 * Get the preview editor, if exists.
+	 *
+	 * @returns The iframed markdown editor, or null.
 	 */
 	get editor(): IFramedMarkdownEditor | null;
 	/**
 	 * Get the path to the file, if any file registered.
+	 *
+	 * @returns The file path.
 	 */
 	get path(): string;
 	/**
 	 * Get the scroll of the file renderer component.
+	 *
+	 * @returns The scroll position.
 	 */
 	get scroll(): unknown;
 	/**
@@ -8258,6 +8493,9 @@ export interface FileExplorerPlugin extends InternalPlugin<FileExplorerPluginIns
 	/**
 	 * Reveals a file or folder in the file explorer view, opens the view if it is not already.
 	 * open/visible.
+	 *
+	 * @param item - The file or folder to reveal.
+	 * @unofficial
 	 */
 	revealInFolder(item: TFile | TFolder): void;
 }
@@ -8276,6 +8514,9 @@ export interface FileExplorerPluginInstance extends InternalPluginInstance<FileE
 	/**
 	 * Reveals a file or folder in the file explorer view, opens the view if it is not already.
 	 * open/visible.
+	 *
+	 * @param item - The file or folder to reveal.
+	 * @unofficial
 	 */
 	revealInFolder(item: TFile | TFolder): void;
 }
@@ -8319,6 +8560,8 @@ export interface FileExplorerView extends View {
 	tree: Tree<FileTreeItem | FolderTreeItem>;
 	/**
 	 * Try to rename the file.
+	 *
+	 * @returns A promise that resolves when the rename is accepted.
 	 */
 	acceptRename(): Promise<void>;
 	/**
@@ -8326,6 +8569,7 @@ export interface FileExplorerView extends View {
 	 *
 	 * @param file - The created file.
 	 * @param newLeaf - Where to open the view for this file.
+	 * @returns A promise that resolves when the file is opened and/or rename is started.
 	 */
 	afterCreate(file: TFile, newLeaf: PaneType | boolean): Promise<void>;
 	/**
@@ -8347,6 +8591,7 @@ export interface FileExplorerView extends View {
 	 * @param type - The type of file to create.
 	 * @param location - The location where to create the file.
 	 * @param newLeaf - Where to open the view for this file.
+	 * @returns A promise that resolves when the file or folder is created.
 	 */
 	createAbstractFile(type: "file" | "folder", location: TFolder, newLeaf: PaneType | boolean): Promise<void>;
 	/**
@@ -8398,6 +8643,8 @@ export interface FileExplorerView extends View {
 	getSortedFolderItems(folder: TFolder): FileTreeItem[];
 	/**
 	 * Get the current view type.
+	 *
+	 * @returns The file explorer view type.
 	 */
 	getViewType(): typeof ViewType.FileExplorer;
 	/**
@@ -8417,12 +8664,14 @@ export interface FileExplorerView extends View {
 	 * Is called when on the new folder icon is clicked. Call createAbstractFile().
 	 *
 	 * @param event - The MouseEvent which triggered this function.
+	 * @returns A promise that resolves when the folder is created.
 	 */
 	onCreateNewFolderClick(event: MouseEvent): Promise<void>;
 	/**
 	 * Is called when on the new note icon is clicked. Call createAbstractFile().
 	 *
 	 * @param event - The MouseEvent which triggered this function.
+	 * @returns A promise that resolves when the note is created.
 	 */
 	onCreateNewNoteClick(event: MouseEvent): Promise<void>;
 	/**
@@ -8435,6 +8684,7 @@ export interface FileExplorerView extends View {
 	 * Called when delete is requested.
 	 *
 	 * @param event - The event triggered this function.
+	 * @returns The result of the delete operation.
 	 */
 	onDeleteSelectedFiles(event: unknown): unknown;
 	/**
@@ -8570,12 +8820,15 @@ export interface FilePropertiesView extends InfoFileView {
 	getFile(): TFile;
 	/**
 	 * Get the current view type.
+	 *
+	 * @returns The file properties view type.
 	 */
 	getViewType(): typeof ViewType.FileProperties;
 	/**
 	 * Checks the file is an markdown file.
 	 *
 	 * @param file - The file to check.
+	 * @returns Whether the file is a supported markdown file.
 	 */
 	isSupportedFile(file: TFile): boolean;
 	/**
@@ -8596,6 +8849,7 @@ export interface FilePropertiesView extends InfoFileView {
 	 * Reads the file if it is supported.
 	 *
 	 * @param file - The file to read.
+	 * @returns A promise that resolves with the file contents.
 	 */
 	readSupportedFile(file: TFile): Promise<unknown>;
 	/**
@@ -8794,10 +9048,10 @@ export interface FileSuggestManager {
 	 * @param block - Block cache entry to match against.
 	 * @param sourcePath - Source path for link resolution.
 	 * @param content - Content of the block.
-	 * @param text_parts - Search fragments to match.
+	 * @param textParts - Search fragments to match.
 	 * @returns Search result if matched, or null.
 	 */
-	matchBlock(path: string, file: TFile, block: BlockCache, sourcePath: null | string, content: string, text_parts: string[]): SearchResult | null;
+	matchBlock(path: string, file: TFile, block: BlockCache, sourcePath: null | string, content: string, textParts: string[]): SearchResult | null;
 }
 /**
  * File suggestion.
@@ -8840,7 +9094,11 @@ export interface FileTreeItem extends AbstractFileTreeItem<TFile> {
 	 * if it wasn't a Markdown file.
 	 */
 	tagEl: HTMLElement | null;
-	/** Check whether the file type is supported for opening. */
+	/**
+	 * Check whether the file type is supported for opening.
+	 *
+	 * @returns Whether the file type is supported.
+	 */
 	isSupported(): boolean;
 }
 /**
@@ -9432,7 +9690,11 @@ export interface GraphPluginInstance extends InternalPluginInstance<GraphPlugin>
 	options: GraphPluginInstanceOptions;
 	/** Reference to the parent graph plugin. */
 	plugin: GraphPlugin;
-	/** Reload options when settings are changed externally. */
+	/**
+	 * Reload options when settings are changed externally.
+	 *
+	 * @returns A promise that resolves when the settings are reloaded.
+	 */
 	onExternalSettingsChange(): Promise<void>;
 	/**
 	 * Add graph-related items to the file context menu.
@@ -9819,6 +10081,10 @@ export interface HardWrapOptions {
 export interface HasCompare {
 	/**
 	 * Compares two values.
+	 *
+	 * @param a - The first value to compare.
+	 * @param b - The second value to compare.
+	 * @returns Whether the comparison is satisfied.
 	 */
 	compare(a: unknown, b: unknown): boolean;
 }
@@ -9831,6 +10097,9 @@ export interface HasCompare {
 export interface HasExtract {
 	/**
 	 * Extracts a date.
+	 *
+	 * @param date - The date to extract from.
+	 * @returns The extracted numeric value.
 	 */
 	extract(date: Date): number;
 }
@@ -9843,6 +10112,9 @@ export interface HasExtract {
 export interface HasGetDisplayName {
 	/**
 	 * Gets the display name.
+	 *
+	 * @param type - The type to get the display name for.
+	 * @returns The display name.
 	 */
 	getDisplayName(type: string): string;
 }
@@ -9855,6 +10127,9 @@ export interface HasGetDisplayName {
 export interface HasGetRHSWidgetType {
 	/**
 	 * Gets the RHS widget type.
+	 *
+	 * @param type - The type to get the RHS widget type for.
+	 * @returns The RHS widget type.
 	 */
 	getRHSWidgetType(type: string): string;
 }
@@ -9870,9 +10145,17 @@ export interface HeaderDom {
 	navButtonsEl: HTMLDivElement;
 	/** Container element for the navigation header. */
 	navHeaderEl: HTMLDivElement;
-	/** Add a navigation button to the header. */
+	/**
+	 * Add a navigation button to the header.
+	 *
+	 * @returns The created navigation button element.
+	 */
 	addNavButton(arg1: unknown, arg2: unknown, arg3: unknown, arg4: unknown): unknown;
-	/** Add a sort button to the header. */
+	/**
+	 * Add a sort button to the header.
+	 *
+	 * @returns The created sort button element.
+	 */
 	addSortButton(arg1: unknown, arg2: unknown, arg3: unknown, arg4: unknown): unknown;
 }
 /**
@@ -9936,31 +10219,39 @@ export interface HotkeyManager {
 	 * Get hotkey associated with command ID.
 	 *
 	 * @param command - Command ID to get hotkey for.
+	 * @returns The default hotkeys for the command.
 	 */
 	getDefaultHotkeys(command: string): KeymapInfo[];
 	/**
 	 * Get hotkey associated with command ID.
 	 *
 	 * @param command - Command ID to get hotkey for.
+	 * @returns The hotkeys for the command.
 	 */
 	getHotkeys(command: string): KeymapInfo[];
 	/**
 	 * Load hotkeys from storage.
 	 */
 	load(): void;
-	/** Handle raw file system change events for the hotkey config. */
+	/**
+	 * Handle raw file system change events for the hotkey config.
+	 *
+	 * @param e - The file system change event.
+	 */
 	onRaw(e: unknown): void;
 	/**
 	 * Trigger a command by keyboard event.
 	 *
 	 * @param event - Keyboard event to trigger command with.
 	 * @param keypress - Pressed key information.
+	 * @returns Whether a command was triggered.
 	 */
 	onTrigger(event: KeyboardEvent, keypress: KeymapInfo): boolean;
 	/**
 	 * Pretty-print hotkey of a command.
 	 *
 	 * @param commandId - Command ID to print hotkey for.
+	 * @returns The formatted hotkey string.
 	 */
 	printHotkeyForCommand(commandId: string): string;
 	/** Register event listeners for hotkey config file changes. */
@@ -10367,7 +10658,11 @@ export interface InternalPlugin<InternalPluginInstance> extends Component {
 	 * @param settingTab - The settings tab to add.
 	 */
 	addSettingTab(settingTab: PluginSettingTab): void;
-	/** Delete persisted data for this plugin. */
+	/**
+	 * Delete persisted data for this plugin.
+	 *
+	 * @returns A promise that resolves when the data is deleted.
+	 */
 	deleteData(): Promise<void>;
 	/**
 	 * Disable this plugin.
@@ -10379,6 +10674,7 @@ export interface InternalPlugin<InternalPluginInstance> extends Component {
 	 * Enable this plugin.
 	 *
 	 * @param isEnabledByUser - Whether the user manually enabled the plugin.
+	 * @returns A promise that resolves when the plugin is enabled.
 	 */
 	enable(isEnabledByUser?: boolean): Promise<void>;
 	/**
@@ -10387,7 +10683,11 @@ export interface InternalPlugin<InternalPluginInstance> extends Component {
 	 * @returns The modification timestamp, or undefined.
 	 */
 	getModifiedTime(): Promise<number | undefined>;
-	/** Handle changes to the plugin config file. */
+	/**
+	 * Handle changes to the plugin config file.
+	 *
+	 * @returns A promise that resolves when the config change is processed.
+	 */
 	handleConfigFileChange(): Promise<void>;
 	/** Initialize this plugin. */
 	init(): void;
@@ -10430,6 +10730,7 @@ export interface InternalPlugin<InternalPluginInstance> extends Component {
 	 * Save data for this plugin.
 	 *
 	 * @param data - The data object to persist.
+	 * @returns A promise that resolves when the data is saved.
 	 */
 	saveData(data: object): Promise<void>;
 }
@@ -10521,6 +10822,8 @@ export interface InternalPlugins extends Events {
 	], Promise<void>>;
 	/**
 	 * - Load plugin configs and enable plugins.
+	 *
+	 * @returns A promise that resolves when all plugins are enabled.
 	 */
 	enable(): Promise<void>;
 	/**
@@ -10558,6 +10861,8 @@ export interface InternalPlugins extends Events {
 	onRaw(configPath: string): void;
 	/**
 	 * - Save current plugin configs.
+	 *
+	 * @returns A promise that resolves when the config is saved.
 	 */
 	saveConfig(): Promise<void>;
 }
@@ -10750,7 +11055,12 @@ export interface LanguageState {
 	 * The current tree. Immutable, because directly accessible from the editor state.
 	 */
 	tree: LezerTree;
-	/** Apply a transaction to produce an updated language state. */
+	/**
+	 * Apply a transaction to produce an updated language state.
+	 *
+	 * @param tr - The transaction to apply.
+	 * @returns The updated language state.
+	 */
 	apply(tr: Transaction): LanguageState;
 }
 /**
@@ -10871,6 +11181,7 @@ export interface LinkUpdater {
 	 *
 	 * @param file - File to update.
 	 * @param updates - Link change updates to apply.
+	 * @returns A promise that resolves when the updates have been applied.
 	 */
 	applyUpdates(file: TFile, updates: LinkChangeUpdate[]): Promise<void>;
 	/**
@@ -10892,6 +11203,7 @@ export interface LinkUpdater {
 	 * @param file - File containing the subpath.
 	 * @param oldSubpath - Previous subpath.
 	 * @param newSubpath - New subpath.
+	 * @returns A promise that resolves when the subpath has been renamed.
 	 */
 	renameSubpath(file: TFile, oldSubpath: string, newSubpath: string): Promise<void>;
 }
@@ -11076,14 +11388,20 @@ export interface MarkdownBaseView extends Component {
 	tableCell: null | TableCellEditor;
 	/**
 	 * Currently active CM instance (table cell CM or main CM).
+	 *
+	 * @returns The active CodeMirror editor view.
 	 */
 	get activeCM(): EditorView;
 	/**
 	 * Returns attached file of the owner instance.
+	 *
+	 * @returns The attached file, or null.
 	 */
 	get file(): TFile | null;
 	/**
 	 * Returns path of the attached file.
+	 *
+	 * @returns The file path.
 	 */
 	get path(): string;
 	/**
@@ -11117,10 +11435,10 @@ export interface MarkdownBaseView extends Component {
 	 * Edit a specified table cell, creating a table cell editor.
 	 *
 	 * @param cell - Table editor owning the cell.
-	 * @param new_cell - Table cell to edit.
+	 * @param newCell - Table cell to edit.
 	 * @returns The created table cell editor.
 	 */
-	editTableCell(cell: TableEditor, new_cell: TableCell): TableCellEditor;
+	editTableCell(cell: TableEditor, newCell: TableCell): TableCellEditor;
 	/**
 	 * Get the current editor document as a string.
 	 *
@@ -11141,7 +11459,7 @@ export interface MarkdownBaseView extends Component {
 	 */
 	getFoldInfo(): null | FoldInfo;
 	/**
-	 * Builds all local extensions and assigns to this.localExtensions.
+	 * Builds all local extensions and assigns to `this.localExtensions`.
 	 *
 	 * @returns The local extensions.
 	 * @remark Will build extensions if they were not already built.
@@ -11152,6 +11470,7 @@ export interface MarkdownBaseView extends Component {
 	 *
 	 * @param event - The pointer event.
 	 * @param x - Whether the context menu was triggered by keyboard.
+	 * @returns A promise that resolves when the context menu is handled.
 	 */
 	onContextMenu(event: PointerEvent, x: boolean): Promise<void>;
 	/**
@@ -11200,9 +11519,9 @@ export interface MarkdownBaseView extends Component {
 	/**
 	 * Move the editor into the new container.
 	 *
-	 * @param new_container - New container element for the editor.
+	 * @param newContainer - New container element for the editor.
 	 */
-	reparent(new_container: HTMLElement): void;
+	reparent(newContainer: HTMLElement): void;
 	/**
 	 * Bodge to reset the syntax highlighting.
 	 *
@@ -11232,9 +11551,9 @@ export interface MarkdownBaseView extends Component {
 	 * Execute functionality of token (open external link, open internal link in leaf, ...).
 	 *
 	 * @param token - The clickable token.
-	 * @param new_leaf - Whether to open in a new leaf.
+	 * @param newLeaf - Whether to open in a new leaf.
 	 */
-	triggerClickableToken(token: Token, new_leaf: boolean): void;
+	triggerClickableToken(token: Token, newLeaf: boolean): void;
 	/**
 	 * Callback for onUpdate functionality added as an extension.
 	 *
@@ -11496,11 +11815,24 @@ export interface MathJax {
 	tex2mmlPromise(math: string, options?: Record<string, unknown>): Promise<string>;
 	/** Reset the TeX input jax, clearing equation numbering and labels. */
 	texReset(): void;
-	/** Typeset math expressions in the given elements synchronously. */
+	/**
+	 * Typeset math expressions in the given elements synchronously.
+	 *
+	 * @param elements - The elements to typeset.
+	 */
 	typeset(elements?: unknown[] | null): void;
-	/** Clear typeset math from the given elements. */
+	/**
+	 * Clear typeset math from the given elements.
+	 *
+	 * @param elements - The elements to clear.
+	 */
 	typesetClear(elements?: unknown[] | null): void;
-	/** Typeset math expressions in the given elements asynchronously. */
+	/**
+	 * Typeset math expressions in the given elements asynchronously.
+	 *
+	 * @param elements - The elements to typeset.
+	 * @returns A promise that resolves when typesetting is complete.
+	 */
 	typesetPromise(elements?: unknown[] | null): Promise<void>;
 }
 /**
@@ -11703,10 +12035,10 @@ export interface MetadataEditor extends Component {
 	 * Remove specified properties from the metadata editor and save, and reset focus if specified.
 	 *
 	 * @param properties - Properties to remove.
-	 * @param reset_focus - Whether to reset focus after removal.
+	 * @param resetFocus - Whether to reset focus after removal.
 	 * @returns The result of the removal operation.
 	 */
-	removeProperties(properties: MetadataEditorProperty[], reset_focus?: boolean): unknown;
+	removeProperties(properties: MetadataEditorProperty[], resetFocus?: boolean): unknown;
 	/**
 	 * Reorder the entry to specified index position and save.
 	 *
@@ -11855,10 +12187,10 @@ export interface MetadataEditorProperty extends Component {
 	 * Render property widget based on type.
 	 *
 	 * @param entry - Property entry data.
-	 * @param check_errors - Whether to check for errors.
-	 * @param use_expected_type - Whether to use the expected type.
+	 * @param checkErrors - Whether to check for errors.
+	 * @param useExpectedType - Whether to use the expected type.
 	 */
-	renderProperty(entry: PropertyEntryData<unknown>, check_errors?: boolean, use_expected_type?: boolean): void;
+	renderProperty(entry: PropertyEntryData<unknown>, checkErrors?: boolean, useExpectedType?: boolean): void;
 	/**
 	 * Set the selected class of property.
 	 *
@@ -11938,14 +12270,23 @@ export interface MetadataTypeManager extends Events {
 	getWidget(type: string): PropertyWidget;
 	/**
 	 * Load property types from config.
+	 *
+	 * @returns A promise that resolves when the property types are loaded.
 	 */
 	loadData(): Promise<void>;
-	/** Handle raw file system change events for the property type config. */
+	/**
+	 * Handle raw file system change events for the property type config.
+	 *
+	 * @param e - The raw file system change event.
+	 * @unofficial
+	 */
 	onRaw(e: unknown): void;
 	/** Register event listeners for property type config file changes. */
 	registerListeners(): void;
 	/**
 	 * Save property types to config.
+	 *
+	 * @returns A promise that resolves when the property types are saved.
 	 */
 	save(): Promise<void>;
 	/**
@@ -11953,12 +12294,14 @@ export interface MetadataTypeManager extends Events {
 	 *
 	 * @param property - Property name.
 	 * @param type - Widget type to assign.
+	 * @returns A promise that resolves when the widget type is set.
 	 */
 	setType(property: string, type: PropertyWidgetType): Promise<void>;
 	/**
 	 * Unset widget type for property.
 	 *
 	 * @param property - Property name.
+	 * @returns A promise that resolves when the widget type is unset.
 	 */
 	unsetType(property: string): Promise<void>;
 	/**
@@ -12082,9 +12425,17 @@ export interface MobileTabSwitcher {
 	onLayoutChange(): void;
 	/** Render the tab switcher content. */
 	render(): void;
-	/** Set up the directory for caching tab preview images. */
+	/**
+	 * Set up the directory for caching tab preview images.
+	 *
+	 * @returns A promise that resolves when the cache directory has been set up.
+	 */
 	setupCacheDir(): Promise<void>;
-	/** Show the tab switcher UI. */
+	/**
+	 * Show the tab switcher UI.
+	 *
+	 * @returns A promise that resolves when the tab switcher is shown.
+	 */
 	show(): Promise<void>;
 	/**
 	 * Display the tab management context menu.
@@ -12131,7 +12482,11 @@ export interface Multiselect {
 	 * @returns the created element or `null` if the value is not valid.
 	 */
 	_createElement(value: string): string | null;
-	/** Create a new input element for the multiselect. */
+	/**
+	 * Create a new input element for the multiselect.
+	 *
+	 * @returns The created input element.
+	 */
 	_createInputEl(): HTMLDivElement;
 	/**
 	 * Add a new element to the multiselect.
@@ -12206,6 +12561,7 @@ export interface Multiselect {
 	 * Remove an element of the multiselect.
 	 *
 	 * @param index - the index of the element.
+	 * @param shouldFocus - Whether to focus the next element after removal.
 	 */
 	removeElement(index: number, shouldFocus?: boolean): void;
 	/** Render the values of the multiselect. */
@@ -12403,7 +12759,11 @@ export interface NoteComposerPluginInstance extends InternalPluginInstance<NoteC
 	 * @param info - The active markdown view or file info.
 	 */
 	onEditorMenu(menu: Menu, editor: Editor, info: MarkdownView | MarkdownFileInfo): void;
-	/** Handle external settings file changes and reload configuration. */
+	/**
+	 * Handle external settings file changes and reload configuration.
+	 *
+	 * @returns A promise that resolves when the settings are reloaded.
+	 */
 	onExternalSettingsChange(): Promise<void>;
 	/**
 	 * Add note composer items to a file context menu.
@@ -12619,6 +12979,8 @@ export interface OutgoingLinkPluginInstance extends InternalPluginInstance<Outgo
 export interface OutgoingLinkView extends InfoFileView {
 	/**
 	 * Get the current view type.
+	 *
+	 * @returns The outgoing link view type.
 	 */
 	getViewType(): typeof ViewType.OutgoingLink;
 	/** Refresh the outgoing links list. */
@@ -12693,6 +13055,8 @@ export interface OutlineView extends InfoFileView {
 	getOwner(): View | null;
 	/**
 	 * Get the current view type.
+	 *
+	 * @returns The outline view type.
 	 */
 	getViewType(): typeof ViewType.Outline;
 	/**
@@ -13020,34 +13384,42 @@ export interface Plugins {
 	updates: Map<string, PluginUpdateManifest>;
 	/**
 	 * Check online list for deprecated plugins to automatically disable.
+	 *
+	 * @returns A promise that resolves when the deprecation check is complete.
 	 */
 	checkForDeprecations(): Promise<void>;
 	/**
 	 * Check for plugin updates.
+	 *
+	 * @returns A promise that resolves when the update check is complete.
 	 */
 	checkForUpdates(): Promise<void>;
 	/**
 	 * Unload a plugin by ID.
 	 *
 	 * @param id - Plugin ID.
+	 * @returns A promise that resolves when the plugin is disabled.
 	 */
 	disablePlugin(id: string): Promise<void>;
 	/**
 	 * Unload a plugin by ID and save config for persistence.
 	 *
 	 * @param id - Plugin ID.
+	 * @returns A promise that resolves when the plugin is disabled and the config is saved.
 	 */
 	disablePluginAndSave(id: string): Promise<void>;
 	/**
 	 * Enable a plugin by ID.
 	 *
 	 * @param id - Plugin ID.
+	 * @returns A promise that resolves when the plugin is enabled.
 	 */
 	enablePlugin(id: string): Promise<void>;
 	/**
 	 * Enable a plugin by ID and save config for persistence.
 	 *
 	 * @param id - Plugin ID.
+	 * @returns A promise that resolves when the plugin is enabled and the config is saved.
 	 */
 	enablePluginAndSave(id: string): Promise<void>;
 	/**
@@ -13065,6 +13437,8 @@ export interface Plugins {
 	getPluginFolder(): string;
 	/**
 	 * Load plugin manifests and enable plugins from config.
+	 *
+	 * @returns A promise that resolves when initialization is complete.
 	 */
 	initialize(): Promise<void>;
 	/**
@@ -13073,6 +13447,7 @@ export interface Plugins {
 	 * @param repo - Repository identifier.
 	 * @param version - Version to install.
 	 * @param manifest - Plugin manifest data.
+	 * @returns A promise that resolves when the plugin is installed.
 	 */
 	installPlugin(repo: string, version: string, manifest: PluginManifest): Promise<void>;
 	/**
@@ -13092,10 +13467,13 @@ export interface Plugins {
 	 * Load a specific plugin's manifest by its folder path.
 	 *
 	 * @param path - Folder path containing the manifest.
+	 * @returns A promise that resolves when the manifest is loaded.
 	 */
 	loadManifest(path: string): Promise<void>;
 	/**
 	 * Load all plugin manifests from plugin folder.
+	 *
+	 * @returns A promise that resolves when all manifests are loaded.
 	 */
 	loadManifests(): Promise<void>;
 	/**
@@ -13105,28 +13483,38 @@ export interface Plugins {
 	 * @returns The loaded plugin instance.
 	 */
 	loadPlugin(id: string): Promise<Plugin>;
-	/** Handle raw file system change events for plugin config files. */
+	/**
+	 * Handle raw file system change events for plugin config files.
+	 *
+	 * @param e - The raw file system change event.
+	 * @unofficial
+	 */
 	onRaw(e: unknown): void;
 	/**
 	 * - Save current plugin configs.
+	 *
+	 * @returns A promise that resolves when the config is saved.
 	 */
 	saveConfig(): Promise<void>;
 	/**
 	 * Toggle whether community plugins are enabled.
 	 *
 	 * @param enabled - Whether to enable community plugins.
+	 * @returns A promise that resolves when the setting is applied.
 	 */
 	setEnable(enabled: boolean): Promise<void>;
 	/**
 	 * Uninstall a plugin by ID.
 	 *
 	 * @param id - Plugin ID.
+	 * @returns A promise that resolves when the plugin is uninstalled.
 	 */
 	uninstallPlugin(id: string): Promise<void>;
 	/**
 	 * Unload a plugin by ID.
 	 *
 	 * @param id - Plugin ID.
+	 * @returns A promise that resolves when the plugin is unloaded.
 	 */
 	unloadPlugin(id: string): Promise<void>;
 }
@@ -13312,14 +13700,25 @@ export interface PropertyPropertyWidgetComponentComboBox extends PopoverSuggest<
 	_onOpen?(): void;
 	/** Attach the DOM of the combobox. */
 	attachDom(): void;
-	/** Detach the DOM of the combobox. */
+	/**
+	 * Detach the DOM of the combobox.
+	 *
+	 * @returns A promise that resolves when the DOM is detached.
+	 */
 	detachDom(): Promise<void>;
 	/** Focus the combobox. */
 	focus(): void;
-	/** Get the items of the combobox. */
+	/**
+	 * Get the items of the combobox.
+	 *
+	 * @returns The combobox items.
+	 */
 	getItems(): PropertyPropertyWidgetComponentComboBoxItem[];
 	/**
 	 * Callback for `getSuggestions`.
+	 *
+	 * @param query - The search query string.
+	 * @returns The matching search results.
 	 */
 	getSuggestions(query: string): SearchResult[];
 	/**
@@ -13389,7 +13788,11 @@ export interface PropertyPropertyWidgetComponentComboBox extends PopoverSuggest<
 	 * @returns the combobox.
 	 */
 	setValueById(id: string): this;
-	/** Toggle the combobox. */
+	/**
+	 * Toggle the combobox.
+	 *
+	 * @returns The result of toggling the combobox.
+	 */
 	toggle(): unknown;
 	/**
 	 * Update the value of the combobox.
@@ -13859,7 +14262,11 @@ export interface ResultDom {
 	 * @returns The result of stopping the loader.
 	 */
 	stopLoader(): unknown;
-	/** Toggle the collapsed state of a result item. */
+	/**
+	 * Toggle the collapsed state of a result item.
+	 *
+	 * @returns The result of toggling the collapse state.
+	 */
 	toggle(arg1: unknown, arg2: unknown): Promise<unknown>;
 }
 /**
@@ -13942,7 +14349,11 @@ export interface ResultDomItem extends TreeNode {
 	onResultMouseover(arg1: unknown, arg2: unknown, arg3: unknown): unknown;
 	/** Render the content matches for this result item. */
 	renderContentMatches(): void;
-	/** Set the collapsed state of this result item. */
+	/**
+	 * Set the collapsed state of this result item.
+	 *
+	 * @returns Resolves when the collapse state has been applied.
+	 */
 	setCollapse(arg1: unknown, arg2: unknown): Promise<unknown>;
 	/**
 	 * Set whether this result item can be collapsed.
@@ -14069,7 +14480,11 @@ export interface RibbonItem {
 	id: string;
 	/** Tooltip title displayed on hover. */
 	title: string;
-	/** Callback invoked when this ribbon item is clicked. */
+	/**
+	 * Callback invoked when this ribbon item is clicked.
+	 *
+	 * @returns A promise that resolves when the callback completes.
+	 */
 	callback(): Promise<void>;
 }
 /**
@@ -14146,7 +14561,13 @@ export interface SQLResultSet {
 export interface SQLResultSetRowList {
 	/** Number of rows in the result set. */
 	length: number;
-	/** Get a row by its index in the result set. */
+	/**
+	 * Get a row by its index in the result set.
+	 *
+	 * @param index - The index of the row to retrieve.
+	 * @returns The row at the specified index.
+	 * @unofficial
+	 */
 	item(index: number): unknown;
 }
 /**
@@ -14248,6 +14669,8 @@ export interface SearchView extends View {
 	getQuery(): string;
 	/**
 	 * Get the current view type.
+	 *
+	 * @returns The search view type.
 	 */
 	getViewType(): typeof ViewType.Search;
 	/**
@@ -14532,18 +14955,21 @@ export interface ShareReceiver {
 	 * Handles shared files.
 	 *
 	 * @param files - Shared files.
+	 * @returns A promise that resolves when the shared files are handled.
 	 */
 	handleShareFiles(files: SharedFile[]): Promise<void>;
 	/**
 	 * Handles shared text.
 	 *
 	 * @param text - Shared text.
+	 * @returns A promise that resolves when the shared text is handled.
 	 */
 	handleShareText(text: string): Promise<void>;
 	/**
 	 * Imports shared files.
 	 *
 	 * @param files - Shared files.
+	 * @returns A promise that resolves when the files are imported.
 	 */
 	importFiles(files: SharedFile[]): Promise<void>;
 	/**
@@ -14818,10 +15244,14 @@ export interface SuggestionContainer<T> {
 	values: SearchResult[];
 	/**
 	 * Amount of suggestions that can be displayed at once within containerEl.
+	 *
+	 * @returns The number of visible items.
 	 */
 	get numVisibleItems(): number;
 	/**
 	 * Height in pixels of the selected item.
+	 *
+	 * @returns The row height in pixels.
 	 */
 	get rowHeight(): number;
 	/**
@@ -14965,7 +15395,11 @@ export interface SyncPluginInstance extends InternalPluginInstance<SyncPlugin> {
  * @unofficial
  */
 export interface SyncView extends View {
-	/** Get the current view type. */
+	/**
+	 * Get the current view type.
+	 *
+	 * @returns The sync view type.
+	 */
 	getViewType(): typeof ViewType.Sync;
 }
 /**
@@ -15051,6 +15485,8 @@ export interface TableEditor {
 export interface TableView extends View {
 	/**
 	 * Get view type.
+	 *
+	 * @returns The table view type.
 	 */
 	getViewType(): typeof ViewType.Table;
 }
@@ -15351,6 +15787,8 @@ export interface Tree<T extends TreeItem> {
 	view: View;
 	/**
 	 * Root item of the tree view.
+	 *
+	 * @returns The root tree item.
 	 */
 	get root(): TreeRoot<T>;
 	/**
@@ -15386,6 +15824,7 @@ export interface Tree<T extends TreeItem> {
 	 * Handle deletion of selected nodes.
 	 *
 	 * @param event - The keyboard event that triggered the deletion.
+	 * @returns A promise that resolves when the selected items are deleted.
 	 */
 	handleDeleteSelectedItems(event: KeyboardEvent): Promise<void>;
 	/**
@@ -15501,6 +15940,7 @@ export interface TreeCollapsibleItem extends TreeItem {
 	 *
 	 * @param value - Whether the item should be collapsed.
 	 * @param animate - If set to `true`, will animate on collapse.
+	 * @returns Resolves when the collapse state has been applied.
 	 */
 	setCollapsed(value: boolean, animate?: boolean): Promise<undefined>;
 	/**
@@ -15513,12 +15953,14 @@ export interface TreeCollapsibleItem extends TreeItem {
 	 * Toggle collapsed state of tree item.
 	 *
 	 * @param animate - If set to `true`, will animate on collapse.
+	 * @returns Resolves when the collapse state has been toggled.
 	 */
 	toggleCollapsed(animate?: boolean): Promise<undefined>;
 	/**
 	 * Update the tree item's cover element.
 	 *
 	 * @param animate - If set to `true`, will animate on collapse.
+	 * @returns Resolves when the cover element has been updated.
 	 */
 	updateCollapsed(animate?: boolean): Promise<undefined>;
 }
@@ -15597,7 +16039,11 @@ export interface TreeNodeVChildren<Item extends TreeNode, Owner extends TreeNode
 	_children: Item[];
 	/** The tree node that owns these children. */
 	owner: Owner;
-	/** Get the array of child items. */
+	/**
+	 * Get the array of child items.
+	 *
+	 * @returns The child items.
+	 */
 	get children(): Item[];
 	/**
 	 * Add a child item to this node.
@@ -16326,13 +16772,20 @@ export interface WebviewerDBStore {
 	 *
 	 * @param url - The URL of the history item.
 	 * @param title - Optional title for the history item.
+	 * @returns A promise that resolves when the history item is added.
 	 */
 	addHistoryItem(url: string, title?: string): Promise<void>;
 	/**
 	 * Clear all history items.
+	 *
+	 * @returns A promise that resolves when all history items are cleared.
 	 */
 	clearHistoryItems(): Promise<void>;
-	/** Open and initialize the IndexedDB connection. */
+	/**
+	 * Open and initialize the IndexedDB connection.
+	 *
+	 * @returns A promise that resolves when the connection is established.
+	 */
 	connect(): Promise<void>;
 	/**
 	 * Get all history items.
@@ -16354,6 +16807,7 @@ export interface WebviewerDBStore {
 	 * Remove specific history item based on its {@link WebviewerHistoryItem.id | id}.
 	 *
 	 * @param item - The history item to remove.
+	 * @returns A promise that resolves when the history item is removed.
 	 */
 	removeHistoryItem(item: WebviewerHistoryItem): Promise<void>;
 	/**
@@ -16362,6 +16816,7 @@ export interface WebviewerDBStore {
 	 * @param el - The element to add the icon to.
 	 * @param url - The URL to get the icon for.
 	 * @param source - Optional source URL for the icon.
+	 * @returns A promise that resolves when the icon is set on the element.
 	 */
 	setIcon(el: HTMLElement, url: string, source?: string): Promise<void>;
 	/**
@@ -16405,9 +16860,15 @@ export interface WebviewerHistoryItem {
 export interface WebviewerHistoryView extends ItemView {
 	/**
 	 * Get the current view type.
+	 *
+	 * @returns The webviewer history view type.
 	 */
 	getViewType(): typeof ViewType.WebviewerHistory;
-	/** Refresh the browsing history list. */
+	/**
+	 * Refresh the browsing history list.
+	 *
+	 * @returns The result of refreshing the history.
+	 */
 	update(): Promise<unknown>;
 }
 /**
@@ -16459,13 +16920,32 @@ export interface WebviewerPluginInstance extends InternalPluginInstance<Webviewe
 	defaultOn: false;
 	/** URLs that are pending to be added to the ignore list. */
 	pendingIgnoredURLs: string[];
-	/** Build a search engine URL for the given search query. */
+	/**
+	 * Build a search engine URL for the given search query.
+	 *
+	 * @param searchQuery - The search query to build a URL for.
+	 * @returns The search engine URL.
+	 */
 	getSearchEngineUrl(searchQuery: string): string;
-	/** Handle a custom open URL event from the webview. */
+	/**
+	 * Handle a custom open URL event from the webview.
+	 *
+	 * @param event - The custom event containing the URL details.
+	 */
 	handleOpenUrl(event: CustomEvent<WebviewerOpenUrlEventDetail>): void;
-	/** Open a URL in the web viewer. */
+	/**
+	 * Open a URL in the web viewer.
+	 *
+	 * @param url - The URL to open.
+	 * @param newLeaf - The pane type or whether to open in a new leaf.
+	 * @param active - Whether to make the new leaf active.
+	 */
 	openUrl(url: string, newLeaf?: PaneType | boolean, active?: boolean): void;
-	/** Open a URL in the system default browser. */
+	/**
+	 * Open a URL in the system default browser.
+	 *
+	 * @param url - The URL to open externally.
+	 */
 	openUrlExternally(url: string): void;
 	/** Update the current browsing session state. */
 	updateSession(): void;
@@ -16539,6 +17019,8 @@ export interface WebviewerView extends ItemView {
 	getReaderModeContent(): Promise<unknown>;
 	/**
 	 * Get the current view type.
+	 *
+	 * @returns The webviewer view type.
 	 */
 	getViewType(): typeof ViewType.Webviewer;
 	/** Hide all view content (webview, reader, error). */
@@ -16782,6 +17264,8 @@ export interface WidgetEditorView extends EmbeddedEditorView {
 	loadContents(data: string, cache: CachedMetadata): void;
 	/**
 	 * Load file from cache based on stored path.
+	 *
+	 * @returns A promise that resolves when the file has been loaded.
 	 */
 	loadFile(): Promise<void>;
 	/**
@@ -16842,6 +17326,7 @@ export interface WidgetEditorView extends EmbeddedEditorView {
 	 *
 	 * @param data - Data to save.
 	 * @param delayed - Whether to delay the save.
+	 * @returns A promise that resolves when the data has been saved.
 	 */
 	save(data: string, delayed?: boolean): Promise<void>;
 	/**
@@ -16923,19 +17408,49 @@ export interface WorkspaceLeafHistory {
 	forwardHistory: WorkspaceLeafHistoryState[];
 	/** The workspace leaf that owns this history. */
 	owner: WorkspaceLeaf;
-	/** Navigate back to the previous state. */
+	/**
+	 * Navigate back to the previous state.
+	 *
+	 * @returns A promise that resolves when navigation is complete.
+	 */
 	back(): Promise<void>;
-	/** Restore history from a serialized representation. */
+	/**
+	 * Restore history from a serialized representation.
+	 *
+	 * @param e - The serialized history data.
+	 */
 	deserialize(e: SerializedWorkspaceLeafHistory): void;
-	/** Navigate forward to the next state. */
+	/**
+	 * Navigate forward to the next state.
+	 *
+	 * @returns A promise that resolves when navigation is complete.
+	 */
 	forward(): Promise<void>;
-	/** Navigate by the given number of steps (negative for back, positive for forward). */
+	/**
+	 * Navigate by the given number of steps (negative for back, positive for forward).
+	 *
+	 * @param step - The number of steps to navigate.
+	 * @returns A promise that resolves when navigation is complete.
+	 */
 	go(step: number): Promise<void>;
-	/** Push a new state onto the back history stack. */
+	/**
+	 * Push a new state onto the back history stack.
+	 *
+	 * @param state - The history state to push.
+	 */
 	pushState(state: WorkspaceLeafHistoryState): void;
-	/** Serialize the history for persistence. */
+	/**
+	 * Serialize the history for persistence.
+	 *
+	 * @returns The serialized history data.
+	 */
 	serialize(): SerializedWorkspaceLeafHistory;
-	/** Update the current state in the history. */
+	/**
+	 * Update the current state in the history.
+	 *
+	 * @param state - The history state to update with.
+	 * @returns A promise that resolves when the state is updated.
+	 */
 	updateState(state: WorkspaceLeafHistoryState): Promise<void>;
 }
 /**