From 94685ecf399bd47bfb44719990a53e8f9ba458f1 Mon Sep 17 00:00:00 2001
From: Mirna Gama <mirnabeatrizgamav@gmail.com>
Date: Sat, 6 Jan 2024 13:43:04 -0300
Subject: [PATCH] [R4] Add java doc to custom repository method

---
 .../domain/repositories/DoctorRepository.java                | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/main/java/com/mirna/hospitalmanagementapi/domain/repositories/DoctorRepository.java b/src/main/java/com/mirna/hospitalmanagementapi/domain/repositories/DoctorRepository.java
index a78532f..be7f6d4 100644
--- a/src/main/java/com/mirna/hospitalmanagementapi/domain/repositories/DoctorRepository.java
+++ b/src/main/java/com/mirna/hospitalmanagementapi/domain/repositories/DoctorRepository.java
@@ -14,5 +14,10 @@ import com.mirna.hospitalmanagementapi.domain.entities.Doctor;
 */
 public interface DoctorRepository extends JpaRepository<Doctor, Long> {
 
+	/**
+	 * 
+	 * @param pageable Pagination information, such as size and page number
+	 * @return A paginated list with active stored doctors if successful, or null if there is an error
+	 */
 	Page<Doctor> findDoctorsByActiveTrue(Pageable pageable);
 }