DOC: comments and ws changes

test/test_ccaosdb.cpp

@@ -52,8 +52,8 @@ TEST(test_ccaosdb, test_count_query) {
   EXPECT_EQ(return_code, 0);
 
   caosdb_transaction_transaction transaction;
-  return_code =
-    caosdb_connection_connection_create_transaction(&connection, &transaction);
+  return_code = caosdb_connection_connection_create_transaction(&connection,
+                                                                &transaction);
   EXPECT_EQ(return_code, 0);
 
   // COUNT query with an empty result
@@ -82,8 +82,8 @@ TEST(test_ccaosdb, test_query) {
   EXPECT_EQ(return_code, 0);
 
   caosdb_transaction_transaction transaction;
-  return_code =
-    caosdb_connection_connection_create_transaction(&connection, &transaction);
+  return_code = caosdb_connection_connection_create_transaction(&connection,
+                                                                &transaction);
   EXPECT_EQ(return_code, 0);
 
   return_code = caosdb_transaction_transaction_query(&transaction,
@@ -115,8 +115,8 @@ TEST(test_ccaosdb, test_single_id_retrieve) {
   EXPECT_EQ(return_code, 0);
 
   caosdb_transaction_transaction transaction;
-  return_code =
-    caosdb_connection_connection_create_transaction(&connection, &transaction);
+  return_code = caosdb_connection_connection_create_transaction(&connection,
+                                                                &transaction);
   EXPECT_EQ(return_code, 0);
 
   return_code =
@@ -161,8 +161,8 @@ TEST(test_ccaosdb, test_multi_id_retrieve) {
   EXPECT_EQ(return_code, 0);
 
   caosdb_transaction_transaction transaction;
-  return_code =
-    caosdb_connection_connection_create_transaction(&connection, &transaction);
+  return_code = caosdb_connection_connection_create_transaction(&connection,
+                                                                &transaction);
   EXPECT_EQ(return_code, 0);
 
   const char *ids[] = {"20", "21", "22"}; // NOLINT

test/test_transaction.cpp

@@ -197,7 +197,12 @@ TEST_F(test_transaction, insert_delete) {
   EXPECT_FALSE(deleted_entity.HasErrors());
 }
 
+/*
+ * Insert a Record with a parent, retrieve and delete it again
+ */
 TEST_F(test_transaction, insert_delete_with_parent) {
+  // same as in insert_without_delete
+  // until marked  END SAME
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();
 
@@ -218,8 +223,9 @@ TEST_F(test_transaction, insert_delete_with_parent) {
   const auto &insert_result_set = insert_transaction->GetResultSet();
 
   const auto &inserted_rt = insert_result_set.at(0);
+  // END SAME
 
-  // insert Record with parent
+  // create Record with parent
   Entity rec;
   rec.SetRole(Role::RECORD);
   rec.SetName("TestRec");
@@ -229,6 +235,7 @@ TEST_F(test_transaction, insert_delete_with_parent) {
   parent.SetId(inserted_rt.GetId());
   rec.AppendParent(parent);
 
+  // insert Record
   auto rec_transaction(connection->CreateTransaction());
   rec_transaction->InsertEntity(&rec);
   rec_transaction->ExecuteAsynchronously();
@@ -244,6 +251,7 @@ TEST_F(test_transaction, insert_delete_with_parent) {
 
   EXPECT_FALSE(inserted_rec.GetId().empty());
 
+  // retrieve inserted Record
   auto retrieve_transaction(connection->CreateTransaction());
   retrieve_transaction->RetrieveById(inserted_rec.GetId());
 
@@ -257,11 +265,13 @@ TEST_F(test_transaction, insert_delete_with_parent) {
   const auto &retrieve_result_set = retrieve_transaction->GetResultSet();
   const auto &retrieved_rec = retrieve_result_set.at(0);
 
+  // compare retrieved record with the one that was inserted
   EXPECT_EQ(retrieved_rec.GetName(), rec.GetName());
   EXPECT_EQ(retrieved_rec.GetParents().size(), 1);
   EXPECT_EQ(retrieved_rec.GetParents().at(0).GetId(), inserted_rt.GetId());
   EXPECT_EQ(retrieved_rec.GetParents().at(0).GetName(), rt.GetName());
 
+  // delete the inserted record again
   auto rec_deletion(connection->CreateTransaction());
 
   rec_deletion->DeleteById(retrieved_rec.GetId());
@@ -272,6 +282,7 @@ TEST_F(test_transaction, insert_delete_with_parent) {
   ASSERT_TRUE(rec_delete_status.IsTerminated());
   ASSERT_FALSE(rec_delete_status.IsError());
 
+  // delete the record type again
   auto rt_deletion(connection->CreateTransaction());
 
   rt_deletion->DeleteById(inserted_rt.GetId());
@@ -283,6 +294,9 @@ TEST_F(test_transaction, insert_delete_with_parent) {
   ASSERT_FALSE(rt_delete_status.IsError());
 }
 
+/*
+ * insert a property, record type with that property and a record with it
+ */
 TEST_F(test_transaction, insert_delete_with_property) {
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();
@@ -387,7 +401,7 @@ TEST_F(test_transaction, insert_delete_with_property) {
   const auto &inserted_rec = rec_result_set.at(0);
   EXPECT_FALSE(inserted_rec.GetId().empty());
 
-  // Retrieve the record and verify paretn and property
+  // Retrieve the record and verify parent and property
   auto rec_retrieval(connection->CreateTransaction());
   rec_retrieval->RetrieveById(inserted_rec.GetId());
   rec_retrieval->ExecuteAsynchronously();
@@ -416,6 +430,9 @@ TEST_F(test_transaction, insert_delete_with_property) {
   EXPECT_EQ(retrieved_prop_rec.GetValue(), prop_rec.GetValue());
 }
 
+/*
+ * test retrieving multiple entities at once
+ */
 TEST_F(test_transaction, test_multi_retrieve) {
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();
@@ -447,6 +464,9 @@ TEST_F(test_transaction, test_multi_retrieve) {
             MessageCode::ENTITY_DOES_NOT_EXIST);
 }
 
+/*
+ * test insert, then update and then delete a RecordType
+ */
 TEST_F(test_transaction, insert_update_delete) {
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();
@@ -512,6 +532,9 @@ TEST_F(test_transaction, insert_update_delete) {
   EXPECT_FALSE(deleted_entity.HasErrors());
 }
 
+/*
+ * test insert a RecordType and then submit a find and a count query
+ */
 TEST_F(test_transaction, test_query) {
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();
@@ -554,6 +577,10 @@ TEST_F(test_transaction, test_query) {
   EXPECT_EQ(count_query_trans->GetCountResult(), 1);
 }
 
+/*
+ * insert three recordtypes and the submit multiple queries in different
+ * combinations
+ */
 TEST_F(test_transaction, test_query_with_retrieve) {
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();
@@ -666,6 +693,9 @@ TEST_F(test_transaction, test_query_with_retrieve) {
   EXPECT_EQ(count_and_retrieve->GetCountResult(), 3);
 }
 
+/*
+ * create a file object and upload it
+ */
 TEST_F(test_transaction, test_file_upload) {
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();
@@ -700,6 +730,9 @@ TEST_F(test_transaction, test_file_upload) {
   EXPECT_EQ(count_query->GetCountResult(), 1);
 }
 
+/*
+ * create a file object, upload and then download it
+ */
 TEST_F(test_transaction, test_file_up_n_download) {
   const auto &connection =
       caosdb::connection::ConnectionManager::GetDefaultConnection();