Warning, /utilities/rsibreak/src/mainpage.dox is written in an unsupported language. File is not indexed.

0001 /**
0002    \mainpage RSIBreak Documentation
0003 
0004    If you want to start hacking on RSIBreak, this page will get you going in no-time.
0005 
0006    This documentation is written by Tom Albers, tomalbers@kde.nl, http://www.omat.nl
0007 
0008    Everything related to the breaks, activating them, maximizing, loading the right images
0009    is done in the RSIWidget class. Everything related to the time of the breaks, duration
0010    and idle detection is done in RSITimer
0011 
0012    The RSIDock class is responsible for handling everything related to the docked icon,
0013    so it handles the context menus and the content of those, for example the about boxes.
0014 
0015    The RSITooltip class is there for displaying info when the user moves the mouse over
0016    the docked icon.
0017    
0018    The RSIPopup class is in fact a subclassed KPassivePopup, which is shown for example
0019    then the user is requested to relax. It can eventually flash to annoy the user a
0020    little bit when he/she keeps on working.
0021 
0022    The RSIStat* classes are responsible for the statistics. The rsiglobals class can be 
0023    used to store some static helpers and the setup* classes are there for the setup
0024    dialogs
0025    
0026    All public classes are documented, and it is mandatory to do that, just like honouring
0027    the hacking style.
0028 
0029    For debugging purposes, you can add a DEBUG=1 to your [General Settings] in the
0030    rsibreakrc config file. This will change the minutes in the settings to seconds.
0031    This is essential for testing purposes. If you do DEBUG=2, you get detailled info
0032    about the timers. Lots of output.
0033 
0034    Have fun!
0035 */