1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-02-06 04:00:08 +00:00

Documentation fixes.

This commit is contained in:
Julian Storer 2010-03-23 20:56:48 +00:00
parent 15711ae344
commit 59569fb58e
5 changed files with 17 additions and 11 deletions

View file

@ -47,7 +47,7 @@
you do this, the array doesn't take any ownership of the objects - see the OwnedArray class or the
ReferenceCountedArray class for more powerful ways of holding lists of objects.
For holding lists of strings, you can use Array <String>, but it's usually better to use the
For holding lists of strings, you can use Array\<String\>, but it's usually better to use the
specialised class StringArray, which provides more useful functions.
To make all the array's methods thread-safe, pass in "CriticalSection" as the templated

View file

@ -152,7 +152,7 @@ public:
The unbounded mode is automatically turned off when the mouse button is released, or
it can be turned off explicitly by calling this method again.
@param shouldUnboundedMovementBeEnabled whether to turn this mode on or off
@param isEnabled whether to turn this mode on or off
@param keepCursorVisibleUntilOffscreen if set to false, the cursor will immediately be
hidden; if true, it will only be hidden when it
is moved beyond the edge of the screen

View file

@ -452,10 +452,14 @@ void StringArray::removeDuplicates (const bool ignoreCase)
void StringArray::appendNumbersToDuplicates (const bool ignoreCase,
const bool appendNumberToFirstInstance,
const juce_wchar* const preNumberString,
const juce_wchar* const postNumberString)
const juce_wchar* preNumberString,
const juce_wchar* postNumberString)
{
jassert (preNumberString != 0 && postNumberString != 0); // These strings can't be null pointers..
if (preNumberString == 0)
preNumberString = T(" (");
if (postNumberString == 0)
postNumberString = T(")");
for (int i = 0; i < size() - 1; ++i)
{

View file

@ -268,13 +268,17 @@ public:
@param ignoreCaseWhenComparing whether the comparison used is case-insensitive
@param appendNumberToFirstInstance whether the first of a group of similar strings
also has a number appended to it.
@param preNumberString when adding a number, this string is added before the number
@param postNumberString this string is appended after any numbers that are added
@param preNumberString when adding a number, this string is added before the number.
If you pass 0, a default string will be used, which adds
brackets around the number.
@param postNumberString this string is appended after any numbers that are added.
If you pass 0, a default string will be used, which adds
brackets around the number.
*/
void appendNumbersToDuplicates (bool ignoreCaseWhenComparing,
bool appendNumberToFirstInstance,
const juce_wchar* preNumberString = JUCE_T(" ("),
const juce_wchar* postNumberString = JUCE_T(")"));
const juce_wchar* preNumberString = 0,
const juce_wchar* postNumberString = 0);
//==============================================================================
/** Joins the strings in the array together into one string.

View file

@ -294,8 +294,6 @@ public:
/** Returns the value of a named attribute.
@param attributeName the name of the attribute to look up
@param defaultReturnValue a value to return if the element doesn't have an attribute
with this name
*/
const String& getStringAttribute (const String& attributeName) const throw();