mirror/JUCE
1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00
Code Activity

Replace all "zeros" with "nullptr" in code documentation when referring to a pointer value

Browse source
This commit is contained in:
hogliux 2016-08-03 09:43:07 +01:00
parent bf582f6c5b
commit 26b6f01ce3
15 changed files with 38 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

2
modules/juce_audio_devices/sources/juce_AudioTransportSource.h
View file

@ -60,7 +60,7 @@ public:
The source passed in will not be deleted by this object, so must be managed by
the caller.
@param newSource the new input source to use. This may be zero
@param newSource the new input source to use. This may be a nullptr
@param readAheadBufferSize a size of buffer to use for reading ahead. If this
is zero, no reading ahead will be done; if it's
greater than zero, a BufferingAudioSource will be used

4
modules/juce_core/containers/juce_PropertySet.h
View file

@ -131,8 +131,8 @@ public:
/** Sets a named property to an XML element.
@param keyName the name of the property to set. (This mustn't be an empty string)
@param xml the new element to set it to. If this is zero, the value will be set to
an empty string
@param xml the new element to set it to. If this is a nullptr, the value will
be set to an empty string
@see getXmlValue
*/
void setValue (const String& keyName, const XmlElement* xml);

2
modules/juce_core/memory/juce_SharedResourcePointer.h
View file

@ -122,7 +122,7 @@ public:
SharedObjectType& get() const noexcept { return *sharedObject; }
/** Returns the object that this pointer references.
The pointer returned may be zero, of course.
The pointer returned may be a nullptr, of course.
*/
SharedObjectType& getObject() const noexcept { return *sharedObject; }

2
modules/juce_core/network/juce_URL.h
View file

@ -283,7 +283,7 @@ public:
if the parameter httpRequestCmd is not specified (or empty) then this
parameter will determine which HTTP request command will be used
(POST or GET).
@param progressCallback if this is non-zero, it lets you supply a callback function
@param progressCallback if this is not a nullptr, it lets you supply a callback function
to keep track of the operation's progress. This can be useful
for lengthy POST operations, so that you can provide user feedback.
@param progressCallbackContext if a callback is specified, this value will be passed to

4
modules/juce_core/threads/juce_ThreadPool.h
View file

@ -237,8 +237,8 @@ public:
methods called to try to interrupt them
@param timeOutMilliseconds the length of time this method should wait for all the jobs to finish
before giving up and returning false
@param selectedJobsToRemove if this is non-zero, the JobSelector object is asked to decide which
jobs should be removed. If it is zero, all jobs are removed
@param selectedJobsToRemove if this is not a nullptr, the JobSelector object is asked to decide
which jobs should be removed. If it is a nullptr, all jobs are removed
@returns true if all jobs are successfully stopped and removed; false if the timeout period
expires while waiting for one or more jobs to stop
*/

4
modules/juce_core/xml/juce_XmlElement.h
View file

@ -457,8 +457,8 @@ public:
Also, it's much easier and neater to use this method indirectly via the
forEachXmlChildElement macro.
@returns the sibling element that follows this one, or zero if this is the last
element in its parent
@returns the sibling element that follows this one, or a nullptr if
this is the last element in its parent
@see getNextElement, isTextElement, forEachXmlChildElement
*/

6
modules/juce_core/zip/juce_ZipFile.h
View file

@ -91,7 +91,7 @@ public:
int getNumEntries() const noexcept;
/** Returns a structure that describes one of the entries in the zip file.
This may return zero if the index is out of range.
This may return a nullptr if the index is out of range.
@see ZipFile::ZipEntry
*/
const ZipEntry* getEntry (int index) const noexcept;
@ -120,7 +120,7 @@ public:
/** Creates a stream that can read from one of the zip file's entries.
The stream that is returned must be deleted by the caller (and
zero might be returned if a stream can't be opened for some reason).
a nullptr might be returned if a stream can't be opened for some reason).
The stream must not be used after the ZipFile object that created
has been deleted.
@ -135,7 +135,7 @@ public:
/** Creates a stream that can read from one of the zip file's entries.
The stream that is returned must be deleted by the caller (and
zero might be returned if a stream can't be opened for some reason).
a nullptr might be returned if a stream can't be opened for some reason).
The stream must not be used after the ZipFile object that created
has been deleted.

2
modules/juce_data_structures/undomanager/juce_UndoableAction.h
View file

@ -90,7 +90,7 @@ public:
If possible, this method should create and return a single action that does the same job as
this one followed by the supplied action.
If it's not possible to merge the two actions, the method should return zero.
If it's not possible to merge the two actions, the method should return a nullptr.
*/
virtual UndoableAction* createCoalescedAction (UndoableAction* nextAction) { ignoreUnused (nextAction); return nullptr; }
};

6
modules/juce_gui_basics/layout/juce_ResizableBorderComponent.h
View file

@ -57,9 +57,9 @@ public:
Remember that when the target component is resized, it'll need to move and
resize this component to keep it in place, as this won't happen automatically.
If the constrainer parameter is non-zero, then this object will be used to enforce
limits on the size and position that the component can be stretched to. Make sure
that the constrainer isn't deleted while still in use by this object.
If the constrainer parameter is not a nullptr, then this object will be used to
enforce limits on the size and position that the component can be stretched to.
Make sure that the constrainer isn't deleted while still in use by this object.
@see ComponentBoundsConstrainer
*/

6
modules/juce_gui_basics/layout/juce_ResizableEdgeComponent.h
View file

@ -60,9 +60,9 @@ public:
Remember that when the target component is resized, it'll need to move and
resize this component to keep it in place, as this won't happen automatically.
If the constrainer parameter is non-zero, then this object will be used to enforce
limits on the size and position that the component can be stretched to. Make sure
that the constrainer isn't deleted while still in use by this object.
If the constrainer parameter is not a nullptr, then this object will be used to
enforce limits on the size and position that the component can be stretched to.
Make sure that the constrainer isn't deleted while still in use by this object.
@see ComponentBoundsConstrainer
*/

12
modules/juce_gui_basics/menus/juce_PopupMenu.h
View file

@ -439,12 +439,12 @@ public:
in zero.
@param standardItemHeight if this is non-zero, it will be used as the standard
height for menu items (apart from custom items)
@param callback if this is non-zero, the menu will be launched asynchronously,
returning immediately, and the callback will receive a
call when the menu is either dismissed or has an item
selected. This object will be owned and deleted by the
system, so make sure that it works safely and that any
pointers that it uses are safely within scope.
@param callback if this is not a nullptr, the menu will be launched
asynchronously, returning immediately, and the callback
will receive a call when the menu is either dismissed or
has an item selected. This object will be owned and
deleted by the system, so make sure that it works safely
and that any pointers that it uses are safely within scope.
@see showAt
*/
int show (int itemIDThatMustBeVisible = 0,

8
modules/juce_gui_basics/windows/juce_CallOutBox.h
View file

@ -67,8 +67,8 @@ public:
@param areaToPointTo the area that the call-out's arrow should point towards. If
a parentComponent is supplied, then this is relative to that
parent; otherwise, it's a global screen coord.
@param parentComponent if non-zero, this is the component to add the call-out to. If
this is a nullptr, the call-out will be added to the desktop.
@param parentComponent if not a nullptr, this is the component to add the call-out to.
If this is a nullptr, the call-out will be added to the desktop.
*/
CallOutBox (Component& contentComponent,
const Rectangle<int>& areaToPointTo,
@ -111,8 +111,8 @@ public:
@param areaToPointTo the area that the call-out's arrow should point towards. If
a parentComponent is supplied, then this is relative to that
parent; otherwise, it's a global screen coord.
@param parentComponent if non-zero, this is the component to add the call-out to. If
this is a nullptr, the call-out will be added to the desktop.
@param parentComponent if not a nullptr, this is the component to add the call-out to.
If this is a nullptr, the call-out will be added to the desktop.
*/
static CallOutBox& launchAsynchronously (Component* contentComponent,
const Rectangle<int>& areaToPointTo,

4
modules/juce_gui_basics/windows/juce_DialogWindow.h
View file

@ -171,7 +171,7 @@ public:
be before calling this method. The component won't
be deleted by this call, so you can re-use it or delete
it afterwards
@param componentToCentreAround if this is non-zero, it indicates a component that
@param componentToCentreAround if this is not a nullptr, it indicates a component that
you'd like to show this dialog box in front of. See the
DocumentWindow::centreAroundComponent() method for more
info on this parameter
@ -217,7 +217,7 @@ public:
be before calling this method. The component won't
be deleted by this call, so you can re-use it or delete
it afterwards
@param componentToCentreAround if this is non-zero, it indicates a component that
@param componentToCentreAround if this is not a nullptr, it indicates a component that
you'd like to show this dialog box in front of. See the
DocumentWindow::centreAroundComponent() method for more
info on this parameter

6
modules/juce_gui_basics/windows/juce_DocumentWindow.h
View file

@ -141,9 +141,9 @@ public:
@param menuBarModel this specifies a MenuBarModel that should be used to
generate the contents of a menu bar that will be placed
just below the title bar, and just above any content
component. If this value is zero, any existing menu bar
will be removed from the component; if non-zero, one will
be added if it's required.
component. If this value is a nullptr, any existing menu bar
will be removed from the component; if it is not a nullptr,
one will be added if it's required.
@param menuBarHeight the height of the menu bar component, if one is needed. Pass a value of zero
or less to use the look-and-feel's default size.
*/

8
modules/juce_gui_extra/misc/juce_RecentlyOpenedFilesList.h
View file

@ -118,10 +118,10 @@ public:
If dontAddNonExistentFiles is true, then each file will be checked and only those
that exist will be added.
If filesToAvoid is non-zero, then it is considered to be a zero-terminated array of
pointers to file objects. Any files that appear in this list will not be added to the
menu - the reason for this is that you might have a number of files already open, so
might not want these to be shown in the menu.
If filesToAvoid is not a nullptr, then it is considered to be a zero-terminated array
of pointers to file objects. Any files that appear in this list will not be added to
the menu - the reason for this is that you might have a number of files already open,
so might not want these to be shown in the menu.
It returns the number of items that were added.
*/