[mlpack-git] master: Fix missing \endcode. (1140d93)

gitdub at mlpack.org gitdub at mlpack.org
Thu Apr 14 10:11:39 EDT 2016

Repository : https://github.com/mlpack/mlpack
On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/f73d89833d45e0870d97c133ad55094f494c8061...08ffa1b0c6d0a9fa05e2eb3dc9a993ea7fa97d54


commit 1140d938662c4879da19e21ee77d1e9a982afca6
Author: Ryan Curtin <ryan at ratml.org>
Date:   Wed Apr 13 15:27:18 2016 -0400

    Fix missing \endcode.


 doc/guide/formats.hpp | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/doc/guide/formats.hpp b/doc/guide/formats.hpp
index 236fce0..846ef59 100644
--- a/doc/guide/formats.hpp
+++ b/doc/guide/formats.hpp
@@ -95,6 +95,7 @@ matrix with 10 points in 3 dimensions and saves it to a file as HDF5.
 // 3 dimensions (rows), with 10 points (columns).
 arma::mat dataset = arma::randu<arma::mat>(3, 10);
 mlpack::data::Save("dataset.h5", dataset);
 As with the command-line programs, the type of data to be loaded is
 automatically detected from the filename extension.  For more details, see the
@@ -250,8 +251,9 @@ void Serialize(Archive& ar, const unsigned int version);
-For more information on this method and how it works, see the TODO: add link
-boost::serialization documentation.  Note that mlpack uses a \c Serialize()
+For more information on this method and how it works, see the
+boost::serialization documentation at http://www.boost.org/libs/serialization/doc/
+.  Note that mlpack uses a \c Serialize()
 method and not a \c serialize() method, and also mlpack uses the
 mlpack::data::CreateNVP() method instead of \c BOOST_SERIALIZATION_NVP() ; this
 is for coherence with the mlpack style guidelines, and is done via a
@@ -261,9 +263,10 @@ head to hurt!).
 Examples of Serialize() methods can be found in most classes; one fairly
-straightforward example is the mlpack::math::Range class (TODO: add link).  A
-more complex example is the mlpack::tree::BinarySpaceTree class (TODO: add
+straightforward example is found \ref mlpack::math::Range::Serialize()
+"in the mlpack::math::Range class".  A more complex example is found \ref
+"in the mlpack::tree::BinarySpaceTree class".
 Using the mlpack::data::Load() and mlpack::data::Save() classes is easy if the
 type being saved has a \c Serialize() method implemented: simply call either

More information about the mlpack-git mailing list