From 81a2809683ceda6475d6d42df644dce102dd290b Mon Sep 17 00:00:00 2001
From: Juraj Hercek <juhe_haskell@hck.sk>
Date: Sun, 23 Dec 2007 00:14:19 +0100
Subject: Added documentation.

  - added Thermal, CoreTemp, CpuFreq documentation to README file
  - added haddock documentation

darcs-hash:20071222231419-f49a6-beadaa214bd80a9eb12f568dbff8dcf0d88ecfe7.gz
---
 Plugins/Monitors/CpuFreq.hs | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'Plugins/Monitors/CpuFreq.hs')

diff --git a/Plugins/Monitors/CpuFreq.hs b/Plugins/Monitors/CpuFreq.hs
index 0258037..0bd99bb 100644
--- a/Plugins/Monitors/CpuFreq.hs
+++ b/Plugins/Monitors/CpuFreq.hs
@@ -17,11 +17,18 @@ module Plugins.Monitors.CpuFreq where
 import Plugins.Monitors.Common
 import Plugins.Monitors.CoreCommon
 
+-- |
+-- Cpu frequency default configuration. Default template contains only one
+-- core frequency, user should specify custom template in order to get more
+-- cpu frequencies.
 cpuFreqConfig :: IO MConfig
 cpuFreqConfig = mkMConfig
        "Freq: <core0>GHz" -- template
        (zipWith (++) (repeat "core") (map show [0 :: Int ..])) -- available
                                                                -- replacements
+
+-- |
+-- Function retrieves monitor string holding the cpu frequency (or frequencies)
 runCpuFreq :: [String] -> Monitor String
 runCpuFreq _ = do
     let dir = "/sys/devices/system/cpu"
-- 
cgit v1.2.3