From ee338521442354523b5ae7e6fd752ea1355aade6 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Thu, 17 Dec 2020 14:38:47 -0700 Subject: [PATCH] Better document serialization functions. Specifically, equip all of them with a link to the BOOST library. --- include/deal.II/base/aligned_vector.h | 9 +++++--- include/deal.II/base/bounding_box.h | 4 +++- include/deal.II/base/data_out_base.h | 4 +++- include/deal.II/base/geometry_info.h | 3 ++- include/deal.II/base/index_set.h | 6 ++++-- include/deal.II/base/parameter_handler.h | 9 +++++--- include/deal.II/base/point.h | 3 ++- include/deal.II/base/polynomial.h | 3 ++- include/deal.II/base/polynomials_piecewise.h | 3 ++- include/deal.II/base/quadrature.h | 3 ++- include/deal.II/base/subscriptor.h | 3 ++- include/deal.II/base/symmetric_tensor.h | 3 ++- include/deal.II/base/table.h | 3 ++- include/deal.II/base/table_handler.h | 21 ++++++++++++------- include/deal.II/base/table_indices.h | 3 ++- include/deal.II/base/tensor.h | 6 ++++-- include/deal.II/base/utilities.h | 2 +- .../sd/symengine_number_types.h | 9 +++++--- .../sd/symengine_number_visitor_internal.h | 18 ++++++++++------ .../differentiation/sd/symengine_optimizer.h | 9 +++++--- include/deal.II/dofs/block_info.h | 3 ++- include/deal.II/dofs/dof_faces.h | 10 ++++++--- include/deal.II/dofs/dof_handler.h | 9 +++++--- include/deal.II/dofs/dof_levels.h | 3 ++- include/deal.II/dofs/dof_objects.h | 3 ++- include/deal.II/dofs/number_cache.h | 3 ++- include/deal.II/grid/cell_id.h | 4 +++- include/deal.II/grid/grid_tools.h | 12 +++++++---- include/deal.II/grid/tria.h | 19 +++++++++++------ include/deal.II/grid/tria_description.h | 12 ++++++++--- include/deal.II/grid/tria_faces.h | 3 ++- include/deal.II/grid/tria_levels.h | 3 ++- include/deal.II/grid/tria_objects.h | 9 +++++--- include/deal.II/lac/affine_constraints.h | 4 +++- include/deal.II/lac/la_vector.h | 6 +++--- include/deal.II/lac/sparsity_pattern.h | 9 +++++--- include/deal.II/lac/vector.h | 9 +++++--- include/deal.II/particles/particle.h | 16 ++++++++------ include/deal.II/particles/particle_accessor.h | 3 ++- include/deal.II/particles/particle_handler.h | 3 ++- 40 files changed, 179 insertions(+), 88 deletions(-) diff --git a/include/deal.II/base/aligned_vector.h b/include/deal.II/base/aligned_vector.h index 3dd7b8f207..09e23fdcd4 100644 --- a/include/deal.II/base/aligned_vector.h +++ b/include/deal.II/base/aligned_vector.h @@ -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 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 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 void diff --git a/include/deal.II/base/bounding_box.h b/include/deal.II/base/bounding_box.h index 937783de0e..5dc7b4f588 100644 --- a/include/deal.II/base/bounding_box.h +++ b/include/deal.II/base/bounding_box.h @@ -289,7 +289,9 @@ public: unit_to_real(const Point &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 void diff --git a/include/deal.II/base/data_out_base.h b/include/deal.II/base/data_out_base.h index bbb6e8827a..360827dfd5 100644 --- a/include/deal.II/base/data_out_base.h +++ b/include/deal.II/base/data_out_base.h @@ -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 void diff --git a/include/deal.II/base/geometry_info.h b/include/deal.II/base/geometry_info.h index 8733379113..742db3c826 100644 --- a/include/deal.II/base/geometry_info.h +++ b/include/deal.II/base/geometry_info.h @@ -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 void diff --git a/include/deal.II/base/index_set.h b/include/deal.II/base/index_set.h index 57573a7335..d0a8623893 100644 --- a/include/deal.II/base/index_set.h +++ b/include/deal.II/base/index_set.h @@ -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 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 void diff --git a/include/deal.II/base/parameter_handler.h b/include/deal.II/base/parameter_handler.h index 9f2b797d3f..31bca948d8 100644 --- a/include/deal.II/base/parameter_handler.h +++ b/include/deal.II/base/parameter_handler.h @@ -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 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 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 void diff --git a/include/deal.II/base/point.h b/include/deal.II/base/point.h index 90f31615c5..2ce148c52e 100644 --- a/include/deal.II/base/point.h +++ b/include/deal.II/base/point.h @@ -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 void diff --git a/include/deal.II/base/polynomial.h b/include/deal.II/base/polynomial.h index 1c708c8cd5..0fd72994cf 100644 --- a/include/deal.II/base/polynomial.h +++ b/include/deal.II/base/polynomial.h @@ -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 void diff --git a/include/deal.II/base/polynomials_piecewise.h b/include/deal.II/base/polynomials_piecewise.h index 20cd47a9e2..e8fa4ff67d 100644 --- a/include/deal.II/base/polynomials_piecewise.h +++ b/include/deal.II/base/polynomials_piecewise.h @@ -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 void diff --git a/include/deal.II/base/quadrature.h b/include/deal.II/base/quadrature.h index c38164901f..b46bf0ccf8 100644 --- a/include/deal.II/base/quadrature.h +++ b/include/deal.II/base/quadrature.h @@ -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 void diff --git a/include/deal.II/base/subscriptor.h b/include/deal.II/base/subscriptor.h index 7f136b4e0b..b528c086f0 100644 --- a/include/deal.II/base/subscriptor.h +++ b/include/deal.II/base/subscriptor.h @@ -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 diff --git a/include/deal.II/base/symmetric_tensor.h b/include/deal.II/base/symmetric_tensor.h index 8d116fb9be..3069872708 100644 --- a/include/deal.II/base/symmetric_tensor.h +++ b/include/deal.II/base/symmetric_tensor.h @@ -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 void diff --git a/include/deal.II/base/table.h b/include/deal.II/base/table.h index e0d8bf351f..d30ddab387 100644 --- a/include/deal.II/base/table.h +++ b/include/deal.II/base/table.h @@ -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 void diff --git a/include/deal.II/base/table_handler.h b/include/deal.II/base/table_handler.h index 93425c3c4b..02cb475574 100644 --- a/include/deal.II/base/table_handler.h +++ b/include/deal.II/base/table_handler.h @@ -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 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 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 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 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 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 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 void diff --git a/include/deal.II/base/table_indices.h b/include/deal.II/base/table_indices.h index bc9196f53e..a72f4b65be 100644 --- a/include/deal.II/base/table_indices.h +++ b/include/deal.II/base/table_indices.h @@ -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 void diff --git a/include/deal.II/base/tensor.h b/include/deal.II/base/tensor.h index 4cddefe90f..c5e1e57166 100644 --- a/include/deal.II/base/tensor.h +++ b/include/deal.II/base/tensor.h @@ -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 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 void diff --git a/include/deal.II/base/utilities.h b/include/deal.II/base/utilities.h index 84428a1f39..b545314492 100644 --- a/include/deal.II/base/utilities.h +++ b/include/deal.II/base/utilities.h @@ -1384,7 +1384,7 @@ namespace boost namespace serialization { // Provides boost and c++11 with a way to serialize tuples and pairs - // automatically + // automatically. template struct Serialize { diff --git a/include/deal.II/differentiation/sd/symengine_number_types.h b/include/deal.II/differentiation/sd/symengine_number_types.h index 3d430e2b90..13ac0572a2 100644 --- a/include/deal.II/differentiation/sd/symengine_number_types.h +++ b/include/deal.II/differentiation/sd/symengine_number_types.h @@ -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. diff --git a/include/deal.II/differentiation/sd/symengine_number_visitor_internal.h b/include/deal.II/differentiation/sd/symengine_number_visitor_internal.h index c3a15ff721..b8872beec5 100644 --- a/include/deal.II/differentiation/sd/symengine_number_visitor_internal.h +++ b/include/deal.II/differentiation/sd/symengine_number_visitor_internal.h @@ -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 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 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 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 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 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 void diff --git a/include/deal.II/differentiation/sd/symengine_optimizer.h b/include/deal.II/differentiation/sd/symengine_optimizer.h index 784b93bab1..440f15761b 100644 --- a/include/deal.II/differentiation/sd/symengine_optimizer.h +++ b/include/deal.II/differentiation/sd/symengine_optimizer.h @@ -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. diff --git a/include/deal.II/dofs/block_info.h b/include/deal.II/dofs/block_info.h index 3cbbfaa066..a1464c6499 100644 --- a/include/deal.II/dofs/block_info.h +++ b/include/deal.II/dofs/block_info.h @@ -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 void diff --git a/include/deal.II/dofs/dof_faces.h b/include/deal.II/dofs/dof_faces.h index 68931e711d..051c7326e9 100644 --- a/include/deal.II/dofs/dof_faces.h +++ b/include/deal.II/dofs/dof_faces.h @@ -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 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 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 void diff --git a/include/deal.II/dofs/dof_handler.h b/include/deal.II/dofs/dof_handler.h index 47ecf1098f..6930091e8f 100644 --- a/include/deal.II/dofs/dof_handler.h +++ b/include/deal.II/dofs/dof_handler.h @@ -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 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 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 void diff --git a/include/deal.II/dofs/dof_levels.h b/include/deal.II/dofs/dof_levels.h index 4512e520e1..09ca461de2 100644 --- a/include/deal.II/dofs/dof_levels.h +++ b/include/deal.II/dofs/dof_levels.h @@ -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 void diff --git a/include/deal.II/dofs/dof_objects.h b/include/deal.II/dofs/dof_objects.h index 2546dd7d7b..fb67727511 100644 --- a/include/deal.II/dofs/dof_objects.h +++ b/include/deal.II/dofs/dof_objects.h @@ -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 void diff --git a/include/deal.II/dofs/number_cache.h b/include/deal.II/dofs/number_cache.h index 59f1839d8f..1db088fdf8 100644 --- a/include/deal.II/dofs/number_cache.h +++ b/include/deal.II/dofs/number_cache.h @@ -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 void diff --git a/include/deal.II/grid/cell_id.h b/include/deal.II/grid/cell_id.h index d1716bb6a4..78fdfb03eb 100644 --- a/include/deal.II/grid/cell_id.h +++ b/include/deal.II/grid/cell_id.h @@ -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 void diff --git a/include/deal.II/grid/grid_tools.h b/include/deal.II/grid/grid_tools.h index 59c6425942..5352abbc1a 100644 --- a/include/deal.II/grid/grid_tools.h +++ b/include/deal.II/grid/grid_tools.h @@ -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 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 void diff --git a/include/deal.II/grid/tria.h b/include/deal.II/grid/tria.h index d98377b26e..058550145c 100644 --- a/include/deal.II/grid/tria.h +++ b/include/deal.II/grid/tria.h @@ -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 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 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 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 all 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 all 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 void diff --git a/include/deal.II/grid/tria_description.h b/include/deal.II/grid/tria_description.h index 0c89189522..6e26bb81f2 100644 --- a/include/deal.II/grid/tria_description.h +++ b/include/deal.II/grid/tria_description.h @@ -131,7 +131,9 @@ struct CellData operator==(const CellData &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 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 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 void diff --git a/include/deal.II/grid/tria_faces.h b/include/deal.II/grid/tria_faces.h index 8c79e57576..ec7cfeb213 100644 --- a/include/deal.II/grid/tria_faces.h +++ b/include/deal.II/grid/tria_faces.h @@ -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 void diff --git a/include/deal.II/grid/tria_levels.h b/include/deal.II/grid/tria_levels.h index ca6a26ebee..557f332900 100644 --- a/include/deal.II/grid/tria_levels.h +++ b/include/deal.II/grid/tria_levels.h @@ -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 void diff --git a/include/deal.II/grid/tria_objects.h b/include/deal.II/grid/tria_objects.h index 1baef00122..79622cda7a 100644 --- a/include/deal.II/grid/tria_objects.h +++ b/include/deal.II/grid/tria_objects.h @@ -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 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 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 void diff --git a/include/deal.II/lac/affine_constraints.h b/include/deal.II/lac/affine_constraints.h index 61b04ad70c..eede1cc32b 100644 --- a/include/deal.II/lac/affine_constraints.h +++ b/include/deal.II/lac/affine_constraints.h @@ -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 void diff --git a/include/deal.II/lac/la_vector.h b/include/deal.II/lac/la_vector.h index 5374770b79..f38c84ada1 100644 --- a/include/deal.II/lac/la_vector.h +++ b/include/deal.II/lac/la_vector.h @@ -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 void diff --git a/include/deal.II/lac/sparsity_pattern.h b/include/deal.II/lac/sparsity_pattern.h index f76681dd6c..5d318174ad 100644 --- a/include/deal.II/lac/sparsity_pattern.h +++ b/include/deal.II/lac/sparsity_pattern.h @@ -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 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 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 void diff --git a/include/deal.II/lac/vector.h b/include/deal.II/lac/vector.h index 99171c9bfe..221ff506a0 100644 --- a/include/deal.II/lac/vector.h +++ b/include/deal.II/lac/vector.h @@ -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 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 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 void diff --git a/include/deal.II/particles/particle.h b/include/deal.II/particles/particle.h index 7c54a29ba4..be64cdda4a 100644 --- a/include/deal.II/particles/particle.h +++ b/include/deal.II/particles/particle.h @@ -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 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 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 void diff --git a/include/deal.II/particles/particle_accessor.h b/include/deal.II/particles/particle_accessor.h index 5cbd0f20c6..b5d271a690 100644 --- a/include/deal.II/particles/particle_accessor.h +++ b/include/deal.II/particles/particle_accessor.h @@ -211,7 +211,8 @@ namespace Particles const Triangulation &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 void diff --git a/include/deal.II/particles/particle_handler.h b/include/deal.II/particles/particle_handler.h index c7d8632b24..fb9f6a4545 100644 --- a/include/deal.II/particles/particle_handler.h +++ b/include/deal.II/particles/particle_handler.h @@ -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 void -- 2.39.5