1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-22 01:34:21 +00:00

Couple of minor documentation fixes.

This commit is contained in:
Julian Storer 2011-03-22 15:40:45 +00:00
parent ca8ce6d354
commit 7a8377aeb7
8 changed files with 13 additions and 16 deletions

View file

@ -243,6 +243,7 @@ public:
@param channel the midi channel, in the range 1 to 16
@param noteNumber the key number, 0 to 127
@param velocity in the range 0 to 127
@see isNoteOff
*/
static const MidiMessage noteOff (int channel, int noteNumber, uint8 velocity = 0) throw();

View file

@ -448,9 +448,9 @@ public:
*/
bool isItemHighlighted() const throw() { return isHighlighted; }
/** @internal. */
/** @internal */
bool isTriggeredAutomatically() const throw() { return triggeredAutomatically; }
/** @internal. */
/** @internal */
void setHighlighted (bool shouldBeHighlighted);
private:

View file

@ -154,7 +154,7 @@ public:
@param useBottomRightCornerResizer if shouldBeResizable is true, this indicates whether
to use a border or corner resizer component. See ResizableWindow::setResizable()
*/
#if JUCE_MODAL_LOOPS_PERMITTED
#if JUCE_MODAL_LOOPS_PERMITTED || DOXYGEN
static int showModalDialog (const String& dialogTitle,
Component* contentComponent,
Component* componentToCentreAround,

View file

@ -67,9 +67,9 @@ public:
inline bool operator== (const CharPointer_ASCII& other) const throw() { return data == other.data; }
inline bool operator!= (const CharPointer_ASCII& other) const throw() { return data != other.data; }
inline bool operator<= (const CharPointer_ASCII& other) const throw() { return data <= other.data; }
inline bool operator< (const CharPointer_ASCII& other) const throw() { return data < other.data; }
inline bool operator< (const CharPointer_ASCII& other) const throw() { return data < other.data; }
inline bool operator>= (const CharPointer_ASCII& other) const throw() { return data >= other.data; }
inline bool operator> (const CharPointer_ASCII& other) const throw() { return data > other.data; }
inline bool operator> (const CharPointer_ASCII& other) const throw() { return data > other.data; }
/** Returns the address that this pointer is pointing to. */
inline CharType* getAddress() const throw() { return data; }

View file

@ -68,9 +68,9 @@ public:
inline bool operator== (const CharPointer_UTF16& other) const throw() { return data == other.data; }
inline bool operator!= (const CharPointer_UTF16& other) const throw() { return data != other.data; }
inline bool operator<= (const CharPointer_UTF16& other) const throw() { return data <= other.data; }
inline bool operator< (const CharPointer_UTF16& other) const throw() { return data < other.data; }
inline bool operator< (const CharPointer_UTF16& other) const throw() { return data < other.data; }
inline bool operator>= (const CharPointer_UTF16& other) const throw() { return data >= other.data; }
inline bool operator> (const CharPointer_UTF16& other) const throw() { return data > other.data; }
inline bool operator> (const CharPointer_UTF16& other) const throw() { return data > other.data; }
/** Returns the address that this pointer is pointing to. */
inline CharType* getAddress() const throw() { return data; }

View file

@ -64,9 +64,9 @@ public:
inline bool operator== (const CharPointer_UTF32& other) const throw() { return data == other.data; }
inline bool operator!= (const CharPointer_UTF32& other) const throw() { return data != other.data; }
inline bool operator<= (const CharPointer_UTF32& other) const throw() { return data <= other.data; }
inline bool operator< (const CharPointer_UTF32& other) const throw() { return data < other.data; }
inline bool operator< (const CharPointer_UTF32& other) const throw() { return data < other.data; }
inline bool operator>= (const CharPointer_UTF32& other) const throw() { return data >= other.data; }
inline bool operator> (const CharPointer_UTF32& other) const throw() { return data > other.data; }
inline bool operator> (const CharPointer_UTF32& other) const throw() { return data > other.data; }
/** Returns the address that this pointer is pointing to. */
inline CharType* getAddress() const throw() { return data; }

View file

@ -63,9 +63,9 @@ public:
inline bool operator== (const CharPointer_UTF8& other) const throw() { return data == other.data; }
inline bool operator!= (const CharPointer_UTF8& other) const throw() { return data != other.data; }
inline bool operator<= (const CharPointer_UTF8& other) const throw() { return data <= other.data; }
inline bool operator< (const CharPointer_UTF8& other) const throw() { return data < other.data; }
inline bool operator< (const CharPointer_UTF8& other) const throw() { return data < other.data; }
inline bool operator>= (const CharPointer_UTF8& other) const throw() { return data >= other.data; }
inline bool operator> (const CharPointer_UTF8& other) const throw() { return data > other.data; }
inline bool operator> (const CharPointer_UTF8& other) const throw() { return data > other.data; }
/** Returns the address that this pointer is pointing to. */
inline CharType* getAddress() const throw() { return data; }

View file

@ -254,11 +254,7 @@ public:
}
}
/** Appends a string to the end of this one.
@param textToAppend the string to add
@param maxCharsToTake the maximum number of characters to take from the string passed in
*/
/** Appends a string to the end of this one. */
template <class CharPointer>
void appendCharPointer (const CharPointer& textToAppend)
{