jsdoc.json

{
  "source": {
    "include": [
      "README.md",
      "src/core/BaseLfo.js",
      "src/core/SourceMixin.js",

      "src/common/operator/Biquad.js",
      "src/common/operator/Clip.js",
      "src/common/operator/Dct.js",
      "src/common/operator/Delta.js",
      "src/common/operator/Fft.js",
      "src/common/operator/Magnitude.js",
      "src/common/operator/MeanStddev.js",
      "src/common/operator/Mel.js",
      "src/common/operator/Mfcc.js",
      "src/common/operator/MinMax.js",
      "src/common/operator/MovingAverage.js",
      "src/common/operator/MovingMedian.js",
      "src/common/operator/Multiplier.js",
      "src/common/operator/OnOff.js",
      "src/common/operator/Power.js",
      "src/common/operator/Rms.js",
      "src/common/operator/Scale.js",
      "src/common/operator/Segmenter.js",
      "src/common/operator/Select.js",
      "src/common/operator/Slicer.js",
      "src/common/operator/Yin.js",

      "src/common/sink/Bridge.js",
      "src/common/sink/DataRecorder.js",
      "src/common/sink/Logger.js",
      "src/common/sink/SignalRecorder.js",

      "src/common/source/EventIn.js",

      "src/client/sink/BaseDisplay.js",
      "src/client/sink/BarChartDisplay.js",
      "src/client/sink/BpfDisplay.js",
      "src/client/sink/MarkerDisplay.js",
      "src/client/sink/SignalDisplay.js",
      "src/client/sink/SocketSend.js",
      "src/client/sink/SpectrumDisplay.js",
      "src/client/sink/TraceDisplay.js",
      "src/client/sink/VuMeterDisplay.js",
      "src/client/sink/WaveformDisplay.js",

      "src/client/source/AudioInBuffer.js",
      "src/client/source/AudioInNode.js",
      "src/client/source/SocketReceive.js",

      "src/node/sink/DataToFile.js",
      "src/node/sink/SocketSend.js",
      "src/node/source/SocketReceive.js"
    ]
  },
  "plugins": [
    "plugins/markdown"
  ],
  "opts": {
    "projectTitle": "lfo (Low Frequency Operators)",
    "template": "node_modules/jsdoc-template",
    "destination": "./docs",
    "encoding": "utf8"
  },
  "templates": {
    "default": {
      "useLongnameInNav": true
    },
    "footer": ""
  }
}