Document and validate web-api constructs

[aaa.git] / web / api / src / main / java / org / opendaylight / aaa / web / WebServer.java

diff --git a/web/api/src/main/java/org/opendaylight/aaa/web/WebServer.java b/web/api/src/main/java/org/opendaylight/aaa/web/WebServer.java
index c7964381fcce33a5a2a9755051537cb660023f91..c08e0792718e20f640ffe9a50604c4a51a85b096 100644 (file)
--- a/web/api/src/main/java/org/opendaylight/aaa/web/WebServer.java
+++ b/web/api/src/main/java/org/opendaylight/aaa/web/WebServer.java
@@ -32,9 +32,11 @@ public interface WebServer {
     Registration registerWebContext(WebContext webContext) throws ServletException;
 
     /**
-     * Base URL of this web server, without any contexts. In production, this would
-     * likely be HTTPS with a well known hostname and fixed port configured e.g. in
-     * a Karaf etc/ configuration file. In tests, this would be typically be HTTP on
+     * Get base URL of this web server, without any contexts.
+     *
+     * <p>
+     * In production, this would likely be HTTPS with a well known hostname and fixed port configured.
+     * For example, in Karaf etc/ configuration file. In tests, this would be typically be HTTP on
      * localhost and an arbitrarily chosen port.
      *
      * @return base URL, with http[s] prefix and port, NOT ending in slash