From 34bbb94e2f8a1a35565a2f18cd6a496dea01f400 Mon Sep 17 00:00:00 2001 From: Tom Poole Date: Wed, 5 Sep 2018 17:23:37 +0100 Subject: [PATCH] Fixed some documentation errors --- modules/juce_core/containers/juce_Array.h | 4 ++-- .../juce_core/containers/juce_ArrayAllocationBase.h | 10 +++------- modules/juce_core/containers/juce_ArrayBase.h | 13 +++++++++++++ 3 files changed, 18 insertions(+), 9 deletions(-) diff --git a/modules/juce_core/containers/juce_Array.h b/modules/juce_core/containers/juce_Array.h index 50e45339db..bb3b733553 100644 --- a/modules/juce_core/containers/juce_Array.h +++ b/modules/juce_core/containers/juce_Array.h @@ -77,7 +77,7 @@ public: } /** Initalises from a null-terminated raw array of values. - @param values the array to copy from + @param data the data to copy from */ template explicit Array (const TypeToCreateFrom* data) @@ -87,7 +87,7 @@ public: } /** 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 */ template diff --git a/modules/juce_core/containers/juce_ArrayAllocationBase.h b/modules/juce_core/containers/juce_ArrayAllocationBase.h index 6ab28e7695..5a82d6ec3e 100644 --- a/modules/juce_core/containers/juce_ArrayAllocationBase.h +++ b/modules/juce_core/containers/juce_ArrayAllocationBase.h @@ -27,13 +27,9 @@ namespace juce /** 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} */ diff --git a/modules/juce_core/containers/juce_ArrayBase.h b/modules/juce_core/containers/juce_ArrayBase.h index e4604e96b3..34c986b2fb 100644 --- a/modules/juce_core/containers/juce_ArrayBase.h +++ b/modules/juce_core/containers/juce_ArrayBase.h @@ -23,6 +23,19 @@ 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 ArrayBase : public TypeOfCriticalSectionToUse {