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

[babeltrace.git] / include / babeltrace2 / trace-ir / field-class.h

diff --git a/include/babeltrace2/trace-ir/field-class.h b/include/babeltrace2/trace-ir/field-class.h
index 1f907b7ff9f22640d068709eb04f6598953064f1..4d8624828e598eac1916d85102214cae5c93cc68 100644 (file)
--- a/include/babeltrace2/trace-ir/field-class.h
+++ b/include/babeltrace2/trace-ir/field-class.h
@@ -1,28 +1,12 @@
-#ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_H
-#define BABELTRACE2_TRACE_IR_FIELD_CLASS_H
-
 /*
- * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
+ * SPDX-License-Identifier: MIT
  *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
+ * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation
  */
 
+#ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_H
+#define BABELTRACE2_TRACE_IR_FIELD_CLASS_H
+
 #ifndef __BT_IN_BABELTRACE_H
 # error "Please include <babeltrace2/babeltrace.h> instead."
 #endif
@@ -1742,10 +1726,10 @@ See the \ref api-tir-fc-int-prop-size "field value range" property.
 
     <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>
-      <dd>[-2<sup><em>N</em></sup>,&nbsp;2<sup><em>N</em></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
 
@@ -1753,7 +1737,7 @@ See the \ref api-tir-fc-int-prop-size "field value range" property.
 @bt_pre_hot{field_class}
 @bt_pre_is_int_fc{field_class}
 @pre
-    \bt_p{n} ⩽ 64.
+    1 ⩽ \bt_p{n} ⩽ 64.
 
 @sa bt_field_class_integer_get_field_value_range() &mdash;
     Returns the field value range of an integer field class.
@@ -1776,10 +1760,10 @@ See the \ref api-tir-fc-int-prop-size "field value range" property.
 
     <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>
-      <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
 
@@ -1895,7 +1879,7 @@ property values:
     <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
@@ -1935,7 +1919,7 @@ property values:
     <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
@@ -2160,7 +2144,7 @@ following property values:
     <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
@@ -2425,7 +2409,7 @@ following property values:
     <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