Adding doxygen file tags and STLSupport module

2024-11-27 05:00:38 +00:00 · 2013-07-06 19:01:04 -07:00 · 2013-07-06 19:01:04 -07:00 · ef4ec7bd69
commit ef4ec7bd69
parent 74737ede8c
23 changed files with 69 additions and 1 deletions
--- a/include/cereal/cereal.hpp
+++ b/include/cereal/cereal.hpp
@ -40,7 +40,9 @@
 namespace cereal
 {
  //! \defgroup Archives Input and output archive types
-
+  //! \defgroup STLSupport Support for types found in the C++ Standard Library
+  //! \defgroup OtherTypes Support for miscellaneous types
+  
  // ######################################################################
  //! An exception class thrown when things go wrong at runtime
  struct Exception : public std::runtime_error
--- a/include/cereal/types/array.hpp
+++ b/include/cereal/types/array.hpp
@ -1,3 +1,6 @@
+/*! \file array.hpp
+    \brief Support for types found in <array>
+    \ingroup STLSupport */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/base_class.hpp
+++ b/include/cereal/types/base_class.hpp
@ -1,3 +1,6 @@
+/*! \file base_class.hpp
+    \brief Support for base classes (virtual and non-virtual)
+    \ingroup OtherTypes */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/bitset.hpp
+++ b/include/cereal/types/bitset.hpp
@ -1,3 +1,6 @@
+/*! \file bitset.hpp
+    \brief Support for types found in <bitset>
+    \ingroup STLSupport */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/boost_variant.hpp
+++ b/include/cereal/types/boost_variant.hpp
@ -1,3 +1,6 @@
+/*! \file boost_variant.hpp
+    \brief Support for boost::variant
+    \ingroup OtherTypes */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/chrono.hpp
+++ b/include/cereal/types/chrono.hpp
@ -1,3 +1,6 @@
+/*! \file chrono.hpp
+    \brief Support for types found in <chrono>
+    \ingroup STLSupport */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/common.hpp
+++ b/include/cereal/types/common.hpp
@ -1,3 +1,6 @@
+/*! \file common.hpp
+    \brief Support common types
+    \ingroup OtherTypes */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/complex.hpp
+++ b/include/cereal/types/complex.hpp
@ -1,3 +1,6 @@
+/*! \file comples.hpp
+    \brief Support for types found in <complex>
+    \ingroup STLSupport */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/deque.hpp
+++ b/include/cereal/types/deque.hpp
@ -1,3 +1,6 @@
+/*! \file deque.hpp
+    \brief Support for types found in <deque>
+    \ingroup STLSupport */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/forward_list.hpp
+++ b/include/cereal/types/forward_list.hpp
@ -1,3 +1,6 @@
+/*! \file forward_list.hpp
+    \brief Support for types found in <forward_list>
+    \ingroup STLSupport */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/list.hpp
+++ b/include/cereal/types/list.hpp
@ -1,3 +1,6 @@
+/*! \file list.hpp
+    \brief Support for types found in \<list>
+    \ingroup STLSupport */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/map.hpp
+++ b/include/cereal/types/map.hpp
@ -1,3 +1,6 @@
+/*! \file map.hpp
+    \brief Support for types found in <map>
+    \ingroup STLSupport */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/memory.hpp
+++ b/include/cereal/types/memory.hpp
@ -1,3 +1,6 @@
+/*! \file memory.hpp
+    \brief Support for types found in <memory>
+    \ingroup STLSupport */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/polymorphic.hpp
+++ b/include/cereal/types/polymorphic.hpp
@ -1,3 +1,6 @@
+/*! \file polymorphic.hpp
+    \brief Support for pointers to polymorphic base classes
+    \ingroup OtherTypes */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/queue.hpp
+++ b/include/cereal/types/queue.hpp
@ -1,3 +1,6 @@
+/*! \file queue.hpp
+    \brief Support for types found in <queue>
+    \ingroup STLSupport */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/set.hpp
+++ b/include/cereal/types/set.hpp
@ -1,3 +1,6 @@
+/*! \file set.hpp
+    \brief Support for types found in <set>
+    \ingroup STLSupport */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/stack.hpp
+++ b/include/cereal/types/stack.hpp
@ -1,3 +1,6 @@
+/*! \file stack.hpp
+    \brief Support for types found in <stack>
+    \ingroup STLSupport */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/string.hpp
+++ b/include/cereal/types/string.hpp
@ -1,3 +1,6 @@
+/*! \file string.hpp
+    \brief Support for types found in <string>
+    \ingroup STLSupport */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/tuple.hpp
+++ b/include/cereal/types/tuple.hpp
@ -1,3 +1,6 @@
+/*! \file tuple.hpp
+    \brief Support for types found in <tuple>
+    \ingroup STLSupport */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/unordered_map.hpp
+++ b/include/cereal/types/unordered_map.hpp
@ -1,3 +1,6 @@
+/*! \file unordered_map.hpp
+    \brief Support for types found in <unordered_map>
+    \ingroup STLSupport */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/unordered_set.hpp
+++ b/include/cereal/types/unordered_set.hpp
@ -1,3 +1,6 @@
+/*! \file unordered_set.hpp
+    \brief Support for types found in <unordered_set>
+    \ingroup STLSupport */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/utility.hpp
+++ b/include/cereal/types/utility.hpp
@ -1,3 +1,6 @@
+/*! \file utility.hpp
+    \brief Support for types found in <utility>
+    \ingroup STLSupport */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.
--- a/include/cereal/types/vector.hpp
+++ b/include/cereal/types/vector.hpp
@ -1,3 +1,6 @@
+/*! \file vector.hpp
+    \brief Support for types found in <vector>
+    \ingroup STLSupport */
 /*
  Copyright (c) 2013, Randolph Voorhies, Shane Grant
  All rights reserved.