Browse Source

Added missing documentation tags

tags/2021-05-28
ed 5 years ago
parent
commit
4855f52e4d
7 changed files with 33 additions and 1 deletions
  1. +4
    -0
      modules/juce_audio_basics/midi/juce_MidiBuffer.h
  2. +8
    -0
      modules/juce_audio_processors/utilities/juce_ParameterAttachments.h
  3. +7
    -1
      modules/juce_core/files/juce_RangedDirectoryIterator.h
  4. +2
    -0
      modules/juce_dsp/containers/juce_FixedSizeFunction.h
  5. +2
    -0
      modules/juce_dsp/frequency/juce_Convolution.h
  6. +8
    -0
      modules/juce_dsp/processors/juce_DelayLine.h
  7. +2
    -0
      modules/juce_gui_extra/misc/juce_WebBrowserComponent.h

+ 4
- 0
modules/juce_audio_basics/midi/juce_MidiBuffer.h View File

@@ -30,6 +30,8 @@ namespace juce
Instances of this class do *not* own the midi data bytes that they point to.
Instead, they expect the midi data to live in a separate buffer that outlives
the MidiMessageMetadata instance.
@tags{Audio}
*/
struct MidiMessageMetadata final
{
@@ -70,6 +72,8 @@ struct MidiMessageMetadata final
Logger::writeToLog (metadata.getMessage().getDescription());
}
@endcode
@tags{Audio}
*/
class JUCE_API MidiBufferIterator
{


+ 8
- 0
modules/juce_audio_processors/utilities/juce_ParameterAttachments.h View File

@@ -33,6 +33,8 @@ namespace juce
Make sure to call `sendInitialUpdate` at the end of your new attachment's
constructor, so that the UI immediately reflects the state of the parameter.
@tags{Audio}
*/
class ParameterAttachment : private AudioProcessorParameter::Listener,
private AsyncUpdater
@@ -118,6 +120,8 @@ private:
it easy to connect a slider to a parameter. When this object is deleted, the
connection is broken. Make sure that your parameter and Slider are not
deleted before this object!
@tags{Audio}
*/
class SliderParameterAttachment : private Slider::Listener
{
@@ -164,6 +168,8 @@ private:
easy to connect a combo box to a parameter. When this object is deleted, the
connection is broken. Make sure that your parameter and ComboBox are not deleted
before this object!
@tags{Audio}
*/
class ComboBoxParameterAttachment : private ComboBox::Listener
{
@@ -202,6 +208,8 @@ private:
easy to connect a button to a parameter. When this object is deleted, the
connection is broken. Make sure that your parameter and Button are not deleted
before this object!
@tags{Audio}
*/
class ButtonParameterAttachment : private Button::Listener
{


+ 7
- 1
modules/juce_core/files/juce_RangedDirectoryIterator.h View File

@@ -24,7 +24,11 @@ namespace juce
{
//==============================================================================
/** Describes the attributes of a file or folder. */
/**
Describes the attributes of a file or folder.
@tags{Core}
*/
class DirectoryEntry final
{
public:
@@ -80,6 +84,8 @@ inline const DirectoryEntry& operator* (const DirectoryEntry& e) noexcept { retu
if (entry.isHidden())
hiddenFiles.push_back (entry.getFile());
@endcode
@tags{Core}
*/
class RangedDirectoryIterator final
{


+ 2
- 0
modules/juce_dsp/containers/juce_FixedSizeFunction.h View File

@@ -88,6 +88,8 @@ class FixedSizeFunction;
a buffer of size `len` that is internal to the FixedSizeFunction instance.
This in turn means that creating a FixedSizeFunction instance will never allocate,
making FixedSizeFunctions suitable for use in realtime contexts.
@tags{DSP}
*/
template <size_t len, typename Ret, typename... Args>
class FixedSizeFunction<len, Ret (Args...)>


+ 2
- 0
modules/juce_dsp/frequency/juce_Convolution.h View File

@@ -26,6 +26,8 @@ namespace dsp
thread.
May be shared between multiple Convolution instances.
@tags{DSP}
*/
class JUCE_API ConvolutionMessageQueue
{


+ 8
- 0
modules/juce_dsp/processors/juce_DelayLine.h View File

@@ -32,6 +32,8 @@ namespace DelayLineInterpolationTypes
No interpolation between successive samples in the delay line will be
performed. This is useful when the delay is a constant integer or to
create lo-fi audio effects.
@tags{DSP}
*/
struct None {};
@@ -40,6 +42,8 @@ namespace DelayLineInterpolationTypes
type of interpolation has a low compuational cost where the delay can be
modulated in real time, but it also introduces a low-pass filtering effect
into your audio signal.
@tags{DSP}
*/
struct Linear {};
@@ -48,6 +52,8 @@ namespace DelayLineInterpolationTypes
Lagrange interpolator. This method incurs more computational overhead than
linear interpolation but reduces the low-pass filtering effect whilst
remaining amenable to real time delay modulation.
@tags{DSP}
*/
struct Lagrange3rd {};
@@ -57,6 +63,8 @@ namespace DelayLineInterpolationTypes
amplitude frequency response in exchange for less accuracy in the phase
response. This interpolation method is stateful so is unsuitable for
applications requiring fast delay modulation.
@tags{DSP}
*/
struct Thiran {};
}


+ 2
- 0
modules/juce_gui_extra/misc/juce_WebBrowserComponent.h View File

@@ -170,6 +170,8 @@ private:
Therefore in order to use WebView2 you need to ensure that WebView2Loader.dll is
installed either to a location covered by the Windows DLL system search paths or
to the folder specified in the constructor of this class.
@tags{GUI}
*/
class WindowsWebView2WebBrowserComponent : public WebBrowserComponent
{


Loading…
Cancel
Save