add javadoc (iluwatar#79)

sergejsvisockis · Apr 15, 2024 · aaf203c · aaf203c
1 parent 584a8ca
commit aaf203c
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/active-record/src/main/java/com/iluwatar/activerecord/RecordBase.java b/active-record/src/main/java/com/iluwatar/activerecord/RecordBase.java
@@ -28,6 +28,13 @@ protected Connection getConnection() throws SQLException {
 
   protected abstract void setFieldsFromResultSet(ResultSet rs);
 
+  /**
+   * Find all the records for a corresponding domain model.
+   *
+   * @param clazz domain model class.
+   * @param <T>   domain model type.
+   * @return all the domain model related records.
+   */
   public <T extends RecordBase> List<T> findAll(Class<T> clazz) {
     List<T> recordList = new ArrayList<>();
     try (Connection conn = getConnection();
@@ -75,6 +82,9 @@ public <T extends RecordBase> T findById(Long id, Class<T> clazz) {
     }
   }
 
+  /**
+   * Save the record.
+   */
   public void save() {
     // TODO
   }