Document remaining functions
This commit is contained in:
parent
d516d765d5
commit
c62428ca27
25 changed files with 179 additions and 94 deletions
|
|
@ -90,6 +90,7 @@ export const setVoicingRange = (name, range) => addVoicings(name, voicingRegistr
|
|||
* Adds a new custom voicing dictionary.
|
||||
*
|
||||
* @name addVoicings
|
||||
* @tags music_theory
|
||||
* @memberof Pattern
|
||||
* @param {string} name identifier for the voicing dictionary
|
||||
* @param {Object} dictionary maps chord symbol to possible voicings
|
||||
|
|
@ -133,6 +134,7 @@ const getVoicing = (chord, dictionaryName, lastVoicing) => {
|
|||
* Uses [chord-voicings package](https://github.com/felixroos/chord-voicings#chord-voicings).
|
||||
*
|
||||
* @name voicings
|
||||
* @tags music_theory
|
||||
* @memberof Pattern
|
||||
* @param {string} dictionary which voicing dictionary to use.
|
||||
* @returns Pattern
|
||||
|
|
@ -157,6 +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
|
||||
* @memberof Pattern
|
||||
* @param {octave} octave octave to use
|
||||
* @returns Pattern
|
||||
|
|
@ -189,6 +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
|
||||
* @returns Pattern
|
||||
* @example
|
||||
* n("0 1 2 3").chord("<C Am F G>").voicing()
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue