冒頭のsafetyセクションを明確に

VOICEVOX · Jul 15, 2023 · 03c8df0 · 03c8df0
1 parent f9a1869
commit 03c8df0
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/crates/voicevox_core_c_api/cbindgen.toml b/crates/voicevox_core_c_api/cbindgen.toml
@@ -12,7 +12,13 @@ header = """
  *   <a href="#voicevox-core-safety">Safety</a>
  * </h2>
  *
- * このライブラリの使用にあたっては次の条件を遵守しなければならない。違反は<b>未定義動作</b>(_undefined behavior_)である。
+ * このライブラリを使用するにあたり、<b>未定義動作</b>(_undefined
+ * behavior_)を避けるために保たなれなければならない不変条件がいくつかある。本ドキュメントではこの不変条件を<b>安全性不変条件</b>(_safety
+ * invariant_)と呼び、"Safety"というセクションの下に安全性不変条件を記述している。
+ *
+ * 安全性不変条件の違反は未定義動作である。未定義動作が発生した場合、<b>それにより何が起きるかの保証もされない</b>。
+ *
+ * `voicevox_core`全体における安全性不変条件は以下の通りである。
  *
  * - 「読み込みについて有効」と説明されているポインタは次の条件を満たしていなければならない。
  *     - <b>間接参照可能</b>(_dereferenceable_)である。

diff --git a/crates/voicevox_core_c_api/include/voicevox_core.h b/crates/voicevox_core_c_api/include/voicevox_core.h