From a167c3e2222b969a4aa65801ee1c0bc891928bea Mon Sep 17 00:00:00 2001 From: lonkaars Date: Sun, 25 Dec 2022 21:48:08 +0100 Subject: small refactoring and add documentation --- oop2eindopdr/ZipExport.h | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) (limited to 'oop2eindopdr/ZipExport.h') diff --git a/oop2eindopdr/ZipExport.h b/oop2eindopdr/ZipExport.h index 741ab4e..0800b41 100644 --- a/oop2eindopdr/ZipExport.h +++ b/oop2eindopdr/ZipExport.h @@ -5,20 +5,28 @@ class Pokedex; +/** @brief handle csv parsing and zip export */ class ZipExport { private: + /** @brief reference to pokedex */ Pokedex* pokedex; - std::string csv_path, zip_path; - std::vector id_list; + std::string csv_path; /** @brief input csv file path */ + std::string zip_path; /** @brief output zip file path */ + std::vector id_list; /** @brief list of id's in csv file */ public: + /** @brief create ZipExport */ ZipExport(); + /** @brief create ZipExport class and immediately start export */ ZipExport(Pokedex* pokedex, std::string input_csv, std::string output_zip); virtual ~ZipExport(); + /** @brief set pokedex reference */ virtual void set_pokedex(Pokedex* pokedex); + /** @brief set csv_path and parse csv file */ virtual void import_csv(std::string filename); + /** @brief generate output export zip file */ virtual void export_zip(std::string filename); }; -- cgit v1.2.3