Move documentation to code

5had3z · May 27, 2024 · 5263eb3 · 5263eb3
1 parent 70bc030
commit 5263eb3
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/docs_sphinx/api/serializer.rst b/docs_sphinx/api/serializer.rst
@@ -3,7 +3,5 @@
 Serialization
 =============
 
-A combination of C++20 Concepts and Requires clauses are used to automatically serialize data structures. [Boost PFR](https://www.boost.org/doc/libs/master/doc/html/boost_pfr.html) is used to iterate over data structures. Data structures must be trivially copyable or some range which can be copied element-by-element.
-
 .. doxygenfile:: serialize.hpp
    :project: StarCraft II Serializer
diff --git a/include/serialize.hpp b/include/serialize.hpp
@@ -1,7 +1,11 @@
 /**
  * @file serialize.hpp
  * @author Bryce Ferenczi ([email protected])
- * @brief Generic Serialisation and Deserialisation Methods
+ * @brief Generic Serialisation and Deserialisation Methods. A combination of C++20 Concepts and Requires clauses are
+ * used to automatically determine how to (de)serialize data. `Boost PFR
+ * <https://www.boost.org/doc/libs/master/doc/html/boost_pfr.html>`_ is used to iterate over non-trivial structures.
+ * Underlying data is ideally trivially copyable or some range which can be copied element-by-element. This will not
+ * work properly with pointer-like objects.
  * @version 0.1
  * @date 2024-05-27
  *