A Trick headers to include files without headers. Ref #403

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>

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>

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>

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"

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"

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"

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"
 

include/trick/MessageLCout.hh

@@ -1,7 +1,8 @@
-
 #ifndef MESSAGELCOUT_HH
 #define MESSAGELCOUT_HH
-
+/*
+    PURPOSE: ( MessageLCout Class )
+*/
 #include <iostream>
 #include <map>
 #include <stdlib.h>

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"

include/trick/MessageSubscriber.hh

@@ -1,7 +1,8 @@
-
 #ifndef MESSAGESUBSCRIBER_HH
 #define MESSAGESUBSCRIBER_HH
-
+/*
+    PURPOSE: ( MessageSubscriber Class )
+*/
 #include <streambuf>
 #include <iostream>
 #include <string>

include/trick/MessageTCDevice.hh

@@ -1,6 +1,8 @@
 #ifndef MESSAGETCDEVICE_HH
 #define MESSAGETCDEVICE_HH
-
+/*
+    PURPOSE: ( MessageTCDevice Class )
+*/
 #include <pthread.h>
 #include <vector>
 

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>

include/trick/STLInterface.hh

@@ -1,7 +1,8 @@
-
 #ifndef STLINTERFACE_HH
 #define STLINTERFACE_HH
-
+/*
+    PURPOSE: ( STLInterface Class )
+*/
 #include <string>
 
 namespace Trick {

include/trick/SimTime.hh

@@ -1,7 +1,8 @@
-
 #ifndef SIMTIME_HH
 #define SIMTIME_HH
-
+/*
+    PURPOSE: ( SimTime Class )
+*/
 #include "trick/time_offset.h"
 
 namespace Trick {

include/trick/UdUnits.hh

@@ -1,7 +1,8 @@
-
 #ifndef UDUNITS_HH
 #define UDUNITS_HH
-
+/*
+    PURPOSE: ( UdUnits Class )
+*/
 #include <udunits2.h>
 #include <string>
 

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"
 

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"
 

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

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,

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

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

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.