From 800d384d8d55b978ecfe92bdcbb14bd28090c562 Mon Sep 17 00:00:00 2001 From: sandre Date: Wed, 25 Mar 2026 21:19:16 +0100 Subject: [PATCH] Add comments --- .../Controllers/TunnelController.cs | 11 ++++- .../Controllers/TunnelFlightController.cs | 41 +++++++++++++++---- .../src/app/login/login.component.html | 2 +- 3 files changed, 44 insertions(+), 10 deletions(-) diff --git a/Back/skydiveLogs-api/Controllers/TunnelController.cs b/Back/skydiveLogs-api/Controllers/TunnelController.cs index ba890a9..79b2083 100644 --- a/Back/skydiveLogs-api/Controllers/TunnelController.cs +++ b/Back/skydiveLogs-api/Controllers/TunnelController.cs @@ -22,7 +22,10 @@ namespace skydiveLogs_api.Controllers #region Public Methods - // GET: api/Tunnel + /// + /// Retrieves a list of all tunnels. + /// + /// A collection of TunnelResp objects containing all tunnels. [HttpGet] [EnableCors] public IEnumerable Get() @@ -31,7 +34,11 @@ namespace skydiveLogs_api.Controllers return _mapper.Map>(result); } - // GET: api/Tunnel/5 + /// + /// Retrieves a tunnel by its ID. + /// + /// The tunnel ID to retrieve. + /// A TunnelResp object containing the tunnel details. [HttpGet("{id}")] [EnableCors] public TunnelResp Get(int id) diff --git a/Back/skydiveLogs-api/Controllers/TunnelFlightController.cs b/Back/skydiveLogs-api/Controllers/TunnelFlightController.cs index 4886112..90b34cd 100644 --- a/Back/skydiveLogs-api/Controllers/TunnelFlightController.cs +++ b/Back/skydiveLogs-api/Controllers/TunnelFlightController.cs @@ -23,7 +23,10 @@ namespace skydiveLogs_api.Controllers #region Public Methods - // GET: api/TunnelFlight + /// + /// Retrieves a list of all tunnel flights. + /// + /// A collection of TunnelFlightResp objects containing all tunnel flights. [HttpGet] [EnableCors] public IEnumerable Get() @@ -32,7 +35,11 @@ namespace skydiveLogs_api.Controllers return _mapper.Map>(result); } - // GET: api/TunnelFlight/5 + /// + /// Retrieves a tunnel flight by its ID. + /// + /// The tunnel flight ID to retrieve. + /// A TunnelFlightResp object containing the tunnel flight details. [HttpGet("{id}")] [EnableCors] public TunnelFlightResp Get(int id) @@ -41,7 +48,12 @@ namespace skydiveLogs_api.Controllers return _mapper.Map(result); } - // GET: api/TunnelFlight/20230101/20230701 + /// + /// Retrieves tunnel flights filtered by date range. + /// + /// The start date for filtering. + /// The end date for filtering. + /// A collection of TunnelFlightResp objects filtered by the specified date range. [HttpGet("{beginDate}/{endDate}")] [EnableCors] public IEnumerable Get(string beginDate, string endDate) @@ -50,7 +62,12 @@ namespace skydiveLogs_api.Controllers return _mapper.Map>(result); } - // GET: api/TunnelFlight/month/20230101/20230701 + /// + /// Retrieves tunnel flights grouped by month within a date range. + /// + /// The start date for grouping. + /// The end date for grouping. + /// A collection of StatisticForChartResp objects grouped by month. [HttpGet("month/{beginDate}/{endDate}")] [EnableCors] public IEnumerable GetGroupByMonth(string beginDate, string endDate) @@ -59,7 +76,10 @@ namespace skydiveLogs_api.Controllers return _mapper.Map>(result); } - // POST: api/Tunnel + /// + /// Adds a new tunnel flight to the system. + /// + /// TunnelFlightReq object containing the new tunnel flight data. [HttpPost] [EnableCors] public void Post([FromBody] TunnelFlightReq value) @@ -69,7 +89,11 @@ namespace skydiveLogs_api.Controllers _mapper.Map(value)); } - // PUT: api/TunnelFlight/5 + /// + /// Updates an existing tunnel flight. + /// + /// The tunnel flight ID to update. + /// TunnelFlightReq object containing the updated tunnel flight data. [HttpPut("{id}")] [EnableCors] public void Put(int id, [FromBody] TunnelFlightReq value) @@ -77,7 +101,10 @@ namespace skydiveLogs_api.Controllers _tunnelFlightService.UpdateTunnelFlight(id, _mapper.Map(value)); } - // DELETE: api/TunnelFlight/5 + /// + /// Deletes a tunnel flight by its ID. + /// + /// The tunnel flight ID to delete. [HttpDelete("{id}")] [EnableCors] public void Delete(int id) diff --git a/Front/skydivelogs-app/src/app/login/login.component.html b/Front/skydivelogs-app/src/app/login/login.component.html index 9931c0e..2dbad8e 100644 --- a/Front/skydivelogs-app/src/app/login/login.component.html +++ b/Front/skydivelogs-app/src/app/login/login.component.html @@ -30,7 +30,7 @@ - + {{ "App_Footer" | translate }}{{ version }} - @Séb