Add minimal documentation.
authorAkos Polster <akos@pipacs.com>
Sun, 10 Oct 2010 19:22:10 +0000 (21:22 +0200)
committerAkos Polster <akos@pipacs.com>
Sun, 10 Oct 2010 19:22:10 +0000 (21:22 +0200)
model/bookdb.h
model/sortedlibrary.h
platform.h
search.h
searchdialog.h
widgets/toolbuttonbox.h

index 3bfa5bb..9b287a8 100644 (file)
@@ -6,6 +6,7 @@
 
 class QString;
 
+/** Persistent storage for book meta-data. */
 class BookDb
 {
 public:
index 3355d3a..f677684 100644 (file)
@@ -4,6 +4,7 @@
 #include <QSortFilterProxyModel>
 #include "library.h"
 
+/** Sorted library model. */
 class SortedLibrary: public QSortFilterProxyModel
 {
     Q_OBJECT
index f4baaad..f328667 100644 (file)
@@ -3,6 +3,7 @@
 
 #include <QString>
 
+/** Platform abstractions. */
 class Platform
 {
 public:
index 47e5b1a..d577f2f 100644 (file)
--- a/search.h
+++ b/search.h
@@ -7,6 +7,7 @@
 #include <QImage>
 #include <QList>
 
+/** Search for books, display and download results. */
 class Search: public QObject
 {
     Q_OBJECT
index 7f8a19b..d75368c 100644 (file)
@@ -8,7 +8,7 @@
 
 class QLineEdit;
 
-class SearchDialog : public Dyalog
+class SearchDialog: public Dyalog
 {
     Q_OBJECT
 
index 17ff60a..758a81c 100644 (file)
@@ -6,6 +6,7 @@
 class QString;
 class QButtonGroup;
 
+/** Frame with tool buttons. */
 class ToolButtonBox: public QFrame
 {
     Q_OBJECT