Documentation on what tests are supposed to test.

1 files changed, 6 insertions, 0 deletions

diff --git a/tests/genericresourcetest.cpp b/tests/genericresourcetest.cpp
index 60b1dab..6dd4108 100644
--- a/tests/genericresourcetest.cpp
+++ b/tests/genericresourcetest.cpp
@@ -20,6 +20,11 @@ static void removeFromDisk(const QString &name)
     store.removeFromDisk();
 }
 
+/**
+ * Test of the generic resource implementation.
+ * 
+ * This test relies on a working pipeline implementation, and writes to storage.
+ */
 class GenericResourceTest : public QObject
 {
     Q_OBJECT
@@ -33,6 +38,7 @@ private Q_SLOTS:
         Akonadi2::Log::setDebugOutputLevel(Akonadi2::Log::Trace);
     }
 
+    ///Ensure the resource can process messages
     void testProcessCommand()
     {
         flatbuffers::FlatBufferBuilder eventFbb;