Website Summary Files Commits Branches @commit @diff @stats
path: root / src / Models
diff options
context:
space:
mode:
2 files changed, 17 insertions, 0 deletions
-rw-r--r--src/Models/CellString.h6
-rw-r--r--src/Models/Table.h11
diff --git a/src/Models/CellString.h b/src/Models/CellString.h
index 071898a..788aa4c 100644
--- a/src/Models/CellString.h
+++ b/src/Models/CellString.h
@@ -1,8 +1,14 @@
#ifndef HEADER_CELLSTRING
#define HEADER_CELLSTRING
+/*! \file CellString.h
+ * \brief Stores the declaration of class CellString
+ */
+
#include "Cell.h"
+/*! \brief A table cell which contains a String value
+ */
class CellString : public Cell {
String value;
diff --git a/src/Models/Table.h b/src/Models/Table.h
index f65cf04..6dc07a3 100644
--- a/src/Models/Table.h
+++ b/src/Models/Table.h
@@ -1,10 +1,16 @@
#ifndef MODELS_TABLE
#define MODELS_TABLE
+/*! \file Table.h
+ * \brief Stores the declaration of class Table
+ */
+
#include "Cell.h"
#include "../Generic/List/List.hpp"
#include <fstream>
+/*! \brief A 2D collection of Cell instances
+ */
class Table {
List<List<Cell*>> cells;
unsigned longestRow;
@@ -14,12 +20,17 @@ public:
Table(const char* filePath);
~Table();
+ //! Returns count of rows
unsigned get_rows() const;
+ //! Returns largest count of columns in all rows
unsigned get_cols() const;
+ //! Parses rawValue and replaces the value at row and col with it
void putCell(unsigned row, unsigned col, const char* rawValue);
+ //! Returns a List of String with String representation of every cell in order
List<String> getAllCells() const;
+ //! Saves all cells to a text file
void saveToFile(const char* filePath) const;
};