From 8145c0789b0ebe8e1b728f13c0554c9c3c499755 Mon Sep 17 00:00:00 2001 From: Shunsuke Kanda Date: Fri, 2 Jul 2021 22:18:55 +0900 Subject: [PATCH] minor --- README.md | 6 +++--- include/xcdat.hpp | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0aac029..365cd2c 100644 --- a/README.md +++ b/README.md @@ -289,11 +289,11 @@ Enumerate() = { ## API -Xcdat can be used by including `xcdat.hpp`. +Xcdat can be used by including only the header `xcdat.hpp`. ### Trie dictionary types -The two dictionary types are difined. +The two dictionary types of specialization of class `xcdat::trie` are difined: - `xcdat::trie_8_type` is the trie dictionary using standard DACs [9] using 8-bit integers for elements. - `xcdat::trie_7_type` is the trie dictionary using pointer-based DACs [2] using 7-bit integers for elements. @@ -454,7 +454,7 @@ class trie { `xcdat.hpp` provides some functions for handling I/O operations. ```c++ -//! Set the continuous memory block to a new trie instance. +//! Set the continuous memory block to a new trie instance (for a memory-mapped file). template Trie mmap(const char* address); diff --git a/include/xcdat.hpp b/include/xcdat.hpp index 2c9ca62..547110f 100644 --- a/include/xcdat.hpp +++ b/include/xcdat.hpp @@ -13,7 +13,7 @@ namespace xcdat { using trie_8_type = trie; using trie_7_type = trie; -//! Set the continuous memory block to a new trie instance. +//! Set the continuous memory block to a new trie instance (for a memory-mapped file). template [[maybe_unused]] Trie mmap(const char* address) { mmap_visitor visitor(address);