mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-10 23:44:24 +00:00
Added some missing documentation tags
This commit is contained in:
parent
133b068dcb
commit
78e2892ba9
8 changed files with 46 additions and 3 deletions
|
|
@ -31,6 +31,8 @@ namespace juce
|
|||
/**
|
||||
Maintains an ongoing measurement of the proportion of time which is being
|
||||
spent inside an audio callback.
|
||||
|
||||
@tags{Audio}
|
||||
*/
|
||||
class JUCE_API AudioProcessLoadMeasurer
|
||||
{
|
||||
|
|
@ -68,6 +70,8 @@ public:
|
|||
myCallback->doTheCallback();
|
||||
}
|
||||
@endcode
|
||||
|
||||
@tags{Audio}
|
||||
*/
|
||||
struct JUCE_API ScopedTimer
|
||||
{
|
||||
|
|
|
|||
|
|
@ -30,6 +30,8 @@ namespace juce
|
|||
To use it, call setSampleRate() with the current sample rate and give it some parameters
|
||||
with setParameters() then call getNextSample() to get the envelope value to be applied
|
||||
to each audio sample or applyEnvelopeToBuffer() to apply the envelope to a whole buffer.
|
||||
|
||||
@tags{Audio}
|
||||
*/
|
||||
class ADSR
|
||||
{
|
||||
|
|
@ -42,7 +44,11 @@ public:
|
|||
}
|
||||
|
||||
//==============================================================================
|
||||
/** Holds the parameters being used by an ADSR object. */
|
||||
/**
|
||||
Holds the parameters being used by an ADSR object.
|
||||
|
||||
@tags{Audio}
|
||||
*/
|
||||
struct Parameters
|
||||
{
|
||||
/** Attack time in seconds. */
|
||||
|
|
|
|||
|
|
@ -179,10 +179,18 @@ protected:
|
|||
*/
|
||||
namespace ValueSmoothingTypes
|
||||
{
|
||||
/** Used to indicate a linear smoothing between values. */
|
||||
/**
|
||||
Used to indicate a linear smoothing between values.
|
||||
|
||||
@tags{Audio}
|
||||
*/
|
||||
struct Linear {};
|
||||
|
||||
/** Used to indicate a smoothing between multiplicative values. */
|
||||
/**
|
||||
Used to indicate a smoothing between multiplicative values.
|
||||
|
||||
@tags{Audio}
|
||||
*/
|
||||
struct Multiplicative {};
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -30,6 +30,8 @@ namespace juce
|
|||
getDefaultDevice() methods of MidiInput and MidiOutput or by calling getDeviceInfo()
|
||||
on an instance of these classes. Devices can be opened by passing the identifier to
|
||||
the openDevice() method.
|
||||
|
||||
@tags{Audio}
|
||||
*/
|
||||
struct MidiDeviceInfo
|
||||
{
|
||||
|
|
|
|||
|
|
@ -27,6 +27,8 @@ namespace juce
|
|||
|
||||
/**
|
||||
Represents traversal paths from master blocks and any connected blocks.
|
||||
|
||||
@tags{Blocks}
|
||||
*/
|
||||
class BlockGraph
|
||||
{
|
||||
|
|
|
|||
|
|
@ -32,6 +32,8 @@ namespace juce
|
|||
main() function to parse.
|
||||
|
||||
@see ConsoleApplication
|
||||
|
||||
@tags{Core}
|
||||
*/
|
||||
struct ArgumentList
|
||||
{
|
||||
|
|
@ -50,6 +52,8 @@ struct ArgumentList
|
|||
//==============================================================================
|
||||
/**
|
||||
One of the arguments in an ArgumentList.
|
||||
|
||||
@tags{Core}
|
||||
*/
|
||||
struct Argument
|
||||
{
|
||||
|
|
@ -226,13 +230,18 @@ struct ArgumentList
|
|||
@endcode
|
||||
|
||||
@see ArgumentList
|
||||
|
||||
@tags{Core}
|
||||
*/
|
||||
struct ConsoleApplication
|
||||
{
|
||||
//==============================================================================
|
||||
/**
|
||||
Represents a command that can be executed if its command-line arguments are matched.
|
||||
|
||||
@see ConsoleApplication::addCommand(), ConsoleApplication::findAndRunCommand()
|
||||
|
||||
@tags{Core}
|
||||
*/
|
||||
struct Command
|
||||
{
|
||||
|
|
|
|||
|
|
@ -28,6 +28,8 @@ namespace juce
|
|||
Contains classes that implement a simple protocol for broadcasting the availability
|
||||
and location of a discoverable service on the local network, and for maintaining a
|
||||
list of known services.
|
||||
|
||||
@tags{Events}
|
||||
*/
|
||||
struct NetworkServiceDiscovery
|
||||
{
|
||||
|
|
@ -36,6 +38,8 @@ struct NetworkServiceDiscovery
|
|||
|
||||
To use, simply create an instance of an Advertiser and it'll broadcast until
|
||||
you delete it.
|
||||
|
||||
@tags{Events}
|
||||
*/
|
||||
struct Advertiser : private Thread
|
||||
{
|
||||
|
|
@ -68,7 +72,10 @@ struct NetworkServiceDiscovery
|
|||
//==============================================================================
|
||||
/**
|
||||
Contains information about a service that has been found on the network.
|
||||
|
||||
@see AvailableServiceList, Advertiser
|
||||
|
||||
@tags{Events}
|
||||
*/
|
||||
struct Service
|
||||
{
|
||||
|
|
@ -87,7 +94,10 @@ struct NetworkServiceDiscovery
|
|||
Just create an instance of AvailableServiceList and it will start listening - you
|
||||
can register a callback with its onChange member to find out when services
|
||||
appear/disappear, and you can call getServices() to find out the current list.
|
||||
|
||||
@see Service, Advertiser
|
||||
|
||||
@tags{Events}
|
||||
*/
|
||||
struct AvailableServiceList : private Thread,
|
||||
private AsyncUpdater
|
||||
|
|
|
|||
|
|
@ -41,6 +41,8 @@ namespace juce
|
|||
|
||||
You shouldn't use this unless you really know what you are doing and
|
||||
are dealing with native HWNDs.
|
||||
|
||||
@tags{GUI}
|
||||
*/
|
||||
class JUCE_API ScopedDPIAwarenessDisabler
|
||||
{
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue