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

Documentation fixes.

This commit is contained in:
jules 2013-04-21 12:30:08 +01:00
parent e339d39eb4
commit eeb59c57a9
4 changed files with 5 additions and 3 deletions

View file

@ -38,7 +38,7 @@ public:
static float JUCE_CALLTYPE getGain();
/** Attempts to set the operating system's current volume level.
@newGain the level, between 0 and 1.0
@param newGain the level, between 0 and 1.0
@returns true if the operation succeeds
*/
static bool JUCE_CALLTYPE setGain (float newGain);
@ -47,7 +47,7 @@ public:
static bool JUCE_CALLTYPE isMuted();
/** Attempts to mute the operating system's audio output.
@shouldBeMuted true if you want it to be muted
@param shouldBeMuted true if you want it to be muted
@returns true if the operation succeeds
*/
static bool JUCE_CALLTYPE setMuted (bool shouldBeMuted);

View file

@ -81,7 +81,7 @@ inline Type* createCopyIfNotNull (const Type* pointer) { return pointer != n
/** A macro that can be used to easily declare a local ScopedAutoReleasePool
object for RAII-based obj-C autoreleasing.
Because this may use the @autoreleasepool syntax, you must follow the macro with
Because this may use the \@autoreleasepool syntax, you must follow the macro with
a set of braces to mark the scope of the pool.
*/
#if (JUCE_COMPILER_SUPPORTS_ARC && defined (__OBJC__)) || DOXYGEN

View file

@ -1565,6 +1565,7 @@ public:
that parent components can collect gesture messages that are unused by child
components.
@param event details about the mouse event
@param scaleFactor a multiplier to indicate by how much the size of the target
should be changed. A value of 1.0 would indicate no change,
values greater than 1.0 mean it should be enlarged.

View file

@ -111,6 +111,7 @@ public:
/** Changes the current filename.
@param newFile the new filename to use
@param addToRecentlyUsedList if true, the filename will also be added to the
drop-down list of recent files.
@param notification whether to send a notification of the change to listeners