Merge branch 'main' into 'main'

Ajout de documentation

See merge request !86

T3-Unity/Assets/Scripts/Waypoints/WaypointsFactory.cs

@@ -6,8 +6,6 @@
     using Mapbox.Utils;
     using Mapbox.Directions;
     using Mapbox.Unity;
-    using Mapbox.Json;
-    using Mapbox.Utils.JsonConverters;
     using Mapbox.Unity.Map;
     using Mapbox.Unity.Utilities;
 
@@ -53,18 +51,11 @@
 
         //! @brief Retourne l'instance
         //! @details return @a instance
+        //! @return @e WaypointsFactory Instance actuelle.
         public static WaypointsFactory getInstance()
         {
             return instance;
         }
-        /*
-        //! @brief Retourne si les waypoints ont fini d'être crée
-        //! @details Retourne si les waypoints ont fini d'être crée
-        public bool getTest()
-        {
-            return test;
-        }*/
-
 
         //! @brief Retourne les coordonnées des waypoints
         //! @details Retourne la liste des coordonnées des waypoints
@@ -84,7 +75,7 @@
             _directions.Query(_directionResource, HandleDirectionsResponse);
         }
 
-
+        //! @param res Réponse de la direction.
         //! @brief Enregistre les informations
         //! @details Enregistre les informations en format json deserialize
         void HandleDirectionsResponse(DirectionsResponse res)
@@ -93,7 +84,8 @@
             test = false;
         }
 
-
+        //! @param coord1 Coordonnée 1
+        //! @param coord2 Coordonnée 2
         //! @brief Lance la création de route
         //! @details Lance la création de route
         public void click(string coord1, string coord2)
@@ -108,6 +100,7 @@
 
         //! @brief Lance la création de route
         //! @details Lance la création de route
+        //! @return @e IEnumerator Permet d'assigner un délai à la répétition de la coroutine.
         IEnumerator createRoad()
         {
             if (coordonnee1 == "" || coordonnee2 == "")
@@ -137,7 +130,7 @@
             }
         }
 
-
+        //! @param coordonnesPoints Coordonnées du point à ajouter.
         //! @brief Enregistre un waypoints
         //! @details Enregistre les coordonnées d'un waypoints
         void PlacementWaypoint(Vector2d coordonnesPoints)