From 2054fa307a621de2df9e82a3e26d54c489ee28c8 Mon Sep 17 00:00:00 2001 From: sandre Date: Wed, 25 Mar 2026 21:00:48 +0100 Subject: [PATCH] Add comments --- .../Controllers/DropZoneController.cs | 44 ++++++++++++++++--- .../Controllers/GearController.cs | 28 +++++++++--- .../Controllers/ImageController.cs | 27 +++++++++--- .../Controllers/JumpTypeController.cs | 32 +++++++++++--- 4 files changed, 107 insertions(+), 24 deletions(-) diff --git a/Back/skydiveLogs-api/Controllers/DropZoneController.cs b/Back/skydiveLogs-api/Controllers/DropZoneController.cs index b22ca95..cf560cc 100644 --- a/Back/skydiveLogs-api/Controllers/DropZoneController.cs +++ b/Back/skydiveLogs-api/Controllers/DropZoneController.cs @@ -23,7 +23,11 @@ namespace skydiveLogs_api.Controllers #region Public Methods - // PUT: api/DropZone/AddToFavorite/5 + /// + /// Adds a drop zone to the user's favorites. + /// + /// The drop zone ID to add to favorites. + /// True if successful, false otherwise. [HttpPut("AddToFavorite/{id}")] [EnableCors] public bool AddToFavorite(int id) @@ -31,7 +35,10 @@ namespace skydiveLogs_api.Controllers return _dropZoneService.AddToFavorite(id); } - // DELETE: api/ApiWithActions + /// + /// Deletes a drop zone by its ID. + /// + /// The drop zone ID to delete. [HttpDelete("{id}")] [EnableCors] public void Delete(int id) @@ -39,7 +46,10 @@ namespace skydiveLogs_api.Controllers _dropZoneService.DeleteDzById(id); } - // GET: api/DropZone + /// + /// Retrieves a list of all drop zones. + /// + /// A collection of DropZoneResp objects containing all drop zones. [HttpGet] [EnableCors] public IEnumerable Get() @@ -49,7 +59,11 @@ namespace skydiveLogs_api.Controllers return _mapper.Map>(result); } - // GET: api/DropZone/5 + /// + /// Retrieves a drop zone by its ID. + /// + /// The drop zone ID to retrieve. + /// A DropZoneResp object containing the drop zone details. [HttpGet("{id}")] [EnableCors] public DropZoneResp Get(int id) @@ -59,6 +73,10 @@ namespace skydiveLogs_api.Controllers return _mapper.Map(result); } + /// + /// Retrieves a simplified list of all drop zones. + /// + /// A collection of DropZoneSimpleResp objects containing simplified drop zone data. [HttpGet("GetSimple")] [EnableCors] public IEnumerable GetSimple() @@ -68,7 +86,10 @@ namespace skydiveLogs_api.Controllers return _mapper.Map>(result); } - // POST: api/DropZone + /// + /// Adds a new drop zone to the system. + /// + /// DropZoneReq object containing the new drop zone data. [HttpPost] [EnableCors] public void Post([FromBody] DropZoneReq value) @@ -76,7 +97,12 @@ namespace skydiveLogs_api.Controllers _dropZoneService.AddNewDz(_mapper.Map(value)); } - // PUT: api/DropZone/5 + /// + /// Updates an existing drop zone. + /// + /// The drop zone ID to update. + /// DropZoneReq object containing the updated drop zone data. + /// True if successful, false otherwise. [HttpPut("{id}")] [EnableCors] public bool Put(int id, [FromBody] DropZoneReq value) @@ -84,7 +110,11 @@ namespace skydiveLogs_api.Controllers return _dropZoneService.UpdateDz(id, _mapper.Map(value)); } - // PUT: api/DropZone/RemoveToFavorite/15 + /// + /// Removes a drop zone from the user's favorites. + /// + /// The drop zone ID to remove from favorites. + /// True if successful, false otherwise. [HttpPut("RemoveToFavorite/{id}")] [EnableCors] public bool RemoveToFavorite(int id) diff --git a/Back/skydiveLogs-api/Controllers/GearController.cs b/Back/skydiveLogs-api/Controllers/GearController.cs index ae22892..40a34bd 100644 --- a/Back/skydiveLogs-api/Controllers/GearController.cs +++ b/Back/skydiveLogs-api/Controllers/GearController.cs @@ -23,7 +23,10 @@ namespace skydiveLogs_api.Controllers #region Public Methods - // DELETE: api/ApiWithActions/5 + /// + /// Deletes a gear item by its ID. + /// + /// The gear ID to delete. [HttpDelete("{id}")] [EnableCors] public void Delete(int id) @@ -31,17 +34,23 @@ namespace skydiveLogs_api.Controllers _gearService.DeleteGearById(id); } - // GET: api/Gear + /// + /// Retrieves a list of all gear items. + /// + /// A collection of GearResp objects containing all gear data. [HttpGet] [EnableCors] public IEnumerable Get() { - //var result = _gearService.GetAllGears(ConnectedUser); var result = _gearService.GetAllGears(); return _mapper.Map>(result); } - // GET: api/Gear/5 + /// + /// Retrieves a gear item by its ID. + /// + /// The gear ID to retrieve. + /// A GearResp object containing the gear details. [HttpGet("{id}")] [EnableCors] public GearResp Get(int id) @@ -50,7 +59,10 @@ namespace skydiveLogs_api.Controllers return _mapper.Map(result); } - // POST: api/Gear + /// + /// Adds a new gear item to the system. + /// + /// GearReq object containing the new gear data. [HttpPost] [EnableCors] public void Post([FromBody] GearReq value) @@ -58,7 +70,11 @@ namespace skydiveLogs_api.Controllers _gearService.AddNewGear(_mapper.Map(value)); } - // PUT: api/Gear/5 + /// + /// Updates an existing gear item. + /// + /// The gear ID to update. + /// GearReq object containing the updated gear data. [HttpPut("{id}")] [EnableCors] public void Put(int id, [FromBody] GearReq value) diff --git a/Back/skydiveLogs-api/Controllers/ImageController.cs b/Back/skydiveLogs-api/Controllers/ImageController.cs index 7a2a08a..5f90765 100644 --- a/Back/skydiveLogs-api/Controllers/ImageController.cs +++ b/Back/skydiveLogs-api/Controllers/ImageController.cs @@ -23,7 +23,10 @@ namespace skydiveLogs_api.Controllers #region Public Methods - // DELETE: api/Image/5 + /// + /// Deletes an image by its ID. + /// + /// The image ID to delete. [HttpDelete("{id}")] [EnableCors] public void Delete(int id) @@ -31,7 +34,10 @@ namespace skydiveLogs_api.Controllers _imageService.DeleteImageById(id); } - // GET: api/Image + /// + /// Retrieves a list of all images. + /// + /// A collection of ImageResp objects containing all images. [HttpGet] [EnableCors] public IEnumerable Get() @@ -40,7 +46,11 @@ namespace skydiveLogs_api.Controllers return _mapper.Map>(result); } - // GET: api/Image/5 + /// + /// Retrieves an image by its ID. + /// + /// The image ID to retrieve. + /// An ImageResp object containing the image details. [HttpGet("{id}")] [EnableCors] public ImageResp Get(int id) @@ -49,7 +59,10 @@ namespace skydiveLogs_api.Controllers return _mapper.Map(result); } - // POST: api/Image + /// + /// Adds a new image to the system. + /// + /// ImageReq object containing the new image data. [HttpPost] [EnableCors] public void Post([FromBody] ImageReq value) @@ -57,7 +70,11 @@ namespace skydiveLogs_api.Controllers _imageService.AddNewImage(_mapper.Map(value)); } - // PUT: api/Image/5 + /// + /// Updates an existing image. + /// + /// The image ID to update. + /// ImageReq object containing the updated image data. [HttpPut("{id}")] [EnableCors] public void Put(int id, [FromBody] ImageReq value) diff --git a/Back/skydiveLogs-api/Controllers/JumpTypeController.cs b/Back/skydiveLogs-api/Controllers/JumpTypeController.cs index f8b065a..a32f56e 100644 --- a/Back/skydiveLogs-api/Controllers/JumpTypeController.cs +++ b/Back/skydiveLogs-api/Controllers/JumpTypeController.cs @@ -23,7 +23,10 @@ namespace skydiveLogs_api.Controllers #region Public Methods - // DELETE: api/ApiWithActions/5 + /// + /// Deletes a jump type by its ID. + /// + /// The jump type ID to delete. [HttpDelete("{id}")] [EnableCors] public void Delete(int id) @@ -31,7 +34,10 @@ namespace skydiveLogs_api.Controllers _jumpTypeService.DeleteJumpTypeById(id); } - // GET: api/JumpType + /// + /// Retrieves a list of all jump types. + /// + /// A collection of JumpTypeResp objects containing all jump types. [HttpGet] [EnableCors] public IEnumerable Get() @@ -40,7 +46,10 @@ namespace skydiveLogs_api.Controllers return _mapper.Map>(result); } - // GET: api/JumpType/tunnel + /// + /// Retrieves jump types used for tunnel operations. + /// + /// A collection of JumpTypeResp objects containing tunnel jump types. [HttpGet("tunnel")] [EnableCors] public IEnumerable GetForTunnel() @@ -49,7 +58,11 @@ namespace skydiveLogs_api.Controllers return _mapper.Map>(result); } - // GET: api/JumpType/5 + /// + /// Retrieves a jump type by its ID. + /// + /// The jump type ID to retrieve. + /// A JumpTypeResp object containing the jump type details. [HttpGet("{id}")] [EnableCors] public JumpTypeResp Get(int id) @@ -58,7 +71,10 @@ namespace skydiveLogs_api.Controllers return _mapper.Map(result); } - // POST: api/JumpType + /// + /// Adds a new jump type to the system. + /// + /// JumpTypeReq object containing the new jump type data. [HttpPost] [EnableCors] public void Post([FromBody] JumpTypeReq value) @@ -66,7 +82,11 @@ namespace skydiveLogs_api.Controllers _jumpTypeService.AddNewJumpType(_mapper.Map(value)); } - // PUT: api/JumpType/5 + /// + /// Updates an existing jump type. + /// + /// The jump type ID to update. + /// JumpTypeReq object containing the updated jump type data. [HttpPut("{id}")] [EnableCors] public void Put(int id, [FromBody] JumpTypeReq value)