Updated documentation

DATABASE
BASE
SPAWN
ESCORT

Moose/Base.lua

@@ -1,4 +1,55 @@
---- The BASE class for all the classes defined within MOOSE.
+--- BASE classes.
+-- 
+-- @{#BASE} class
+-- ==============
+-- The @{#BASE} class is the super class for most of the classes defined within MOOSE.
+-- 
+-- It handles:
+-- 
+--   * The construction and inheritance of child classes.
+--   * The tracing of objects during mission execution within the DCS.log file (under saved games folder).
+-- 
+-- Note: Normally you would not use the BASE class unless you are extending the MOOSE framework with new classes.
+-- 
+-- BASE Trace functionality
+-- ========================
+-- The BASE class contains trace methods to trace progress within a mission execution of a certain object.
+-- Note that these trace methods are inherited by each MOOSE class interiting BASE.
+-- As such, each object created from derived class from BASE can use the tracing functions to trace its execution.
+-- 
+-- Trace a function call
+-- ---------------------
+-- There are basically 3 types of tracing methods available within BASE:
+-- 
+--   * @{#BASE.F}: Trace the beginning of a function and its given parameters.
+--   * @{#BASE.T}: Trace further logic within a function giving optional variables or parameters.
+--   * @{#BASE.E}: Trace an execption within a function giving optional variables or parameters. An exception will always be traced.
+-- 
+-- Tracing levels
+-- --------------
+-- There are 3 tracing levels within MOOSE.  
+-- These tracing levels were defined to avoid bulks of tracing to be generated by lots of objects.
+-- 
+-- As such, the F and T methods have additional variants to trace level 2 and 3 respectively:
+--
+--   * @{#BASE.F2}: Trace the beginning of a function and its given parameters with tracing level 2.
+--   * @{#BASE.F3}: Trace the beginning of a function and its given parameters with tracing level 3.
+--   * @{#BASE.T2}: Trace further logic within a function giving optional variables or parameters with tracing level 2.
+--   * @{#BASE.T3}: Trace further logic within a function giving optional variables or parameters with tracing level 3.
+-- 
+-- BASE Inheritance support
+-- ========================
+-- The following methods are available to support inheritance:
+-- 
+--   * @{#BASE.Inherit}: Inherits from a class.
+--   * @{#BASE.Inherited}: Returns the parent class from the class.
+-- 
+-- Future
+-- ======
+-- Further methods may be added to BASE whenever there is a need to make "overall" functions available within MOOSE.
+-- 
+-- ====
+-- 
 -- @module Base
 -- @author FlightControl