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

Add documentation tags

This commit is contained in:
ed 2018-03-15 10:47:05 +00:00
parent e982c70438
commit cdbc28c18b
534 changed files with 1531 additions and 72 deletions

View file

@ -51,7 +51,10 @@ template <typename type>
struct SIMDNativeOps;
//==============================================================================
/** Single-precision floating point AVX intrinsics. */
/** Single-precision floating point AVX intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<float>
{
@ -111,7 +114,10 @@ struct SIMDNativeOps<float>
};
//==============================================================================
/** Double-precision floating point AVX intrinsics. */
/** Double-precision floating point AVX intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<double>
{
@ -167,7 +173,10 @@ struct SIMDNativeOps<double>
};
//==============================================================================
/** Signed 8-bit integer AVX intrinsics */
/** Signed 8-bit integer AVX intrinsics
@tags{DSP}
*/
template <>
struct SIMDNativeOps<int8_t>
{
@ -238,7 +247,10 @@ struct SIMDNativeOps<int8_t>
};
//==============================================================================
/** Unsigned 8-bit integer AVX intrinsics. */
/** Unsigned 8-bit integer AVX intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<uint8_t>
{
@ -312,7 +324,10 @@ struct SIMDNativeOps<uint8_t>
};
//==============================================================================
/** Signed 16-bit integer AVX intrinsics. */
/** Signed 16-bit integer AVX intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<int16_t>
{
@ -365,7 +380,10 @@ struct SIMDNativeOps<int16_t>
};
//==============================================================================
/** Unsigned 16-bit integer AVX intrinsics. */
/** Unsigned 16-bit integer AVX intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<uint16_t>
{
@ -421,7 +439,10 @@ struct SIMDNativeOps<uint16_t>
};
//==============================================================================
/** Signed 32-bit integer AVX intrinsics. */
/** Signed 32-bit integer AVX intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<int32_t>
{
@ -472,7 +493,10 @@ struct SIMDNativeOps<int32_t>
};
//==============================================================================
/** Unsigned 32-bit integer AVX intrinsics. */
/** Unsigned 32-bit integer AVX intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<uint32_t>
{
@ -526,7 +550,10 @@ struct SIMDNativeOps<uint32_t>
};
//==============================================================================
/** Signed 64-bit integer AVX intrinsics. */
/** Signed 64-bit integer AVX intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<int64_t>
{
@ -596,7 +623,10 @@ struct SIMDNativeOps<int64_t>
};
//==============================================================================
/** Unsigned 64-bit integer AVX intrinsics. */
/** Unsigned 64-bit integer AVX intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<uint64_t>
{

View file

@ -53,6 +53,8 @@ namespace SIMDInternal
/**
Useful fallback routines to use if the native SIMD op is not supported. You
should never need to use this directly. Use juce_SIMDRegister instead.
@tags{DSP}
*/
template <typename ScalarType, typename vSIMDType>
struct SIMDFallbackOps

View file

@ -51,7 +51,10 @@ template <typename type>
struct SIMDNativeOps;
//==============================================================================
/** Unsigned 32-bit integer NEON intrinsics. */
/** Unsigned 32-bit integer NEON intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<uint32_t>
{
@ -90,7 +93,10 @@ struct SIMDNativeOps<uint32_t>
};
//==============================================================================
/** Signed 32-bit integer NEON intrinsics. */
/** Signed 32-bit integer NEON intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<int32_t>
{
@ -130,7 +136,10 @@ struct SIMDNativeOps<int32_t>
};
//==============================================================================
/** Signed 8-bit integer NEON intrinsics. */
/** Signed 8-bit integer NEON intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<int8_t>
{
@ -165,7 +174,10 @@ struct SIMDNativeOps<int8_t>
};
//==============================================================================
/** Unsigned 8-bit integer NEON intrinsics. */
/** Unsigned 8-bit integer NEON intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<uint8_t>
{
@ -200,7 +212,10 @@ struct SIMDNativeOps<uint8_t>
};
//==============================================================================
/** Signed 16-bit integer NEON intrinsics. */
/** Signed 16-bit integer NEON intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<int16_t>
{
@ -236,7 +251,10 @@ struct SIMDNativeOps<int16_t>
//==============================================================================
/** Unsigned 16-bit integer NEON intrinsics. */
/** Unsigned 16-bit integer NEON intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<uint16_t>
{
@ -271,7 +289,10 @@ struct SIMDNativeOps<uint16_t>
};
//==============================================================================
/** Signed 64-bit integer NEON intrinsics. */
/** Signed 64-bit integer NEON intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<int64_t>
{
@ -307,7 +328,10 @@ struct SIMDNativeOps<int64_t>
//==============================================================================
/** Unsigned 64-bit integer NEON intrinsics. */
/** Unsigned 64-bit integer NEON intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<uint64_t>
{
@ -342,7 +366,10 @@ struct SIMDNativeOps<uint64_t>
};
//==============================================================================
/** Single-precision floating point NEON intrinsics. */
/** Single-precision floating point NEON intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<float>
{
@ -399,6 +426,8 @@ struct SIMDNativeOps<float>
//==============================================================================
/** Double-precision floating point NEON intrinsics does not exist in NEON
so we need to emulate this.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<double>

View file

@ -51,7 +51,10 @@ template <typename type>
struct SIMDNativeOps;
//==============================================================================
/** Single-precision floating point SSE intrinsics. */
/** Single-precision floating point SSE intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<float>
{
@ -111,7 +114,10 @@ struct SIMDNativeOps<float>
};
//==============================================================================
/** Double-precision floating point SSE intrinsics. */
/** Double-precision floating point SSE intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<double>
{
@ -172,7 +178,10 @@ struct SIMDNativeOps<double>
};
//==============================================================================
/** Signed 8-bit integer SSE intrinsics. */
/** Signed 8-bit integer SSE intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<int8_t>
{
@ -257,7 +266,10 @@ struct SIMDNativeOps<int8_t>
};
//==============================================================================
/** Unsigned 8-bit integer SSE intrinsics. */
/** Unsigned 8-bit integer SSE intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<uint8_t>
{
@ -339,7 +351,10 @@ struct SIMDNativeOps<uint8_t>
};
//==============================================================================
/** Signed 16-bit integer SSE intrinsics. */
/** Signed 16-bit integer SSE intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<int16_t>
{
@ -401,7 +416,10 @@ struct SIMDNativeOps<int16_t>
};
//==============================================================================
/** Unsigned 16-bit integer SSE intrinsics. */
/** Unsigned 16-bit integer SSE intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<uint16_t>
{
@ -470,7 +488,10 @@ struct SIMDNativeOps<uint16_t>
};
//==============================================================================
/** Signed 32-bit integer SSE intrinsics. */
/** Signed 32-bit integer SSE intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<int32_t>
{
@ -555,7 +576,10 @@ struct SIMDNativeOps<int32_t>
};
//==============================================================================
/** Unsigned 32-bit integer SSE intrinsics. */
/** Unsigned 32-bit integer SSE intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<uint32_t>
{
@ -647,7 +671,10 @@ struct SIMDNativeOps<uint32_t>
};
//==============================================================================
/** Signed 64-bit integer SSE intrinsics. */
/** Signed 64-bit integer SSE intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<int64_t>
{
@ -738,7 +765,10 @@ struct SIMDNativeOps<int64_t>
};
//==============================================================================
/** Unsigned 64-bit integer SSE intrinsics. */
/** Unsigned 64-bit integer SSE intrinsics.
@tags{DSP}
*/
template <>
struct SIMDNativeOps<uint64_t>
{