1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00

Fixed some documentation issues

This commit is contained in:
ed 2020-06-27 11:19:12 +01:00
parent 6b6cc53778
commit fa4fde08ec
5 changed files with 22 additions and 1 deletions

View file

@ -132,7 +132,7 @@ The BEGIN_JUCE_MODULE_DECLARATION block
=======================================
This block of text needs to go inside the module's main header file. It should be commented-out
and perhaps inside an #if 0 block too, but the Introjucer will just scan the whole file for the
and perhaps inside an `#if 0` block too, but the Introjucer will just scan the whole file for the
string BEGIN_JUCE_MODULE_DECLARATION, and doesn't care about its context in terms of C++ syntax.
The block needs a corresponding END_JUCE_MODULE_DECLARATION to finish the block.

View file

@ -19,6 +19,14 @@
namespace juce
{
/**
A collection of different interpolators for resampling streams of floats.
@see GenericInterpolator, WindowedSincInterpolator, LagrangeInterpolator,
CatmullRomInterpolator, LinearInterpolator, ZeroOrderHoldInterpolator
@tags{Audio}
*/
class Interpolators
{
private:

View file

@ -79,6 +79,8 @@ enum UnityEventModifiers
};
//==============================================================================
#ifndef DOXYGEN
struct UnityAudioSpatializerData
{
float listenerMatrix[16];
@ -165,6 +167,8 @@ struct UnityAudioEffectDefinition
getFloatBufferCallback getFloatBuffer;
};
#endif
//==============================================================================
// Unity callback
extern "C" UNITY_INTERFACE_EXPORT int UNITY_INTERFACE_API UnityGetAudioEffectDefinitions (UnityAudioEffectDefinition*** definitionsPtr);

View file

@ -25,6 +25,11 @@
namespace juce
{
/**
Represents the version number of a block device.
@tags{Blocks}
*/
struct BlocksVersion
{
public:

View file

@ -21,6 +21,8 @@ namespace juce
namespace dsp
{
#ifndef DOXYGEN
namespace detail
{
template <typename Ret, typename... Args>
@ -77,6 +79,8 @@ namespace detail
template <size_t len, typename T>
class FixedSizeFunction;
#endif
/**
A type similar to `std::function` that holds a callable object.