add javadoc

Author: antkorwin

src/main/java/com/antkorwin/springtestmongo/internal/DataSet.java

@@ -15,8 +15,8 @@ public interface DataSet {
      *
      * @return map with the data set,
      * map looks like this:
-     * "org.package....FirstDocument" : [FirstDocument doc1, FirstDocument doc2, FirstDocument doc3],
-     * "org.package....SecondDocument" : [SecondDocument Doc1, SecondDocument Doc2, SecondDocument Doc3]
+     * "org.package....FirstDocument" : [{"id":"1", "field":"aaa"}, {"id":"2", "field":"bbb"}],
+     * "org.package....SecondDocument" : [{"id":"1", "value":"123"}, {"id":"2", "value":"456"}]
      */
     Map<String, List<Map<String, Object>>> read();
 }

src/main/java/com/antkorwin/springtestmongo/internal/MongoDbTest.java

@@ -3,6 +3,7 @@
 import com.antkorwin.commonutils.exceptions.InternalException;
 import com.antkorwin.commonutils.validation.Guard;
 import com.antkorwin.springtestmongo.internal.expect.MatchDataSets;
+
 import org.springframework.data.mongodb.core.MongoTemplate;
 
 import static com.antkorwin.springtestmongo.errorinfo.MongoDbErrorInfo.MONGO_TEMPLATE_IS_MANDATORY;
@@ -40,6 +41,12 @@ public void importFrom(String fileName) {
         new MongoDataImport(mongoTemplate).importFrom(new JsonImport(new ImportFile(fileName)));
     }
 
+    /**
+     * Check data in the mongodb,
+     * try to match data from the DB to loaded from file data set.
+     *
+     * @param fileName path to file with an expected data set
+     */
     public void expect(String fileName) {
         DataSet dataSet = new JsonImport(new ImportFile(fileName));
         DataSet mongoData = new MongoDataExport(mongoTemplate);