From 033416a15fe60fe10387119e0e63bb9ed9e8aedd Mon Sep 17 00:00:00 2001
From: mitchell <70453897+667e-11@users.noreply.github.com>
Date: Sat, 25 Jul 2009 23:34:13 -0400
Subject: Documentation overhaul.

---
 core/locale.lua | 24 +++++++++++++++++++++---
 1 file changed, 21 insertions(+), 3 deletions(-)

(limited to 'core/locale.lua')

diff --git a/core/locale.lua b/core/locale.lua
index 306bb64d..be37499d 100644
--- a/core/locale.lua
+++ b/core/locale.lua
@@ -1,11 +1,24 @@
 -- Copyright 2007-2009 Mitchell mitchell<att>caladbolg.net. See LICENSE.
 
 ---
--- This module loads all messages used by Textadept for localization.
--- Localized strings are contained in 'core/locale.conf'. Please see this file
--- for more information.
+-- Contains all messages used by Textadept for localization.
 module('locale', package.seeall)
 
+-- Markdown:
+-- ## Overview
+--
+-- All Textadept messages displayed are located in `core/locale.conf`. To change
+-- the language, simply replace that file with a similar file containing the
+-- translated messages. See `core/locale.conf` for more information.
+--
+-- Feel free to translate Textadept and send your modified `locale.conf` files
+-- to me. I will put them up on the site where they can be accessed.
+--
+-- ## Fields
+--
+-- Each message ID in `core/locale.conf` is accessible as a field in this
+-- module.
+
 local escapes = { ['\\n'] = '\n', ['\\r'] = '\r', ['\\t'] = '\t' }
 
 local f = io.open(_HOME..'/core/locale.conf', 'rb')
@@ -17,3 +30,8 @@ for line in f:lines() do
   end
 end
 f:close()
+
+---
+-- This module contains no functions.
+function no_functions() end
+no_functions = nil -- undefine
-- 
cgit v1.2.3