From 38d6d25e55765f681362b32a64b3db811404cbfe Mon Sep 17 00:00:00 2001 From: Jean-Paul Pelteret Date: Sat, 25 Apr 2020 14:39:58 +0200 Subject: [PATCH] Add documentation for hidden serialize() functions --- include/deal.II/base/aligned_vector.h | 12 +++++++++ include/deal.II/base/parameter_handler.h | 12 +++++++++ include/deal.II/base/table_handler.h | 34 ++++++++++++++++++++++-- include/deal.II/dofs/dof_handler.h | 12 +++++++++ include/deal.II/grid/grid_tools.h | 12 +++++++++ include/deal.II/grid/tria.h | 13 ++++++++- include/deal.II/hp/dof_handler.h | 12 +++++++++ include/deal.II/lac/sparsity_pattern.h | 24 +++++++++++++++++ include/deal.II/lac/vector.h | 12 +++++++++ include/deal.II/particles/particle.h | 12 +++++++++ 10 files changed, 152 insertions(+), 3 deletions(-) diff --git a/include/deal.II/base/aligned_vector.h b/include/deal.II/base/aligned_vector.h index 485a5930b7..e8e041a35d 100644 --- a/include/deal.II/base/aligned_vector.h +++ b/include/deal.II/base/aligned_vector.h @@ -327,7 +327,19 @@ public: void load(Archive &ar, const unsigned int version); +#ifdef DOXYGEN + /** + * Write and read the data of this object from a stream for the purpose + * of serialization. + */ + template + void + serialize(Archive &archive, const unsigned int version); +#else + // This macro defines the serialize() method that is compatible with + // the templated save() and load() method that have been implemented. BOOST_SERIALIZATION_SPLIT_MEMBER() +#endif private: /** diff --git a/include/deal.II/base/parameter_handler.h b/include/deal.II/base/parameter_handler.h index e198a5613e..2699965e4f 100644 --- a/include/deal.II/base/parameter_handler.h +++ b/include/deal.II/base/parameter_handler.h @@ -1537,7 +1537,19 @@ public: void load(Archive &ar, const unsigned int version); +#ifdef DOXYGEN + /** + * Write and read the data of this object from a stream for the purpose + * of serialization. + */ + template + void + serialize(Archive &archive, const unsigned int version); +#else + // This macro defines the serialize() method that is compatible with + // the templated save() and load() method that have been implemented. BOOST_SERIALIZATION_SPLIT_MEMBER() +#endif /** * Test for equality. diff --git a/include/deal.II/base/table_handler.h b/include/deal.II/base/table_handler.h index aef7443dc1..5ba8988053 100644 --- a/include/deal.II/base/table_handler.h +++ b/include/deal.II/base/table_handler.h @@ -129,7 +129,19 @@ namespace internal void load(Archive &ar, const unsigned int version); +#ifdef DOXYGEN + /** + * Write and read the data of this object from a stream for the purpose + * of serialization. + */ + template + void + serialize(Archive &archive, const unsigned int version); +#else + // This macro defines the serialize() method that is compatible with + // the templated save() and load() method that have been implemented. BOOST_SERIALIZATION_SPLIT_MEMBER() +#endif private: /** @@ -631,16 +643,34 @@ protected: pad_column_below(const unsigned int length); /** - * Read or write the data of this object to or from a stream for the - * purpose of serialization. + * Write the data of this object to a stream for the purpose of + * serialization. */ template void save(Archive &ar, const unsigned int version) const; + + /** + * Read the data of this object from a stream for the purpose of + * serialization. + */ template void load(Archive &ar, const unsigned int version); + +#ifdef DOXYGEN + /** + * Write and read the data of this object from a stream for the purpose + * of serialization. + */ + template + void + serialize(Archive &archive, const unsigned int version); +#else + // This macro defines the serialize() method that is compatible with + // the templated save() and load() method that have been implemented. BOOST_SERIALIZATION_SPLIT_MEMBER() +#endif /** diff --git a/include/deal.II/dofs/dof_handler.h b/include/deal.II/dofs/dof_handler.h index db99c0dd48..33e5c8ee95 100644 --- a/include/deal.II/dofs/dof_handler.h +++ b/include/deal.II/dofs/dof_handler.h @@ -1174,7 +1174,19 @@ public: void load(Archive &ar, const unsigned int version); +#ifdef DOXYGEN + /** + * Write and read the data of this object from a stream for the purpose + * of serialization. + */ + template + void + serialize(Archive &archive, const unsigned int version); +#else + // This macro defines the serialize() method that is compatible with + // the templated save() and load() method that have been implemented. BOOST_SERIALIZATION_SPLIT_MEMBER() +#endif /** * Exception diff --git a/include/deal.II/grid/grid_tools.h b/include/deal.II/grid/grid_tools.h index b8cb641a6e..0d182b614b 100644 --- a/include/deal.II/grid/grid_tools.h +++ b/include/deal.II/grid/grid_tools.h @@ -3030,7 +3030,19 @@ namespace GridTools void load(Archive &ar, const unsigned int version); +# ifdef DOXYGEN + /** + * Write and read the data of this object from a stream for the purpose + * of serialization. + */ + template + void + serialize(Archive &archive, const unsigned int version); +# else + // This macro defines the serialize() method that is compatible with + // the templated save() and load() method that have been implemented. BOOST_SERIALIZATION_SPLIT_MEMBER() +# endif }; /** diff --git a/include/deal.II/grid/tria.h b/include/deal.II/grid/tria.h index 0c40ea2ef4..3dc59c6bfc 100644 --- a/include/deal.II/grid/tria.h +++ b/include/deal.II/grid/tria.h @@ -3340,8 +3340,19 @@ public: coarse_cell_index_to_coarse_cell_id( const unsigned int coarse_cell_index) const; - +#ifdef DOXYGEN + /** + * Write and read the data of this object from a stream for the purpose + * of serialization. + */ + template + void + serialize(Archive &archive, const unsigned int version); +#else + // This macro defines the serialize() method that is compatible with + // the templated save() and load() method that have been implemented. BOOST_SERIALIZATION_SPLIT_MEMBER() +#endif /** * @name Exceptions diff --git a/include/deal.II/hp/dof_handler.h b/include/deal.II/hp/dof_handler.h index a6514f9447..336442d943 100644 --- a/include/deal.II/hp/dof_handler.h +++ b/include/deal.II/hp/dof_handler.h @@ -1025,7 +1025,19 @@ namespace hp void load(Archive &ar, const unsigned int version); +#ifdef DOXYGEN + /** + * Write and read the data of this object from a stream for the purpose + * of serialization. + */ + template + void + serialize(Archive &archive, const unsigned int version); +#else + // This macro defines the serialize() method that is compatible with + // the templated save() and load() method that have been implemented. BOOST_SERIALIZATION_SPLIT_MEMBER() +#endif /** * Exception diff --git a/include/deal.II/lac/sparsity_pattern.h b/include/deal.II/lac/sparsity_pattern.h index 68b98d153e..7158255a20 100644 --- a/include/deal.II/lac/sparsity_pattern.h +++ b/include/deal.II/lac/sparsity_pattern.h @@ -680,7 +680,19 @@ public: void load(Archive &ar, const unsigned int version); +#ifdef DOXYGEN + /** + * Write and read the data of this object from a stream for the purpose + * of serialization. + */ + template + void + serialize(Archive &archive, const unsigned int version); +#else + // This macro defines the serialize() method that is compatible with + // the templated save() and load() method that have been implemented. BOOST_SERIALIZATION_SPLIT_MEMBER() +#endif // @} @@ -1257,7 +1269,19 @@ public: void load(Archive &ar, const unsigned int version); +#ifdef DOXYGEN + /** + * Write and read the data of this object from a stream for the purpose + * of serialization. + */ + template + void + serialize(Archive &archive, const unsigned int version); +#else + // This macro defines the serialize() method that is compatible with + // the templated save() and load() method that have been implemented. BOOST_SERIALIZATION_SPLIT_MEMBER() +#endif // @} diff --git a/include/deal.II/lac/vector.h b/include/deal.II/lac/vector.h index 54820a90ec..a2af8375b1 100644 --- a/include/deal.II/lac/vector.h +++ b/include/deal.II/lac/vector.h @@ -898,7 +898,19 @@ public: void load(Archive &ar, const unsigned int version); +#ifdef DOXYGEN + /** + * Write and read the data of this object from a stream for the purpose + * of serialization. + */ + template + void + serialize(Archive &archive, const unsigned int version); +#else + // This macro defines the serialize() method that is compatible with + // the templated save() and load() method that have been implemented. BOOST_SERIALIZATION_SPLIT_MEMBER() +#endif /** * @} diff --git a/include/deal.II/particles/particle.h b/include/deal.II/particles/particle.h index 4e3727ead5..59eff734ea 100644 --- a/include/deal.II/particles/particle.h +++ b/include/deal.II/particles/particle.h @@ -355,7 +355,19 @@ namespace Particles void load(Archive &ar, const unsigned int version); +#ifdef DOXYGEN + /** + * Write and read the data of this object from a stream for the purpose + * of serialization. + */ + template + void + serialize(Archive &archive, const unsigned int version); +#else + // This macro defines the serialize() method that is compatible with + // the templated save() and load() method that have been implemented. BOOST_SERIALIZATION_SPLIT_MEMBER() +#endif private: /** -- 2.39.5