diff options
| author | Wladimir J. van der Laan <laanwj@gmail.com> | 2011-11-13 13:19:52 +0100 |
|---|---|---|
| committer | Wladimir J. van der Laan <laanwj@gmail.com> | 2011-11-13 14:12:44 +0100 |
| commit | af836ad58808a1f6437a8b9a76b670c07c9a1212 (patch) | |
| tree | dbc63d61b6404cbdb1f1bd45b58efe794621ab4a /src/qt/csvmodelwriter.h | |
| parent | 66112ed6e69d304eb9be5721f8d9b76375930c52 (diff) | |
Improve documentation for UI classes
Diffstat (limited to 'src/qt/csvmodelwriter.h')
| -rw-r--r-- | src/qt/csvmodelwriter.h | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/src/qt/csvmodelwriter.h b/src/qt/csvmodelwriter.h index 7367f3a6a9..6c9dcbaf3b 100644 --- a/src/qt/csvmodelwriter.h +++ b/src/qt/csvmodelwriter.h @@ -8,7 +8,9 @@ QT_BEGIN_NAMESPACE class QAbstractItemModel; QT_END_NAMESPACE -// Export TableModel to CSV file +/** Export a Qt table model to a CSV file. This is useful for analyzing or post-processing the data in + a spreadsheet. + */ class CSVModelWriter : public QObject { Q_OBJECT @@ -18,8 +20,9 @@ public: void setModel(const QAbstractItemModel *model); void addColumn(const QString &title, int column, int role=Qt::EditRole); - // Perform write operation - // Returns true on success, false otherwise + /** Perform export of the model to CSV. + @returns true on success, false otherwise + */ bool write(); private: |