Fixed template params absorbing general class documentation

Author: EliasH-E

source/sgp_mode/ProgramBuilder.h

@@ -23,8 +23,8 @@
 namespace sgpmode {
 
 /**
+* Used to generate starter genomes and read genomes from a json.
 * @tparam HW_SPEC_T: A specifier that bundles many required types for SGP scripts together
-* The ProgramBuilder is used to generate starter genomes and read genomes from a json.
 */
 template<typename HW_SPEC_T>
 class ProgramBuilder {

source/sgp_mode/SGPHost.h

@@ -15,8 +15,8 @@
 
 namespace sgpmode {
 /**
-* @tparam HW_SPEC_T: A specifier that bundles many required types for SGP scripts together
 * The SignalGP version of the base host
+* @tparam HW_SPEC_T: A specifier that bundles many required types for SGP scripts together
 */
 template <typename HW_SPEC_T>
 class SGPHost : public Host {

source/sgp_mode/SGPMutator.h

@@ -9,9 +9,9 @@ namespace sgpmode {
 //        ability to "layer on" different mutaiton types).
 //        For now, it just replicates functionality of previous mutator
 /**
+* Used to mutate the program of organisms
 * @tparam PROGRAM_T: The type representing the program that is going to be mutated
 * @tparam INST_LIBRARY_T: Contains all instructions that can be mutated.
-* Purpose: Used to mutate the program of organisms
 */
 template<typename PROGRAM_T, typename INST_LIBRARY_T>
 class SGPMutator {

source/sgp_mode/SGPSymbiont.h

@@ -11,8 +11,8 @@
 namespace sgpmode {
 
 /**
-* @tparam HW_SPEC_T: A specifier that bundles many required types for SGP scripts together
 * The SignalGP version of the base symbiont
+* @tparam HW_SPEC_T: A specifier that bundles many required types for SGP scripts together
 */
 template<typename HW_SPEC_T>
 class SGPSymbiont : public Symbiont {

source/sgp_mode/hardware/CPUState.h

@@ -24,9 +24,9 @@ namespace sgpmode {
 enum class ReproState { NONE=0, ATTEMPTING, IN_PROGRESS };
 
 /**
- * @tparam WORLD_T: The type representing to the world the simulation is in
  * The CPUState holds all state that can be accessed by instructions in the
  * organism's genomes. Each organism has its own CPUState.
+ * @tparam WORLD_T: The type representing to the world the simulation is in
  */
 // TODO - write tests
 // TODO - cleanup member variables (reduce down to only what we're using)

source/sgp_mode/hardware/RingBuffer.h

@@ -8,9 +8,9 @@ namespace sgpmode {
 
 // TODO - write tests for IORingBuffer
 /**
-* @tparam T, the type of what is being stored in the RingBuffer
 *A helper class for a ring buffer that keeps the latest `len` inputs and
 *discards the rest.
+*@tparam T, the type of what is being stored in the RingBuffer
 */
 template <typename T>
 class RingBuffer {

source/sgp_mode/hardware/SGPHardware.h

@@ -20,9 +20,9 @@ namespace sgpmode {
 
 
 /**
- * @tparam HW_SPEC_T: A specifier that bundles many required types for SGP scripts together
  * Represents the virtual CPU and the program genome for an organism in the SGP
  * mode.
+ * @tparam HW_SPEC_T: A specifier that bundles many required types for SGP scripts together
  */
 template<typename HW_SPEC_T>
 class SGPHardware {

source/sgp_mode/hardware/Stacks.h

@@ -9,8 +9,9 @@
 namespace sgpmode {
 
 /**
- * @tparam T, the type of what is being stored in the stack
+ * 
  * The Stacks are used as a first in, last out data structure.
+ * @tparam T, the type of what is being stored in the stack
  */
 template<typename T>
 class Stacks {

source/sgp_mode/tasks/TaskSet.h

@@ -18,16 +18,16 @@ namespace sgpmode::tasks {
   TaskSet is adapted from class of the same name from
     https://github.com/amlalejini/directed-digital-evolution
 
-  @tparam INPUT_T: A type containing vector of inputs, OUTPUT_T: A type representing output of a task given INPUT_T
-
-  Purpose: TaskSet defines a set of tasks where each task can be identified by a numeric ID
+  TaskSet defines a set of tasks where each task can be identified by a numeric ID
   and a given string name.
 
   A Task defines a mapping from a given set (vector) of inputs (INPUT_T) to a
   given output (OUTPUT_T). This mapping is specified by the task's calc_output_fun,
   which takes a vector of inputs and maps it to the correct output for the given
   task.
 
+  @tparam INPUT_T: A type containing vector of inputs, OUTPUT_T: A type representing output of a task given INPUT_T
+
 */
 template<typename INPUT_T, typename OUTPUT_T>
 class TaskSet {