From 3b2db2915b7d7906f705cecd3b758a4c4e2adca1 Mon Sep 17 00:00:00 2001 From: thchazot1 Date: Sun, 12 Jun 2022 12:26:03 +0200 Subject: [PATCH] La vrai doc cette fois --- Business/Manager.cs | 37 +++++++++++---- Business/ManagerUsers.cs | 12 +++++ Modèle/Conservation.cs | 29 +++++++++++- Modèle/Expert.cs | 10 +++- Modèle/Personne.cs | 10 +++- Modèle/Position.cs | 20 ++++++-- Modèle/Requin.cs | 49 +++++++++++++++----- Modèle/UCrequinType.cs | 9 ++++ Modèle/Utilisateur.cs | 5 +- Modèle/Zone.cs | 12 +++++ WpfApp1/AddAShark.xaml.cs | 14 ++++-- WpfApp1/App.xaml.cs | 12 +++++ WpfApp1/ChangerMotDePasse.xaml.cs | 9 +++- WpfApp1/CreerCompte.xaml.cs | 10 +++- WpfApp1/DescriptionAdd.xaml.cs | 17 +++++-- WpfApp1/DescriptionEdit.xaml.cs | 23 +++++++-- WpfApp1/InfoUtilisateur.xaml.cs | 16 +++++-- WpfApp1/MainWindow.xaml.cs | 27 ++++++++--- WpfApp1/SeConnecter.xaml.cs | 10 +++- WpfApp1/UserControlBoite.xaml.cs | 11 ++++- WpfApp1/UserControlEdit.xaml.cs | 40 ++++++++++++++-- WpfApp1/UserControlPosition.xaml.cs | 13 +++++- WpfApp1/UserControlRequin.xaml.cs | 25 +++++++++- WpfApp1/ValiderSubmit.xaml.cs | 7 +++ WpfApp1/userControlAcceuil.xaml.cs | 33 +++++++++++-- WpfApp1/userControlDescription.xaml.cs | 64 +++++++++++++++++++++++--- 26 files changed, 451 insertions(+), 73 deletions(-) diff --git a/Business/Manager.cs b/Business/Manager.cs index 3b22c5c..15efe11 100644 --- a/Business/Manager.cs +++ b/Business/Manager.cs @@ -15,13 +15,28 @@ namespace Business /// public class Manager { - public ObservableCollection Requins { get; private set; } //ObservableCollection les requins qui ont déjà été validés - public ObservableCollection RequinsEdit { get; private set; } //ObservableCollection les requins qui ont été modifiés par des utilisateurs et qui n'ont pas encore été validés - public ObservableCollection RequinsAdd { get; private set; } //ObservableCollection les requins qui ont été ajoutés par des utilisateurs et qui n'ont pas encore été validés - public Requin SelectedRequin { get; set; } //Requin actuellement utilisé dans l'application + /// + /// ObservableCollection de Requin les requins qui ont déjà été validés + /// + public ObservableCollection Requins { get; private set; } + /// + /// ObservableCollection de Requin les requins qui ont été modifiés par des utilisateurs et qui n'ont pas encore été validés + /// + public ObservableCollection RequinsEdit { get; private set; } + /// + /// ObservableCollection les requins qui ont été ajoutés par des utilisateurs et qui n'ont pas encore été validés + /// + public ObservableCollection RequinsAdd { get; private set; } + /// + /// Requin actuellement utilisé dans l'application + /// + public Requin SelectedRequin { get; set; } - public List FunFacts { get; private set; } = new List(); //List la liste des fun facts + /// + /// List de string la liste des fun facts + /// + public List FunFacts { get; private set; } = new List(); /// @@ -238,12 +253,12 @@ namespace Business /// - /// Méthode RechercherRequins qui permet de rechercher des requins dans une ObservableCollection en fonction de leurs zones et d'un motif + /// Méthode RechercherRequins qui permet de rechercher des requins dans une ObservableCollection de Requin en fonction de leurs zones et d'un motif /// - /// ObservableCollection dans laquelle on fait la recherche + /// ObservableCollection de Requin dans laquelle on fait la recherche /// string sur lequel on fait la recherche /// Zone? sur laquelle on fait la recherche - /// List contenant tous les requins trouvés en fonction du motif et de la zone + /// List de Requin contenant tous les requins trouvés en fonction du motif et de la zone public List RechercherRequins(ObservableCollection lRech, Nullable zone, string motif) { List nvReq = new List(); @@ -282,6 +297,12 @@ namespace Business /// /// Méthode vérifierRequin qui permet de vérifiersi les strings que l'on donnerait au constructeur de requin son vides /// + /// + /// + /// + /// + /// + /// /// Booléen : true si il n'y en a pas de vide, false sinon public bool verifierRequin(String nom, String nomSci, String description, String photo, String video, String photoCarte) { diff --git a/Business/ManagerUsers.cs b/Business/ManagerUsers.cs index 9caaf9f..2ea1832 100644 --- a/Business/ManagerUsers.cs +++ b/Business/ManagerUsers.cs @@ -9,10 +9,22 @@ using System.Threading.Tasks; namespace Business { + /// + /// Class Manager qui gère les Experts et les Utilisateurs + /// public class ManagerUsers { + /// + /// List d'Utilisateur, la liste des utilisateurs de l'application + /// public List Utilisateurs { get; private set; } + /// + /// List d'Expert, la liste des experts de l'application + /// public List Experts { get; private set; } + /// + /// L'utilisateur ou l'expert actuellement connecté + /// public Personne SelectedUser { get; set; } /// diff --git a/Modèle/Conservation.cs b/Modèle/Conservation.cs index 15fe8d7..3803a26 100644 --- a/Modèle/Conservation.cs +++ b/Modèle/Conservation.cs @@ -14,22 +14,49 @@ namespace Modèle [DataContract] public enum Conservation { + /// + /// Extinct + /// [EnumMember] EX, + /// + /// Extinct in the Wild + /// [EnumMember] EW, + /// + /// Critically Endangered + /// [EnumMember] CR, + /// + /// Endangered + /// [EnumMember] EN, - [EnumMember] + /// + /// Vulnerable + /// + [EnumMember] VU, + /// + /// Near Threatened + /// [EnumMember] NT, + /// + /// Least Concern + /// [EnumMember] LC, + /// + /// Data Deficient + /// [EnumMember] DD, + /// + /// Not Evaluated + /// [EnumMember] NE } diff --git a/Modèle/Expert.cs b/Modèle/Expert.cs index d2334e3..5d78bbe 100644 --- a/Modèle/Expert.cs +++ b/Modèle/Expert.cs @@ -18,10 +18,16 @@ namespace Modèle [DataContract] public class Expert : Personne { + /// + /// DateTime qui permet de connaitre la date de création x'un compte expert + /// [DataMember] - public DateTime DateD { get; private set; } //DateTime qui permet de connaitre la date de création x'un compte expert + public DateTime DateD { get; private set; } + /// + /// /String le surnom d'un expert + /// [DataMember] - public string Surnom { get; private set; } //String le surnom d'un expert + public string Surnom { get; private set; } /// diff --git a/Modèle/Personne.cs b/Modèle/Personne.cs index 1cb690e..615d7cc 100644 --- a/Modèle/Personne.cs +++ b/Modèle/Personne.cs @@ -16,10 +16,16 @@ namespace Modèle [DataContract] public abstract class Personne { + /// + /// String email d'une Personne + /// [DataMember] - public string Email { get; protected set; } //String email d'une Personne + public string Email { get; protected set; } + /// + /// String mot de passe d'une Personne + /// [DataMember] - public string MotDePasse { get; protected set; } //String mot de passe d'une Personne + public string MotDePasse { get; protected set; } /// diff --git a/Modèle/Position.cs b/Modèle/Position.cs index 3d1bbf6..d78fbb2 100644 --- a/Modèle/Position.cs +++ b/Modèle/Position.cs @@ -13,10 +13,22 @@ namespace Modèle /// public class Position { - public float LattitudeDeb { get; set; } //Int lattitude la plus faible - public float LattitudeFin { get; set; } //Int lattitude la plus haute - public float LongitudeDeb { get; set; } //Int longitude la plus faible - public float LongitudeFin { get; set; } //Int longitude la plus haute + /// + /// Int lattitude la plus faible + /// + public float LattitudeDeb { get; set; } + /// + /// Int lattitude la plus haute + /// + public float LattitudeFin { get; set; } + /// + /// Int longitude la plus faible + /// + public float LongitudeDeb { get; set; } + /// + /// Int longitude la plus haute + /// + public float LongitudeFin { get; set; } /// diff --git a/Modèle/Requin.cs b/Modèle/Requin.cs index f7fefba..7c5fe8d 100644 --- a/Modèle/Requin.cs +++ b/Modèle/Requin.cs @@ -9,29 +9,56 @@ namespace Modèle { /// - /// Classe Requin qui impléemente la méthode IEquatable + /// Classe Requin qui implémente la méthode IEquatable de Requin /// [DataContract] public class Requin : IEquatable { + /// + /// string le nom du requin + /// [DataMember] - public string Nom { get; private set; } //string le nom du requin + public string Nom { get; private set; } + /// + /// string le nom scientifique du requin + /// [DataMember] - public string NomSci { get; private set; } //string le nom scientifique du requin + public string NomSci { get; private set; } + /// + /// string la description du requin + /// [DataMember] - public string Description { get; private set; } //string la description du requin + public string Description { get; private set; } + /// + /// string l'URL de la photo du requin + /// [DataMember] - public string Photo { get; private set; } //string l'URL de la photo du requin + public string Photo { get; private set; } + /// + /// string le chemin de la vidéo du requin + /// [DataMember] - public string Video { get; private set; } //string le chemin de la vidéo du requin + public string Video { get; private set; } + /// + /// string l'URL de la photo de la carte de répartition du requin + /// [DataMember] - public string PhotoCarte { get; private set; } //string l'URL de la photo de la carte de répartition du requin + public string PhotoCarte { get; private set; } + /// + /// Conservation le statut de conservation du requin + /// [DataMember] - public Conservation StatutCons { get; private set; } //Conservation le statut de conservation du requin + public Conservation StatutCons { get; private set; } + /// + /// string fun fact sur les requins + /// [DataMember] - public string FunFact { get; private set; } //string fun fact sur les requins + public string FunFact { get; private set; } + /// + /// List de Zone la répartition du requin sur la planète + /// [DataMember] - public List Repartition { get; private set; } //List la répartition du requin sur la planète + public List Repartition { get; private set; } /// @@ -105,7 +132,7 @@ namespace Modèle /// - /// Méthode ToString de la classe Requin qui permet l'implémentation de la méthode IEquatable + /// Méthode ToString de la classe Requin qui permet l'implémentation de la méthode IEquatable de Requin /// public override bool Equals(object obj) { diff --git a/Modèle/UCrequinType.cs b/Modèle/UCrequinType.cs index 0de654a..6c7474f 100644 --- a/Modèle/UCrequinType.cs +++ b/Modèle/UCrequinType.cs @@ -11,8 +11,17 @@ namespace Modèle /// public enum UCrequinType { + /// + /// UCRequin qui mène à la description du requin + /// normal, + /// + /// UCRequin qui mène à DescriptionEdit + /// edit, + /// + /// UCRequin qui mène à DescriptionAdd + /// add, } } diff --git a/Modèle/Utilisateur.cs b/Modèle/Utilisateur.cs index 72bbdba..38a21e3 100644 --- a/Modèle/Utilisateur.cs +++ b/Modèle/Utilisateur.cs @@ -15,8 +15,11 @@ namespace Modèle [DataContract] public class Utilisateur : Personne { + /// + /// int qui permet de savoir le nombre d'ajouts et de modifications qu'à fait un utilisateur + /// [DataMember] - public int NbSubmit { get; private set; } //int qui permet de savoir le nombre d'ajouts et de modifications qu'à fait un utilisateur + public int NbSubmit { get; private set; } /// /// Constructeur d'utilisateur sans nombre de submits diff --git a/Modèle/Zone.cs b/Modèle/Zone.cs index 2345124..df894bd 100644 --- a/Modèle/Zone.cs +++ b/Modèle/Zone.cs @@ -13,12 +13,24 @@ namespace Modèle [DataContract] public enum Zone { + /// + /// Océan Atlantique + /// [EnumMember] ATLANTIQUE, + /// + /// Océan Arctique + /// [EnumMember] ARCTIQUE, + /// + /// Océan Pacifique + /// [EnumMember] PACIFIQUE, + /// + /// Océan Indien + /// [EnumMember] INDIEN } diff --git a/WpfApp1/AddAShark.xaml.cs b/WpfApp1/AddAShark.xaml.cs index f34148d..da431e8 100644 --- a/WpfApp1/AddAShark.xaml.cs +++ b/WpfApp1/AddAShark.xaml.cs @@ -18,10 +18,12 @@ namespace WpfApp1 { /// /// Logique d'interaction pour AddAShark.xaml - /// Page qui permet à un utilisateur d'ajouter un requin /// public partial class AddAShark : Window { + /// + /// Page qui permet à un utilisateur d'ajouter un requin + /// public AddAShark() { InitializeComponent(); @@ -30,8 +32,14 @@ namespace WpfApp1 } - public Manager Mgr => (Application.Current as App).LeManager; //Manager lié à celui de l'app - public ManagerUsers MgrUser => (Application.Current as App).LeManagerUsers; //ManagerUser lié à celui de l'app + /// + /// Manager lié à celui de l'app + /// + public Manager Mgr => (Application.Current as App).LeManager; + /// + /// ManagerUser lié à celui de l'app + /// + public ManagerUsers MgrUser => (Application.Current as App).LeManagerUsers; private List consList = new List //List contenant toutes les conservations diff --git a/WpfApp1/App.xaml.cs b/WpfApp1/App.xaml.cs index 0cff48d..4f4570e 100644 --- a/WpfApp1/App.xaml.cs +++ b/WpfApp1/App.xaml.cs @@ -15,11 +15,23 @@ namespace WpfApp1 /// public partial class App : Application { + /// + /// L'IPersistanceManager qui fait référence à notre DataContract + /// public static IPersistanceManager strat { get; private set; } = new DataContractPersistance(); + /// + /// L'IPersistanceManager qui fait référence à notre stub + /// public static IPersistanceManager stubtruc { get; private set; } = new StubLib.Stub(); + /// + /// Le Manager des requins qui contiendra toutes les listes + /// public Manager LeManager { get; private set; } = new Manager(strat); + /// + /// Le Manager des utilisateurs qui contiendra toutes les listes + /// public ManagerUsers LeManagerUsers { get; private set; } = new ManagerUsers(strat); diff --git a/WpfApp1/ChangerMotDePasse.xaml.cs b/WpfApp1/ChangerMotDePasse.xaml.cs index 78097ac..1d36d4c 100644 --- a/WpfApp1/ChangerMotDePasse.xaml.cs +++ b/WpfApp1/ChangerMotDePasse.xaml.cs @@ -17,16 +17,21 @@ namespace WpfApp1 { /// /// Logique d'interaction pour ChangerMotDePasse.xaml - /// Page qui permet à un utilisateur de changer son mot de passe /// public partial class ChangerMotDePasse : Window { + /// + /// Page qui permet à un utilisateur de changer son mot de passe + /// public ChangerMotDePasse() { InitializeComponent(); } - public ManagerUsers MgrUser => (Application.Current as App).LeManagerUsers; //ManagerUser lié à celui de l'app + /// + /// ManagerUser lié à celui de l'app + /// + public ManagerUsers MgrUser => (Application.Current as App).LeManagerUsers; /// diff --git a/WpfApp1/CreerCompte.xaml.cs b/WpfApp1/CreerCompte.xaml.cs index e085138..465d921 100644 --- a/WpfApp1/CreerCompte.xaml.cs +++ b/WpfApp1/CreerCompte.xaml.cs @@ -18,16 +18,22 @@ namespace WpfApp1 { /// /// Logique d'interaction pour CreerCompte.xaml - /// Page qui permet à un utilisateur de créer un compte /// public partial class CreerCompte : Window { + /// + /// Page qui permet à un utilisateur de créer un compte + /// public CreerCompte() { InitializeComponent(); } - public ManagerUsers MgrUser => (Application.Current as App).LeManagerUsers; //ManagerUser lié à celui de l'app + + /// + /// ManagerUser lié à celui de l'app + /// + public ManagerUsers MgrUser => (Application.Current as App).LeManagerUsers; /// diff --git a/WpfApp1/DescriptionAdd.xaml.cs b/WpfApp1/DescriptionAdd.xaml.cs index e4f0c44..60fcdf6 100644 --- a/WpfApp1/DescriptionAdd.xaml.cs +++ b/WpfApp1/DescriptionAdd.xaml.cs @@ -19,23 +19,32 @@ namespace WpfApp1 { /// /// Logique d'interaction pour Description.xaml - /// Page qui affiche la description d'un requin de la liste des requins ajoutéss /// public partial class DescriptionAdd : Window { + + /// + /// Page qui affiche la description d'un requin de la liste des requins ajoutéss + /// public DescriptionAdd() { InitializeComponent(); } - - public Manager Mgr => (Application.Current as App).LeManager; //Manager lié à celui de l'app + /// + /// Manager lié à celui de l'app + /// + public Manager Mgr => (Application.Current as App).LeManager; private Requin _requin; - public Requin requin //requin sur lequel se base l'affichage de la page + + /// + /// requin sur lequel se base l'affichage de la page + /// + public Requin requin { get { return _requin; } set diff --git a/WpfApp1/DescriptionEdit.xaml.cs b/WpfApp1/DescriptionEdit.xaml.cs index 7fbcd62..95dee38 100644 --- a/WpfApp1/DescriptionEdit.xaml.cs +++ b/WpfApp1/DescriptionEdit.xaml.cs @@ -18,18 +18,29 @@ namespace WpfApp1 { /// /// Logique d'interaction pour DescriptionEdit.xaml - /// Page qui affiche la description d'un requins de la liste des requins modifiés avec la description du requin de base /// public partial class DescriptionEdit : Window { + + /// + /// Page qui affiche la description d'un requins de la liste des requins modifiés avec la description du requin de base + /// public DescriptionEdit() { InitializeComponent(); } - public Manager Mgr => (Application.Current as App).LeManager; //Manager lié à celui de l'app - private Requin _requin; //requin sur lequel se base l'affichage de la partie droite de la page + /// + /// Manager lié à celui de l'app + /// + public Manager Mgr => (Application.Current as App).LeManager; + + private Requin _requin; + + /// + /// requin sur lequel se base l'affichage de la partie droite de la page + /// public Requin requin { get { return _requin; } @@ -41,8 +52,12 @@ namespace WpfApp1 } - private Requin _requinOld; //requin sur lequel se base l'affichage de la partie gauche de la page + private Requin _requinOld; + + /// + /// requin sur lequel se base l'affichage de la partie gauche de la page + /// public Requin requinOld { get { return _requinOld; } diff --git a/WpfApp1/InfoUtilisateur.xaml.cs b/WpfApp1/InfoUtilisateur.xaml.cs index 8985316..ee26182 100644 --- a/WpfApp1/InfoUtilisateur.xaml.cs +++ b/WpfApp1/InfoUtilisateur.xaml.cs @@ -18,20 +18,30 @@ namespace WpfApp1 { /// /// Logique d'interaction pour InfoUtilisateur.xaml - /// Page qui permet à un utilisateur de voir ses informations /// public partial class InfoUtilisateur : Window { + /// + /// Page qui permet à un utilisateur de voir ses informations + /// public InfoUtilisateur() { InitializeComponent(); } - public ManagerUsers MgrUser => (Application.Current as App).LeManagerUsers; //ManagerUser lié à celui de l'app + + /// + /// ManagerUser lié à celui de l'app + /// + public ManagerUsers MgrUser => (Application.Current as App).LeManagerUsers; private Personne _pers; - public Personne pers //L'utilisateur qui permettra de mettre les informations de la page à jour + + /// + /// L'utilisateur qui permettra de mettre les informations de la page à jour + /// + public Personne pers { get { return _pers; } set diff --git a/WpfApp1/MainWindow.xaml.cs b/WpfApp1/MainWindow.xaml.cs index a0ed87c..74ed0f4 100644 --- a/WpfApp1/MainWindow.xaml.cs +++ b/WpfApp1/MainWindow.xaml.cs @@ -19,23 +19,38 @@ using Business; namespace WpfApp1 { /// - /// Interaction logic for MainWindow.xaml - /// Page principal de CShark + /// Interaction logic for MainWindow.xam /// public partial class MainWindow : Window { - public Manager Mgr => (Application.Current as App).LeManager; //Manager lié à celui de l'app - public ManagerUsers MgrUser => (Application.Current as App).LeManagerUsers; //ManagerUser lié à celui de l'app + /// + /// Manager lié à celui de l'app + /// + public Manager Mgr => (Application.Current as App).LeManager; - Nullable zonePage{ get; set; } //Zone qui permet de connaitre la zone de la comboBox + /// + /// ManagerUser lié à celui de l'app + /// + public ManagerUsers MgrUser => (Application.Current as App).LeManagerUsers; - public bool aChanger = false; //Booléen qui permet de savoir si l'utilisateur a déjà changer la zone de la listBox + /// + /// Zone qui permet de connaitre la zone de la comboBox + /// + Nullable zonePage{ get; set; } + + /// + /// Booléen qui permet de savoir si l'utilisateur a déjà changer la zone de la listBox + /// + public bool aChanger = false; List lesZones = new List() { Zone.ARCTIQUE, Zone.ATLANTIQUE, Zone.INDIEN, Zone.PACIFIQUE }; + /// + /// Page principal de CShark + /// public MainWindow() { diff --git a/WpfApp1/SeConnecter.xaml.cs b/WpfApp1/SeConnecter.xaml.cs index 1a88732..38caa12 100644 --- a/WpfApp1/SeConnecter.xaml.cs +++ b/WpfApp1/SeConnecter.xaml.cs @@ -18,12 +18,18 @@ namespace WpfApp1 { /// /// Logique d'interaction pour SeConnecter.xaml - /// Page qui permet à l'utilisateur de se connecter /// public partial class SeConnecter : Window { - public ManagerUsers MgrUser => (Application.Current as App).LeManagerUsers; //ManagerUser lié à celui de l'app + /// + /// ManagerUser lié à celui de l'app + /// + public ManagerUsers MgrUser => (Application.Current as App).LeManagerUsers; + + /// + /// Page qui permet à l'utilisateur de se connecter + /// public SeConnecter() { InitializeComponent(); diff --git a/WpfApp1/UserControlBoite.xaml.cs b/WpfApp1/UserControlBoite.xaml.cs index 9b42c74..295f6b3 100644 --- a/WpfApp1/UserControlBoite.xaml.cs +++ b/WpfApp1/UserControlBoite.xaml.cs @@ -17,15 +17,21 @@ namespace WpfApp1 { /// /// Logique d'interaction pour UserControlBoite.xaml - /// UerControl pour toutes les fois ou nous avons besoins d'un textBlock et en dessous d'une textBox /// public partial class UserControlBoite : UserControl { + + /// + /// UerControl pour toutes les fois ou nous avons besoins d'un textBlock et en dessous d'une textBox + /// public UserControlBoite() { InitializeComponent(); } + /// + /// Le text du textBlock + /// public string Message { set @@ -34,6 +40,9 @@ namespace WpfApp1 } } + /// + /// Le contenu de la textBox + /// public string Contenu { set diff --git a/WpfApp1/UserControlEdit.xaml.cs b/WpfApp1/UserControlEdit.xaml.cs index 0bc5861..150092a 100644 --- a/WpfApp1/UserControlEdit.xaml.cs +++ b/WpfApp1/UserControlEdit.xaml.cs @@ -17,10 +17,22 @@ using System.Windows.Shapes; namespace WpfApp1 { + + /// + /// Classe DescWeGoEventArgs qui implémente EventArgs + /// Elle permet de créer un argument qui permet de transformer le content control de la main window en UserControlDescription après avoir cliquer sur un UserControlRequin + /// public class DescWeGoEventArgs : EventArgs { + /// + /// Le requin que l'on veut passer lors de l'événement + /// public Requin Requin { get; private set; } + /// + /// L'Evénement pour changer le content control + /// + /// public DescWeGoEventArgs(Requin requin) => Requin = requin; } @@ -30,6 +42,9 @@ namespace WpfApp1 /// public partial class UserControlEdit : UserControl { + /// + /// UserControl qui permet de modifier un requin + /// public UserControlEdit() { InitializeComponent(); @@ -38,13 +53,23 @@ namespace WpfApp1 } - - public Manager Mgr => (Application.Current as App).LeManager; //ManagerUser lié à celui de l'app - public ManagerUsers MgrUser => (Application.Current as App).LeManagerUsers; //ManagerUser lié à celui de l'app + /// + /// ManagerUser lié à celui de l'app + /// + public Manager Mgr => (Application.Current as App).LeManager; + + /// + /// ManagerUser lié à celui de l'app + /// + public ManagerUsers MgrUser => (Application.Current as App).LeManagerUsers; private Requin _requin; - public Requin requin //Requin qui permet de mettre à jour l'affichage de la page + + /// + /// Requin qui permet de mettre à jour l'affichage de la page + /// + public Requin requin { get { return _requin; } set @@ -68,8 +93,15 @@ namespace WpfApp1 Conservation.NE }; + /// + /// L'Event handler DescWeGo + /// public event EventHandler DescWeGo; + /// + /// L'Evénement appelé lors du clique + /// + /// protected virtual void OnDescWeGo(DescWeGoEventArgs args) => DescWeGo?.Invoke(this, args); diff --git a/WpfApp1/UserControlPosition.xaml.cs b/WpfApp1/UserControlPosition.xaml.cs index a2f2f2f..0b4a633 100644 --- a/WpfApp1/UserControlPosition.xaml.cs +++ b/WpfApp1/UserControlPosition.xaml.cs @@ -19,10 +19,12 @@ namespace WpfApp1 { /// /// Logique d'interaction pour UserControlPosition.xaml - /// Le userControl que l'on aurait utilisé pour afficher les zones des requins sur la carte /// public partial class UserControlPosition : UserControl { + /// + /// Le userControl que l'on aurait utilisé pour afficher les zones des requins sur la carte + /// public UserControlPosition() { InitializeComponent(); @@ -30,6 +32,9 @@ namespace WpfApp1 private Position _pos; + /// + /// Position qui permet de mettre à jour l'affichage + /// public Position position { get { return _pos; } @@ -41,6 +46,9 @@ namespace WpfApp1 } private double _widthImage; + /// + /// La largeur de la carte + /// public double widthImage { get { return _widthImage; } @@ -51,6 +59,9 @@ namespace WpfApp1 } private double _heightImage; + /// + /// La hauteur de la carte + /// public double heightImage { get { return _heightImage; } diff --git a/WpfApp1/UserControlRequin.xaml.cs b/WpfApp1/UserControlRequin.xaml.cs index 0356272..eec7f1d 100644 --- a/WpfApp1/UserControlRequin.xaml.cs +++ b/WpfApp1/UserControlRequin.xaml.cs @@ -25,8 +25,15 @@ namespace WpfApp1 /// public class DescriptionWeGoEventArgs : EventArgs { + /// + /// Le requin que l'on veut passer lors de l'événement + /// public Requin Requin { get; private set; } + /// + /// L'Evénement pour changer le content control en UserControlDescription + /// + /// public DescriptionWeGoEventArgs(Requin requin) => Requin = requin; } @@ -38,8 +45,14 @@ namespace WpfApp1 { + /// + /// Manager lié à celui de l'app + /// public Manager Mgr => (Application.Current as App).LeManager; + /// + /// Le UserControl qui est stocké dans une listBox et permet d'ouvrir les pages de description + /// public UserControlRequin() { InitializeComponent(); @@ -50,7 +63,11 @@ namespace WpfApp1 /// public event EventHandler DescriptionWeGo; - //L'événement qui permet de passer à l'UserControlDescription + /// + /// L'événement qui permet de passer à l'UserControlDescription + /// + /// + protected virtual void OnDescriptionWeGo(DescriptionWeGoEventArgs args) => DescriptionWeGo?.Invoke(this, args); @@ -82,6 +99,9 @@ namespace WpfApp1 } private Requin _requin; + /// + /// Le requin qui permet de mettre à jour l'affichage + /// public Requin requin { get { return _requin; } @@ -91,6 +111,9 @@ namespace WpfApp1 } } + /// + /// Le type d'userControl requi que c'est (permet de savoir quelle description ouvrir) + /// public UCrequinType type; diff --git a/WpfApp1/ValiderSubmit.xaml.cs b/WpfApp1/ValiderSubmit.xaml.cs index cd90f35..bbe6db1 100644 --- a/WpfApp1/ValiderSubmit.xaml.cs +++ b/WpfApp1/ValiderSubmit.xaml.cs @@ -24,7 +24,14 @@ namespace WpfApp1 public partial class ValiderSubmit : Window { + /// + /// Manager lié à celui de l'app + /// public Manager Mgr => (Application.Current as App).LeManager; + + /// + /// Page qui permet aux Experts de voir tous les requins ajoutés et modifiés + /// public ValiderSubmit() { InitializeComponent(); diff --git a/WpfApp1/userControlAcceuil.xaml.cs b/WpfApp1/userControlAcceuil.xaml.cs index f320be5..5a361f2 100644 --- a/WpfApp1/userControlAcceuil.xaml.cs +++ b/WpfApp1/userControlAcceuil.xaml.cs @@ -25,29 +25,46 @@ namespace WpfApp1 /// public class AccueilWeChangeEventArgs : EventArgs { + /// + /// Zone la zone que l'on transmettra avec l'événement + /// public Zone Zone { get; private set; } + /// + /// L'Evénement pour changer la zone de l'accueil + /// + /// public AccueilWeChangeEventArgs(Zone zone) => Zone = zone; } /// /// Logique d'interaction pour userControlAcceuil.xaml - /// UserControl qui permet d'afficher la carte du monde et le bandeau de l'application /// public partial class userControlAcceuil : UserControl { - public ManagerUsers MgrUser => (Application.Current as App).LeManagerUsers; //ManagerUser lié à celui de l'app + /// + /// ManagerUser lié à celui de l'app + /// + public ManagerUsers MgrUser => (Application.Current as App).LeManagerUsers; + + + /// + /// UserControl qui permet d'afficher la carte du monde et le bandeau de l'application + /// public userControlAcceuil() { InitializeComponent(); } + /// + /// string qui permet de modifier directement la source de l'image + /// public string Carte { - set //set qui permet de modifier directement la source de l'image + set { laCarte.Source = new BitmapImage(new Uri(value, UriKind.Relative)); } @@ -55,7 +72,10 @@ namespace WpfApp1 private Nullable _zone; - public Nullable zone //Zone qui permet d'appeler la méthode choixCarte quand elle est modifiée + /// + /// Zone qui permet d'appeler la méthode choixCarte quand elle est modifiée + /// + public Nullable zone { get { return _zone; } set @@ -71,7 +91,10 @@ namespace WpfApp1 /// public event EventHandler AccueilWeChange; - //L'événement qui permet de passer à l'UserControlDescription + /// + /// L'événement qui permet de passer à l'UserControlDescription + /// + /// protected virtual void OnAccueilWeChange(AccueilWeChangeEventArgs args) => AccueilWeChange?.Invoke(this, args); diff --git a/WpfApp1/userControlDescription.xaml.cs b/WpfApp1/userControlDescription.xaml.cs index 4b0e387..9f78ae1 100644 --- a/WpfApp1/userControlDescription.xaml.cs +++ b/WpfApp1/userControlDescription.xaml.cs @@ -16,42 +16,75 @@ using System.Windows.Media; using System.Windows.Media.Imaging; using System.Windows.Navigation; using System.Windows.Shapes; -using VideoLibrary; namespace WpfApp1 { + /// + /// Classe EditWeGoEventArgs qui implémente EventArgs + /// Elle permet de créer un argument qui permet de transformer le content control de la main window en UserControlEdit après avoir cliquer sur le bouton Edit + /// public class EditWeGoEventArgs : EventArgs { + /// + /// Le requin que l'on veut passer lors de l'événement + /// public Requin Requin { get; private set; } + /// + /// L'Evénement pour changer le content control + /// + /// public EditWeGoEventArgs(Requin requin) => Requin = requin; } + /// + /// Classe AccueilWeGo qui implémente EventArgs + /// Elle permet de créer un argument qui permet de transformer le content control de la main window en UserControlAccueil après avoir cliquer sur le bouton Exit + /// public class AccueilWeGoEventArgs : EventArgs { + /// + /// La Zone que l'on veut passer lors de l'événement + /// public Nullable Zone { get; private set; } + /// + /// L'Evénement pour crevenir à la page d'accueil + /// + /// public AccueilWeGoEventArgs(Zone? zone) => Zone = zone; } /// /// Logique d'interaction pour userControlDescription.xaml - /// UserControl qui affiche la desription d'un requin /// public partial class userControlDescription : UserControl { + + /// + /// UserControl qui affiche la desription d'un requin + /// public userControlDescription() { InitializeComponent(); } - public ManagerUsers MgrUser => (Application.Current as App).LeManagerUsers; //ManagerUser lié à celui de l'app - public Manager Mgr => (Application.Current as App).LeManager; //Manager lié à celui de l'app + /// + /// ManagerUser lié à celui de l'app + /// + public ManagerUsers MgrUser => (Application.Current as App).LeManagerUsers; + /// + /// Manager lié à celui de l'app + /// + public Manager Mgr => (Application.Current as App).LeManager; private Requin _requin; - public Requin requin //le requin qui permet de changer l'affichage de la page + /// + /// le requin qui permet de changer l'affichage de la page + /// + public Requin requin { get { return _requin; } set @@ -61,20 +94,39 @@ namespace WpfApp1 } } + /// + /// La zone de la page principale + /// public Zone? zone { get; set; } + /// + /// L'Event handler EditWeGo + /// public event EventHandler EditWeGo; + /// + /// L'événement appelé lors du clique + /// + /// protected virtual void OnEditWeGo(EditWeGoEventArgs args) => EditWeGo?.Invoke(this, args); + /// + /// L'eventhandler AccueilWeGo + /// public event EventHandler AccueilWeGo; + /// + /// L'événement appelé lors du clique + /// + /// protected virtual void OnAccueilWeGo(AccueilWeGoEventArgs args) => AccueilWeGo?.Invoke(this, args); - + /// + /// Un compteur + /// public int cmp = 0;