doc: add ktdoc to reportingModelJpa and reportingModel

MTES-MCT · Sep 18, 2024 · 0d96e0d · 0d96e0d
1 parent 7ecb323
commit 0d96e0d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 15 deletions.
diff --git a/...otlin/fr/gouv/cacem/monitorenv/infrastructure/database/model/reportings/ReportingModel.kt b/...otlin/fr/gouv/cacem/monitorenv/infrastructure/database/model/reportings/ReportingModel.kt
@@ -4,16 +4,17 @@ import fr.gouv.cacem.monitorenv.domain.entities.VehicleTypeEnum
 import fr.gouv.cacem.monitorenv.domain.entities.reporting.ReportingTypeEnum
 import fr.gouv.cacem.monitorenv.domain.entities.reporting.TargetDetailsEntity
 import fr.gouv.cacem.monitorenv.domain.entities.reporting.TargetTypeEnum
-import fr.gouv.cacem.monitorenv.infrastructure.database.model.ControlPlanThemeModel
-import fr.gouv.cacem.monitorenv.infrastructure.database.model.EnvActionModel
-import fr.gouv.cacem.monitorenv.infrastructure.database.model.MissionModel
-import fr.gouv.cacem.monitorenv.infrastructure.database.model.ReportingSourceModel
-import fr.gouv.cacem.monitorenv.infrastructure.database.model.ReportingsControlPlanSubThemeModel
+import fr.gouv.cacem.monitorenv.infrastructure.database.model.*
 import jakarta.persistence.Entity
 import jakarta.persistence.Table
 import org.locationtech.jts.geom.Geometry
 import java.time.Instant
 
+/**
+ *
+ * For native queries prupose only
+ * For JPQL queries you should use [ReportingModelJpa]
+ */
 @Entity
 @Table(name = "reportings")
 class ReportingModel(

diff --git a/...in/fr/gouv/cacem/monitorenv/infrastructure/database/model/reportings/ReportingModelJpa.kt b/...in/fr/gouv/cacem/monitorenv/infrastructure/database/model/reportings/ReportingModelJpa.kt
@@ -4,20 +4,16 @@ import fr.gouv.cacem.monitorenv.domain.entities.VehicleTypeEnum
 import fr.gouv.cacem.monitorenv.domain.entities.reporting.ReportingTypeEnum
 import fr.gouv.cacem.monitorenv.domain.entities.reporting.TargetDetailsEntity
 import fr.gouv.cacem.monitorenv.domain.entities.reporting.TargetTypeEnum
-import fr.gouv.cacem.monitorenv.infrastructure.database.model.ControlPlanThemeModel
-import fr.gouv.cacem.monitorenv.infrastructure.database.model.EnvActionModel
-import fr.gouv.cacem.monitorenv.infrastructure.database.model.MissionModel
-import fr.gouv.cacem.monitorenv.infrastructure.database.model.ReportingSourceModel
-import fr.gouv.cacem.monitorenv.infrastructure.database.model.ReportingsControlPlanSubThemeModel
-import jakarta.persistence.Entity
-import jakarta.persistence.NamedAttributeNode
-import jakarta.persistence.NamedEntityGraph
-import jakarta.persistence.NamedSubgraph
-import jakarta.persistence.Table
+import fr.gouv.cacem.monitorenv.infrastructure.database.model.*
+import jakarta.persistence.*
 import org.hibernate.annotations.Formula
 import org.locationtech.jts.geom.Geometry
 import java.time.Instant
 
+/**
+ * For JPQL queries purpose only
+ * For native queries you should use [ReportingModel]
+ */
 @Entity
 @Table(name = "reportings")
 @NamedEntityGraph(