Define a replacement for Restconf{Error,Exception,Future}

[netconf.git] / restconf / restconf-nb / src / main / java / org / opendaylight / restconf / server / api / package-info.java

diff --git a/restconf/restconf-nb/src/main/java/org/opendaylight/restconf/server/api/package-info.java b/restconf/restconf-nb/src/main/java/org/opendaylight/restconf/server/api/package-info.java
index d31d477278b30e73f07f8d79bfa2c030a30c8a9d..655d0add8d81cde73b1027a1875e044f71f5b411 100644 (file)
--- a/restconf/restconf-nb/src/main/java/org/opendaylight/restconf/server/api/package-info.java
+++ b/restconf/restconf-nb/src/main/java/org/opendaylight/restconf/server/api/package-info.java
@@ -6,6 +6,8 @@
  * and is available at http://www.eclipse.org/legal/epl-v10.html
  */
 /**
- * Interface to a RESTCONF server instance. The primary entry point is {@link RestconfServer}.
+ * Interface to a RESTCONF server instance. The primary entry point is {@link RestconfServer}, which is typically given
+ * a {@link ServerRequest} coupled with an {@link org.opendaylight.restconf.api.ApiPath} and perhaps a
+ * {@link RequestBody}.
  */
 package org.opendaylight.restconf.server.api;
\ No newline at end of file