Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Sep 23, 2010, 1:00:42 PM (14 years ago)
Author:
dafrick
Message:

Doing some documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • code/trunk/src/modules/notifications/dispatchers/SimpleNotification.h

    r7456 r7484  
    4646    @brief
    4747        The SimpleNotification class enables the sending of (in XML) predefined Notifications upon some kind of triggering event.
     48
     49        In use it would like this:
     50        @code
     51        <SimpleNotification message="some message..." >
     52            <events>
     53                <trigger>
     54                    <PlayerTrigger />
     55                </trigger>
     56            </events>
     57        </SimpleNotification>
     58        @endcode
     59        For more information on what can be used for @code <PlayerTrigger /> @endcode see the @ref orxonox::NotificationDispatcher "NotificationDispatcher" documentation.
    4860    @author
    4961        Damian 'Mozork' Frick
Note: See TracChangeset for help on using the changeset viewer.