From 913d95d011b9dbe6d8d09563bec08a0ae659ef56 Mon Sep 17 00:00:00 2001 From: James Whitehead II Date: Thu, 14 Oct 2010 21:00:18 +0100 Subject: [PATCH] Add headers to each file to make viewing source a bit easier --- AddonCore.lua | 15 +++++++++++++++ BindConfig.lua | 9 +++++++++ BlizzardFrames.lua | 11 +++++++++++ FrameOptionsPanel.lua | 9 +++++++++ OptionsPanel.lua | 10 ++++++++++ Utils.lua | 11 +++++++++++ 6 files changed, 65 insertions(+) diff --git a/AddonCore.lua b/AddonCore.lua index 0808bdf..c3260d9 100644 --- a/AddonCore.lua +++ b/AddonCore.lua @@ -1,3 +1,18 @@ +--[[------------------------------------------------------------------------- +-- AddonCore.lua +-- +-- This is a very simple, bare-minimum core for addon development. It provide +-- methods to register events, call initialization functions, and sets up the +-- localization table so it can be used elsewhere. This file is designed to be +-- loaded first, as it has no further dependencies. +-- +-- Events registered: +-- * ADDON_LOADED - Watch for saved variables to be loaded, and call the +-- 'Initialize' function in response. +-- * PLAYER_LOGIN - Call the 'Enable' method once the major UI elements +-- have been loaded and initialized. +-------------------------------------------------------------------------]]-- + local addonName, addon = ... -- Set global name of addon diff --git a/BindConfig.lua b/BindConfig.lua index 274580f..b5372fe 100755 --- a/BindConfig.lua +++ b/BindConfig.lua @@ -1,3 +1,12 @@ +--[[------------------------------------------------------------------------- +-- BindConfig.lua +-- +-- This file contains the definitions of the binding configuration panel. +-- +-- Events registered: +-- None +-------------------------------------------------------------------------]]-- + local addonName, addon = ... local L = addon.L diff --git a/BlizzardFrames.lua b/BlizzardFrames.lua index 10d2cc6..118ba33 100644 --- a/BlizzardFrames.lua +++ b/BlizzardFrames.lua @@ -1,3 +1,14 @@ +--[[------------------------------------------------------------------------- +-- BlizzardFrames.lua +-- +-- This file contains the definitions of the blizzard frame integration +-- options. These settings will not apply until the user interface is +-- reloaded. +-- +-- Events registered: +-- * ADDON_LOADED - To watch for loading of the ArenaUI +-------------------------------------------------------------------------]]-- + local addonName, addon = ... local L = addon.L diff --git a/FrameOptionsPanel.lua b/FrameOptionsPanel.lua index 8db4f05..38ba719 100644 --- a/FrameOptionsPanel.lua +++ b/FrameOptionsPanel.lua @@ -1,3 +1,12 @@ +--[[------------------------------------------------------------------------- +-- FrameOptionsPanel.lua +-- +-- This file contains the definitions of the frame blacklist options panel. +-- +-- Events registered: +-- None +-------------------------------------------------------------------------]]-- + local addonName, addon = ... local L = addon.L diff --git a/OptionsPanel.lua b/OptionsPanel.lua index e3d5d0a..1420eda 100644 --- a/OptionsPanel.lua +++ b/OptionsPanel.lua @@ -1,3 +1,13 @@ +--[[------------------------------------------------------------------------- +-- OptionsPanel.lua +-- +-- This file contains the definitions of the main interface options panel. +-- Any other options panels are sub-categories of this main panel. +-- +-- Events registered: +-- None +-------------------------------------------------------------------------]]-- + local addonName, addon = ... local L = addon.L diff --git a/Utils.lua b/Utils.lua index 8aefb53..439821d 100644 --- a/Utils.lua +++ b/Utils.lua @@ -1,3 +1,14 @@ +--[[------------------------------------------------------------------------- +-- Utils.lua +-- +-- This file contains a series of general utility functions that could be +-- used throughout the addon, although in practice they are mostly used in +-- the GUI. +-- +-- Events registered: +-- None +-------------------------------------------------------------------------]]-- + local addonName, addon = ... local L = addon.L -- 1.7.9.5