Fix boilerplate

devosoft · Dec 8, 2023 · 831af72 · 831af72
1 parent 4fa794d
commit 831af72
Show file tree

Hide file tree

Showing 18 changed files with 55 additions and 17 deletions.
diff --git a/demos/utils/words/Wordle-simple.cpp b/demos/utils/words/Wordle-simple.cpp
@@ -4,8 +4,8 @@
  *  date: 2022
 */
 /**
- *  This version of Wordle is a bit simpler than it should be; it does not handle double letters
- *  correctly.
+ *  @file
+ *  @brief TODO.
  */
 
 #include <cmath>

diff --git a/demos/utils/words/Wordle/Wordle.cpp b/demos/utils/words/Wordle/Wordle.cpp
@@ -4,11 +4,7 @@
  *  date: 2022
 */
 /**
- *  @note This file is part of Empirical, https://github.com/devosoft/Empirical
- *  @copyright Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
- *  @date 2022
- *
- *  @file Wordle.cpp
+ *  @file
  */
 
 #include <cmath>

diff --git a/include/emp/datastructs/QueueCache.hpp b/include/emp/datastructs/QueueCache.hpp
@@ -6,7 +6,7 @@
 /**
  *  @file
  *  @brief A simple implementation of a Least-Recently Used Cache.
- *    It orders elements by access time and removes the stalest ones in case 
+ *    It orders elements by access time and removes the stalest ones in case
  *    maximum capacity is reached.
  */
 

diff --git a/tests/base/notify.cpp b/tests/base/notify.cpp
@@ -4,11 +4,7 @@
  *  date: 2022
 */
 /**
- *  @note This file is part of Empirical, https://github.com/devosoft/Empirical
- *  @copyright Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
- *  @date 2022
- *
- *  @file notify.cpp
+ *  @file
  */
 
 #define CATCH_CONFIG_MAIN

diff --git a/tests/bits/Bits.cpp b/tests/bits/Bits.cpp
@@ -3,6 +3,10 @@
  *  Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
  *  date: 2022
 */
+/**
+ *  @file
+ */
+
 #include <limits>
 #include <map>
 #include <ratio>

diff --git a/tests/data/Datum.cpp b/tests/data/Datum.cpp
@@ -3,6 +3,10 @@
  *  Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
  *  date: 2022
 */
+/**
+ *  @file
+ */
+
 #ifndef CATCH_CONFIG_MAIN
 #define CATCH_CONFIG_MAIN
 #endif

diff --git a/tests/data/SimpleParser.cpp b/tests/data/SimpleParser.cpp
@@ -3,6 +3,10 @@
  *  Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
  *  date: 2022
 */
+/**
+ *  @file
+ */
+
 #define CATCH_CONFIG_MAIN
 
 #include "third-party/Catch/single_include/catch2/catch.hpp"

diff --git a/tests/datastructs/ra_map.cpp b/tests/datastructs/ra_map.cpp
@@ -3,6 +3,9 @@
  *  Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
  *  date: 2022
 */
+/**
+ *  @file
+ */
 
 #include "third-party/Catch/single_include/catch2/catch.hpp"
 

diff --git a/tests/hardware/VirtualCPU.cpp b/tests/hardware/VirtualCPU.cpp
@@ -4,6 +4,10 @@
  *  date: 2021-2022
 */
 /**
+ *  @file
+ */
+
+/*
  *  TODO
  *  [ ] *INSTRUCTIONS struct
  *    [ ] Constructors assign values correctly

diff --git a/tests/math/RangeSet.cpp b/tests/math/RangeSet.cpp
@@ -3,6 +3,10 @@
  *  Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
  *  date: 2023
 */
+/**
+ *  @file
+ */
+
 #include <iostream>
 #include <sstream>
 

diff --git a/tests/meta/FunInfo.cpp b/tests/meta/FunInfo.cpp
@@ -3,6 +3,9 @@
  *  Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
  *  date: 2021-2022
 */
+/**
+ *  @file
+ */
 
 #define CATCH_CONFIG_MAIN
 

diff --git a/tests/text/EmphaticText.cpp b/tests/text/EmphaticText.cpp
@@ -3,6 +3,10 @@
  *  Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
  *  date: 2022
 */
+/**
+ *  @file
+ */
+
 #include <iostream>
 #include <sstream>
 

diff --git a/tests/text/HTMLText.cpp b/tests/text/HTMLText.cpp
@@ -3,6 +3,10 @@
  *  Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
  *  date: 2022-2023
 */
+/**
+ *  @file
+ */
+
 #include <iostream>
 #include <sstream>
 

diff --git a/tests/text/Text.cpp b/tests/text/Text.cpp
@@ -3,6 +3,10 @@
  *  Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
  *  date: 2022
 */
+/**
+ *  @file
+ */
+
 #include <iostream>
 #include <sstream>
 

diff --git a/tests/tools/MemoryFactory.cpp b/tests/tools/MemoryFactory.cpp
@@ -3,6 +3,9 @@
  *  Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
  *  date: 2022
 */
+/**
+ *  @file
+ */
 
 #include "../third-party/Catch/single_include/catch2/catch.hpp"
 

diff --git a/tests/tools/StaticString.cpp b/tests/tools/StaticString.cpp
@@ -3,6 +3,9 @@
  *  Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
  *  date: 2022
 */
+/**
+ *  @file
+ */
 
 #include "../third-party/Catch/single_include/catch2/catch.hpp"
 

diff --git a/tests/tools/String.cpp b/tests/tools/String.cpp
@@ -3,10 +3,9 @@
  *  Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
  *  date: 2023
 */
-
-#include "../third-party/Catch/single_include/catch2/catch.hpp"
-
-#include "emp/tools/String.hpp"
+/**
+ *  @file
+ */
 
 TEST_CASE("Test String Constructors", "[tools]")
 {

diff --git a/tests/tools/char_utils.cpp b/tests/tools/char_utils.cpp
@@ -3,6 +3,9 @@
  *  Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
  *  date: 2021-2022
 */
+/**
+ *  @file
+ */
 
 #include "../third-party/Catch/single_include/catch2/catch.hpp"
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,6 +3,9 @@ @@
      *  Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
      *  date: 2022
     */
+    /**
+     *  @file
+     */
     #include "third-party/Catch/single_include/catch2/catch.hpp"
@@ Expand Down @@