Merge pull request #454 from iRevive/meter-improve-docs

metrics: improve Scaladoc regarding supported measurement values
typelevel · Jan 28, 2024 · f3a690f · f3a690f
2 parents d55916a + 4d91b24
commit f3a690f
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 18 deletions.
diff --git a/core/metrics/src/main/scala/org/typelevel/otel4s/metrics/Counter.scala b/core/metrics/src/main/scala/org/typelevel/otel4s/metrics/Counter.scala
@@ -32,8 +32,9 @@ import org.typelevel.otel4s.meta.InstrumentMeta
   *   the higher-kinded type of a polymorphic effect
   *
   * @tparam A
-  *   the type of the values to record. OpenTelemetry specification expects `A`
-  *   to be either [[scala.Long]] or [[scala.Double]]
+  *   the type of the values to record. The type must have an instance of
+  *   [[MeasurementValue]]. [[scala.Long]] and [[scala.Double]] are supported
+  *   out of the box.
   */
 trait Counter[F[_], A] extends CounterMacro[F, A]
 
@@ -45,8 +46,9 @@ object Counter {
     *   the higher-kinded type of a polymorphic effect
     *
     * @tparam A
-    *   the type of the values to record. OpenTelemetry specification expects
-    *   `A` to be either [[scala.Long]] or [[scala.Double]].
+    *   the type of the values to record. The type must have an instance of
+    *   [[MeasurementValue]]. [[scala.Long]] and [[scala.Double]] are supported
+    *   out of the box.
     */
   trait Builder[F[_], A] {
 

diff --git a/core/metrics/src/main/scala/org/typelevel/otel4s/metrics/Histogram.scala b/core/metrics/src/main/scala/org/typelevel/otel4s/metrics/Histogram.scala
@@ -38,8 +38,9 @@ import scala.concurrent.duration.TimeUnit
   *   the higher-kinded type of a polymorphic effect
   *
   * @tparam A
-  *   the type of the values to record. OpenTelemetry specification expects `A`
-  *   to be either [[scala.Long]] or [[scala.Double]].
+  *   the type of the values to record. The type must have an instance of
+  *   [[MeasurementValue]]. [[scala.Long]] and [[scala.Double]] are supported
+  *   out of the box.
   */
 trait Histogram[F[_], A] extends HistogramMacro[F, A]
 
@@ -51,8 +52,9 @@ object Histogram {
     *   the higher-kinded type of a polymorphic effect
     *
     * @tparam A
-    *   the type of the values to record. OpenTelemetry specification expects
-    *   `A` to be either [[scala.Long]] or [[scala.Double]].
+    *   the type of the values to record. The type must have an instance of
+    *   [[MeasurementValue]]. [[scala.Long]] and [[scala.Double]] are supported
+    *   out of the box.
     */
   trait Builder[F[_], A] {
 

diff --git a/core/metrics/src/main/scala/org/typelevel/otel4s/metrics/Meter.scala b/core/metrics/src/main/scala/org/typelevel/otel4s/metrics/Meter.scala
@@ -63,8 +63,8 @@ trait Meter[F[_]] {
     *   the name of the instrument
     *
     * @tparam A
-    *   the type of the measurement. `Long` and `Double` are supported out of
-    *   the box
+    *   the type of the measurement. [[scala.Long]] and [[scala.Double]] are
+    *   supported out of the box
     */
   def counter[A: MeasurementValue](name: String): Counter.Builder[F, A]
 
@@ -95,8 +95,8 @@ trait Meter[F[_]] {
     *   the name of the instrument
     *
     * @tparam A
-    *   the type of the measurement. `Long` and `Double` are supported out of
-    *   the box
+    *   the type of the measurement. [[scala.Long]] and [[scala.Double]] are
+    *   supported out of the box
     */
   def histogram[A: MeasurementValue](name: String): Histogram.Builder[F, A]
 
@@ -128,8 +128,8 @@ trait Meter[F[_]] {
     *   the name of the instrument
     *
     * @tparam A
-    *   the type of the measurement. `Long` and `Double` are supported out of
-    *   the box
+    *   the type of the measurement. [[scala.Long]] and [[scala.Double]] are
+    *   supported out of the box
     */
   def upDownCounter[A: MeasurementValue](
       name: String

diff --git a/core/metrics/src/main/scala/org/typelevel/otel4s/metrics/UpDownCounter.scala b/core/metrics/src/main/scala/org/typelevel/otel4s/metrics/UpDownCounter.scala
@@ -32,8 +32,9 @@ import org.typelevel.otel4s.meta.InstrumentMeta
   *   the higher-kinded type of a polymorphic effect
   *
   * @tparam A
-  *   the type of the values to record. OpenTelemetry specification expects `A`
-  *   to be either [[scala.Long]] or [[scala.Double]]
+  *   the type of the values to record. The type must have an instance of
+  *   [[MeasurementValue]]. [[scala.Long]] and [[scala.Double]] are supported
+  *   out of the box.
   */
 trait UpDownCounter[F[_], A] extends UpDownCounterMacro[F, A]
 
@@ -45,8 +46,9 @@ object UpDownCounter {
     *   the higher-kinded type of a polymorphic effect
     *
     * @tparam A
-    *   the type of the values to record. OpenTelemetry specification expects
-    *   `A` to be either [[scala.Long]] or [[scala.Double]].
+    *   the type of the values to record. The type must have an instance of
+    *   [[MeasurementValue]]. [[scala.Long]] and [[scala.Double]] are supported
+    *   out of the box.
     */
   trait Builder[F[_], A] {