diff --git a/docs/md/checkpoint_learn_example_2.md b/docs/md/checkpoint_learn_example_2.md index 65cc5539..3cce924f 100644 --- a/docs/md/checkpoint_learn_example_2.md +++ b/docs/md/checkpoint_learn_example_2.md @@ -3,6 +3,6 @@ The full code for this *checkpoint* example can be found here: `examples/checkpoint_example_2.cc` -\subsubsection ex Example source code: +\subsubsection ex2 Example source code: \snippet examples/checkpoint_example_2.cc Serialize custom structure diff --git a/docs/md/checkpoint_learn_example_2_nonintrusive.md b/docs/md/checkpoint_learn_example_2_nonintrusive.md index 68c64780..1178d948 100644 --- a/docs/md/checkpoint_learn_example_2_nonintrusive.md +++ b/docs/md/checkpoint_learn_example_2_nonintrusive.md @@ -5,6 +5,6 @@ The full code for this *checkpoint* example can be found here: `examples/checkpoint_example_2_nonintrusive.cc` -\subsubsection ex Example source code: +\subsubsection ex2 Example source code: \snippet examples/checkpoint_example_2_nonintrusive.cc Non-Intrusive Serialize custom structure diff --git a/docs/md/checkpoint_learn_example_3_nonintrusive.md b/docs/md/checkpoint_learn_example_3_nonintrusive.md index e8d0d2dd..46c95b6d 100644 --- a/docs/md/checkpoint_learn_example_3_nonintrusive.md +++ b/docs/md/checkpoint_learn_example_3_nonintrusive.md @@ -5,5 +5,5 @@ The full code for this *checkpoint* example can be found here: `examples/checkpoint_example_3_nonintrusive.cc` -\subsubsection ex Example source code: +\subsubsection ex3 Example source code: \snippet examples/checkpoint_example_3_nonintrusive.cc Non-Intrusive Serialize constraints constructor destructor diff --git a/docs/md/checkpoint_learn_example_polymorphic_macro_nonintrusive.md b/docs/md/checkpoint_learn_example_polymorphic_macro_nonintrusive.md index ddf7073c..b1a7b7a0 100644 --- a/docs/md/checkpoint_learn_example_polymorphic_macro_nonintrusive.md +++ b/docs/md/checkpoint_learn_example_polymorphic_macro_nonintrusive.md @@ -1,9 +1,9 @@ -\page ckpt_learn_example_polymorphic_macro_nonintrusive Non-Intrusive Polymorphic Serialization Example w/Macros +\page ckpt_learn_ex6_polymorphic_macro_nonintrusive Non-Intrusive Polymorphic Serialization Example w/Macros \attention All Non-Intrusive serialize methods MUST be placed in the namespace of type which they serialize. The full code for this *checkpoint* example can be found here: `examples/checkpoint_example_polymorphic_macro_nonintrusive.cc` -\subsubsection ex Example source code: +\subsubsection ex6 Example source code: \snippet examples/checkpoint_example_polymorphic_macro_nonintrusive.cc Non-Intrusive Serialize polymorphic macro diff --git a/docs/md/checkpoint_learn_example_polymorphic_nonintrusive.md b/docs/md/checkpoint_learn_example_polymorphic_nonintrusive.md index 0250f876..28c57395 100644 --- a/docs/md/checkpoint_learn_example_polymorphic_nonintrusive.md +++ b/docs/md/checkpoint_learn_example_polymorphic_nonintrusive.md @@ -1,9 +1,9 @@ -\page ckpt_learn_example_polymorphic_nonintrusive Non-Intrusive Polymorphic Serialization Example +\page ckpt_learn_ex5_polymorphic_nonintrusive Non-Intrusive Polymorphic Serialization Example \attention All Non-Intrusive serialize methods MUST be placed in the namespace of type which they serialize. The full code for this *checkpoint* example can be found here: `examples/checkpoint_example_polymorphic_nonintrusive.cc` -\subsubsection ex Example source code: +\subsubsection ex5 Example source code: \snippet examples/checkpoint_example_polymorphic_nonintrusive.cc Non-Intrusive Serialize polymorphic diff --git a/docs/md/checkpoint_learn_example_to_file.md b/docs/md/checkpoint_learn_example_to_file.md index 5300ea7b..1f37945d 100644 --- a/docs/md/checkpoint_learn_example_to_file.md +++ b/docs/md/checkpoint_learn_example_to_file.md @@ -1,4 +1,4 @@ -\page ckpt_learn_ex_tofile Program Example Serialize To File +\page ckpt_learn_ex4_tofile Program Example Serialize To File One potential application for this approach is to generate a restart file for a simulation. @@ -6,5 +6,5 @@ for a simulation. The full code for this example can be found here: `examples/checkpoint_example_to_file.cc` -\subsubsection ex Example source code: +\subsubsection ex4 Example source code: \snippet examples/checkpoint_example_to_file.cc Serialize structure to file diff --git a/docs/md/checkpoint_learn_example_to_file_nonintrusive.md b/docs/md/checkpoint_learn_example_to_file_nonintrusive.md index e60ceb27..d1cab45c 100644 --- a/docs/md/checkpoint_learn_example_to_file_nonintrusive.md +++ b/docs/md/checkpoint_learn_example_to_file_nonintrusive.md @@ -1,4 +1,4 @@ -\page ckpt_learn_ex_tofile_nonintrusive Non-Intrusive Program Example Serialize To File +\page ckpt_learn_ex4_tofile_nonintrusive Non-Intrusive Program Example Serialize To File \attention All Non-Intrusive serialize methods MUST be placed in the namespace of type which they serialize. @@ -8,5 +8,5 @@ for a simulation. The full code for this example can be found here: `examples/checkpoint_example_to_file_nonintrusive.cc` -\subsubsection ex Example source code: +\subsubsection ex4 Example source code: \snippet examples/checkpoint_example_to_file_nonintrusive.cc Non-Intrusive Serialize structure to file diff --git a/docs/md/checkpoint_learn_example_traversal.md b/docs/md/checkpoint_learn_example_traversal.md index 7b0e18ce..132948c7 100644 --- a/docs/md/checkpoint_learn_example_traversal.md +++ b/docs/md/checkpoint_learn_example_traversal.md @@ -1,8 +1,8 @@ -\page ckpt_learn_ex_traversal Program Example Traversal +\page ckpt_learn_ex7_traversal Program Example Traversal The full code for this *checkpoint* example can be found here: `examples/checkpoint_example_traversal.cc` -\subsubsection ex Example source code: +\subsubsection ex7 Example source code: \snippet examples/checkpoint_example_traversal.cc Serialization with custom traverser diff --git a/docs/md/checkpoint_learn_example_traversal_nonintrusive.md b/docs/md/checkpoint_learn_example_traversal_nonintrusive.md index 87351450..59dea49b 100644 --- a/docs/md/checkpoint_learn_example_traversal_nonintrusive.md +++ b/docs/md/checkpoint_learn_example_traversal_nonintrusive.md @@ -1,10 +1,10 @@ -\page ckpt_learn_ex_traversal_nonintrusive Non-Intrusive Program Example Traversal +\page ckpt_learn_ex7_traversal_nonintrusive Non-Intrusive Program Example Traversal \attention All Non-Intrusive serialize methods MUST be placed in the namespace of type which they serialize. The full code for this *checkpoint* example can be found here: `examples/checkpoint_example_traversal_nonintrusive.cc` -\subsubsection ex Example source code: +\subsubsection ex7 Example source code: \snippet examples/checkpoint_example_traversal_nonintrusive.cc Non-Intrusive Serialization with custom traverser diff --git a/docs/md/checkpoint_learn_examples.md b/docs/md/checkpoint_learn_examples.md index 73967bd5..27551159 100644 --- a/docs/md/checkpoint_learn_examples.md +++ b/docs/md/checkpoint_learn_examples.md @@ -5,10 +5,10 @@ | checkpoint_example_1 | Serialization of a structure | \subpage ckpt_learn_ex1 | | checkpoint_example_2 | Serialization of a custom structure | \subpage ckpt_learn_ex2 | | checkpoint_example_3 | Illustrate needs for constructor/destructor | \subpage ckpt_learn_ex3 | -| checkpoint_example_to_file | Serialize / deserialize structure to file | \subpage ckpt_learn_ex_tofile | -| checkpoint_example_polymorphic | Serialization of polymorphic class hierarchy | \subpage ckpt_learn_example_polymorphic | -| checkpoint_example_polymorphic_macro | Serialization of polymorphic class hierarchy with macros | \subpage ckpt_learn_example_polymorphic_macro | -| checkpoint_example_traversal | Serialization with custom traverser | \subpage ckpt_learn_ex_traversal | +| checkpoint_example_4_to_file | Serialize / deserialize structure to file | \subpage ckpt_learn_ex4_tofile | +| checkpoint_example_5_polymorphic | Serialization of polymorphic class hierarchy | \subpage ckpt_learn_ex5_polymorphic | +| checkpoint_example_6_polymorphic_macro | Serialization of polymorphic class hierarchy with macros | \subpage ckpt_learn_ex6_polymorphic_macro | +| checkpoint_example_7_traversal | Serialization with custom traverser | \subpage ckpt_learn_ex7_traversal |     @@ -21,7 +21,7 @@ Please do not put serialize methods in global magistrate namespace. | checkpoint_example_1 | Serialization of a structure | \subpage ckpt_learn_ex1_nonintrusive | | checkpoint_example_2 | Serialization of a custom structure | \subpage ckpt_learn_ex2_nonintrusive | | checkpoint_example_3 | Illustrate needs for constructor/destructor | \subpage ckpt_learn_ex3_nonintrusive | -| checkpoint_example_to_file | Serialize / deserialize structure to file | \subpage ckpt_learn_ex_tofile_nonintrusive | -| checkpoint_example_polymorphic | Serialization of polymorphic class hierarchy | \subpage ckpt_learn_example_polymorphic_nonintrusive | -| checkpoint_example_polymorphic_macro | Serialization of polymorphic class hierarchy with macros | \subpage ckpt_learn_example_polymorphic_macro_nonintrusive | -| checkpoint_example_traversal | Serialization with custom traverser | \subpage ckpt_learn_ex_traversal_nonintrusive | +| checkpoint_example_4_to_file | Serialize / deserialize structure to file | \subpage ckpt_learn_ex4_tofile_nonintrusive | +| checkpoint_example_5_polymorphic | Serialization of polymorphic class hierarchy | \subpage ckpt_learn_ex5_polymorphic_nonintrusive | +| checkpoint_example_6_polymorphic_macro | Serialization of polymorphic class hierarchy with macros | \subpage ckpt_learn_ex6_polymorphic_macro_nonintrusive | +| checkpoint_example_7_traversal | Serialization with custom traverser | \subpage ckpt_learn_ex7_traversal_nonintrusive | diff --git a/docs/shared/checkpoint_learn_example_polymorphic.md b/docs/shared/checkpoint_learn_example_polymorphic.md index 2bca6c48..29c79394 100644 --- a/docs/shared/checkpoint_learn_example_polymorphic.md +++ b/docs/shared/checkpoint_learn_example_polymorphic.md @@ -1,4 +1,4 @@ -\page ckpt_learn_example_polymorphic Polymorphic Serialization Example +\page ckpt_learn_ex5_polymorphic Polymorphic Serialization Example The full code for this *checkpoint* example can be found here: `examples/checkpoint_example_polymorphic.cc` diff --git a/docs/shared/checkpoint_learn_example_polymorphic_macro.md b/docs/shared/checkpoint_learn_example_polymorphic_macro.md index 293899f8..98c6c103 100644 --- a/docs/shared/checkpoint_learn_example_polymorphic_macro.md +++ b/docs/shared/checkpoint_learn_example_polymorphic_macro.md @@ -1,4 +1,4 @@ -\page ckpt_learn_example_polymorphic_macro Polymorphic Serialization Example w/Macros +\page ckpt_learn_ex6_polymorphic_macro Polymorphic Serialization Example w/Macros The full code for this *checkpoint* example can be found here: `examples/checkpoint_example_polymorphic_macro.cc` diff --git a/docs/shared/checkpoint_learn_serialize.md b/docs/shared/checkpoint_learn_serialize.md index ac6ea82d..24fcbda5 100644 --- a/docs/shared/checkpoint_learn_serialize.md +++ b/docs/shared/checkpoint_learn_serialize.md @@ -88,7 +88,7 @@ hierarchy so it can automatically traverse the hierarchy. Alternatively, the user may use the inheritance wrappers `checkpoint::SerializableBase` and `checkpoint::SerializableDerived` to achieve the same effect. -The example in \ref ckpt_learn_example_polymorphic_macro illustrates the +The example in \ref ckpt_learn_ex6_polymorphic_macro illustrates the approach uses the macros. The example in \ref ckpt_learn_example_polymorphic illustrates this approach.