From ce193e034dbaf8978630fa15d0d9b1af13f7df8e Mon Sep 17 00:00:00 2001
From: Mark Abraham <mark.j.abraham@gmail.com>
Date: Tue, 20 Dec 2016 16:53:52 +1100
Subject: [PATCH] Document ISerializer class

Change-Id: I85f84bb2538a8583781a62b8f1789701939b8c69
---
 src/gromacs/utility/iserializer.h | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/src/gromacs/utility/iserializer.h b/src/gromacs/utility/iserializer.h
index 52b4f88dd8..64fdf96384 100644
--- a/src/gromacs/utility/iserializer.h
+++ b/src/gromacs/utility/iserializer.h
@@ -48,18 +48,29 @@
 namespace gmx
 {
 
+/*! \libinternal
+ * \brief Interface for types that convert standard data types into a
+ * form suitable for storage or transfer.
+ *
+ * Different implementations could suit MPI, file I/O, or in-memory
+ * conversion. */
 class ISerializer
 {
     public:
+        //! Destructor.
         virtual ~ISerializer() {}
-
+        /*! \brief Returns whether the serializer is reading or
+         * writing, because details like memory management vary
+         * accordingly. */
         virtual bool reading() const = 0;
-
+        //! \brief Serialize values of different types.
+        ///@{
         virtual void doUChar(unsigned char *value) = 0;
         virtual void doInt(int *value)             = 0;
         virtual void doFloat(float *value)         = 0;
         virtual void doDouble(double *value)       = 0;
         virtual void doString(std::string *value)  = 0;
+        ///@}
 };
 
 } // namespace gmx
-- 
2.11.4.GIT