From a8f15e93cd3878276de3dffd22117ebc5d7940f4 Mon Sep 17 00:00:00 2001 From: Andreas Tschabuschnig Date: Mon, 15 Jan 2024 09:57:25 +0800 Subject: [PATCH] update transportserver doc --- .../com/izivia/ocpi/toolkit/transport/TransportServer.kt | 5 ++++- 1 file changed, 4 insertions(+), 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 index ae57ad7..28b7fad 100644 --- 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 }