api: More comprehensive documentation of INTERNAL_KIND. (#8400)
authorAina Niemetz <aina.niemetz@gmail.com>
Fri, 25 Mar 2022 23:33:17 +0000 (16:33 -0700)
committerGitHub <noreply@github.com>
Fri, 25 Mar 2022 23:33:17 +0000 (23:33 +0000)
src/api/cpp/cvc5_kind.h

index 9beca24ae5db589ed7ea4284561b7fd6cd21a8c7..598b65b6cf7ea227db613a1e024fbdde9f16434c 100644 (file)
@@ -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,