From 0fd619f41b3d5f343bb24d1a570c5b3e69ed5305 Mon Sep 17 00:00:00 2001
From: Jordan Artzet <jordan.artzet1@gmail.com>
Date: Sun, 12 Feb 2023 21:15:50 +0100
Subject: [PATCH] :memo: add documentation

---
 .../iut/pm/movieapplication/data/dao/MovieDAO.kt |  9 +++++++++
 .../data/mapper/GenreLocalMapper.kt              |  9 +++++++++
 .../data/mapper/MovieLocalMapper.kt              | 16 +++++++++++++++-
 3 files changed, 33 insertions(+), 1 deletion(-)

diff --git a/Sources/app/src/main/java/fr/iut/pm/movieapplication/data/dao/MovieDAO.kt b/Sources/app/src/main/java/fr/iut/pm/movieapplication/data/dao/MovieDAO.kt
index 4e78588..af5ae2d 100644
--- a/Sources/app/src/main/java/fr/iut/pm/movieapplication/data/dao/MovieDAO.kt
+++ b/Sources/app/src/main/java/fr/iut/pm/movieapplication/data/dao/MovieDAO.kt
@@ -11,12 +11,21 @@ interface MovieDAO {
     @Insert(onConflict = OnConflictStrategy.IGNORE)
     suspend fun insert(movieEntity : MovieEntity)
 
+    /**
+     * Get all movies from the movies_table
+     */
     @Query("SELECT * FROM movies_table")
     suspend fun getAllMovies() : List<MovieEntity>
 
+    /**
+     * Get all movies from the movies_details_table
+     */
     @Query("SELECT * FROM movies_details_table")
     suspend fun getAllMoviesDetails() : List<MovieDetailsEntity>
 
+    /**
+     * Get a movie by id
+     */
     @Query("SELECT * FROM movies_table WHERE id = :id")
     fun getMovieById(id : Int) : MovieEntity
 
diff --git a/Sources/app/src/main/java/fr/iut/pm/movieapplication/data/mapper/GenreLocalMapper.kt b/Sources/app/src/main/java/fr/iut/pm/movieapplication/data/mapper/GenreLocalMapper.kt
index 64355b1..a444333 100644
--- a/Sources/app/src/main/java/fr/iut/pm/movieapplication/data/mapper/GenreLocalMapper.kt
+++ b/Sources/app/src/main/java/fr/iut/pm/movieapplication/data/mapper/GenreLocalMapper.kt
@@ -5,6 +5,9 @@ import fr.iut.pm.movieapplication.model.Genre
 
 object GenreLocalMapper {
 
+    /**
+     * Map a [Genre] to a [GenreEntity]
+     */
     fun mapToGenreEntity(genre : Genre) : GenreEntity {
         return GenreEntity(
             genreId = genre.id,
@@ -12,10 +15,16 @@ object GenreLocalMapper {
         )
     }
 
+    /**
+     * Map a list of [Genre] to a list of [GenreEntity]
+     */
     fun mapToGenreEntities(genres : List<Genre>) : List<GenreEntity> {
         return genres.map { mapToGenreEntity(it) }
     }
 
+    /**
+     * Map a [GenreEntity] to a [Genre]
+     */
     fun mapToGenre(genreEntity : GenreEntity) : Genre {
         return Genre(
             id = genreEntity.genreId,
diff --git a/Sources/app/src/main/java/fr/iut/pm/movieapplication/data/mapper/MovieLocalMapper.kt b/Sources/app/src/main/java/fr/iut/pm/movieapplication/data/mapper/MovieLocalMapper.kt
index fdd5d9a..fef1f61 100644
--- a/Sources/app/src/main/java/fr/iut/pm/movieapplication/data/mapper/MovieLocalMapper.kt
+++ b/Sources/app/src/main/java/fr/iut/pm/movieapplication/data/mapper/MovieLocalMapper.kt
@@ -8,6 +8,9 @@ import fr.iut.pm.movieapplication.model.media.movie.MovieDetails
 
 object MovieLocalMapper {
 
+    /**
+     * Map a [MovieEntity] to a [Movie]
+     */
     fun mapToMovie(movieEntity : MovieEntity) : Movie {
         return Movie(
             posterPath = movieEntity.posterPath,
@@ -26,7 +29,9 @@ object MovieLocalMapper {
     }
 
 
-
+    /**
+     * Map a [Movie] to a [MovieEntity]
+     */
     fun mapToMovieEntity(movie : Movie) : MovieEntity {
         return MovieEntity(
             posterPath = movie.posterPath,
@@ -45,6 +50,9 @@ object MovieLocalMapper {
         )
     }
 
+    /**
+     * Map a [MovieDetails] to a [MovieDetailsEntity]
+     */
     fun mapToMovieDetailsEntity(movieDetails : MovieDetails) : MovieDetailsEntity {
         return MovieDetailsEntity(
             movieId = movieDetails.id,
@@ -56,6 +64,9 @@ object MovieLocalMapper {
         )
     }
 
+    /**
+     * Map a [MovieDetails] to a [MovieDetailsWithGenres]
+     */
     fun mapToMovieDetailsWithGenres(movieDetails: MovieDetails) : MovieDetailsWithGenres {
         return MovieDetailsWithGenres(
             movieDetails = mapToMovieDetailsEntity(movieDetails),
@@ -63,6 +74,9 @@ object MovieLocalMapper {
         )
     }
 
+    /**
+     * Map a [MovieDetailsWithGenres] to a [MovieDetails]
+     */
     fun mapToMovieDetails(movieDetailsWithGenres: MovieDetailsWithGenres) : MovieDetails {
         return MovieDetails(
             id = movieDetailsWithGenres.movieDetails.movieId,