diff --git a/Space4x/Assets/Scripts/Research/Events/EResearchEvent.cs b/Space4x/Assets/Scripts/Research/Events/EResearchEvent.cs index 1b66e9a..8d3af3b 100644 --- a/Space4x/Assets/Scripts/Research/Events/EResearchEvent.cs +++ b/Space4x/Assets/Scripts/Research/Events/EResearchEvent.cs @@ -1,8 +1,16 @@ +/** + * @file + * + * @author Marc de Craigher + * @author Aaron Moser + * + * @package Assets.Scripts.Research.Events + */ namespace NResearch { - /// - /// Enum for any event conected to research. - /// + /** + * Enum for any event connected to research. + */ public enum EResearchEvent { AddIndustryTechToQueue, diff --git a/Space4x/Assets/Scripts/Research/Events/ResearchEventArgs.cs b/Space4x/Assets/Scripts/Research/Events/ResearchEventArgs.cs index 975541b..64e9e6b 100644 --- a/Space4x/Assets/Scripts/Research/Events/ResearchEventArgs.cs +++ b/Space4x/Assets/Scripts/Research/Events/ResearchEventArgs.cs @@ -1,12 +1,44 @@ +/** + * @file + * + * @author Aaron Moser + * + * @package Assets.Scripts.Research.Events + */ namespace NResearch { + /** + * @section DESCRIPTION + * + * Class is a container for additional arguments for research events. + */ public class ResearchEventArgs { + //--------------------------------------------------------------------------------------------------------------------------------------------------------------------- + // Public values + + /** + * Event type indicated by enum value. + */ public EResearchEvent eResearchEvent { get; set; } + //--------------------------------------------------------------------------------------------------------------------------------------------------------------------- + // Private values + + //--------------------------------------------------------------------------------------------------------------------------------------------------------------------- + // Public functions + + /** + * Constructor sets enum value research event to overhanded value. + * + * @param eResearchEvent, event type occured. + */ public ResearchEventArgs(EResearchEvent eResearchEvent) { this.eResearchEvent = eResearchEvent; } + + //--------------------------------------------------------------------------------------------------------------------------------------------------------------------- + // Private functions } }