Skip to content

Commit

Permalink
Add javadoc to Subsegment.close() method. (aws#342)
Browse files Browse the repository at this point in the history
This method should not be used externally in general. See aws#318 for details.
  • Loading branch information
Kurru authored Jul 28, 2022
1 parent 3692320 commit 5981f27
Showing 1 changed file with 8 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ static Subsegment noOp(Segment parent, AWSXRayRecorder recorder) {
/**
* Serializes the subsegment as a standalone String with enough information for the subsegment to be streamed on its own.
* @return
* the string representation of the subsegment with enouogh information for it to be streamed
* the string representation of the subsegment with enough information for it to be streamed
*/
String streamSerialize();

Expand All @@ -96,10 +96,16 @@ static Subsegment noOp(Segment parent, AWSXRayRecorder recorder) {
* own. Only used for debugging.
*
* @return
* the pretty string representation of the subsegment with enouogh information for it to be streamed
* the pretty string representation of the subsegment with enough information for it to be streamed
*/
String prettyStreamSerialize();

/**
* Implements the {@link AutoCloseable} interface.
*
* Warning. This method is intended to be private to the xray library and should not be used externally. Instead, use
* {@link com.amazonaws.xray.AWSXRay#endSubsegment(Subsegment)}.
*/
@Override
void close();
}

0 comments on commit 5981f27

Please sign in to comment.