Add some comments
continuous-integration/drone/push Build is passing Details

pull/38/head
Corentin LEMAIRE 2 years ago
parent 52079cdaf0
commit 5921c430ba

@ -7,6 +7,7 @@ namespace Model
/// <remarks>
/// Classe Album
/// </remarks>
public class Album
{
private static long nbAlbum = 0;
@ -100,9 +101,14 @@ namespace Model
private ObservableCollection<InfoTitle> infoTitles = new ObservableCollection<InfoTitle>();
/// <summary>
/// Constructeur de la classe album
/// </summary>
/**
* \brief Constructeur de la classe album
* \param[in] name Nom de l'album
* \param[in] imageURL Chemin d'accès de l'image d'un album
* \param[in] artist Artiste de l'album
* \param[in] description Description de l'album
* \param[in] information Informations complémentaires sur un album
*/
public Album(string name, string imageURL, Artist artist, string description, string information)
{
id = nbAlbum;
@ -121,18 +127,20 @@ namespace Model
{
Artist = new Artist(Manager.DEFAULT_NAME);
}
/// <summary>
/// Permet d'ajouter l'InfoTitle passé en paramètre à la liste
/// </summary>
/// <param name="title"></param>
/// <param name="title">Titre à rajouter à l'album</param>
public void AddTitle(InfoTitle title)
{
infoTitles.Add(title);
}
/// <summary>
/// Permet de supprimer l'InfoTitle passé en paramètre si il est présent dans la liste
/// </summary>
/// <param name="title"></param>
/// <param name="title">Titre à supprimer de l'album</param>
public void RemoveTitle(InfoTitle title)
{
infoTitles.Remove(title);
@ -141,7 +149,7 @@ namespace Model
/// <summary>
/// Fonction qui permet de déterminer si deux objets Album sont égaux
/// </summary>
/// <param name="obj"></param>
/// <param name="obj">Objet comparé à l'album actuel</param>
/// <returns>Un booléen indiquant si l'objet est égal</returns>
public override bool Equals(object obj)
{
@ -150,19 +158,20 @@ namespace Model
if (obj is Album album && Name == album.Name) return true;
else return false;
}
/// <summary>
/// Permet de déterminer le hash d'un objet Album
/// </summary>
/// <returns>hash de l'attribut ImageURL</returns>
/// <returns>Hash de l'attribut Name</returns>
public override int GetHashCode()
{
return ImageURL.GetHashCode();
return Name.GetHashCode();
}
/// <summary>
/// Permet de convertir un objet Album en string
/// </summary>
/// <returns>une nouvelle chaîne caractères contenant le nom de l'album et le nom de l'artiste</returns>
/// <returns>Une nouvelle chaîne caractères contenant le nom de l'Album et le nom de l'Artist</returns>
public override string ToString()
{
return $"Name : {Name}, Artist : {Artist}";

@ -5,6 +5,10 @@ namespace Model;
public class Artist
{
/// <remarks>
/// Classe Artist
/// </remarks>
public string Name
{
get => name;
@ -30,6 +34,11 @@ public class Artist
}
/// <summary>
/// Fonction qui permet de déterminer si deux objets Artist sont égaux
/// </summary>
/// <param name="obj"></param>
/// <returns>Un booléen indiquant si l'objet est égal</returns>
public override bool Equals(object obj)
{
if(obj == null) return false;
@ -38,11 +47,19 @@ public class Artist
else return false;
}
/// <summary>
/// Permet de déterminer le hash d'un objet Artist
/// </summary>
/// <returns>Hash de l'attribut Name</returns>
public override int GetHashCode()
{
return Name.GetHashCode();
}
/// <summary>
/// Permet de convertir un objet Artist en string
/// </summary>
/// <returns>Une nouvelle chaîne caractères contenant le nom de l'Artist</returns>
public override string ToString()
{
return $"{Name}";

@ -6,7 +6,10 @@ namespace Model;
public class CustomTitle : Title, INotifyPropertyChanged
{
/// <remarks>
/// Classe CustomTitle
/// </remarks>
public string Path
{
get => path;
@ -75,9 +78,19 @@ public class CustomTitle : Title, INotifyPropertyChanged
public CustomTitle() : base(Manager.DEFAULT_NAME, Manager.DEFAULT_URL, Manager.DEFAULT_DESC) { }
/// <summary>
/// Fonction qui permet de déterminer si deux objets CustomTitle sont égaux selon leurs chemin d'accès
/// </summary>
/// <param name="other"></param>
/// <returns>Un booléen indiquant si les chemins d'accès sont égaux</returns>
public bool Equals(CustomTitle other)
=> Path.Equals(other?.Path);
/// <summary>
/// Fonction qui permet de déterminer si deux objets CustomTitle sont égaux
/// </summary>
/// <param name="obj"></param>
/// <returns>Un booléen indiquant si l'objet est égal</returns>
public override bool Equals(object obj)
{
if (ReferenceEquals(obj, null)) return false;
@ -86,11 +99,19 @@ public class CustomTitle : Title, INotifyPropertyChanged
return Equals(obj as CustomTitle);
}
/// <summary>
/// Permet de déterminer le hash d'un objet CustomTitle
/// </summary>
/// <returns>Hash de l'attribut Path</returns>
public override int GetHashCode()
{
return ImageURL.GetHashCode();
return Path.GetHashCode();
}
/// <summary>
/// Permet de convertir un objet CustomTitle en string
/// </summary>
/// <returns>Une nouvelle chaîne caractères contenant le nom du CustomTitle et le chemin d'accès</returns>
public override string ToString()
{
return $"Name : {Name}, Path : {Path}";

@ -2,6 +2,9 @@
public enum Genre
{
/// <remarks>
/// Enum des diffénres genres référencés.
/// </remarks>
HIP_HOP, POP, ROCK, ELECTRO, CLASSIQUE, JAZZ, VARIETE_FRANCAISE, VARIETE_INTERNATIONALE, REGGAE, RAP, RNB, DISCO, BLUES, COUNTRY, FUNK, GOSPEL,
METAL, K_POP
}

@ -5,6 +5,10 @@ namespace Model;
public class InfoTitle : Title
{
/// <remarks>
/// Classe InfoTitle
/// </remarks>
public string Description
{
get => description;
@ -67,6 +71,11 @@ public class InfoTitle : Title
}
}
/// <summary>
/// Fonction qui permet de déterminer si deux objets InfoTitle sont égaux
/// </summary>
/// <param name="obj"></param>
/// <returns>Un booléen indiquant si l'objet est égal</returns>
public override bool Equals(object obj)
{
if (obj is null) return false;
@ -75,11 +84,19 @@ public class InfoTitle : Title
else return false;
}
/// <summary>
/// Permet de déterminer le hash d'un objet InfoTitle
/// </summary>
/// <returns>Hash de l'attribut Name</returns>
public override int GetHashCode()
{
return ImageURL.GetHashCode();
return Name.GetHashCode();
}
/// <summary>
/// Permet de convertir un objet InfoTitle en string
/// </summary>
/// <returns>Une nouvelle chaîne caractères contenant le nom de l'InfoTitle et le chemin d'accès à l'image</returns>
public override string ToString()
{
return $"Name : {Name}, ImageUrl : {ImageURL}";

@ -8,6 +8,10 @@ namespace Model;
public class Playlist : INotifyPropertyChanged
{
/// <remarks>
/// Classe Playlist
/// </remarks>
public event PropertyChangedEventHandler PropertyChanged;
public string Name
@ -214,6 +218,11 @@ public class Playlist : INotifyPropertyChanged
}
/// <summary>
/// Fonction qui permet de déterminer si deux objets Playlist sont égaux
/// </summary>
/// <param name="obj"></param>
/// <returns>Un booléen indiquant si l'objet est égal</returns>
public override bool Equals(object obj)
{
if (obj is null) return false;
@ -222,11 +231,19 @@ public class Playlist : INotifyPropertyChanged
else return false;
}
/// <summary>
/// Permet de déterminer le hash d'un objet Playlist
/// </summary>
/// <returns>Hash de l'attribut Name</returns>
public override int GetHashCode()
{
return ImageURL.GetHashCode();
return Name.GetHashCode();
}
/// <summary>
/// Permet de convertir un objet Playlist en string
/// </summary>
/// <returns>Une nouvelle chaîne caractères contenant le nom de la Playlist</returns>
public override string ToString()
{
return $"Name : {Name}";

@ -7,6 +7,9 @@ namespace Model;
public class Title
{
/// <remarks>
/// Classe Title
/// </remarks>
public event PropertyChangedEventHandler PropertyChanged;
@ -71,6 +74,11 @@ public class Title
Information = informations;
}
/// <summary>
/// Fonction qui permet de déterminer si deux objets Title sont égaux
/// </summary>
/// <param name="obj"></param>
/// <returns>Un booléen indiquant si l'objet est égal</returns>
public override bool Equals(object obj)
{
if (obj is null) return false;
@ -79,11 +87,19 @@ public class Title
else return false;
}
/// <summary>
/// Permet de déterminer le hash d'un objet Title
/// </summary>
/// <returns>Hash de l'attribut Name</returns>
public override int GetHashCode()
{
return ImageURL.GetHashCode();
return Name.GetHashCode();
}
/// <summary>
/// Permet de convertir un objet Title en string
/// </summary>
/// <returns>Une nouvelle chaîne caractères contenant le nom du Title</returns>
public override string ToString()
{
return $"Name : {Name}";

Loading…
Cancel
Save