Add "Description" field to module headers

Fixes: https://github.com/xmonad/xmonad-contrib/issues/592
2025-08-01 04:31:52 -07:00 · 2021-09-25 12:25:59 +02:00
parent 4d1f76f7d8
commit 38c11c1e3c
292 changed files with 327 additions and 13 deletions
--- a/XMonad/Util/ActionCycle.hs
+++ b/XMonad/Util/ActionCycle.hs
@@ -2,6 +2,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.ActionCycle
+-- Description :  Provides a way to implement cycling actions.
 -- Copyright   :  (c) 2020 Leon Kowarschick
 -- License     :  BSD3-style (see LICENSE)
 --
--- a/XMonad/Util/ClickableWorkspaces.hs
+++ b/XMonad/Util/ClickableWorkspaces.hs
@@ -1,6 +1,7 @@
 -------------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.ClickableWorkspaces
+-- Description :  Make workspace tags clickable in XMobar (for switching focus).
 -- Copyright   :  (c) Geoff deRosenroll <geoffderosenroll@gmail.com>
 -- License     :  BSD3-style (see LICENSE)
 --
--- a/XMonad/Util/Cursor.hs
+++ b/XMonad/Util/Cursor.hs
@@ -1,6 +1,7 @@
 ----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Cursor
+-- Description :  Set the default mouse cursor.
 -- Copyright   :  (c) 2009 Collabora Ltd
 -- License     :  BSD-style (see xmonad/LICENSE)
 --
--- a/XMonad/Util/CustomKeys.hs
+++ b/XMonad/Util/CustomKeys.hs
@@ -1,8 +1,9 @@
 --------------------------------------------------------------------
 -- |
-- Module     : XMonad.Util.CustomKeys
-- Copyright  : (c) 2007 Valery V. Vorotyntsev
-- License    : BSD3-style (see LICENSE)
+-- Module      : XMonad.Util.CustomKeys
+-- Description : Configure key bindings.
+-- Copyright   : (c) 2007 Valery V. Vorotyntsev
+-- License     : BSD3-style (see LICENSE)
 --
 -- Customized key bindings.
 --
--- a/XMonad/Util/DebugWindow.hs
+++ b/XMonad/Util/DebugWindow.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.DebugWindow
+-- Description :  Dump window information for diagnostic\/debugging purposes.
 -- Copyright   :  (c) Brandon S Allbery KF8NH, 2014
 -- License     :  BSD3-style (see LICENSE)
 --
--- a/XMonad/Util/Dmenu.hs
+++ b/XMonad/Util/Dmenu.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Dmenu
+-- Description :  Convenient bindings to dmenu.
 -- Copyright   :  (c) Spencer Janssen <spencerjanssen@gmail.com>
 -- License     :  BSD-style (see LICENSE)
 --
--- a/XMonad/Util/DynamicScratchpads.hs
+++ b/XMonad/Util/DynamicScratchpads.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.DynamicScratchpads
+-- Description :  Dynamically declare any window as a scratchpad.
 -- Copyright   :  (c) Robin Oberschweiber <mephory@mephory.com>
 -- License     :  BSD-style (see LICENSE)
 --
--- a/XMonad/Util/Dzen.hs
+++ b/XMonad/Util/Dzen.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Dzen
+-- Description :  Handy wrapper for dzen.
 -- Copyright   :  (c) glasser@mit.edu
 -- License     :  BSD
 --
--- a/XMonad/Util/EZConfig.hs
+++ b/XMonad/Util/EZConfig.hs
@@ -1,6 +1,7 @@
 --------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.EZConfig
+-- Description :  Configure key bindings easily in Emacs style.
 -- Copyright   :  Devin Mullins <me@twifkak.com>
 --                Brent Yorgey <byorgey@gmail.com> (key parsing)
 -- License     :  BSD3-style (see LICENSE)
--- a/XMonad/Util/ExclusiveScratchpads.hs
+++ b/XMonad/Util/ExclusiveScratchpads.hs
@@ -3,6 +3,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.ExclusiveScratchpads
+-- Description :  Named scratchpads that can be mutually exclusive.
 -- Copyright   :  Bruce Forte (2017)
 -- License     :  BSD-style (see LICENSE)
 --
--- a/XMonad/Util/ExtensibleConf.hs
+++ b/XMonad/Util/ExtensibleConf.hs
@@ -4,6 +4,7 @@

 -- |
 -- Module      :  XMonad.Util.ExtensibleConf
+-- Description :  Extensible and composable configuration for contrib modules.
 -- Copyright   :  (c) 2021 Tomáš Janoušek <tomi@nomi.cz>
 -- License     :  BSD3
 -- Maintainer  :  Tomáš Janoušek <tomi@nomi.cz>
--- a/XMonad/Util/ExtensibleState.hs
+++ b/XMonad/Util/ExtensibleState.hs
@@ -3,6 +3,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.ExtensibleState
+-- Description :  Module for storing custom mutable state in xmonad.
 -- Copyright   :  (c) Daniel Schoepe 2009
 -- License     :  BSD3-style (see LICENSE)
 --
--- a/XMonad/Util/Font.hs
+++ b/XMonad/Util/Font.hs
@@ -2,6 +2,7 @@
 ----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Font
+-- Description :  A module for abstracting a font facility over Core fonts and Xft.
 -- Copyright   :  (c) 2007 Andrea Rossato and Spencer Janssen
 -- License     :  BSD-style (see xmonad/LICENSE)
 --
--- a/XMonad/Util/Hacks.hs
+++ b/XMonad/Util/Hacks.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Hacks
+-- Description :  A collection of small fixes and utilities with possibly hacky implementations.
 -- Copyright   :  (c) 2020 Leon Kowarschick
 -- License     :  BSD3-style (see LICENSE)
 --
--- a/XMonad/Util/Image.hs
+++ b/XMonad/Util/Image.hs
@@ -1,6 +1,7 @@
 ----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Image
+-- Description :  Utilities for manipulating @[[Bool]]@ as images.
 -- Copyright   :  (c) 2010 Alejandro Serrano
 -- License     :  BSD-style (see xmonad/LICENSE)
 --
--- a/XMonad/Util/Invisible.hs
+++ b/XMonad/Util/Invisible.hs
@@ -3,6 +3,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Invisible
+-- Description :  A data type to store the layout state.
 -- Copyright   :  (c) 2007 Andrea Rossato, David Roundy
 -- License     :  BSD-style (see xmonad/LICENSE)
 --
--- a/XMonad/Util/Loggers.hs
+++ b/XMonad/Util/Loggers.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Loggers
+-- Description :  A collection of simple logger functions and formatting utilities.
 -- Copyright   :  (c) Brent Yorgey, Wirt Wolff
 -- License     :  BSD-style (see LICENSE)
 --
--- a/XMonad/Util/Loggers/NamedScratchpad.hs
+++ b/XMonad/Util/Loggers/NamedScratchpad.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Loggers.NamedScratchpad
+-- Description :  A collection of Loggers for "XMonad.Util.NamedScratchpad".
 -- Copyright   :  (c) Brandon S Allbery <allbery.b@gmail.com>
 -- License     :  BSD-style (see LICENSE)
 --
--- a/XMonad/Util/Minimize.hs
+++ b/XMonad/Util/Minimize.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Minimize
+-- Description :  Common utilities for window minimizing\/maximizing.
 -- Copyright   :  (c) Bogdan Sinitsyn (2016)
 -- License     :  BSD3-style (see LICENSE)
 --
--- a/XMonad/Util/NamedActions.hs
+++ b/XMonad/Util/NamedActions.hs
@@ -3,6 +3,7 @@
 --------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.NamedActions
+-- Description :  A wrapper for keybinding configuration that can list the available keybindings.
 -- Copyright   :  2009 Adam Vogt <vogt.adam@gmail.com>
 -- License     :  BSD3-style (see LICENSE)
 --
--- a/XMonad/Util/NamedScratchpad.hs
+++ b/XMonad/Util/NamedScratchpad.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.NamedScratchpad
+-- Description :  Toggle arbitrary windows to and from the current workspace.
 -- Copyright   :  (c) Konstantin Sobolev <konstantin.sobolev@gmail.com>
 -- License     :  BSD-style (see LICENSE)
 --
--- a/XMonad/Util/NamedWindows.hs
+++ b/XMonad/Util/NamedWindows.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.NamedWindows
+-- Description :  Associate the X titles of windows with them.
 -- Copyright   :  (c) David Roundy <droundy@darcs.net>
 -- License     :  BSD3-style (see LICENSE)
 --
--- a/XMonad/Util/NoTaskbar.hs
+++ b/XMonad/Util/NoTaskbar.hs
@@ -1,3 +1,17 @@
+-----------------------------------------------------------------------------
+-- |
+-- Module      : XMonad.Util.NoTaskbar
+-- Description : Mark a window to be ignored by EWMH taskbars and pagers.
+-- Copyright   : (c) ???
+-- License     : BSD3-style (see LICENSE)
+--
+-- Maintainer  : ???
+--
+-- Function and manageHook to mark a window to be ignored by EWMH
+-- taskbars and pagers.
+--
+-----------------------------------------------------------------------------
+
 module XMonad.Util.NoTaskbar (-- * Usage
                              -- $usage
                              noTaskbar
--- a/XMonad/Util/Paste.hs
+++ b/XMonad/Util/Paste.hs
@@ -1,5 +1,6 @@
 {- |
 Module      :  XMonad.Util.Paste
+Description :  A module for sending key presses to windows.
 Copyright   :  (C) 2008 Jérémy Bobbio, gwern
 License     :  BSD3

--- a/XMonad/Util/PositionStore.hs
+++ b/XMonad/Util/PositionStore.hs
@@ -1,6 +1,7 @@
 ----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.PositionStore
+-- Description :  A utility module to store information about position and size of a window.
 -- Copyright   :  (c) Jan Vornberger 2009
 -- License     :  BSD3-style (see LICENSE)
 --
--- a/XMonad/Util/PureX.hs
+++ b/XMonad/Util/PureX.hs
@@ -3,6 +3,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.PureX
+-- Description :  Composable @X@ actions.
 -- Copyright   :  L. S. Leary 2018
 -- License     :  BSD3-style (see LICENSE)
 --
--- a/XMonad/Util/Rectangle.hs
+++ b/XMonad/Util/Rectangle.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Rectangle
+-- Description :  A module for handling pixel rectangles.
 -- Copyright   :  (c) 2018 Yclept Nemo
 -- License     :  BSD-style (see LICENSE)
 --
--- a/XMonad/Util/RemoteWindows.hs
+++ b/XMonad/Util/RemoteWindows.hs
@@ -2,6 +2,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.RemoteWindows
+-- Description :  A module to find out whether the window is remote or local.
 -- Copyright   :  (c) Anton Vorontsov <anton@enomsg.org> 2014
 -- License     :  BSD-style (as xmonad)
 --
--- a/XMonad/Util/Replace.hs
+++ b/XMonad/Util/Replace.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Replace
+-- Description :  Implements a @--replace@ flag outside of core.
 -- Copyright   :  (c) Jan Vornberger 2009
 -- License     :  BSD3-style (see LICENSE)
 --
--- a/XMonad/Util/Run.hs
+++ b/XMonad/Util/Run.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Run
+-- Description :  This modules provides several commands to run an external process.
 -- Copyright   :  (C) 2007 Spencer Janssen, Andrea Rossato, glasser@mit.edu
 -- License     :  BSD-style (see LICENSE)
 --
--- a/XMonad/Util/Scratchpad.hs
+++ b/XMonad/Util/Scratchpad.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Scratchpad
+-- Description :  Very handy hotkey-launched toggleable floating terminal window.
 -- Copyright   :  (c) Braden Shepherdson 2008
 -- License     :  BSD-style (as xmonad)
 --
--- a/XMonad/Util/SessionStart.hs
+++ b/XMonad/Util/SessionStart.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.SessionStart
+-- Description :  A module for detectiong session startup.
 -- Copyright   :  (c) Markus Ongyerth 2017
 -- License     :  BSD3-style (see LICENSE)
 --
--- a/XMonad/Util/SpawnNamedPipe.hs
+++ b/XMonad/Util/SpawnNamedPipe.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.SpawnNamedPipe
+-- Description :  A module for spawning a pipe whose handle lives in the XMonad state.
 -- Copyright   :  (c) Christian Wills 2014
 -- License     :  BSD3-style (see LICENSE)
 --
--- a/XMonad/Util/SpawnOnce.hs
+++ b/XMonad/Util/SpawnOnce.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.SpawnOnce
+-- Description :  A module for spawning a command once, and only once.
 -- Copyright   :  (c) Spencer Janssen 2009
 -- License     :  BSD3-style (see LICENSE)
 --
--- a/XMonad/Util/Stack.hs
+++ b/XMonad/Util/Stack.hs
@@ -3,6 +3,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Stack
+-- Description :  Utility functions for manipulating @Maybe Stack@s.
 -- Copyright   :  Quentin Moser <moserq@gmail.com>
 -- License     :  BSD-style (see LICENSE)
 --
--- a/XMonad/Util/StringProp.hs
+++ b/XMonad/Util/StringProp.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.StringProp
+-- Description :  Internal utility functions for storing Strings with the root window.
 -- Copyright   :  (c) Nicolas Pouillard 2009
 -- License     :  BSD-style (see LICENSE)
 --
--- a/XMonad/Util/Themes.hs
+++ b/XMonad/Util/Themes.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Themes
+-- Description :  A collection of themes for decorated layouts.
 -- Copyright   :  (C) 2007 Andrea Rossato
 -- License     :  BSD3
 --
--- a/XMonad/Util/Timer.hs
+++ b/XMonad/Util/Timer.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Timer
+-- Description :  A module for setting up timers.
 -- Copyright   :  (c) Andrea Rossato and David Roundy 2007
 -- License     :  BSD-style (see xmonad/LICENSE)
 --
--- a/XMonad/Util/TreeZipper.hs
+++ b/XMonad/Util/TreeZipper.hs
@@ -2,6 +2,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Actions.TreeSelect
+-- Description :  Zipper over "Data.Tree".
 -- Copyright   :  (c) Tom Smeets <tom.tsmeets@gmail.com>
 -- License     :  BSD3-style (see LICENSE)
 --
--- a/XMonad/Util/Types.hs
+++ b/XMonad/Util/Types.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Types
+-- Description :  Miscellaneous commonly used types.
 -- Copyright   :  (c) Daniel Schoepe (2009)
 -- License     :  BSD3-style (see LICENSE)
 --
--- a/XMonad/Util/Ungrab.hs
+++ b/XMonad/Util/Ungrab.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.Ungrab
+-- Description :  Release xmonad's keyboard and pointer grabs immediately.
 -- Copyright   :  (c) 2016 Brandon S Allbery
 -- License     :  BSD-style (see xmonad/LICENSE)
 --
--- a/XMonad/Util/WindowProperties.hs
+++ b/XMonad/Util/WindowProperties.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.WindowProperties
+-- Description :  EDSL for specifying window properties.
 -- Copyright   :  (c) Roman Cheplyaka
 -- License     :  BSD-style (see LICENSE)
 --
--- a/XMonad/Util/WindowState.hs
+++ b/XMonad/Util/WindowState.hs
@@ -1,11 +1,9 @@
-{-#
-  LANGUAGE ScopedTypeVariables, GeneralizedNewtypeDeriving,
-  FlexibleInstances, MultiParamTypeClasses,
-  FlexibleContexts -- ghc-6.12 only
-  #-}
+{-# LANGUAGE ScopedTypeVariables, GeneralizedNewtypeDeriving,
+  FlexibleInstances, MultiParamTypeClasses, FlexibleContexts #-}
 -----------------------------------------------------------------------------
 -- |
 -- Module       : XMonad.Util.WindowState
+-- Description  :  Functions for saving per-window data.
 -- Copyright    : (c) Dmitry Bogatov <KAction@gnu.org>
 -- License      : BSD
 --
--- a/XMonad/Util/WorkspaceCompare.hs
+++ b/XMonad/Util/WorkspaceCompare.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.WorkspaceCompare
+-- Description :  Functions for examining, comparing, and sorting workspaces.
 -- Copyright   :  (c) Spencer Janssen <spencerjanssen@gmail.com>
 -- License     :  BSD3-style (see LICENSE)
 --
--- a/XMonad/Util/XSelection.hs
+++ b/XMonad/Util/XSelection.hs
@@ -1,6 +1,7 @@
 {-# LANGUAGE CPP #-}
 {- |
 Module      :  XMonad.Util.XSelection
+Description :  A module for accessing and manipulating the primary selection.
 Copyright   :  (C) 2007 Andrea Rossato, Matthew Sackman
 License     :  BSD3

--- a/XMonad/Util/XUtils.hs
+++ b/XMonad/Util/XUtils.hs
@@ -1,6 +1,7 @@
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Util.XUtils
+-- Description :  A module for painting on the screen.
 -- Copyright   :  (c) 2007 Andrea Rossato
 --                    2010 Alejandro Serrano
 -- License     :  BSD-style (see xmonad/LICENSE)