From 4d1c3eae4f01a7fc3ac6f66e9c41c23cc257a072 Mon Sep 17 00:00:00 2001
From: "John M. Penn" <john.m.penn@nasa.gov>
Date: Thu, 20 Apr 2017 13:26:47 -0500
Subject: [PATCH] A Trick headers to include files without headers. Ref #403

---
 include/trick/AttributesMap.hh     | 9 +++------
 include/trick/CheckPointAgent.hh   | 5 ++++-
 include/trick/EnumAttributesMap.hh | 9 +++------
 include/trick/Event.hh             | 4 +++-
 include/trick/EventInstrument.hh   | 4 +++-
 include/trick/IPPythonEvent.hh     | 5 +++--
 include/trick/MTV.hh               | 5 +++--
 include/trick/MessageLCout.hh      | 5 +++--
 include/trick/MessagePublisher.hh  | 5 +++--
 include/trick/MessageSubscriber.hh | 5 +++--
 include/trick/MessageTCDevice.hh   | 4 +++-
 include/trick/RtiEvent.hh          | 4 +++-
 include/trick/STLInterface.hh      | 5 +++--
 include/trick/SimTime.hh           | 5 +++--
 include/trick/UdUnits.hh           | 5 +++--
 include/trick/attributes.h         | 5 +++++
 include/trick/io_alloc.h           | 4 ++++
 include/trick/message_type.h       | 4 +++-
 include/trick/mm_error.h           | 4 +++-
 include/trick/parameter_types.h    | 5 +++++
 include/trick/time_offset.h        | 5 +++--
 include/trick/var.h                | 8 +++++---
 22 files changed, 74 insertions(+), 40 deletions(-)

diff --git a/include/trick/AttributesMap.hh b/include/trick/AttributesMap.hh
index 08676921..410574ca 100644
--- a/include/trick/AttributesMap.hh
+++ b/include/trick/AttributesMap.hh
@@ -1,11 +1,8 @@
-
-/**
- * Provides a map of class/struct attributes and enumeration attributes
- */
-
 #ifndef ATTRIBUTESMAP_HH
 #define ATTRIBUTESMAP_HH
-
+/*
+    PURPOSE: ( Provides a map of class/struct attributes and enumeration attributes)
+*/
 #include <map>
 #include <string>
 #include <fstream>
diff --git a/include/trick/CheckPointAgent.hh b/include/trick/CheckPointAgent.hh
index 7bd191ad..cbf6c8e4 100644
--- a/include/trick/CheckPointAgent.hh
+++ b/include/trick/CheckPointAgent.hh
@@ -1,6 +1,9 @@
 #ifndef CHECKPOINTAGENT_HH
 #define CHECKPOINTAGENT_HH
-
+/*
+    PURPOSE: ( CheckPointAgent - virtual base class for a component that
+               writes an external representation of the simulation state.)
+*/
 #include "trick/attributes.h"
 #include "trick/io_alloc.h"
 #include <stdio.h>
diff --git a/include/trick/EnumAttributesMap.hh b/include/trick/EnumAttributesMap.hh
index 56675ba0..b12ad09d 100644
--- a/include/trick/EnumAttributesMap.hh
+++ b/include/trick/EnumAttributesMap.hh
@@ -1,11 +1,8 @@
-
-/**
- * Provides a map of class/struct attributes and enumeration attributes
- */
-
 #ifndef ENUMATTRIBUTESMAP_HH
 #define ENUMATTRIBUTESMAP_HH
-
+/*
+    PURPOSE: (Provides a map of class/struct attributes and enumeration attributes)
+*/
 #include <map>
 #include <string>
 #include <fstream>
diff --git a/include/trick/Event.hh b/include/trick/Event.hh
index f07509e3..b81f021e 100644
--- a/include/trick/Event.hh
+++ b/include/trick/Event.hh
@@ -1,6 +1,8 @@
 #ifndef EVENT_HH
 #define EVENT_HH
-
+/*
+    PURPOSE: ( Event Class )
+*/
 #include <string>
 #include "trick/mm_macros.hh"
 #include "trick/exec_proto.h"
diff --git a/include/trick/EventInstrument.hh b/include/trick/EventInstrument.hh
index fe7f056d..da35b70f 100644
--- a/include/trick/EventInstrument.hh
+++ b/include/trick/EventInstrument.hh
@@ -1,6 +1,8 @@
 #ifndef EVENTINSTRUMENT_HH
 #define EVENTINSTRUMENT_HH
-
+/*
+    PURPOSE: ( EventInstrument Class )
+*/
 #include <string>
 #include "trick/Event.hh"
 #include "trick/InstrumentBase.hh"
diff --git a/include/trick/IPPythonEvent.hh b/include/trick/IPPythonEvent.hh
index 490f89b8..a8c846ef 100644
--- a/include/trick/IPPythonEvent.hh
+++ b/include/trick/IPPythonEvent.hh
@@ -1,7 +1,8 @@
-
 #ifndef IPPYTHONEVENT_HH
 #define IPPYTHONEVENT_HH
-
+/*
+    PURPOSE: ( IPPythonEvent Class provides python input file event capability.)
+*/
 #include <string>
 #include "trick/Event.hh"
 #include "trick/reference.h"
diff --git a/include/trick/MTV.hh b/include/trick/MTV.hh
index 60652138..fda83510 100644
--- a/include/trick/MTV.hh
+++ b/include/trick/MTV.hh
@@ -1,7 +1,8 @@
-
 #ifndef MTV_HH
 #define MTV_HH
-
+/*
+    PURPOSE: ( MTV Class - Malfunction events for Malfunction Trick View )
+*/
 #include <string>
 #include "trick/IPPythonEvent.hh"
 
diff --git a/include/trick/MessageLCout.hh b/include/trick/MessageLCout.hh
index b3dc1378..9fe42ccd 100644
--- a/include/trick/MessageLCout.hh
+++ b/include/trick/MessageLCout.hh
@@ -1,7 +1,8 @@
-
 #ifndef MESSAGELCOUT_HH
 #define MESSAGELCOUT_HH
-
+/*
+    PURPOSE: ( MessageLCout Class )
+*/
 #include <iostream>
 #include <map>
 #include <stdlib.h>
diff --git a/include/trick/MessagePublisher.hh b/include/trick/MessagePublisher.hh
index f73d29a4..70d61430 100644
--- a/include/trick/MessagePublisher.hh
+++ b/include/trick/MessagePublisher.hh
@@ -1,7 +1,8 @@
-
 #ifndef MESSAGEPUBLISHER_HH
 #define MESSAGEPUBLISHER_HH
-
+/*
+    PURPOSE: ( MessagePublisher Class )
+*/
 #include <string>
 #include <list>
 #include "trick/MessageSubscriber.hh"
diff --git a/include/trick/MessageSubscriber.hh b/include/trick/MessageSubscriber.hh
index 1db438bb..7abde06b 100644
--- a/include/trick/MessageSubscriber.hh
+++ b/include/trick/MessageSubscriber.hh
@@ -1,7 +1,8 @@
-
 #ifndef MESSAGESUBSCRIBER_HH
 #define MESSAGESUBSCRIBER_HH
-
+/*
+    PURPOSE: ( MessageSubscriber Class )
+*/
 #include <streambuf>
 #include <iostream>
 #include <string>
diff --git a/include/trick/MessageTCDevice.hh b/include/trick/MessageTCDevice.hh
index f8853959..8504e249 100644
--- a/include/trick/MessageTCDevice.hh
+++ b/include/trick/MessageTCDevice.hh
@@ -1,6 +1,8 @@
 #ifndef MESSAGETCDEVICE_HH
 #define MESSAGETCDEVICE_HH
-
+/*
+    PURPOSE: ( MessageTCDevice Class )
+*/
 #include <pthread.h>
 #include <vector>
 
diff --git a/include/trick/RtiEvent.hh b/include/trick/RtiEvent.hh
index 2d547983..392b83fb 100644
--- a/include/trick/RtiEvent.hh
+++ b/include/trick/RtiEvent.hh
@@ -1,6 +1,8 @@
 #ifndef RTIEVENT_H
 #define RTIEVENT_H
-
+/*
+    PURPOSE: ( Real Time Injector Classes )
+*/
 #include <string>
 #include <sstream>
 #include <stdlib.h>
diff --git a/include/trick/STLInterface.hh b/include/trick/STLInterface.hh
index 60f0f7e8..be28c1bc 100644
--- a/include/trick/STLInterface.hh
+++ b/include/trick/STLInterface.hh
@@ -1,7 +1,8 @@
-
 #ifndef STLINTERFACE_HH
 #define STLINTERFACE_HH
-
+/*
+    PURPOSE: ( STLInterface Class )
+*/
 #include <string>
 
 namespace Trick {
diff --git a/include/trick/SimTime.hh b/include/trick/SimTime.hh
index aa7fb2dd..2b70b859 100644
--- a/include/trick/SimTime.hh
+++ b/include/trick/SimTime.hh
@@ -1,7 +1,8 @@
-
 #ifndef SIMTIME_HH
 #define SIMTIME_HH
-
+/*
+    PURPOSE: ( SimTime Class )
+*/
 #include "trick/time_offset.h"
 
 namespace Trick {
diff --git a/include/trick/UdUnits.hh b/include/trick/UdUnits.hh
index 1ebf98e6..373cd7c0 100644
--- a/include/trick/UdUnits.hh
+++ b/include/trick/UdUnits.hh
@@ -1,7 +1,8 @@
-
 #ifndef UDUNITS_HH
 #define UDUNITS_HH
-
+/*
+    PURPOSE: ( UdUnits Class )
+*/
 #include <udunits2.h>
 #include <string>
 
diff --git a/include/trick/attributes.h b/include/trick/attributes.h
index 3f8dfaea..3203a930 100644
--- a/include/trick/attributes.h
+++ b/include/trick/attributes.h
@@ -1,6 +1,11 @@
 #ifndef ATTRIBUTES_H
 #define ATTRIBUTES_H
 
+/*
+    PURPOSE: ( Defines data-structures that Trick uses to describe
+               C/C++ data-types found in a simulation header files.)
+*/
+
 #include <stddef.h>
 #include "trick/parameter_types.h"
 
diff --git a/include/trick/io_alloc.h b/include/trick/io_alloc.h
index 02a89da3..9d2e26ce 100644
--- a/include/trick/io_alloc.h
+++ b/include/trick/io_alloc.h
@@ -1,5 +1,9 @@
 #ifndef IO_ALLOC_H
 #define IO_ALLOC_H
+/*
+    PURPOSE: (The ALLOC_INFO structure describes a chunk of
+              memory that the MemoryManager knows about.)
+*/
 #include "trick/attributes.h"
 #include "trick/parameter_types.h"
 
diff --git a/include/trick/message_type.h b/include/trick/message_type.h
index a767ac0f..768b6790 100644
--- a/include/trick/message_type.h
+++ b/include/trick/message_type.h
@@ -1,6 +1,8 @@
 #ifndef MESSAGE_TYPE_H
 #define MESSAGE_TYPE_H
-
+/*
+    PURPOSE: ( Define message types for the message publisher. )
+*/
 #ifdef __cplusplus
 extern "C" {
 #endif
diff --git a/include/trick/mm_error.h b/include/trick/mm_error.h
index f97d4160..bb13e260 100644
--- a/include/trick/mm_error.h
+++ b/include/trick/mm_error.h
@@ -1,6 +1,8 @@
 #ifndef MM_ERROR_H
 #define MM_ERROR_H
-
+/*
+    PURPOSE: ( Memory Manager Error Types )
+*/
     typedef enum {
         MM_OK,
         MM_ASSIGNMENT_LIST,
diff --git a/include/trick/parameter_types.h b/include/trick/parameter_types.h
index de96c954..e88347a8 100644
--- a/include/trick/parameter_types.h
+++ b/include/trick/parameter_types.h
@@ -1,6 +1,11 @@
 #ifndef PARAMETER_TYPES_H
 #define PARAMETER_TYPES_H
 
+/*
+    PURPOSE: ( Defines the Trick data-types, used in ATTRIBUTES descriptions of
+               variables, found in io_src files.)
+*/
+
 #ifdef __cplusplus
 extern "C" {
 #endif
diff --git a/include/trick/time_offset.h b/include/trick/time_offset.h
index 05167cc6..008dd173 100644
--- a/include/trick/time_offset.h
+++ b/include/trick/time_offset.h
@@ -1,7 +1,8 @@
-
 #ifndef TIME_OFFSET_H
 #define TIME_OFFSET_H
-
+/*
+    PURPOSE: ( TIME_OFFSET struct )
+*/
 #ifdef __cplusplus
 extern "C" {
 #endif
diff --git a/include/trick/var.h b/include/trick/var.h
index 1906295b..db2d7f82 100644
--- a/include/trick/var.h
+++ b/include/trick/var.h
@@ -1,8 +1,10 @@
-
-#include "trick/value.h"
-
 #ifndef VAR_H
 #define VAR_H
+/*
+    PURPOSE: ( Variable declarator structures. )
+*/
+
+#include "trick/value.h"
 
 /**
  * VAR_DECLARE represents a declarator.