tagging a lot of superdough functions

This commit is contained in:
Felix Roos 2026-01-23 23:40:51 +01:00
parent b824ad16ae
commit 55ffb59b9c
No known key found for this signature in database
9 changed files with 314 additions and 309 deletions

View file

@ -100,7 +100,7 @@ function scaleOffset(scale, offset, note) {
* - 5P = perfect fifth
* - 5d = diminished fifth
*
* @tags music_theory
* @tags tonal
* @param {string | number} amount Either number of semitones or interval string.
* @returns Pattern
* @memberof Pattern
@ -155,7 +155,7 @@ export const { transpose, trans } = register(['transpose', 'trans'], function tr
*
* @memberof Pattern
* @name scaleTranspose
* @tags music_theory
* @tags tonal
* @param {offset} offset number of steps inside the scale
* @returns Pattern
* @synonyms scaleTrans, strans
@ -246,7 +246,7 @@ function _getNearestScaleNote(scaleName, note, preferHigher = true) {
* The root note defaults to octave 3, if no octave number is given.
*
* @name scale
* @tags music_theory
* @tags tonal
* @param {string} scale Name of scale
* @returns Pattern
* @example

View file

@ -90,7 +90,7 @@ export const setVoicingRange = (name, range) => addVoicings(name, voicingRegistr
* Adds a new custom voicing dictionary.
*
* @name addVoicings
* @tags music_theory
* @tags tonal
* @memberof Pattern
* @param {string} name identifier for the voicing dictionary
* @param {Object} dictionary maps chord symbol to possible voicings
@ -134,7 +134,7 @@ const getVoicing = (chord, dictionaryName, lastVoicing) => {
* Uses [chord-voicings package](https://github.com/felixroos/chord-voicings#chord-voicings).
*
* @name voicings
* @tags music_theory
* @tags tonal
* @memberof Pattern
* @param {string} dictionary which voicing dictionary to use.
* @returns Pattern
@ -159,7 +159,7 @@ export const voicings = register('voicings', function (dictionary, pat) {
* Maps the chords of the incoming pattern to root notes in the given octave.
*
* @name rootNotes
* @tags music_theory
* @tags tonal
* @memberof Pattern
* @param {octave} octave octave to use
* @returns Pattern
@ -192,7 +192,7 @@ export const rootNotes = register('rootNotes', function (octave, pat) {
* If you pass a pattern of strings to voicing, they will be interpreted as chords.
*
* @name voicing
* @tags music_theory
* @tags tonal
* @returns Pattern
* @example
* n("0 1 2 3").chord("<C Am F G>").voicing()