Fix docstrings

devosoft · Feb 29, 2024 · 99386bd · 99386bd
1 parent 9f73a69
commit 99386bd
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 21 deletions.
diff --git a/include/emp/Evolve/Systematics.hpp b/include/emp/Evolve/Systematics.hpp
@@ -1,11 +1,11 @@
+/*
+ *  This file is part of Empirical, https://github.com/devosoft/Empirical
+ *  Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
+ *  date: 2024
+*/
 /**
- *  @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 2017-2023
- *
- *  @file Systematics.hpp
- *  @brief Track genotypes, species, clades, or lineages of organisms in a world.
- *
+ *  @file
+ *  @brief TODO.
  *  @todo We should provide an option to back up systematics data to a file so that it doesn't all
  *        need to be kept in memory, especially if we're only doing post-analysis.
  *  @todo This inheritance system makes adding new systematics-related data tracking kind of a pain.

diff --git a/include/emp/base/_optional_throw.hpp b/include/emp/base/_optional_throw.hpp
@@ -1,11 +1,11 @@
+/*
+ *  This file is part of Empirical, https://github.com/devosoft/Empirical
+ *  Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
+ *  date: 2024
+*/
 /**
- *  @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 2023.
- *
- *  @file _optional_throw.hpp
- *  @brief Variant of asserts that throws exception
- *  @note This is useful for writing code that gets wrapped in Python via pybind11
+ *  @file
+ *  @brief TODO.
  */
 
 #ifndef EMP_BASE__OPTIONAL_THROW_TRIGGER_HPP_INCLUDE

diff --git a/include/emp/base/optional_throw.hpp b/include/emp/base/optional_throw.hpp
@@ -1,11 +1,11 @@
+/*
+ *  This file is part of Empirical, https://github.com/devosoft/Empirical
+ *  Copyright (C) Michigan State University, MIT Software license; see doc/LICENSE.md
+ *  date: 2024
+*/
 /**
- *  @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 2023.
- *
- *  @file optional_throw.hpp
- *  @brief Like emp_assert, but throws an exception if in Python
- *  @note Status: RELEASE
+ *  @file
+ *  @brief TODO.
  *
  */