mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-10 23:44:24 +00:00
Added missing documentation tags
This commit is contained in:
parent
fa4fde08ec
commit
4855f52e4d
7 changed files with 33 additions and 1 deletions
|
|
@ -30,6 +30,8 @@ namespace juce
|
||||||
Instances of this class do *not* own the midi data bytes that they point to.
|
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
|
Instead, they expect the midi data to live in a separate buffer that outlives
|
||||||
the MidiMessageMetadata instance.
|
the MidiMessageMetadata instance.
|
||||||
|
|
||||||
|
@tags{Audio}
|
||||||
*/
|
*/
|
||||||
struct MidiMessageMetadata final
|
struct MidiMessageMetadata final
|
||||||
{
|
{
|
||||||
|
|
@ -70,6 +72,8 @@ struct MidiMessageMetadata final
|
||||||
Logger::writeToLog (metadata.getMessage().getDescription());
|
Logger::writeToLog (metadata.getMessage().getDescription());
|
||||||
}
|
}
|
||||||
@endcode
|
@endcode
|
||||||
|
|
||||||
|
@tags{Audio}
|
||||||
*/
|
*/
|
||||||
class JUCE_API MidiBufferIterator
|
class JUCE_API MidiBufferIterator
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -33,6 +33,8 @@ namespace juce
|
||||||
|
|
||||||
Make sure to call `sendInitialUpdate` at the end of your new attachment's
|
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.
|
constructor, so that the UI immediately reflects the state of the parameter.
|
||||||
|
|
||||||
|
@tags{Audio}
|
||||||
*/
|
*/
|
||||||
class ParameterAttachment : private AudioProcessorParameter::Listener,
|
class ParameterAttachment : private AudioProcessorParameter::Listener,
|
||||||
private AsyncUpdater
|
private AsyncUpdater
|
||||||
|
|
@ -118,6 +120,8 @@ private:
|
||||||
it easy to connect a slider to a parameter. When this object is deleted, the
|
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
|
connection is broken. Make sure that your parameter and Slider are not
|
||||||
deleted before this object!
|
deleted before this object!
|
||||||
|
|
||||||
|
@tags{Audio}
|
||||||
*/
|
*/
|
||||||
class SliderParameterAttachment : private Slider::Listener
|
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
|
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
|
connection is broken. Make sure that your parameter and ComboBox are not deleted
|
||||||
before this object!
|
before this object!
|
||||||
|
|
||||||
|
@tags{Audio}
|
||||||
*/
|
*/
|
||||||
class ComboBoxParameterAttachment : private ComboBox::Listener
|
class ComboBoxParameterAttachment : private ComboBox::Listener
|
||||||
{
|
{
|
||||||
|
|
@ -202,6 +208,8 @@ private:
|
||||||
easy to connect a button to a parameter. When this object is deleted, the
|
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
|
connection is broken. Make sure that your parameter and Button are not deleted
|
||||||
before this object!
|
before this object!
|
||||||
|
|
||||||
|
@tags{Audio}
|
||||||
*/
|
*/
|
||||||
class ButtonParameterAttachment : private Button::Listener
|
class ButtonParameterAttachment : private Button::Listener
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -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
|
class DirectoryEntry final
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
|
@ -80,6 +84,8 @@ inline const DirectoryEntry& operator* (const DirectoryEntry& e) noexcept { retu
|
||||||
if (entry.isHidden())
|
if (entry.isHidden())
|
||||||
hiddenFiles.push_back (entry.getFile());
|
hiddenFiles.push_back (entry.getFile());
|
||||||
@endcode
|
@endcode
|
||||||
|
|
||||||
|
@tags{Core}
|
||||||
*/
|
*/
|
||||||
class RangedDirectoryIterator final
|
class RangedDirectoryIterator final
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -88,6 +88,8 @@ class FixedSizeFunction;
|
||||||
a buffer of size `len` that is internal to the FixedSizeFunction instance.
|
a buffer of size `len` that is internal to the FixedSizeFunction instance.
|
||||||
This in turn means that creating a FixedSizeFunction instance will never allocate,
|
This in turn means that creating a FixedSizeFunction instance will never allocate,
|
||||||
making FixedSizeFunctions suitable for use in realtime contexts.
|
making FixedSizeFunctions suitable for use in realtime contexts.
|
||||||
|
|
||||||
|
@tags{DSP}
|
||||||
*/
|
*/
|
||||||
template <size_t len, typename Ret, typename... Args>
|
template <size_t len, typename Ret, typename... Args>
|
||||||
class FixedSizeFunction<len, Ret (Args...)>
|
class FixedSizeFunction<len, Ret (Args...)>
|
||||||
|
|
|
||||||
|
|
@ -26,6 +26,8 @@ namespace dsp
|
||||||
thread.
|
thread.
|
||||||
|
|
||||||
May be shared between multiple Convolution instances.
|
May be shared between multiple Convolution instances.
|
||||||
|
|
||||||
|
@tags{DSP}
|
||||||
*/
|
*/
|
||||||
class JUCE_API ConvolutionMessageQueue
|
class JUCE_API ConvolutionMessageQueue
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -32,6 +32,8 @@ namespace DelayLineInterpolationTypes
|
||||||
No interpolation between successive samples in the delay line will be
|
No interpolation between successive samples in the delay line will be
|
||||||
performed. This is useful when the delay is a constant integer or to
|
performed. This is useful when the delay is a constant integer or to
|
||||||
create lo-fi audio effects.
|
create lo-fi audio effects.
|
||||||
|
|
||||||
|
@tags{DSP}
|
||||||
*/
|
*/
|
||||||
struct None {};
|
struct None {};
|
||||||
|
|
||||||
|
|
@ -40,6 +42,8 @@ namespace DelayLineInterpolationTypes
|
||||||
type of interpolation has a low compuational cost where the delay can be
|
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
|
modulated in real time, but it also introduces a low-pass filtering effect
|
||||||
into your audio signal.
|
into your audio signal.
|
||||||
|
|
||||||
|
@tags{DSP}
|
||||||
*/
|
*/
|
||||||
struct Linear {};
|
struct Linear {};
|
||||||
|
|
||||||
|
|
@ -48,6 +52,8 @@ namespace DelayLineInterpolationTypes
|
||||||
Lagrange interpolator. This method incurs more computational overhead than
|
Lagrange interpolator. This method incurs more computational overhead than
|
||||||
linear interpolation but reduces the low-pass filtering effect whilst
|
linear interpolation but reduces the low-pass filtering effect whilst
|
||||||
remaining amenable to real time delay modulation.
|
remaining amenable to real time delay modulation.
|
||||||
|
|
||||||
|
@tags{DSP}
|
||||||
*/
|
*/
|
||||||
struct Lagrange3rd {};
|
struct Lagrange3rd {};
|
||||||
|
|
||||||
|
|
@ -57,6 +63,8 @@ namespace DelayLineInterpolationTypes
|
||||||
amplitude frequency response in exchange for less accuracy in the phase
|
amplitude frequency response in exchange for less accuracy in the phase
|
||||||
response. This interpolation method is stateful so is unsuitable for
|
response. This interpolation method is stateful so is unsuitable for
|
||||||
applications requiring fast delay modulation.
|
applications requiring fast delay modulation.
|
||||||
|
|
||||||
|
@tags{DSP}
|
||||||
*/
|
*/
|
||||||
struct Thiran {};
|
struct Thiran {};
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -170,6 +170,8 @@ private:
|
||||||
Therefore in order to use WebView2 you need to ensure that WebView2Loader.dll is
|
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
|
installed either to a location covered by the Windows DLL system search paths or
|
||||||
to the folder specified in the constructor of this class.
|
to the folder specified in the constructor of this class.
|
||||||
|
|
||||||
|
@tags{GUI}
|
||||||
*/
|
*/
|
||||||
class WindowsWebView2WebBrowserComponent : public WebBrowserComponent
|
class WindowsWebView2WebBrowserComponent : public WebBrowserComponent
|
||||||
{
|
{
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue