gitea/hospital-management-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[R5] Fix java doc

Browse Source
This commit is contained in:
Mirna Gama 2024-01-06 18:13:29 -03:00 committed by Mirna Gama
parent eb32b7e182
commit 2e657cd64c
2 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/main/java/com/mirna/hospitalmanagementapi/application/controllers/PatientController.java
View File

@ -59,7 +59,7 @@ public class PatientController {
/** /**
* Get method to receive a Patient record by the provided ID * Get method to receive a Patient record by the provided ID
* *
* @param id * @param id A long representing the patient's unique identifier
* *
* @return A response entity containing the saved patient if successful, or * @return A response entity containing the saved patient if successful, or
* a 404 level error if it is non-existent * a 404 level error if it is non-existent

10
src/main/java/com/mirna/hospitalmanagementapi/application/services/DoctorServiceImpl.java
View File

@ -57,8 +57,10 @@ public class DoctorServiceImpl implements DoctorService {
* Finds a stored doctor by id. * Finds a stored doctor by id.
* *
* @param id A long representing the doctor's unique identifier * @param id A long representing the doctor's unique identifier
*
* @return The corresponding doctor if successful, or throws an * @return The corresponding doctor if successful, or throws an
* EntityNotFoundException if it is non-existent. * EntityNotFoundException if it is non-existent.
*
* @throws EntityNotFoundException When doctor with id provided is non-existent * @throws EntityNotFoundException When doctor with id provided is non-existent
*/ */
@Override @Override
@ -86,7 +88,9 @@ public class DoctorServiceImpl implements DoctorService {
* Updates an existing doctor record * Updates an existing doctor record
* @param doctorUpdatedDataDTO Data transfer object containing the doctor updated data along with their corresponding id * @param doctorUpdatedDataDTO Data transfer object containing the doctor updated data along with their corresponding id
* *
* @return The updated doctor if successful, or null if there is an error. * @return The updated doctor if successful, or throws an
* EntityNotFoundException if it is non-existent.
* @throws EntityNotFoundException When doctor with id provided is non-existent
*/ */
@Override @Override
public Doctor updateDoctor(DoctorUpdatedDataDTO doctorUpdatedDataDTO) throws EntityNotFoundException { public Doctor updateDoctor(DoctorUpdatedDataDTO doctorUpdatedDataDTO) throws EntityNotFoundException {
@ -150,7 +154,9 @@ public class DoctorServiceImpl implements DoctorService {
* Deactivates an existing doctor record by provided id * Deactivates an existing doctor record by provided id
* @param id Long that represents the doctor's unique identifier * @param id Long that represents the doctor's unique identifier
* *
* @return The deactivated doctor if successful, or null if there is an error. * @return The deactivated doctor if successful, or throws an
* EntityNotFoundException if it is non-existent.
* @throws EntityNotFoundException When doctor with id provided is non-existent
*/ */
@Override @Override
public Doctor deactivateDoctor(Long id) throws EntityNotFoundException { public Doctor deactivateDoctor(Long id) throws EntityNotFoundException {