Browse Source

Couple of minor documentation fixes.

tags/2021-05-28
Julian Storer 14 years ago
parent
commit
7a8377aeb7
8 changed files with 13 additions and 16 deletions
  1. +1
    -0
      src/audio/midi/juce_MidiMessage.h
  2. +2
    -2
      src/gui/components/menus/juce_PopupMenu.h
  3. +1
    -1
      src/gui/components/windows/juce_DialogWindow.h
  4. +2
    -2
      src/text/juce_CharPointer_ASCII.h
  5. +2
    -2
      src/text/juce_CharPointer_UTF16.h
  6. +2
    -2
      src/text/juce_CharPointer_UTF32.h
  7. +2
    -2
      src/text/juce_CharPointer_UTF8.h
  8. +1
    -5
      src/text/juce_String.h

+ 1
- 0
src/audio/midi/juce_MidiMessage.h 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();


+ 2
- 2
src/gui/components/menus/juce_PopupMenu.h 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:


+ 1
- 1
src/gui/components/windows/juce_DialogWindow.h 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,


+ 2
- 2
src/text/juce_CharPointer_ASCII.h 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; }


+ 2
- 2
src/text/juce_CharPointer_UTF16.h 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; }


+ 2
- 2
src/text/juce_CharPointer_UTF32.h 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; }


+ 2
- 2
src/text/juce_CharPointer_UTF8.h 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; }


+ 1
- 5
src/text/juce_String.h 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)
{


Loading…
Cancel
Save