From 64c984896e3fca0aa80e873c17c260a6c33f105d Mon Sep 17 00:00:00 2001
From: jules <jules@rawmaterialsoftware.com>
Date: Fri, 1 Feb 2013 20:33:04 +0000
Subject: [PATCH] Added some documentation.

---
 .../juce_core/threads/juce_HighResolutionTimer.h   | 14 ++++++++++++++
 modules/juce_events/timers/juce_Timer.h            |  2 +-
 2 files changed, 15 insertions(+), 1 deletion(-)

diff --git a/modules/juce_core/threads/juce_HighResolutionTimer.h b/modules/juce_core/threads/juce_HighResolutionTimer.h
index 1c9b69149f..4fd59d5103 100644
--- a/modules/juce_core/threads/juce_HighResolutionTimer.h
+++ b/modules/juce_core/threads/juce_HighResolutionTimer.h
@@ -26,6 +26,20 @@
 #ifndef __JUCE_HIGHRESOLUTIONTIMER_JUCEHEADER__
 #define __JUCE_HIGHRESOLUTIONTIMER_JUCEHEADER__
 
+/**
+    A high-resolution periodic timer.
+
+    This provides accurately-timed regular callbacks. Unlike the normal Timer
+    class, this one uses a dedicated thread, not the message thread, so is
+    far more stable and precise.
+
+    You should only use this class in situations where you really need accuracy,
+    because unlike the normal Timer class, which is very lightweight and cheap
+    to start/stop, the HighResolutionTimer will use far more resources, and
+    starting/stopping it may involve launching and killing threads.
+
+    @see Timer
+*/
 class JUCE_API  HighResolutionTimer
 {
 protected:
diff --git a/modules/juce_events/timers/juce_Timer.h b/modules/juce_events/timers/juce_Timer.h
index cde616b2e2..3db51f1613 100644
--- a/modules/juce_events/timers/juce_Timer.h
+++ b/modules/juce_events/timers/juce_Timer.h
@@ -48,7 +48,7 @@
     structure is very similar to the Timer class, but contains multiple timers
     internally, each one identified by an ID number.
 
-    @see MultiTimer
+    @see HighResolutionTimer, MultiTimer
 */
 class JUCE_API  Timer
 {