Markdown Documentation Comments

Author: ZahidFKhan

src/test/java/com/github/streams/interview/problems/employee/E_EmployeesBelongToEachDept.java

@@ -9,27 +9,29 @@
 import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 
-/**
- * Returns a map where each department is mapped to a list of employee names belonging to that
- * department.
- *
- * <p>Example:
- *
- * <pre>
- * Input: [
- *   Employee("John", "Sales"),
- *   Employee("Alice", "Marketing"),
- *   Employee("Bob", "Sales"),
- *   Employee("Charlie", "IT")
- * ]
- * <br>
- * Output: {
- *   "Sales"     : "John", "Bob",
- *   "Marketing" : "Alice",
- *   "IT"        : "Charlie"
- * }
- * </pre>
- */
+/// Returns a map where each department is mapped to a list of employee names belonging to that
+/// department.
+///
+/// ### Example:
+///
+/// ### Input:
+/// ```json
+/// [
+///   Employee("John", "Sales"),
+///   Employee("Alice", "Marketing"),
+///   Employee("Bob", "Sales"),
+///   Employee("Charlie", "IT")
+/// ]
+/// ```
+///
+/// ### Output:
+/// ```json
+/// {
+///   "Sales"     : "John", "Bob",
+///   "Marketing" : "Alice",
+///   "IT"        : "Charlie"
+/// }
+/// ```
 class E_EmployeesBelongToEachDept {
   @Test
   @Disabled

src/test/java/com/github/streams/interview/problems/employee/F_ManagerWithMaxEmployees.java

@@ -8,25 +8,27 @@
 
 class F_ManagerWithMaxEmployees {
 
-  /**
-   * Returns the manager with the maximum number of employees.
-   *
-   * <p>This method takes a list of employees as input, groups them by their managers, and returns
-   * the manager with the most employees.
-   *
-   * <p>Example:
-   *
-   * <pre>
-   * Input: [
-   *   Employee("John", "Alice"), // John's manager is Alice
-   *   Employee("Bob", "Alice"), // Bob's manager is Alice
-   *   Employee("Charlie", "David"), // Charlie's manager is David
-   *   Employee("David", null) // David has no manager
-   * ]
-   * <br>
-   * Output: "Alice" (since Alice has 2 employees: John and Bob)
-   * </pre>
-   */
+  ///  Returns the manager with the maximum number of employees.
+  ///
+  /// Given a list of employees as input, groups them by their managers, and returns
+  /// the manager with the most employees.
+  ///
+  /// ### Example:
+  ///
+  /// #### Input:
+  /// ```json
+  ///   Employee("John", "Alice"), // John's manager is Alice
+  ///   Employee("Bob", "Alice"), // Bob's manager is Alice
+  ///   Employee("Charlie", "David"), // Charlie's manager is David
+  ///   Employee("David", null) // David has no manager
+  /// ```
+  ///
+  ///
+  /// #### Output:
+  /// ```json
+  /// "Alice"
+  /// ```
+  /// Explanation: (since Alice has 2 employees: John and Bob)
   @Test
   @Disabled
   void findManagerWithMaxEmployeesTest() {