diff options
| author | Roland Reichwein <mail@reichwein.it> | 2022-01-03 15:15:09 +0100 |
|---|---|---|
| committer | Roland Reichwein <mail@reichwein.it> | 2022-01-03 15:15:09 +0100 |
| commit | ec9c8e682d615cd2b51ea0fec05273ed4dcad50a (patch) | |
| tree | b42c3bc2cfd2b79e89e846b9b4f18ea4efb23d2f /include | |
| parent | 92a6e4270e752acc01b0823713919b2446ec7753 (diff) | |
Documentation
Diffstat (limited to 'include')
| -rw-r--r-- | include/unicode.h | 4 | ||||
| -rw-r--r-- | include/unicode/predicate.h | 6 |
2 files changed, 10 insertions, 0 deletions
diff --git a/include/unicode.h b/include/unicode.h index feb012a..d033f63 100644 --- a/include/unicode.h +++ b/include/unicode.h @@ -4,6 +4,9 @@ // // Available under the conditions of CC0 1.0 Universal // https://creativecommons.org/publicdomain/zero/1.0/ +// +// This is the main library header, including all other headers of this library. +// #pragma once @@ -26,6 +29,7 @@ namespace unicode { + // Helper function: Item distance of specified iterators // std::distance doesn't work here: it is based on "output" distance of iterators template<class Iterator> inline size_t input_distance(const Iterator& it1, const Iterator& it2) 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> |