]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Better document serialization functions. 11392/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Thu, 17 Dec 2020 21:38:47 +0000 (14:38 -0700)
committerWolfgang Bangerth <bangerth@colostate.edu>
Sat, 2 Jan 2021 00:26:18 +0000 (17:26 -0700)
Specifically, equip all of them with a link to the BOOST library.

40 files changed:
include/deal.II/base/aligned_vector.h
include/deal.II/base/bounding_box.h
include/deal.II/base/data_out_base.h
include/deal.II/base/geometry_info.h
include/deal.II/base/index_set.h
include/deal.II/base/parameter_handler.h
include/deal.II/base/point.h
include/deal.II/base/polynomial.h
include/deal.II/base/polynomials_piecewise.h
include/deal.II/base/quadrature.h
include/deal.II/base/subscriptor.h
include/deal.II/base/symmetric_tensor.h
include/deal.II/base/table.h
include/deal.II/base/table_handler.h
include/deal.II/base/table_indices.h
include/deal.II/base/tensor.h
include/deal.II/base/utilities.h
include/deal.II/differentiation/sd/symengine_number_types.h
include/deal.II/differentiation/sd/symengine_number_visitor_internal.h
include/deal.II/differentiation/sd/symengine_optimizer.h
include/deal.II/dofs/block_info.h
include/deal.II/dofs/dof_faces.h
include/deal.II/dofs/dof_handler.h
include/deal.II/dofs/dof_levels.h
include/deal.II/dofs/dof_objects.h
include/deal.II/dofs/number_cache.h
include/deal.II/grid/cell_id.h
include/deal.II/grid/grid_tools.h
include/deal.II/grid/tria.h
include/deal.II/grid/tria_description.h
include/deal.II/grid/tria_faces.h
include/deal.II/grid/tria_levels.h
include/deal.II/grid/tria_objects.h
include/deal.II/lac/affine_constraints.h
include/deal.II/lac/la_vector.h
include/deal.II/lac/sparsity_pattern.h
include/deal.II/lac/vector.h
include/deal.II/particles/particle.h
include/deal.II/particles/particle_accessor.h
include/deal.II/particles/particle_handler.h

index 3dd7b8f207827458860efbbfedb57a598d0fd5b2..09e23fdcd404c1a58192809f12c4f5b9918fae1a 100644 (file)
@@ -313,7 +313,8 @@ public:
 
   /**
    * Write the data of this object to a stream for the purpose of
-   * serialization.
+   * serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
@@ -321,7 +322,8 @@ public:
 
   /**
    * Read the data of this object from a stream for the purpose of
-   * serialization.
+   * serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
@@ -330,7 +332,8 @@ public:
 #ifdef DOXYGEN
   /**
    * Write and read the data of this object from a stream for the purpose
-   * of serialization.
+   * of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
index 937783de0ebabc676a2dfd30007212efe459afa9..5dc7b4f588a54a542617cabab9e080d8a8a48a41 100644 (file)
@@ -289,7 +289,9 @@ public:
   unit_to_real(const Point<spacedim, Number> &point) const;
 
   /**
-   * Boost serialization function
+   * Write or read the data of this object to or from a stream for the
+   * purpose of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
index bbb6e8827a778ee4f5fda460f9d21cb2c9875f09..360827dfd59ca688119ea09bbe0ce941b25a5334 100644 (file)
@@ -3316,7 +3316,9 @@ public:
   add_attribute(const std::string &attr_name, const unsigned int dimension);
 
   /**
-   * Read or write the data of this object for serialization
+   * Read or write the data of this object for serialization using the
+   * [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
index 8733379113fe2c04731e9e17ac0ccdf82da67f99..742db3c826e577de72318f861d0d951bae2b0dec 100644 (file)
@@ -860,7 +860,8 @@ public:
 
   /**
    * Read or write the data of this object to or from a stream for the purpose
-   * of serialization
+   * of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
index 57573a7335840ce0b656658a4a342904776cb256..d0a86238936e411ed5a04179fef6f3a45ce0c14e 100644 (file)
@@ -505,7 +505,8 @@ public:
 
   /**
    * Write or read the data of this object to or from a stream for the purpose
-   * of serialization
+   * of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
@@ -932,7 +933,8 @@ private:
 
     /**
      * Write or read the data of this object to or from a stream for the
-     * purpose of serialization
+     * purpose of serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
      */
     template <class Archive>
     void
index 9f2b797d3f8eac080eb25b24f279176fbe5670bc..31bca948d86f37fb1fca378312b4f59097a667e7 100644 (file)
@@ -1543,7 +1543,8 @@ public:
 
   /**
    * Write the data of this object to a stream for the purpose of
-   * serialization.
+   * serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
@@ -1551,7 +1552,8 @@ public:
 
   /**
    * Read the data of this object from a stream for the purpose of
-   * serialization.
+   * serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
@@ -1560,7 +1562,8 @@ public:
 #ifdef DOXYGEN
   /**
    * Write and read the data of this object from a stream for the purpose
-   * of serialization.
+   * of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
index 90f31615c5897f8ef741e49754081a2194192ce1..2ce148c52e96432f58ea5cd3c316807aa7cb2f03 100644 (file)
@@ -330,7 +330,8 @@ public:
 
   /**
    * Read or write the data of this object to or from a stream for the purpose
-   * of serialization
+   * of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
index 1c708c8cd5a2bdc00b6103eeac0c15f89de840eb..0fd72994cf5726368dbbe045e042795a9958635d 100644 (file)
@@ -227,7 +227,8 @@ namespace Polynomials
 
     /**
      * Write or read the data of this object to or from a stream for the
-     * purpose of serialization.
+     * purpose of serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
      */
     template <class Archive>
     void
index 20cd47a9e2ccfa35bb201aead9ccc74aa409f0c7..e8fa4ff67df2a7cd80dfaf0938e1470c4901bc20 100644 (file)
@@ -124,7 +124,8 @@ namespace Polynomials
 
     /**
      * Write or read the data of this object to or from a stream for the
-     * purpose of serialization.
+     * purpose of serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
      */
     template <class Archive>
     void
index c38164901fb22f7f91636f53c8bd0a7a1ba8875b..b46bf0ccf8dd1771a07b3421a405d4d777565f43 100644 (file)
@@ -233,7 +233,8 @@ public:
 
   /**
    * Write or read the data of this object to or from a stream for the purpose
-   * of serialization.
+   * of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
index 7f136b4e0bd3ed40c1f810f357a5fd4af33c01bc..b528c086f00a8436b47a8b8de4acb18d6538007b 100644 (file)
@@ -186,7 +186,8 @@ public:
 
   /**
    * Read or write the data of this object to or from a stream for the purpose
-   * of serialization.
+   * of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    *
    * This function does not actually serialize any of the member variables of
    * this class. The reason is that what this class stores is only who
index 8d116fb9bebbaa20612fd483bb5c4a72608b6977..306987270861433c47053f8d3f1749a7c80249b5 100644 (file)
@@ -923,7 +923,8 @@ public:
 
   /**
    * Read or write the data of this object to or from a stream for the purpose
-   * of serialization
+   * of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
index e0d8bf351f853f8fb51a8546a92b0072a65a2875..d30ddab3873108d2d4902fe50f02ec68241b8e06 100644 (file)
@@ -618,7 +618,8 @@ public:
 
   /**
    * Write or read the data of this object to or from a stream for the purpose
-   * of serialization.
+   * of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
index 93425c3c4bd2873c0a4b060df16ca6e0ebc8eff8..02cb4755748b4ab34c225389fda9471462d2d4c2 100644 (file)
@@ -115,7 +115,8 @@ namespace internal
 
     /**
      * Write the data of this object to a stream for the purpose of
-     * serialization.
+     * serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
      */
     template <class Archive>
     void
@@ -123,7 +124,8 @@ namespace internal
 
     /**
      * Read the data of this object from a stream for the purpose of
-     * serialization.
+     * serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
      */
     template <class Archive>
     void
@@ -132,7 +134,8 @@ namespace internal
 #ifdef DOXYGEN
     /**
      * Write and read the data of this object from a stream for the purpose
-     * of serialization.
+     * of serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
      */
     template <class Archive>
     void
@@ -564,7 +567,8 @@ public:
 
   /**
    * Read or write the data of this object to or from a stream for the purpose
-   * of serialization.
+   * of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
@@ -643,7 +647,8 @@ protected:
 
     /**
      * Write the data of this object to a stream for the purpose of
-     * serialization.
+     * serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
      */
     template <class Archive>
     void
@@ -651,7 +656,8 @@ protected:
 
     /**
      * Read the data of this object from a stream for the purpose of
-     * serialization.
+     * serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
      */
     template <class Archive>
     void
@@ -660,7 +666,8 @@ protected:
 #ifdef DOXYGEN
     /**
      * Write and read the data of this object from a stream for the purpose
-     * of serialization.
+     * of serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
      */
     template <class Archive>
     void
index bc9196f53eff2e00838d3c591506a814ecbcc97c..a72f4b65be4a8033530cb24b9b379d1157a0b690 100644 (file)
@@ -94,7 +94,8 @@ public:
 
   /**
    * Write or read the data of this object to or from a stream for the purpose
-   * of serialization.
+   * of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
index 4cddefe90fbc3b54614a71caa4e2c1aedd1900d2..c5e1e571669a8506daa51ee17fc7b5917f438c29 100644 (file)
@@ -338,7 +338,8 @@ public:
 
   /**
    * Read or write the data of this object to or from a stream for the purpose
-   * of serialization
+   * of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
@@ -747,7 +748,8 @@ public:
 
   /**
    * Read or write the data of this object to or from a stream for the purpose
-   * of serialization
+   * of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
index 84428a1f398cd2dd2cdddb6cf348985164b4807f..b5453144929eaafb2a426273ac5e9bda25004a50 100644 (file)
@@ -1384,7 +1384,7 @@ namespace boost
   namespace serialization
   {
     // Provides boost and c++11 with a way to serialize tuples and pairs
-    // automatically
+    // automatically.
     template <int N>
     struct Serialize
     {
index 3d430e2b909a68393c4d572d05f11dcaca80e577..13ac0572a23b6045e6254e01de8e0021f0198ff3 100644 (file)
@@ -438,7 +438,8 @@ namespace Differentiation
       save(std::ostream &stream) const;
 
       /**
-       * Load the value stored in the @p stream into this object.
+       * Load the value stored in the @p stream into this object using the [BOOST serialization
+       * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
        *
        * It is expected that each expression appears on its own on single
        * line of @p stream.
@@ -452,7 +453,8 @@ namespace Differentiation
 
       /**
        * Write the data of this object to a stream for the purpose
-       * of serialization.
+       * of serialization using the [BOOST serialization
+       * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
        *
        * This effectively saves the value stored in this object to the
        * @p archive with the given @p version number.
@@ -480,7 +482,8 @@ namespace Differentiation
 #  ifdef DOXYGEN
       /**
        * Write and read the data of this object from a stream for the purpose
-       * of serialization.
+       * of serialization using the [BOOST serialization
+       * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
        *
        * This effectively saves or loads the value stored into/out of the
        * @p archive with the given @p version number into this object.
index c3a15ff721c46767d8b5fcd0fc0462d3aa82c18a..b8872beec5b8b9c70e3334850105f1d99dd27d8e 100644 (file)
@@ -133,7 +133,8 @@ namespace Differentiation
 
         /**
          * Write the data of this object to a stream for the purpose
-         * of serialization.
+         * of serialization using the [BOOST serialization
+         * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
          */
         template <class Archive>
         void
@@ -141,7 +142,8 @@ namespace Differentiation
 
         /**
          * Read the data for this object from a stream for the purpose
-         * of serialization.
+         * of serialization using the [BOOST serialization
+         * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
          */
         template <class Archive>
         void
@@ -150,7 +152,8 @@ namespace Differentiation
 #  ifdef DOXYGEN
         /**
          * Write and read the data of this object from a stream for the purpose
-         * of serialization.
+         * of serialization using the [BOOST serialization
+         * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
          */
         template <class Archive>
         void
@@ -444,7 +447,8 @@ namespace Differentiation
 
         /**
          * Write the data of this object to a stream for the purpose
-         * of serialization.
+         * of serialization using the [BOOST serialization
+         * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
          */
         template <class Archive>
         void
@@ -452,7 +456,8 @@ namespace Differentiation
 
         /**
          * Read the data for this object from a stream for the purpose
-         * of serialization.
+         * of serialization using the [BOOST serialization
+         * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
          */
         template <class Archive>
         void
@@ -461,7 +466,8 @@ namespace Differentiation
 #  ifdef DOXYGEN
         /**
          * Write and read the data of this object from a stream for the purpose
-         * of serialization.
+         * of serialization using the [BOOST serialization
+         * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
          */
         template <class Archive>
         void
index 784b93bab1482935c222dc0e2955522d1efb29ce..440f15761b10f7338500b717e91362bf4be59359 100644 (file)
@@ -1497,7 +1497,8 @@ namespace Differentiation
 
       /**
        * Write the data of this object from a stream for the purpose
-       * of serialization.
+       * of serialization using the [BOOST serialization
+       * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
        *
        * This effectively saves the value stored into the @p archive with the
        * given @p version number into this object.
@@ -1508,7 +1509,8 @@ namespace Differentiation
 
       /**
        * Read the data of this object from a stream for the purpose
-       * of serialization.
+       * of serialization using the [BOOST serialization
+       * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
        *
        * This effectively loads the value stored out of the
        * @p archive with the given @p version number into this object.
@@ -1525,7 +1527,8 @@ namespace Differentiation
 #  ifdef DOXYGEN
       /**
        * Write and read the data of this object from a stream for the purpose
-       * of serialization.
+       * of serialization using the [BOOST serialization
+       * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
        *
        * This effectively saves or loads the value stored into/out of the
        * @p archive with the given @p version number into this object.
index 3cbbfaa06650b17d329f06fd78e11507552568f8..a1464c649920f9b721e01682f42383e65872448c 100644 (file)
@@ -178,7 +178,8 @@ public:
 
   /**
    * Read or write the data of this object to or from a stream for the purpose
-   * of serialization
+   * of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
index 68931e711d4f382157762dd10f1685fa2c3be610..051c7326e92012ce315e9486bca8f265f601b60c 100644 (file)
@@ -92,7 +92,9 @@ namespace internal
 
       /**
        * Read or write the data of this object to or from a stream for the
-       * purpose of serialization
+       * purpose of serialization using the [BOOST serialization
+       * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
+       *
        */
       template <class Archive>
       void
@@ -121,7 +123,8 @@ namespace internal
 
       /**
        * Read or write the data of this object to or from a stream for the
-       * purpose of serialization
+       * purpose of serialization using the [BOOST serialization
+       * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
        */
       template <class Archive>
       void
@@ -155,7 +158,8 @@ namespace internal
 
       /**
        * Read or write the data of this object to or from a stream for the
-       * purpose of serialization
+       * purpose of serialization using the [BOOST serialization
+       * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
        */
       template <class Archive>
       void
index 47ecf1098feb282e29d4e1d3c917eae7f3415393..6930091e8fab19930a103cc0795c7a59bc97e7d3 100644 (file)
@@ -1317,7 +1317,8 @@ public:
 
   /**
    * Write the data of this object to a stream for the purpose of
-   * serialization.
+   * serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
@@ -1325,7 +1326,8 @@ public:
 
   /**
    * Read the data of this object from a stream for the purpose of
-   * serialization.
+   * serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
@@ -1334,7 +1336,8 @@ public:
 #ifdef DOXYGEN
   /**
    * Write and read the data of this object from a stream for the purpose
-   * of serialization.
+   * of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
index 4512e520e19996ac44cc6ce6212015018ef67f84..09ca461de28b69f6026c4cc78120ef2d2c187dda 100644 (file)
@@ -102,7 +102,8 @@ namespace internal
 
       /**
        * Read or write the data of this object to or from a stream for the
-       * purpose of serialization
+       * purpose of serialization using the [BOOST serialization
+       * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
        */
       template <class Archive>
       void
index 2546dd7d7b80bc954253e3f2ad0eb02c2b8a5f4b..fb677275112588e39017a5457a583ff132438ceb 100644 (file)
@@ -146,7 +146,8 @@ namespace internal
 
       /**
        * Read or write the data of this object to or from a stream for the
-       * purpose of serialization
+       * purpose of serialization using the [BOOST serialization
+       * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
        */
       template <class Archive>
       void
index 59f1839d8fb9134bbb561242ac7c51fa59edcc4a..1db088fdf87f4297ddeb011ce39591ca87f7dcd4 100644 (file)
@@ -181,7 +181,8 @@ namespace internal
 
       /**
        * Read or write the data of this object to or from a stream for the
-       * purpose of serialization
+       * purpose of serialization using the [BOOST serialization
+       * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
        */
       template <class Archive>
       void
index d1716bb6a4204fdfe3c0eb33b0a58da4b6082d0d..78fdfb03eb77be2e09c44697fe686946ebb10f16 100644 (file)
@@ -188,7 +188,9 @@ public:
   is_ancestor_of(const CellId &other) const;
 
   /**
-   * Boost serialization function
+   * Read or write the data of this object to or from a stream for the
+   * purpose of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
index 59c642594285810bf87dc2982068d5525e15c287..5352abbc1ae0a64fd0244950b6fe8e9e926ff8bc 100644 (file)
@@ -3072,7 +3072,8 @@ namespace GridTools
 
     /**
      * Write the data of this object to a stream for the purpose of
-     * serialization.
+     * serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html)
      *
      * @pre The user is responsible to keep the size of @p data
      * equal to the size as @p cell_ids .
@@ -3083,7 +3084,9 @@ namespace GridTools
 
     /**
      * Read the data of this object from a stream for the purpose of
-     * serialization. Throw away the previous content.
+     * serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
+     * Throw away the previous content.
      */
     template <class Archive>
     void
@@ -3091,8 +3094,9 @@ namespace GridTools
 
 #  ifdef DOXYGEN
     /**
-     * Write and read the data of this object from a stream for the purpose
-     * of serialization.
+     * Read or write the data of this object to or from a stream for the
+     * purpose of serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
      */
     template <class Archive>
     void
index d98377b26ea5ad4c3f26801f5fcb5cfe88bb6f6b..058550145ce2f4e898860f39bcf2cec45fb4c95a 100644 (file)
@@ -196,7 +196,8 @@ namespace internal
 
       /**
        * Read or write the data of this object to or from a stream for the
-       * purpose of serialization
+       * purpose of serialization using the [BOOST serialization
+       * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
        */
       template <class Archive>
       void
@@ -253,7 +254,8 @@ namespace internal
 
       /**
        * Read or write the data of this object to or from a stream for the
-       * purpose of serialization
+       * purpose of serialization using the [BOOST serialization
+       * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
        */
       template <class Archive>
       void
@@ -311,7 +313,8 @@ namespace internal
 
       /**
        * Read or write the data of this object to or from a stream for the
-       * purpose of serialization
+       * purpose of serialization using the [BOOST serialization
+       * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
        */
       template <class Archive>
       void
@@ -3319,7 +3322,8 @@ public:
 
   /**
    * Write the data of this object to a stream for the purpose of
-   * serialization.
+   * serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    *
    * @note This function does not save <i>all</i> member variables of the
    * current triangulation. Rather, only certain kinds of information are
@@ -3331,7 +3335,9 @@ public:
 
   /**
    * Read the data of this object from a stream for the purpose of
-   * serialization. Throw away the previous content.
+   * serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
+   * Throw away the previous content.
    *
    * @note This function does not reset <i>all</i> member variables of the
    * current triangulation to the ones of the triangulation that was
@@ -3393,7 +3399,8 @@ public:
 #ifdef DOXYGEN
   /**
    * Write and read the data of this object from a stream for the purpose
-   * of serialization.
+   * of serialization. using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
index 0c8918952234b59a377794abf7954a81ea926a6d..6e26bb81f2fcce7965b9d2bd4a288b5ff5959e43 100644 (file)
@@ -131,7 +131,9 @@ struct CellData
   operator==(const CellData<structdim> &other) const;
 
   /**
-   * Boost serialization function
+   * Read or write the data of this object to or from a stream for the
+   * purpose of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
@@ -279,7 +281,9 @@ namespace TriangulationDescription
   struct CellData
   {
     /**
-     * Boost serialization function
+     * Read or write the data of this object to or from a stream for the
+     * purpose of serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
      */
     template <class Archive>
     void
@@ -342,7 +346,9 @@ namespace TriangulationDescription
   struct Description
   {
     /**
-     * Boost serialization function
+     * Read or write the data of this object to or from a stream for the
+     * purpose of serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
      */
     template <class Archive>
     void
index 8c79e575764645e1fb0b5dc7d40811f45920715d..ec7cfeb2133a66fb12c9730dcd0fdf0609d5842d 100644 (file)
@@ -95,7 +95,8 @@ namespace internal
 
       /**
        * Read or write the data of this object to or from a stream for the
-       * purpose of serialization
+       * purpose of serialization using the [BOOST serialization
+       * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
        */
       template <class Archive>
       void
index ca6a26ebeef8ed358bb4a1594332d6f2170eb8e7..557f332900830b1bb94038ae1e84de242de072b7 100644 (file)
@@ -233,7 +233,8 @@ namespace internal
 
       /**
        * Read or write the data of this object to or from a stream for the
-       * purpose of serialization
+       * purpose of serialization using the [BOOST serialization
+       * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
        */
       template <class Archive>
       void
index 1baef00122b73aafadb2add756a397f5369811c1..79622cda7ae25d1e7a115c5b1968e734770e6e60 100644 (file)
@@ -154,7 +154,8 @@ namespace internal
 
         /**
          * Read or write the data of this object to or from a stream for the
-         * purpose of serialization
+         * purpose of serialization using the [BOOST serialization
+         * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
          */
         template <class Archive>
         void
@@ -274,7 +275,8 @@ namespace internal
 
       /**
        * Read or write the data of this object to or from a stream for the
-       * purpose of serialization
+       * purpose of serialization using the [BOOST serialization
+       * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
        */
       template <class Archive>
       void
@@ -329,7 +331,8 @@ namespace internal
 
         /**
          * Write the data of this object to a stream for the purpose of
-         * serialization.
+         * serialization using the [BOOST serialization
+         * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
          */
         template <class Archive>
         void
index 61b04ad70c60c0745f6b590dfe8a2ffdd9bbcf77..eede1cc32bbe502a791fa843c447edbc59c39e99 100644 (file)
@@ -1623,7 +1623,9 @@ public:
     memory_consumption() const;
 
     /**
-     * Support for boost:serialization.
+     * Write and read the data of this object from a stream for the purpose
+     * of serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
      */
     template <class Archive>
     void
index 5374770b791b0309f8d1ff30c229383590c3af97..f38c84ada17db5f01161b615aea4cc87595334f2 100644 (file)
@@ -408,9 +408,9 @@ namespace LinearAlgebra
 
   private:
     /**
-     * Serialize the data of this object using boost. This function is
-     * necessary to use boost::archive::text_iarchive and
-     * boost::archive::text_oarchive.
+     * Write and read the data of this object from a stream for the purpose
+     * of serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
      */
     template <typename Archive>
     void
index f76681dd6c135ea3a679d7a67484ebde87daa746..5d318174adf0c5cbe732f5f9b25c19139961abd9 100644 (file)
@@ -661,7 +661,8 @@ public:
 
   /**
    * Write the data of this object to a stream for the purpose of
-   * serialization
+   * serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
@@ -669,7 +670,8 @@ public:
 
   /**
    * Read the data of this object from a stream for the purpose of
-   * serialization
+   * serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
@@ -678,7 +680,8 @@ public:
 #ifdef DOXYGEN
   /**
    * Write and read the data of this object from a stream for the purpose
-   * of serialization.
+   * of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
index 99171c9bfee12c111e6256a7acf3000597e72e64..221ff506a0a15f4a71cb97bd511ff31006d92844 100644 (file)
@@ -881,7 +881,8 @@ public:
 
   /**
    * Write the data of this object to a stream for the purpose of
-   * serialization.
+   * serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
@@ -889,7 +890,8 @@ public:
 
   /**
    * Read the data of this object from a stream for the purpose of
-   * serialization.
+   * serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
@@ -898,7 +900,8 @@ public:
 #ifdef DOXYGEN
   /**
    * Write and read the data of this object from a stream for the purpose
-   * of serialization.
+   * of serialization using the [BOOST serialization
+   * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
    */
   template <class Archive>
   void
index 7c54a29ba4cf965d547c43a4946adc911fb766b6..be64cdda4a560607cadf931cddaecbe6e9d0eb7d 100644 (file)
@@ -422,7 +422,8 @@ namespace Particles
 
     /**
      * Write the data of this object to a stream for the purpose of
-     * serialization.
+     * serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
      */
     template <class Archive>
     void
@@ -430,10 +431,12 @@ namespace Particles
 
     /**
      * Read the data of this object from a stream for the purpose of
-     * serialization. Note that in order to store the properties
-     * correctly, the property pool of this particle has to
-     * be known at the time of reading, i.e. set_property_pool()
-     * has to have been called, before this function is called.
+     * serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
+     * Note that in order to store the properties correctly, the property pool
+     * of this particle has to be known at the time of reading, i.e.
+     * set_property_pool() has to have been called, before this function is
+     * called.
      */
     template <class Archive>
     void
@@ -448,7 +451,8 @@ namespace Particles
 #ifdef DOXYGEN
     /**
      * Write and read the data of this object from a stream for the purpose
-     * of serialization.
+     * of serialization using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
      */
     template <class Archive>
     void
index 5cbd0f20c6415fee8924cde76888a36eb0c8e4ec..b5d271a6908b6269b05a79e6ed81479f8e84fc9d 100644 (file)
@@ -211,7 +211,8 @@ namespace Particles
       const Triangulation<dim, spacedim> &triangulation) const;
 
     /**
-     * Serialize the contents of this class.
+     * Serialize the contents of this class using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
      */
     template <class Archive>
     void
index c7d8632b244c61be0e97fe5457e16e5ea0c10ee8..fb9f6a45450e06e693e3af8d52a57efb3cd3a63b 100644 (file)
@@ -737,7 +737,8 @@ namespace Particles
     register_load_callback_function(const bool serialization);
 
     /**
-     * Serialize the contents of this class.
+     * Serialize the contents of this class using the [BOOST serialization
+     * library](https://www.boost.org/doc/libs/1_74_0/libs/serialization/doc/index.html).
      */
     template <class Archive>
     void

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.