From: Aina Niemetz <aina.niemetz@gmail.com>
Date: Fri, 25 Mar 2022 23:33:17 +0000 (-0700)
Subject: api: More comprehensive documentation of INTERNAL_KIND. (#8400)
X-Git-Tag: cvc5-1.0.0~165
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=457a5f563649eab95350b0df819dfec2d6a67221;p=cvc5.git

api: More comprehensive documentation of INTERNAL_KIND. (#8400)
---

diff --git a/src/api/cpp/cvc5_kind.h b/src/api/cpp/cvc5_kind.h
index 9beca24ae..598b65b6c 100644
--- a/src/api/cpp/cvc5_kind.h
+++ b/src/api/cpp/cvc5_kind.h
@@ -45,6 +45,10 @@ enum Kind : int32_t
   /**
    * Internal kind.
    *
+   * This kind serves as an abstraction for internal kinds that are not exposed
+   * via the API but may appear in terms returned by API functions, e.g.,
+   * when querying the simplified form of a term.
+   *
    * @note Should never be created via the API.
    */
   INTERNAL_KIND = -2,