From ec9c8e682d615cd2b51ea0fec05273ed4dcad50a Mon Sep 17 00:00:00 2001 From: Roland Reichwein Date: Mon, 3 Jan 2022 15:15:09 +0100 Subject: Documentation --- include/unicode.h | 4 ++++ include/unicode/predicate.h | 6 ++++++ 2 files changed, 10 insertions(+) (limited to 'include') 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 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 -- cgit v1.2.3