From 514f88b0eb7653b0b0a716e1e416dbfe9ad81012 Mon Sep 17 00:00:00 2001
From: tastytea <tastytea@tastytea.de>
Date: Sat, 27 Jul 2019 22:29:43 +0200
Subject: [PATCH] Documented ExportBase.

---
 src/lib/export/export.hpp | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/src/lib/export/export.hpp b/src/lib/export/export.hpp
index 1eddfdd..737708e 100644
--- a/src/lib/export/export.hpp
+++ b/src/lib/export/export.hpp
@@ -32,16 +32,31 @@ namespace Export
     class ExportBase
     {
     public:
+        /*!
+         *  @brief   Export vector of Database::entry.
+         *
+         *  @param   entries Vector of Database::entry to export.
+         *  @param   out     Output stream.
+         */
         explicit ExportBase(const vector<Database::entry> &entries,
                             ostream &out = cout);
 
+        /*!
+         *  @brief   Print output to std::ostream.
+         */
         virtual void print() const = 0;
 
     protected:
         const vector<Database::entry> _entries;
         ostream &_out;
 
-        //! Sort entries from newest to oldest.
+        /*!
+         *  @brief   Sort entries from newest to oldest.
+         *
+         *  @param   entries Vector of Database::entry to sort.
+         *
+         *  @return  Sorted vector of Database::entry.
+         */
         const vector<Database::entry>
         sort_entries(vector<Database::entry> entries) const;
     };