Browse Source

Improve some documentation

v7.0.9
Tom Poole 3 years ago
parent
commit
cb2efe5d59
4 changed files with 8 additions and 6 deletions
  1. +1
    -1
      docs/CMake API.md
  2. +5
    -3
      modules/juce_core/files/juce_File.h
  3. +1
    -1
      modules/juce_core/misc/juce_RuntimePermissions.h
  4. +1
    -1
      modules/juce_core/text/juce_LocalisedStrings.h

+ 1
- 1
docs/CMake API.md View File

@@ -544,7 +544,7 @@ attributes directly to these creation functions, rather than adding them later.
`AAX_ePlugInCategory_NoiseReduction`, `AAX_ePlugInCategory_Dither`,
`AAX_ePlugInCategory_SoundField`, `AAX_ePlugInCategory_HWGenerators`,
`AAX_ePlugInCategory_SWGenerators`, `AAX_ePlugInCategory_WrappedPlugin`,
`AAX_ePlugInCategory_Effect`
`AAX_EPlugInCategory_Effect`

`PLUGINHOST_AU`
- May be either TRUE or FALSE (defaults to FALSE). If TRUE, will add the preprocessor definition


+ 5
- 3
modules/juce_core/files/juce_File.h View File

@@ -516,9 +516,11 @@ public:
/** Copies a file.
Tries to copy a file to a different location.
If the target file already exists, this will attempt to delete it first, and
will fail if this can't be done.
Tries to copy a file to a different location. If the target file already exists,
this will attempt to delete it first, and will fail if this can't be done.
Note that the target file isn't the directory to put it in, it's the actual
filename that you want the new file to have.
@returns true if the operation succeeds
*/


+ 1
- 1
modules/juce_core/misc/juce_RuntimePermissions.h View File

@@ -46,7 +46,7 @@ namespace juce
New code:
RuntimePermissions::request (
RuntimePermissions::audioRecording,
RuntimePermissions::recordAudio,
[this] (bool wasGranted)
{
if (! wasGranted)


+ 1
- 1
modules/juce_core/text/juce_LocalisedStrings.h View File

@@ -50,7 +50,7 @@ namespace juce
"goodbye" = "au revoir"
@endcode
If the strings need to contain a quote character, they can use '\"' instead, and
If the strings need to contain a quote character, they can use `\"` instead, and
if the first non-whitespace character on a line isn't a quote, then it's ignored,
(you can use this to add comments).


Loading…
Cancel
Save