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

Doxygen warning fixes and extra comments.

Browse source
This commit is contained in:
jules 2013-08-21 17:19:47 +01:00
parent 45b56e2e20
commit 1e3973a212
9 changed files with 28 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

2
modules/juce_core/containers/juce_Array.h
View file

@ -1025,9 +1025,11 @@ public:
//==============================================================================
#ifndef DOXYGEN
// Note that the swapWithArray method has been replaced by a more flexible templated version,
// and renamed "swapWith" to be more consistent with the names used in other classes.
JUCE_DEPRECATED_WITH_BODY (void swapWithArray (Array& other) noexcept, { swapWith (other); })
#endif
private:
//==============================================================================

9
modules/juce_core/containers/juce_HashMap.h
View file

@ -109,11 +109,10 @@ public:
//==============================================================================
/** Creates an empty hash-map.
The numberOfSlots parameter specifies the number of hash entries the map will
use. This will be the "upperLimit" parameter that is passed to your generateHash()
function. The number of hash slots will grow automatically if necessary, or
it can be remapped manually using remapTable().
@param numberOfSlots Specifies the number of hash entries the map will use. This will be
the "upperLimit" parameter that is passed to your generateHash()
function. The number of hash slots will grow automatically if necessary,
or it can be remapped manually using remapTable().
@param hashFunction An instance of HashFunctionType, which will be copied and
stored to use with the HashMap. This parameter can be omitted
if HashFunctionType has a default constructor.

2
modules/juce_core/containers/juce_OwnedArray.h
View file

@ -875,9 +875,11 @@ public:
//==============================================================================
#ifndef DOXYGEN
// Note that the swapWithArray method has been replaced by a more flexible templated version,
// and renamed "swapWith" to be more consistent with the names used in other classes.
JUCE_DEPRECATED_WITH_BODY (void swapWithArray (OwnedArray& other) noexcept, { swapWith (other); })
#endif
private:
//==============================================================================

2
modules/juce_core/containers/juce_ReferenceCountedArray.h
View file

@ -858,9 +858,11 @@ public:
//==============================================================================
#ifndef DOXYGEN
// Note that the swapWithArray method has been replaced by a more flexible templated version,
// and renamed "swapWith" to be more consistent with the names used in other classes.
JUCE_DEPRECATED_WITH_BODY (void swapWithArray (ReferenceCountedArray& other) noexcept, { swapWith (other); })
#endif
private:
//==============================================================================

2
modules/juce_graphics/geometry/juce_Rectangle.h
View file

@ -827,8 +827,10 @@ public:
parseIntAfterSpace (toks[3]));
}
#ifndef DOXYGEN
// This has been renamed by transformedBy, in order to match the method names used in the Point class.
JUCE_DEPRECATED_WITH_BODY (Rectangle transformed (const AffineTransform& t) const noexcept, { return transformedBy (t); })
#endif
private:
template <typename OtherType> friend class Rectangle;

3
modules/juce_gui_basics/components/juce_Desktop.cpp
View file

@ -413,7 +413,7 @@ bool operator!= (const Desktop::Displays::Display& d1, const Desktop::Displays::
void Desktop::Displays::init (Desktop& desktop)
{
findDisplays (desktop.masterScaleFactor);
findDisplays (desktop.getGlobalScaleFactor());
jassert (displays.size() > 0);
}
@ -483,7 +483,6 @@ void Desktop::setGlobalScaleFactor (float newScaleFactor) noexcept
if (masterScaleFactor != newScaleFactor)
{
masterScaleFactor = newScaleFactor;
displays->refresh();
}
}

12
modules/juce_gui_basics/components/juce_Desktop.h
View file

@ -403,14 +403,14 @@ private:
friend class DeletedAtShutdown;
friend class TopLevelWindowManager;
OwnedArray <MouseInputSource> mouseSources;
OwnedArray<MouseInputSource> mouseSources;
bool addMouseInputSource();
ListenerList <MouseListener> mouseListeners;
ListenerList <FocusChangeListener> focusListeners;
ListenerList<MouseListener> mouseListeners;
ListenerList<FocusChangeListener> focusListeners;
Array <Component*> desktopComponents;
Array <ComponentPeer*> peers;
Array<Component*> desktopComponents;
Array<ComponentPeer*> peers;
ScopedPointer<Displays> displays;
@ -436,7 +436,7 @@ private:
void timerCallback() override;
void resetTimer();
ListenerList <MouseListener>& getMouseListeners();
ListenerList<MouseListener>& getMouseListeners();
MouseInputSource* getOrCreateMouseInputSource (int touchIndex);
void addDesktopComponent (Component*);

4
modules/juce_gui_basics/lookandfeel/juce_LookAndFeel.h
View file

@ -247,7 +247,7 @@ public:
@param isMouseOverButton whether the mouse is currently over the button (also true if it's held down)
@param isButtonDown whether the mouse button's held down
*/
virtual void drawScrollbarButton (Graphics&,
virtual void drawScrollbarButton (Graphics& g,
ScrollBar& scrollbar,
int width, int height,
int buttonDirection,
@ -272,7 +272,7 @@ public:
currently dragging the thumb
@param isMouseDown whether the mouse is currently dragging the scrollbar
*/
virtual void drawScrollbar (Graphics&,
virtual void drawScrollbar (Graphics& g,
ScrollBar& scrollbar,
int x, int y,
int width, int height,

8
modules/juce_opengl/opengl/juce_OpenGLShaderProgram.cpp
View file

@ -41,7 +41,9 @@ OpenGLShaderProgram::~OpenGLShaderProgram() noexcept
double OpenGLShaderProgram::getLanguageVersion()
{
#if JUCE_OPENGL_ES
jassertfalse; // doesn't work in ES
// GLES doesn't support this version number, but that shouldn't matter since
// on GLES you probably won't need to check it.
jassertfalse;
return 0;
#else
return String ((const char*) glGetString (GL_SHADING_LANGUAGE_VERSION))
@ -66,6 +68,8 @@ bool OpenGLShaderProgram::addShader (const char* const code, GLenum type)
errorLog = String (infoLog, (size_t) infoLogLength);
#if JUCE_DEBUG
// Your GLSL code contained compile errors!
// Hopefully this compile log should help to explain what went wrong.
DBG (errorLog);
jassertfalse;
#endif
@ -94,6 +98,8 @@ bool OpenGLShaderProgram::link() noexcept
errorLog = String (infoLog, (size_t) infoLogLength);
#if JUCE_DEBUG
// Your GLSL code contained link errors!
// Hopefully this compile log should help to explain what went wrong.
DBG (errorLog);
jassertfalse;
#endif