Update comments in dataProvider.hpp

include/aidge/data/DataProvider.hpp

@@ -77,7 +77,7 @@ public:
     std::vector<std::shared_ptr<Tensor>> readBatch() const;
 
     /**
-     * @brief Get the Number of Batch
+     * @brief Get the Number of Batch.
      * 
      * @return std::size_t 
      */
@@ -86,7 +86,7 @@ public:
     };
 
     /**
-     * @brief Get the current Index Batch
+     * @brief Get the current Index Batch.
      * 
      * @return std::size_t 
      */
@@ -108,10 +108,13 @@ public:
         ++mIndexBatch;
     };
 
+    /**
+     * @brief Setup the batches for one pass on the database.
+     */
     void setBatches();
 
     /**
-     * @brief End of dataProvider condition 
+     * @brief End condition of dataProvider for one pass on the database.
      * 
      * @return true when all batch were fetched, False otherwise
      */
@@ -119,10 +122,20 @@ public:
         return (mIndexBatch == mNbBatch);
     };
 
+
     // Functions for python iterator iter and next (definition in pybind.cpp)
-    // __iter__ method for iterator protocol
+    /**
+     * @brief __iter__ method for iterator protocol
+     * 
+     * @return DataProvider* 
+     */
     DataProvider* iter();
-    // __next__ method for iterator protocol
+
+    /**
+     * @brief __next__ method for iterator protocol
+     * 
+     * @return std::vector<std::shared_ptr<Aidge::Tensor>> 
+     */
     std::vector<std::shared_ptr<Aidge::Tensor>> next();
 };