Browse Source

Fixed some documentation errors

tags/2021-05-28
Tom Poole 6 years ago
parent
commit
34bbb94e2f
3 changed files with 18 additions and 9 deletions
  1. +2
    -2
      modules/juce_core/containers/juce_Array.h
  2. +3
    -7
      modules/juce_core/containers/juce_ArrayAllocationBase.h
  3. +13
    -0
      modules/juce_core/containers/juce_ArrayBase.h

+ 2
- 2
modules/juce_core/containers/juce_Array.h View File

@@ -77,7 +77,7 @@ public:
} }
/** Initalises from a null-terminated raw array of values. /** Initalises from a null-terminated raw array of values.
@param values the array to copy from
@param data the data to copy from
*/ */
template <typename TypeToCreateFrom> template <typename TypeToCreateFrom>
explicit Array (const TypeToCreateFrom* data) explicit Array (const TypeToCreateFrom* data)
@@ -87,7 +87,7 @@ public:
} }
/** Initalises from a raw array of values. /** Initalises from a raw array of values.
@param values the array to copy from
@param data the data to copy from
@param numValues the number of values in the array @param numValues the number of values in the array
*/ */
template <typename TypeToCreateFrom> template <typename TypeToCreateFrom>


+ 3
- 7
modules/juce_core/containers/juce_ArrayAllocationBase.h View File

@@ -27,13 +27,9 @@ namespace juce
/** /**
Implements some basic array storage allocation functions. Implements some basic array storage allocation functions.
This class isn't really for public use - it's used by the other
array classes, but might come in handy for some purposes.
It inherits from a critical section class to allow the arrays to use
the "empty base class optimisation" pattern to reduce their footprint.
@see Array, OwnedArray, ReferenceCountedArray
This class isn't really for public use - it used to be part of the
container classes but has since been superseded by ArrayBase. Eventually
it will be removed from the API.
@tags{Core} @tags{Core}
*/ */


+ 13
- 0
modules/juce_core/containers/juce_ArrayBase.h View File

@@ -23,6 +23,19 @@
namespace juce namespace juce
{ {
/**
A basic object container.
This class isn't really for public use - it's used by the other
array classes, but might come in handy for some purposes.
It inherits from a critical section class to allow the arrays to use
the "empty base class optimisation" pattern to reduce their footprint.
@see Array, OwnedArray, ReferenceCountedArray
@tags{Core}
*/
template <class ElementType, class TypeOfCriticalSectionToUse> template <class ElementType, class TypeOfCriticalSectionToUse>
class ArrayBase : public TypeOfCriticalSectionToUse class ArrayBase : public TypeOfCriticalSectionToUse
{ {


Loading…
Cancel
Save