Browse Source

Minor documentation cleanup in the DSP module

tags/2021-05-28
ed 6 years ago
parent
commit
13fadfe5e3
3 changed files with 7 additions and 7 deletions
  1. +1
    -1
      modules/juce_dsp/processors/juce_FIRFilter.h
  2. +4
    -4
      modules/juce_dsp/processors/juce_IIRFilter.h
  3. +2
    -2
      modules/juce_dsp/processors/juce_ProcessContext.h

+ 1
- 1
modules/juce_dsp/processors/juce_FIRFilter.h View File

@@ -120,7 +120,7 @@ namespace FIR
typename Coefficients<NumericType>::Ptr coefficients;
//==============================================================================
/** Processes as a block of samples */
/** Processes a block of samples */
template <typename ProcessContext>
void process (const ProcessContext& context) noexcept
{


+ 4
- 4
modules/juce_dsp/processors/juce_IIRFilter.h View File

@@ -66,8 +66,8 @@ namespace IIR
/** Creates a filter.
Initially the filter is inactive, so will have no effect on samples that
you process with it. Use the setCoefficients() method to turn it into the
type of filter needed.
you process with it. You can modify the coefficients member to turn it into
the type of filter needed.
*/
Filter();
@@ -105,7 +105,7 @@ namespace IIR
/** Called before processing starts. */
void prepare (const ProcessSpec&) noexcept;
/** Processes as a block of samples */
/** Processes a block of samples */
template <typename ProcessContext>
void process (const ProcessContext& context) noexcept
{
@@ -134,7 +134,7 @@ namespace IIR
//==============================================================================
void check();
/** Processes as a block of samples */
/** Processes a block of samples */
template <typename ProcessContext, bool isBypassed>
void processInternal (const ProcessContext& context) noexcept;


+ 2
- 2
modules/juce_dsp/processors/juce_ProcessContext.h View File

@@ -50,8 +50,8 @@ struct ProcessSpec
//==============================================================================
/**
This is a handy base class for the state of a processor (such as parameter values)
which is typically shared among several procoessors. This is useful to for
multi-mono filters which share the same state among several mono processors.
which is typically shared among several processors. This is useful for multi-mono
filters which share the same state among several mono processors.
@tags{DSP}
*/


Loading…
Cancel
Save