vcl: comment timer classes at least minimally.

Change-Id: Iabc76b3e78afa491a38fa04d648f48f15ac3870e

1 files changed, 4 insertions, 1 deletions

diff --git a/include/vcl/timer.hxx b/include/vcl/timer.hxx
index 665978076727..d3ebe1a256e5 100644
--- a/include/vcl/timer.hxx
+++ b/include/vcl/timer.hxx
@@ -27,6 +27,7 @@
 struct ImplTimerData;
 struct ImplSVData;
 
+/// Base-class for timers - usually a simple, one-shot timeout
 class VCL_DLLPUBLIC Timer
 {
 protected:
@@ -51,6 +52,7 @@ public:
     sal_uLong       GetTimeout() const { return mnTimeout; }
     bool            IsActive() const { return mbActive; }
 
+    /// Make it possible to associate a callback with this timeout
     void            SetTimeoutHdl( const Link& rLink ) { maTimeoutHdl = rLink; }
     const Link&     GetTimeoutHdl() const { return maTimeoutHdl; }
 
@@ -60,7 +62,8 @@ public:
     static void ImplTimerCallbackProc();
 };
 
-
+/// An auto-timer is a multi-shot timer re-emitting itself at
+/// interval until destroyed.
 class VCL_DLLPUBLIC AutoTimer : public Timer
 {
 public: