Warp.hs: info and documentation

darcs-hash:20070614144426-32816-3a83cfbe88d90218d94294a12921a845bcc0735d.gz

1 files changed, 36 insertions, 16 deletions

diff --git a/Warp.hs b/Warp.hs
index 8f1cd54..43a833f 100644
--- a/Warp.hs
+++ b/Warp.hs
@@ -1,19 +1,24 @@
-module XMonadContrib.Warp where
-
-{- Usage:
- - This can be used to make a keybinding that warps the pointer to a given
- - window or screen.  For example, I've added the following keybindings to
- - my Config.hs:
- - 
- -   , ((modMask,   xK_z     ), warpToWindow (1%2) (1%2)) -- @@ Move pointer to currently focused window
- - 
- - -- mod-ctrl-{w,e,r} @@ Move mouse pointer to screen 1, 2, or 3
- -    ++
- -    [((modMask .|. controlMask, key), warpToScreen sc (1%2) (1%2))
- -        | (key, sc) <- zip [xK_w, xK_e, xK_r] [0..]]
- -
- - Note that warping to a particular screen may change the focus.
- -}
+-----------------------------------------------------------------------------
+-- |
+-- Module      :  XMonadContrib.Warp
+-- Copyright   :  (c) daniel@wagner-home.com
+-- License     :  BSD3-style (see LICENSE)
+-- 
+-- Maintainer  :  daniel@wagner-home.com
+-- Stability   :  unstable
+-- Portability :  unportable
+--
+-- This can be used to make a keybinding that warps the pointer to a given
+-- window or screen.
+--
+-----------------------------------------------------------------------------
+
+module XMonadContrib.Warp (
+                           -- * Usage
+                           -- $usage
+                           warpToScreen, 
+                           warpToWindow
+                          ) where
 
 import Data.Ratio
 import Data.Maybe
@@ -23,6 +28,21 @@ import Graphics.X11.Xlib.Extras
 import Operations
 import XMonad
 
+{- $usage
+This can be used to make a keybinding that warps the pointer to a given
+window or screen.  For example, I've added the following keybindings to
+my Config.hs:
+
+> , ((modMask,   xK_z     ), warpToWindow (1%2) (1%2)) -- @@ Move pointer to currently focused window
+> 
+>-- mod-ctrl-{w,e,r} @@ Move mouse pointer to screen 1, 2, or 3
+>   
+>   [((modMask .|. controlMask, key), warpToScreen sc (1%2) (1%2))
+>       | (key, sc) <- zip [xK_w, xK_e, xK_r] [0..]]
+
+Note that warping to a particular screen may change the focus.
+-}
+
 fraction :: (Integral a, Integral b) => Rational -> a -> b
 fraction f x = floor (f * fromIntegral x)