Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMaarten Gribnau <mail@maartengribnau.com>2002-12-29 01:26:45 +0300
committerMaarten Gribnau <mail@maartengribnau.com>2002-12-29 01:26:45 +0300
commitb2824fe23a152f1e53d73cbf846d4843360c6601 (patch)
treefc60bfb0ad5a97300d49f75e0012f4adaea9911c /intern/ghost/GHOST_ITimerTask.h
parent9e3c814e7272237c9d6b13f4d7b8a9b5d41a3ed6 (diff)
Removed those extra CVS tag lines in the header files of ghost (now I know what
Gilles meant) and added some extra doxygen tags I had lying around. Removed the cocoa file since it was rubbish. Maarten
Diffstat (limited to 'intern/ghost/GHOST_ITimerTask.h')
-rw-r--r--intern/ghost/GHOST_ITimerTask.h17
1 files changed, 11 insertions, 6 deletions
diff --git a/intern/ghost/GHOST_ITimerTask.h b/intern/ghost/GHOST_ITimerTask.h
index a9adb447ee2..61a2b83011b 100644
--- a/intern/ghost/GHOST_ITimerTask.h
+++ b/intern/ghost/GHOST_ITimerTask.h
@@ -28,13 +28,9 @@
*
* ***** END GPL/BL DUAL LICENSE BLOCK *****
*/
-
/**
-
- * $Id$
- * Copyright (C) 2001 NaN Technologies B.V.
- * @author Maarten Gribnau
- * @date May 31, 2001
+ * @file GHOST_ITimerTask.h
+ * Declaration of GHOST_ITimerTask interface class.
*/
#ifndef _GHOST_ITIMER_TASK_H_
@@ -45,6 +41,15 @@
/**
* Interface for a timer task.
+ * Timer tasks are created by the system and can be installed by the system.
+ * After installation, the timer callback-procedure or "timerProc" will be called
+ * periodically. You should not need to inherit this class. It is passed to the
+ * application in the timer-callback.<br>
+ * <br>
+ * Note that GHOST processes timers in the UI thread. You should ask GHOST
+ * process messages in order for the timer-callbacks to be called.
+ * @see GHOST_ISystem#installTimer
+ * @see GHOST_TimerProcPtr
* @author Maarten Gribnau
* @date May 31, 2001
*/