update transportserver doc

IZIVIA · Jan 15, 2024 · a8f15e9 · a8f15e9
1 parent dca9ee5
commit a8f15e9
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/transport/src/main/kotlin/com/izivia/ocpi/toolkit/transport/TransportServer.kt b/transport/src/main/kotlin/com/izivia/ocpi/toolkit/transport/TransportServer.kt
@@ -33,7 +33,10 @@ interface TransportServer {
     fun stop()
 
     /**
-     * The configured baseUrl this server listens to, used to generate NextPageUrl and Endpoint Url
+     * The configured baseUrl this server listens to.
+     * Used by [com.izivia.ocpi.toolkit.common.OcpiSelfRegisteringModuleServer] to generate Endpoint URL.
+     * Can be used by implementations of TransportServer to populate the baseUrl of HttpRequest (see example), which in
+     * turn is used to generate NextPageUrl of SearchResult
      */
     fun baseUrl(): String
 }