diff options
Diffstat (limited to 'intern/ghost/intern/GHOST_EventManager.h')
| -rw-r--r-- | intern/ghost/intern/GHOST_EventManager.h | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/intern/ghost/intern/GHOST_EventManager.h b/intern/ghost/intern/GHOST_EventManager.h index eec00789800..fea8214c7f2 100644 --- a/intern/ghost/intern/GHOST_EventManager.h +++ b/intern/ghost/intern/GHOST_EventManager.h @@ -62,21 +62,21 @@ public: /** * Returns the number of events currently on the stack. - * @return The number of events on the stack. + * \return The number of events on the stack. */ virtual GHOST_TUns32 getNumEvents(); /** * Returns the number of events of a certain type currently on the stack. - * @param type The type of events to be counted. - * @return The number of events on the stack of this type. + * \param type The type of events to be counted. + * \return The number of events on the stack of this type. */ virtual GHOST_TUns32 getNumEvents(GHOST_TEventType type); /** * Return the event at the top of the stack without removal. * Do not delete the event! - * @return The event at the top of the stack. + * \return The event at the top of the stack. */ virtual GHOST_IEvent *peekEvent(); @@ -84,47 +84,47 @@ public: * Pushes an event on the stack. * To dispatch it, call dispatchEvent() or dispatchEvents(). * Do not delete the event! - * @param event The event to push on the stack. + * \param event The event to push on the stack. */ virtual GHOST_TSuccess pushEvent(GHOST_IEvent *event); /** * Dispatches the given event directly, bypassing the event stack. - * @return Indication as to whether any of the consumers handled the event. + * \return Indication as to whether any of the consumers handled the event. */ virtual bool dispatchEvent(GHOST_IEvent *event); /** * Dispatches the event at the back of the stack. * The event will be removed from the stack. - * @return Indication as to whether any of the consumers handled the event. + * \return Indication as to whether any of the consumers handled the event. */ virtual bool dispatchEvent(); /** * Dispatches all the events on the stack. * The event stack will be empty afterwards. - * @return Indication as to whether any of the consumers handled the events. + * \return Indication as to whether any of the consumers handled the events. */ virtual bool dispatchEvents(); /** * Adds a consumer to the list of event consumers. - * @param consumer The consumer added to the list. - * @return Indication as to whether addition has succeeded. + * \param consumer The consumer added to the list. + * \return Indication as to whether addition has succeeded. */ virtual GHOST_TSuccess addConsumer(GHOST_IEventConsumer *consumer); /** * Removes a consumer from the list of event consumers. - * @param consumer The consumer removed from the list. - * @return Indication as to whether removal has succeeded. + * \param consumer The consumer removed from the list. + * \return Indication as to whether removal has succeeded. */ virtual GHOST_TSuccess removeConsumer(GHOST_IEventConsumer *consumer); /** * Removes all events for a window from the stack. - * @param window The window to remove events for. + * \param window The window to remove events for. */ virtual void removeWindowEvents( @@ -135,8 +135,8 @@ public: * Removes all events of a certain type from the stack. * The window parameter is optional. If non-null, the routine will remove * events only associated with that window. - * @param type The type of events to be removed. - * @param window The window to remove the events for. + * \param type The type of events to be removed. + * \param window The window to remove the events for. */ virtual void removeTypeEvents( @@ -148,7 +148,7 @@ protected: /** * Returns the event at the top of the stack and removes it. * Delete the event after use! - * @return The event at the top of the stack. + * \return The event at the top of the stack. */ virtual GHOST_IEvent *popEvent(); |