From ec9c8e682d615cd2b51ea0fec05273ed4dcad50a Mon Sep 17 00:00:00 2001
From: Roland Reichwein <mail@reichwein.it>
Date: Mon, 3 Jan 2022 15:15:09 +0100
Subject: Documentation

---
 include/unicode/predicate.h | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'include/unicode')

diff --git a/include/unicode/predicate.h b/include/unicode/predicate.h
index e326529..82031d1 100644
--- a/include/unicode/predicate.h
+++ b/include/unicode/predicate.h
@@ -6,6 +6,12 @@
 
 namespace unicode {
 
+ // Detection of a valid Unicode code point value. Independent of encoding.
+ //
+ // Note: This doesn't tell if the specified value is actually allocated in an
+ // existing Unicode version, but rather just detects if the value is inside
+ // allocatable range.
+ // 
  // bits_to_compare: limit bits to consider even further than defined by T
  // T: usually, char32_t, uint32_t etc.
  template<size_t bits_to_compare = 32, typename T>
-- 
cgit v1.2.3