From 2a5126f4f0c0a3e073becb98f49499363072643d Mon Sep 17 00:00:00 2001
From: "Adrian C. (anrxc)" <anrxc@sysphere.org>
Date: Mon, 14 Sep 2009 17:25:23 +0200
Subject: General cleanup

---
 init.lua | 39 ++++++++++++++++-----------------------
 1 file changed, 16 insertions(+), 23 deletions(-)

(limited to 'init.lua')

diff --git a/init.lua b/init.lua
index bf22918..78f49a5 100644
--- a/init.lua
+++ b/init.lua
@@ -1,16 +1,13 @@
-----------------------------------------------------------------
+--------------------------------------------------------------
 -- Vicious widgets for the awesome window manager
---
+--------------------------------------------------------------
 -- Licensed under the GNU General Public License version 2
 --   * Copyright (C) 2009 Adrian C. <anrxc_sysphere_org>
---
--- To view a human-readable summary of the license, visit:
---   * http://creativecommons.org/licenses/GPL/2.0/
-----------------------------------------------------------------
+--------------------------------------------------------------
 -- Derived from Wicked, by Lucas de Vries <lucas_glacicle_com>
 --   * http://git.glacicle.com/cgit.cgi/wicked
 --   * Wicked is licensed under the WTFPL v2
-----------------------------------------------------------------
+--------------------------------------------------------------
 
 -- {{{ Grab environment
 require("awful")
@@ -63,7 +60,7 @@ require("vicious.date")
 module("vicious")
 
 
--- {{{ Initialise variables
+-- {{{ Initialise tables
 local timers       = {}
 local registered   = {}
 local widget_cache = {}
@@ -88,7 +85,7 @@ end
 -- }}}
 
 -- {{{ Main functions
--- {{{ Register widget
+-- {{{ Register a widget
 function register(widget, wtype, format, timer, warg)
     local reg = {}
     local widget = widget
@@ -110,10 +107,10 @@ function register(widget, wtype, format, timer, warg)
         reg.timer = 1
     end
 
-    -- Register reg object
+    -- Register a reg object
     regregister(reg)
 
-    -- Return reg object for reuse
+    -- Return a reg object for reuse
     return reg
 end
 -- }}}
@@ -121,12 +118,11 @@ end
 -- {{{ Register from reg object
 function regregister(reg)
     if not reg.running then
-        -- Put widget in table
         if registered[reg.widget] == nil then
             registered[reg.widget] = {}
             table.insert(registered[reg.widget], reg)
         else
-            already = false
+            local already = false
 
             for w, i in pairs(registered) do
                 if w == reg.widget then
@@ -148,7 +144,7 @@ function regregister(reg)
             end
         end
 
-        -- Start timer
+        -- Start the timer
         if reg.timer > 0 then
             timers[reg.update] = {
                 timer = capi.timer({ timeout = reg.timer })
@@ -159,14 +155,12 @@ function regregister(reg)
 
         -- Initial update
         reg.update()
-
-        -- Set running
         reg.running = true
     end
 end
 -- }}}
 
--- {{{ Unregister widget
+-- {{{ Unregister a widget
 function unregister(widget, keep, reg)
     if reg == nil then
         for w, i in pairs(registered) do
@@ -192,7 +186,7 @@ function unregister(widget, keep, reg)
         end
     end
 
-    -- Stop timer
+    -- Stop the timer
     if timers[reg.update].timer.started then
         timers[reg.update].timer:stop()
     end
@@ -202,7 +196,7 @@ function unregister(widget, keep, reg)
 end
 -- }}}
 
--- {{{ Suspend vicious, halt all widget updates
+-- {{{ Suspend vicious
 function suspend()
     for w, i in pairs(registered) do
         for _, v in pairs(i) do
@@ -212,7 +206,7 @@ function suspend()
 end
 -- }}}
 
--- {{{ Activate vicious, restart all widget updates
+-- {{{ Activate vicious
 function activate(widget)
     for w, i in pairs(registered) do
         if widget == nil or w == widget then
@@ -224,7 +218,7 @@ function activate(widget)
 end
 -- }}}
 
--- {{{ Update widget
+-- {{{ Update a widget
 function update(widget, reg, disablecache)
     -- Check if there are any equal widgets
     if reg == nil then
@@ -242,8 +236,7 @@ function update(widget, reg, disablecache)
     local t = os.time()
     local data = {}
 
-    -- Check if we have output chached for this widget newer than last
-    -- widget update
+    -- Do we have output chached for a widget newer than last update
     if widget_cache[reg.type] ~= nil then
         local c = widget_cache[reg.type]
 
-- 
cgit v1.2.3