Pull request #190: Minor naming and doc improvements

Merge in OP/openkit-java from noissue/minor-improvements to main

* commit 'c7daeadff272fbdb2e372cf4ba347949aa8fe085':
  Minor naming and doc improvements

GitOrigin-RevId: 1c4e5a5b7908f4ae0cfc84ce9b4ca14f69e4a01c

docs/example.md

@@ -262,9 +262,9 @@ Action parentAction = action.leaveAction(); // returns the appropriate RootActio
 Action parent = parentAction.leaveAction(); // will always return null
 ```
 
-## Cancelling Actions
+## Canceling Actions
 
-Cancelling an `Action` is similar to leaving an `Action`, except that the `Action` will be discarded
+Canceling an `Action` is similar to leaving an `Action`, except that the `Action` will be discarded
 and not reported to Dynatrace. Open child objects, like child actions and web request tracers, will be
 discarded as well.
 To cancel an `Action` simply use the method `cancelAction` as shown in the example below.

src/main/java/com/dynatrace/openkit/api/http/HttpResponse.java

@@ -70,6 +70,8 @@ public interface HttpResponse {
      * <p>
      *     If the header occurs multiple times, it depends on the underlying implementation
      *     which value is returned.
+	 *
+	 *     In this case prefer {@link #getHeaders()} instead.
      * </p>
      *
      * @return Value associated with HTTP response header {@code name} or {@code null}.

src/main/java/com/dynatrace/openkit/api/http/HttpResponseInterceptor.java

@@ -20,7 +20,7 @@
  * An interface allowing to intercept an HTTP response from Dynatrace backends.
  *
  * <p>
- *     This interceptor is only applied to HTTP requests which are sent to Dynatrace backends.
+ *     This interceptor is only applied to HTTP responses coming from Dynatrace backend requests.
  * </p>
  */
 public interface HttpResponseInterceptor {

src/test/java/com/dynatrace/openkit/core/objects/BaseActionImplTest.java

@@ -1250,7 +1250,7 @@ public void closeActionLeavesTheAction() {
     }
 
     @Test
-    public void afterCancellingAnActionItIsLeft() {
+    public void afterCancelingAnActionItIsLeft() {
         // given
         BaseActionImpl target = new StubBaseActionImpl(logger, openKitComposite, ACTION_NAME, beacon);
 
@@ -1382,7 +1382,7 @@ public void cancelingAnAlreadyCanceledActionReturnsTheParentAction() {
     }
 
     @Test
-    public void cancelingAnAlreadyCancelledActionReturnsImmediately() {
+    public void cancelingAnAlreadyCanceledActionReturnsImmediately() {
         // given
         BaseActionImpl target = new StubBaseActionImpl(logger, openKitComposite, ACTION_NAME, beacon);
         target.cancelAction(); // canceling the first time

src/test/java/com/dynatrace/openkit/protocol/http/NullHttpRequestInterceptorTest.java

@@ -33,7 +33,7 @@ public void setUp() {
     }
 
     @Test
-    public void interceptDoesNotInteractHttpResponse() {
+    public void interceptDoesNotInteractWithHttpRequest() {
         // given
         NullHttpRequestInterceptor target = NullHttpRequestInterceptor.INSTANCE;
 

src/test/java/com/dynatrace/openkit/protocol/http/NullHttpResponseInterceptorTest.java

@@ -33,7 +33,7 @@ public void setUp() {
     }
 
     @Test
-    public void interceptDoesNotInteractHttpResponse() {
+    public void interceptDoesNotInteractWithHttpResponse() {
         // given
         NullHttpResponseInterceptor target = NullHttpResponseInterceptor.INSTANCE;