Browse Source

Documentation fixes.

tags/2021-05-28
jules 12 years ago
parent
commit
f9759ecc6b
8 changed files with 11 additions and 12 deletions
  1. +1
    -2
      modules/juce_audio_devices/sources/juce_AudioSourcePlayer.h
  2. +2
    -2
      modules/juce_core/containers/juce_PropertySet.h
  3. +1
    -1
      modules/juce_core/threads/juce_ThreadPool.h
  4. +1
    -1
      modules/juce_data_structures/values/juce_ValueTree.h
  5. +1
    -1
      modules/juce_gui_basics/components/juce_Component.h
  6. +1
    -1
      modules/juce_gui_basics/drawables/juce_Drawable.h
  7. +3
    -3
      modules/juce_gui_basics/keyboard/juce_KeyboardFocusTraverser.h
  8. +1
    -1
      modules/juce_gui_basics/widgets/juce_TableListBox.h

+ 1
- 2
modules/juce_audio_devices/sources/juce_AudioSourcePlayer.h View File

@@ -65,8 +65,7 @@ public:
void setSource (AudioSource* newSource);
/** Returns the source that's playing.
May return 0 if there's no source.
May return nullptr if there's no source.
*/
AudioSource* getCurrentSource() const noexcept { return source; }


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

@@ -109,8 +109,8 @@ public:
/** Returns one of the properties as an XML element.
The result will a new XMLElement object that the caller must delete. If may return 0 if the
key isn't found, or if the entry contains an string that isn't valid XML.
The result will a new XMLElement object that the caller must delete. If may return nullptr
if the key isn't found, or if the entry contains an string that isn't valid XML.
If the value isn't found in this set, then this will look for it in a fallback
property set (if you've specified one with the setFallbackPropertySet() method),


+ 1
- 1
modules/juce_core/threads/juce_ThreadPool.h View File

@@ -247,7 +247,7 @@ public:
/** Returns one of the jobs in the queue.
Note that this can be a very volatile list as jobs might be continuously getting shifted
around in the list, and this method may return 0 if the index is currently out-of-range.
around in the list, and this method may return nullptr if the index is currently out-of-range.
*/
ThreadPoolJob* getJob (int index) const;


+ 1
- 1
modules/juce_data_structures/values/juce_ValueTree.h View File

@@ -317,7 +317,7 @@ public:
//==============================================================================
/** Creates an XmlElement that holds a complete image of this node and all its children.
If this node is invalid, this may return 0. Otherwise, the XML that is produced can
If this node is invalid, this may return nullptr. Otherwise, the XML that is produced can
be used to recreate a similar node by calling fromXml()
@see fromXml
*/


+ 1
- 1
modules/juce_gui_basics/components/juce_Component.h View File

@@ -178,7 +178,7 @@ public:
object that it is using. Otherwise, it will return the window of
its top-level parent component.
This may return 0 if there isn't a desktop component.
This may return nullptr if there isn't a desktop component.
@see addToDesktop, isOnDesktop
*/


+ 1
- 1
modules/juce_gui_basics/drawables/juce_Drawable.h View File

@@ -142,7 +142,7 @@ public:
into a Drawable tree.
The object returned must be deleted by the caller. If something goes wrong
while parsing, it may return 0.
while parsing, it may return nullptr.
SVG is a pretty large and complex spec, and this doesn't aim to be a full
implementation, but it can return the basic vector objects.


+ 3
- 3
modules/juce_gui_basics/keyboard/juce_KeyboardFocusTraverser.h View File

@@ -60,7 +60,7 @@ public:
The default implementation will return the next component which is to the
right of or below this one.
This may return 0 if there's no suitable candidate.
This may return nullptr if there's no suitable candidate.
*/
virtual Component* getNextComponent (Component* current);
@@ -70,7 +70,7 @@ public:
The default implementation will return the next component which is to the
left of or above this one.
This may return 0 if there's no suitable candidate.
This may return nullptr if there's no suitable candidate.
*/
virtual Component* getPreviousComponent (Component* current);
@@ -80,7 +80,7 @@ public:
The default implementation will just return the foremost child component that
wants focus.
This may return 0 if there's no suitable candidate.
This may return nullptr if there's no suitable candidate.
*/
virtual Component* getDefaultComponent (Component* parentComponent);
};


+ 1
- 1
modules/juce_gui_basics/widgets/juce_TableListBox.h View File

@@ -278,7 +278,7 @@ public:
/** Returns the component that currently represents a given cell.
If the component for this cell is off-screen or if the position is out-of-range,
this may return 0.
this may return nullptr.
@see getCellPosition
*/
Component* getCellComponent (int columnId, int rowNumber) const;


Loading…
Cancel
Save