docs: Update kdocs in project

Author: thorlauridsen

apps/api/src/main/kotlin/com/github/thorlauridsen/controller/CustomerController.kt

@@ -10,11 +10,14 @@ import java.net.URI
 import java.util.UUID
 
 /**
- * REST controller for customers.
- * This controller consists of endpoints for:
+ * This REST controller consists of endpoints for:
  * - Saving customers.
  * - Fetching customers.
  *
+ * This class implements the [ICustomerController] interface and
+ * overrides the methods defined in the interface with implementations.
+ * The controller is responsible for converting data transfer objects to models and vice versa.
+ *
  * @param customerService [CustomerService] service layer.
  */
 @Controller

apps/api/src/main/kotlin/com/github/thorlauridsen/controller/ICustomerController.kt

@@ -20,6 +20,12 @@ import java.util.UUID
 
 const val CUSTOMER_BASE_ENDPOINT = "/customers"
 
+/**
+ * Customer controller interface.
+ * This interface defines the endpoints for the customer controller.
+ * It also defines the operations which will be used in the OpenAPI documentation.
+ * The purpose with this interface is to separate the controller definition from the implementation.
+ */
 @Tag(name = "Customer Controller", description = "API for managing customers")
 @RequestMapping(CUSTOMER_BASE_ENDPOINT)
 interface ICustomerController {

settings.gradle.kts

@@ -20,7 +20,7 @@ pluginManagement {
 }
 
 /**
- * Includes all subprojects within the given directory.
+ * Include all subprojects within the given directory.
  * This function scans the given directory for subdirectories containing a build.gradle.kts file.
  * @param directory The relative path (from the root project) of the directory containing subprojects.
  */