Skip to content

Commit

Permalink
organizing docs (#1235)
Browse files Browse the repository at this point in the history
  • Loading branch information
tambien authored Apr 29, 2024
1 parent f8fcc4c commit 0808562
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 2 deletions.
1 change: 1 addition & 0 deletions Tone/core/context/ToneAudioNode.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ export type ToneAudioNodeOptions = ToneWithContextOptions;

/**
* ToneAudioNode is the base class for classes which process audio.
* @category Core
*/
export abstract class ToneAudioNode<Options extends ToneAudioNodeOptions = ToneAudioNodeOptions>
extends ToneWithContext<Options> {
Expand Down
1 change: 1 addition & 0 deletions Tone/core/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,5 @@ export { Unit };

// export the debug stuff as Debug
import * as debug from "./util/Debug";
/** @internal */
export { debug };
2 changes: 2 additions & 0 deletions Tone/core/util/Defaults.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ export function deepEquals<T>(arrayA: T[], arrayB: T[]): boolean {

/**
* Convert an args array into an object.
* @internal
*/
export function optionsFromArguments<T extends object>(
defaults: T,
Expand Down Expand Up @@ -101,6 +102,7 @@ export function getDefaultsFromInstance<T>(instance: T): BaseToneOptions {
/**
* Returns the fallback if the given object is undefined.
* Take an array of arguments and return a formatted options object.
* @internal
*/
export function defaultArg<T>(given: T, fallback: T): T {
if (isUndef(given)) {
Expand Down
9 changes: 7 additions & 2 deletions scripts/typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,15 @@
"defaultCategory" : "Global",
"categorizeByGroup" : true,
"categoryOrder" : ["Core", "Source", "Instrument", "Effect", "Component", "Signal"],
"navigation" : {
"includeCategories": true,
"includeFolders": false,
"includeGroups": true
},
"externalPattern": ["**/node_modules/**"],
"excludeProtected" : true,
"excludePrivate" : true,
"hideGenerator": true,
"includeVersion": true,
"excludeInternal": true
"includeVersion": false,
"excludeInternal": true,
}

0 comments on commit 0808562

Please sign in to comment.