From eeb59c57a9af80ed39747a6aa8c256a5f53b2f5b Mon Sep 17 00:00:00 2001 From: jules Date: Sun, 21 Apr 2013 12:30:08 +0100 Subject: [PATCH] Documentation fixes. --- modules/juce_audio_devices/audio_io/juce_SystemAudioVolume.h | 4 ++-- modules/juce_core/memory/juce_Memory.h | 2 +- modules/juce_gui_basics/components/juce_Component.h | 1 + modules/juce_gui_basics/filebrowser/juce_FilenameComponent.h | 1 + 4 files changed, 5 insertions(+), 3 deletions(-) diff --git a/modules/juce_audio_devices/audio_io/juce_SystemAudioVolume.h b/modules/juce_audio_devices/audio_io/juce_SystemAudioVolume.h index dd56ec5416..58b764120c 100644 --- a/modules/juce_audio_devices/audio_io/juce_SystemAudioVolume.h +++ b/modules/juce_audio_devices/audio_io/juce_SystemAudioVolume.h @@ -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); diff --git a/modules/juce_core/memory/juce_Memory.h b/modules/juce_core/memory/juce_Memory.h index e1de06200f..1a187df454 100644 --- a/modules/juce_core/memory/juce_Memory.h +++ b/modules/juce_core/memory/juce_Memory.h @@ -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 diff --git a/modules/juce_gui_basics/components/juce_Component.h b/modules/juce_gui_basics/components/juce_Component.h index da3f95f9f6..cdfddb36cf 100644 --- a/modules/juce_gui_basics/components/juce_Component.h +++ b/modules/juce_gui_basics/components/juce_Component.h @@ -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. diff --git a/modules/juce_gui_basics/filebrowser/juce_FilenameComponent.h b/modules/juce_gui_basics/filebrowser/juce_FilenameComponent.h index 4b1ca94e9c..9aea4ad05f 100644 --- a/modules/juce_gui_basics/filebrowser/juce_FilenameComponent.h +++ b/modules/juce_gui_basics/filebrowser/juce_FilenameComponent.h @@ -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