From f9759ecc6b109647b5b0b47e3c5e0e38df4769cb Mon Sep 17 00:00:00 2001 From: jules Date: Sat, 30 Nov 2013 20:04:17 +0000 Subject: [PATCH] Documentation fixes. --- modules/juce_audio_devices/sources/juce_AudioSourcePlayer.h | 3 +-- modules/juce_core/containers/juce_PropertySet.h | 4 ++-- modules/juce_core/threads/juce_ThreadPool.h | 2 +- modules/juce_data_structures/values/juce_ValueTree.h | 2 +- modules/juce_gui_basics/components/juce_Component.h | 2 +- modules/juce_gui_basics/drawables/juce_Drawable.h | 2 +- .../juce_gui_basics/keyboard/juce_KeyboardFocusTraverser.h | 6 +++--- modules/juce_gui_basics/widgets/juce_TableListBox.h | 2 +- 8 files changed, 11 insertions(+), 12 deletions(-) diff --git a/modules/juce_audio_devices/sources/juce_AudioSourcePlayer.h b/modules/juce_audio_devices/sources/juce_AudioSourcePlayer.h index badd6519a5..0a3751c514 100644 --- a/modules/juce_audio_devices/sources/juce_AudioSourcePlayer.h +++ b/modules/juce_audio_devices/sources/juce_AudioSourcePlayer.h @@ -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; } diff --git a/modules/juce_core/containers/juce_PropertySet.h b/modules/juce_core/containers/juce_PropertySet.h index 8d3f429508..3018b886ca 100644 --- a/modules/juce_core/containers/juce_PropertySet.h +++ b/modules/juce_core/containers/juce_PropertySet.h @@ -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), diff --git a/modules/juce_core/threads/juce_ThreadPool.h b/modules/juce_core/threads/juce_ThreadPool.h index c93d4363f4..ed820e8065 100644 --- a/modules/juce_core/threads/juce_ThreadPool.h +++ b/modules/juce_core/threads/juce_ThreadPool.h @@ -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; diff --git a/modules/juce_data_structures/values/juce_ValueTree.h b/modules/juce_data_structures/values/juce_ValueTree.h index 44fd13f28a..311d722f31 100644 --- a/modules/juce_data_structures/values/juce_ValueTree.h +++ b/modules/juce_data_structures/values/juce_ValueTree.h @@ -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 */ diff --git a/modules/juce_gui_basics/components/juce_Component.h b/modules/juce_gui_basics/components/juce_Component.h index e3e4e31141..313216e53d 100644 --- a/modules/juce_gui_basics/components/juce_Component.h +++ b/modules/juce_gui_basics/components/juce_Component.h @@ -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 */ diff --git a/modules/juce_gui_basics/drawables/juce_Drawable.h b/modules/juce_gui_basics/drawables/juce_Drawable.h index da67b22cea..6a59c59c52 100644 --- a/modules/juce_gui_basics/drawables/juce_Drawable.h +++ b/modules/juce_gui_basics/drawables/juce_Drawable.h @@ -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. diff --git a/modules/juce_gui_basics/keyboard/juce_KeyboardFocusTraverser.h b/modules/juce_gui_basics/keyboard/juce_KeyboardFocusTraverser.h index a22311d567..94ef5f7c1a 100644 --- a/modules/juce_gui_basics/keyboard/juce_KeyboardFocusTraverser.h +++ b/modules/juce_gui_basics/keyboard/juce_KeyboardFocusTraverser.h @@ -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); }; diff --git a/modules/juce_gui_basics/widgets/juce_TableListBox.h b/modules/juce_gui_basics/widgets/juce_TableListBox.h index 6076dabb4a..9f83e86c69 100644 --- a/modules/juce_gui_basics/widgets/juce_TableListBox.h +++ b/modules/juce_gui_basics/widgets/juce_TableListBox.h @@ -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;