From 9de1ab563bda5cabaf48af6391e3d0333c1acb4c Mon Sep 17 00:00:00 2001 From: jules Date: Wed, 12 Dec 2012 10:26:03 +0000 Subject: [PATCH] Documentation fixes. --- modules/juce_core/juce_core.h | 5 +++++ modules/juce_core/threads/juce_ReadWriteLock.h | 3 +-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/modules/juce_core/juce_core.h b/modules/juce_core/juce_core.h index f630048536..067d2d8527 100644 --- a/modules/juce_core/juce_core.h +++ b/modules/juce_core/juce_core.h @@ -40,6 +40,11 @@ namespace DummyNamespaceStatementToCatchSyntaxErrors {} different memory layouts, leading to very nasty memory corruption errors when they all get linked together. That's why it's best to always include the Introjucer-generated AppConfig.h file before any juce headers. + + Note that if you do have an AppConfig.h file and hit this warning, it means that it doesn't + contain the JUCE_MODULE_AVAILABLE_xxx flags, which are necessary for some inter-module + functionality to work correctly. In that case, you should either rebuild your AppConfig.h with + the latest introjucer, or fix it manually to contain these flags. */ #ifdef _MSC_VER #pragma message ("Have you included your AppConfig.h file before including the JUCE headers?") diff --git a/modules/juce_core/threads/juce_ReadWriteLock.h b/modules/juce_core/threads/juce_ReadWriteLock.h index b5a37c2d5d..1723933d04 100644 --- a/modules/juce_core/threads/juce_ReadWriteLock.h +++ b/modules/juce_core/threads/juce_ReadWriteLock.h @@ -82,8 +82,7 @@ public: /** Tries to lock this object for reading. Multiple threads can simulaneously lock the object for reading, but if another - thread has it locked for writing, then this will block until it releases the - lock. + thread has it locked for writing, then this will fail and return false. @returns true if the lock is successfully gained. @see exitRead, ScopedReadLock