Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Scaladoc: use @note tag #852

Merged
merged 1 commit into from
Nov 22, 2024
Merged

Scaladoc: use @note tag #852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions core/trace/src/main/scala-2/org/typelevel/otel4s/trace/SpanMacro.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ private[otel4s] trait SpanMacro[F[_]] {

/** Adds an event to the span with the given attributes and timestamp.
*
* '''Note''': the timestamp should be based on `Clock[F].realTime`. Using `Clock[F].monotonic` may lead to an
* incorrect data.
* @note
* the timestamp should be based on `Clock[F].realTime`. Using `Clock[F].monotonic` may lead to an incorrect data.
*
* @param name
* the name of the event
Expand All @@ -98,8 +98,8 @@ private[otel4s] trait SpanMacro[F[_]] {

/** Adds an event to the span with the given attributes and timestamp.
*
* '''Note''': the timestamp should be based on `Clock[F].realTime`. Using `Clock[F].monotonic` may lead to an
* incorrect data.
* @note
* the timestamp should be based on `Clock[F].realTime`. Using `Clock[F].monotonic` may lead to an incorrect data.
*
* @param name
* the name of the event
Expand Down
8 changes: 4 additions & 4 deletions core/trace/src/main/scala-3/org/typelevel/otel4s/trace/SpanMacro.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ private[otel4s] trait SpanMacro[F[_]] {

/** Adds an event to the span with the given attributes and timestamp.
*
* '''Note''': the timestamp should be based on `Clock[F].realTime`. Using `Clock[F].monotonic` may lead to an
* incorrect data.
* @note
* the timestamp should be based on `Clock[F].realTime`. Using `Clock[F].monotonic` may lead to an incorrect data.
*
* @param name
* the name of the event
Expand All @@ -104,8 +104,8 @@ private[otel4s] trait SpanMacro[F[_]] {

/** Adds an event to the span with the given attributes and timestamp.
*
* '''Note''': the timestamp should be based on `Clock[F].realTime`. Using `Clock[F].monotonic` may lead to an
* incorrect data.
* @note
* the timestamp should be based on `Clock[F].realTime`. Using `Clock[F].monotonic` may lead to an incorrect data.
*
* @param name
* the name of the event
Expand Down
7 changes: 4 additions & 3 deletions core/trace/src/main/scala/org/typelevel/otel4s/trace/Span.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,8 @@ trait Span[F[_]] extends SpanMacro[F] {

/** Updates the name of the [[Span]].
*
* '''Note''': if used, this will override the name provided via the [[SpanBuilder]].
* @note
* if used, this will override the name provided via the [[SpanBuilder]].
*
* '''Caution''': upon this update, any sampling behavior based on span's name will depend on the implementation.
*
Expand All @@ -96,8 +97,8 @@ trait Span[F[_]] extends SpanMacro[F] {
*
* Only the timing of the first end call for a given span will be recorded, the subsequent calls will be ignored.
*
* '''Note''': the timestamp should be based on `Clock[F].realTime`. Using `Clock[F].monotonic` may lead to a missing
* span.
* @note
* the timestamp should be based on `Clock[F].realTime`. Using `Clock[F].monotonic` may lead to a missing span.
*
* @param timestamp
* the explicit timestamp from the epoch
Expand Down
3 changes: 2 additions & 1 deletion sdk/common/shared/src/main/scala/org/typelevel/otel4s/sdk/common/InstrumentationScope.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,8 @@ object InstrumentationScope {

/** Assigns the attributes to the scope.
*
* '''Note''': if called multiple times, only the last specified attributes will be used.
* @note
* if called multiple times, only the last specified attributes will be used.
*
* @param attributes
* the attributes to assign
Expand Down