Improve javadoc.

cszhan163 · Jun 4, 2014 · 5905108 · 5905108
1 parent 1953503
commit 5905108
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/...ing/src/main/java/com/github/kristofa/brave/resteasy/BraveClientExecutionInterceptor.java b/...ing/src/main/java/com/github/kristofa/brave/resteasy/BraveClientExecutionInterceptor.java
@@ -31,7 +31,14 @@
  * requests.
  * </ul>
  * If you add a http header with key: X-B3-SpanName, and with a custom span name as value this value will be used as span
- * name iso the context path.
+ * name iso the path.
+ * <p/>
+ * We assume the first part of the URI is the context path. The context name will be used as service name in endpoint.
+ * Remaining part of path will be used as span name unless X-B3-SpanName http header is set. For example, if we have URI:
+ * <p/>
+ * <code>http://localhost:8080/service/path/a/b</code>
+ * <p/>
+ * The service name will be 'service. The span name will be '/path/a/b'.
  * 
  * @author kristof
  */