@summary

Syntax

@summary text

Overview

@summary provides a brief one-sentence summary of a symbol. It is separate from the longer @description and is displayed in index pages and overviews where only a short description is shown.

Example

/**
 * Computes the Levenshtein distance between two strings.
 *
 * The Levenshtein distance is the minimum number of single-character edits
 * (insertions, deletions, or substitutions) required to change one string
 * into the other. Useful for fuzzy matching and spell-checking.
 *
 * @summary Compute the edit distance between two strings.
 * @param {string} a
 * @param {string} b
 * @returns {number}
 */
function levenshtein(a, b) {}

Syntax​

Overview​

Example​

See also​

Syntax

Overview

Example

See also