API doc: use minus sign (U+2212) where appropriate instead of `-`

The minus sign is usually rendered larger than `-` and therefore
visually more interesting for mathematical expressions.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I9f9dc8cde4ecce1b40e9fb08ac2e188221fffe3b
Reviewed-on: https://review.lttng.org/c/babeltrace/+/4527
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/include/babeltrace2/graph/message.h b/include/babeltrace2/graph/message.h
index 27730f69549dfc9aafe9ddee603049bffae46c98..c5a75bda2eff7233b0f98c2410e4674e8cebbb53 100644 (file)
--- a/include/babeltrace2/graph/message.h
+++ b/include/babeltrace2/graph/message.h
@@ -804,7 +804,7 @@ For example:
 
 - The maximum
   \ref api-tir-fc-int-prop-size "field value range" for an \bt_uint_fc
 
 - The maximum
   \ref api-tir-fc-int-prop-size "field value range" for an \bt_uint_fc

-  is [0,&nbsp;2<sup>64</sup>&nbsp;-&nbsp;1].
+  is [0,&nbsp;2<sup>64</sup>&nbsp;−&nbsp;1].

 
 - The available message types are stream beginning and end, event,
   packet beginning and end, discarded events and packets, and message
 
 - The available message types are stream beginning and end, event,
   packet beginning and end, discarded events and packets, and message

diff --git a/include/babeltrace2/integer-range-set.h b/include/babeltrace2/integer-range-set.h
index 86b0dc46cf050e8df359a5888ae1d7af590012f8..7e87fe9df5663fadc94bad680acdf3fcb59e485c 100644 (file)
--- a/include/babeltrace2/integer-range-set.h
+++ b/include/babeltrace2/integer-range-set.h
@@ -624,8 +624,8 @@ bt_integer_range_set_signed_borrow_range_by_index_const(
 
 Two signed integer range sets are considered equal if they contain the
 exact same signed integer ranges, whatever the order. In other words,
 
 Two signed integer range sets are considered equal if they contain the
 exact same signed integer ranges, whatever the order. In other words,

-a signed integer range set containing [-57, 23] and [24, 42]
-is \em not equal to a signed integer range containing [-57, 42].
+a signed integer range set containing [−57, 23] and [24, 42]
+is \em not equal to a signed integer range containing [−57, 42].

 
 @param[in] int_range_set_a
     Signed integer range set A.
 
 @param[in] int_range_set_a
     Signed integer range set A.

diff --git a/include/babeltrace2/trace-ir/clock-class.h b/include/babeltrace2/trace-ir/clock-class.h
index d9f77b8b13198d485b2a430e602c4d55d8b8252a..b28a6c5e8295352ec0622e1fb16bade342688661 100644 (file)
--- a/include/babeltrace2/trace-ir/clock-class.h
+++ b/include/babeltrace2/trace-ir/clock-class.h
@@ -147,12 +147,12 @@ The clock class's "offset in seconds" property can be negative.
 For example, considering:
 
 - Frequency: 1000 Hz.
 For example, considering:
 
 - Frequency: 1000 Hz.

-- Offset in seconds: -10 seconds.
+- Offset in seconds: −10 seconds.

 - Offset in cycles: 500 cycles (that is, 0.5 seconds).
 - Stream clock's value: 2000 cycles (that is, 2 seconds).
 
 - Offset in cycles: 500 cycles (that is, 0.5 seconds).
 - Stream clock's value: 2000 cycles (that is, 2 seconds).
 

-Then the computed value is -7.5 seconds from origin, or
--7,500,000,000 nanoseconds from origin.
+Then the computed value is −7.5 seconds from origin, or
+−7,500,000,000 nanoseconds from origin.

 
 <h1>Properties</h1>
 
 
 <h1>Properties</h1>
 

diff --git a/include/babeltrace2/trace-ir/field-class.h b/include/babeltrace2/trace-ir/field-class.h
index d8b49a3ee4ce3c593c080ab54d5658f1fc7ab9f5..4d8624828e598eac1916d85102214cae5c93cc68 100644 (file)
--- a/include/babeltrace2/trace-ir/field-class.h
+++ b/include/babeltrace2/trace-ir/field-class.h
@@ -1726,10 +1726,10 @@ See the \ref api-tir-fc-int-prop-size "field value range" property.
 
     <dl>
       <dt>Unsigned integer field class</dt>
 
     <dl>
       <dt>Unsigned integer field class</dt>

-      <dd>[0,&nbsp;2<sup><em>N</em></sup>&nbsp;-&nbsp;1]</dd>
+      <dd>[0,&nbsp;2<sup><em>N</em></sup>&nbsp;−&nbsp;1]</dd>

 
       <dt>Signed integer field class</dt>
 
       <dt>Signed integer field class</dt>

-      <dd>[-2<sup><em>N</em>&nbsp;-&nbsp;1</sup>,&nbsp;2<sup><em>N</em>&nbsp;-&nbsp;1</sup>&nbsp;-&nbsp;1]</dd>
+      <dd>[−2<sup><em>N</em>&nbsp;−&nbsp;1</sup>,&nbsp;2<sup><em>N</em>&nbsp;−&nbsp;1</sup>&nbsp;−&nbsp;1]</dd>

     </dl>
     @endparblock
 
     </dl>
     @endparblock
 


@@ -1760,10 +1760,10 @@ See the \ref api-tir-fc-int-prop-size "field value range" property.
 
     <dl>
       <dt>Unsigned integer field class</dt>
 
     <dl>
       <dt>Unsigned integer field class</dt>

-      <dd>[0,&nbsp;2<sup><em>N</em></sup>&nbsp;-&nbsp;1]</dd>
+      <dd>[0,&nbsp;2<sup><em>N</em></sup>&nbsp;−&nbsp;1]</dd>

 
       <dt>Signed integer field class</dt>
 
       <dt>Signed integer field class</dt>

-      <dd>[-2<sup><em>N</em></sup>,&nbsp;2<sup><em>N</em></sup>&nbsp;-&nbsp;1]</dd>
+      <dd>[−2<sup><em>N</em></sup>,&nbsp;2<sup><em>N</em></sup>&nbsp;−&nbsp;1]</dd>

     </dl>
     @endparblock
 
     </dl>
     @endparblock
 


@@ -1879,7 +1879,7 @@ property values:
     <th>Value
   <tr>
     <td>\ref api-tir-fc-int-prop-size "Field value range"
     <th>Value
   <tr>
     <td>\ref api-tir-fc-int-prop-size "Field value range"

-    <td>[0,&nbsp;2<sup>64</sup>&nbsp;-&nbsp;1]
+    <td>[0,&nbsp;2<sup>64</sup>&nbsp;−&nbsp;1]

   <tr>
     <td>\ref api-tir-fc-int-prop-base "Preferred display base"
     <td>#BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL
   <tr>
     <td>\ref api-tir-fc-int-prop-base "Preferred display base"
     <td>#BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL


@@ -1919,7 +1919,7 @@ property values:
     <th>Value
   <tr>
     <td>\ref api-tir-fc-int-prop-size "Field value range"
     <th>Value
   <tr>
     <td>\ref api-tir-fc-int-prop-size "Field value range"

-    <td>[-2<sup>63</sup>,&nbsp;2<sup>63</sup>&nbsp;-&nbsp;1]
+    <td>[−2<sup>63</sup>,&nbsp;2<sup>63</sup>&nbsp;−&nbsp;1]

   <tr>
     <td>\ref api-tir-fc-int-prop-base "Preferred display base"
     <td>#BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL
   <tr>
     <td>\ref api-tir-fc-int-prop-base "Preferred display base"
     <td>#BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL


@@ -2144,7 +2144,7 @@ following property values:
     <th>Value
   <tr>
     <td>\ref api-tir-fc-int-prop-size "Field value range"
     <th>Value
   <tr>
     <td>\ref api-tir-fc-int-prop-size "Field value range"

-    <td>[0,&nbsp;2<sup>64</sup>&nbsp;-&nbsp;1]
+    <td>[0,&nbsp;2<sup>64</sup>&nbsp;−&nbsp;1]

   <tr>
     <td>\ref api-tir-fc-int-prop-base "Preferred display base"
     <td>#BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL
   <tr>
     <td>\ref api-tir-fc-int-prop-base "Preferred display base"
     <td>#BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL


@@ -2409,7 +2409,7 @@ following property values:
     <th>Value
   <tr>
     <td>\ref api-tir-fc-int-prop-size "Field value range"
     <th>Value
   <tr>
     <td>\ref api-tir-fc-int-prop-size "Field value range"

-    <td>[-2<sup>63</sup>,&nbsp;2<sup>63</sup>&nbsp;-&nbsp;1]
+    <td>[−2<sup>63</sup>,&nbsp;2<sup>63</sup>&nbsp;−&nbsp;1]

   <tr>
     <td>\ref api-tir-fc-int-prop-base "Preferred display base"
     <td>#BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL
   <tr>
     <td>\ref api-tir-fc-int-prop-base "Preferred display base"
     <td>#BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL

diff --git a/include/babeltrace2/util.h b/include/babeltrace2/util.h
index 1c37b8e3b2668e27335c68cc38b854201a62e881..8426a0adeff4c0729c2d01ee001a7adb531226d0 100644 (file)
--- a/include/babeltrace2/util.h
+++ b/include/babeltrace2/util.h
@@ -73,13 +73,13 @@ The following illustration shows the possible scenarios:
 \bt_p{offset_seconds} can be negative. For example, considering:
 
 - A 1000 Hz clock.
 \bt_p{offset_seconds} can be negative. For example, considering:
 
 - A 1000 Hz clock.

-- \bt_p{offset_seconds} set to -10 seconds.
+- \bt_p{offset_seconds} set to −10 seconds.

 - \bt_p{offset_cycles} set to 500 cycles
   (that is, 0.5 seconds).
 - \bt_p{cycles} set to 2000 cycles (that is, 2 seconds).
 
 - \bt_p{offset_cycles} set to 500 cycles
   (that is, 0.5 seconds).
 - \bt_p{cycles} set to 2000 cycles (that is, 2 seconds).
 

-The computed value is -7.5 seconds, so this function sets
-\bt_p{*ns_from_origin} to -7,500,000,000.
+The computed value is −7.5 seconds, so this function sets
+\bt_p{*ns_from_origin} to −7,500,000,000.

 
 This function can fail and return the
 #BT_UTIL_CLOCK_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OVERFLOW_ERROR status
 
 This function can fail and return the
 #BT_UTIL_CLOCK_CYCLES_TO_NS_FROM_ORIGIN_STATUS_OVERFLOW_ERROR status