From 0c0c44de30364ddcacdbda56e0e695d4e8f857bd Mon Sep 17 00:00:00 2001 From: Kaoru Takeda Date: Sat, 26 Jun 2021 14:47:13 +0900 Subject: [PATCH] Merge pull request #159 from tetengo/document Correct the documents #151 (cherry picked from commit fd3bd7ac0448dc77ced5c7b8c9eeec5df1a02b06) --- library/lattice/c/include/tetengo/lattice/vocabulary.h | 2 +- .../cpp/include/tetengo/lattice/unordered_map_vocabulary.hpp | 2 +- library/text/c/include/tetengo/text/graphemeSplitter.h | 2 +- sample/json2timetable/src/arrayList.h | 4 ++-- sample/make_dict/README.md | 2 +- sample/transfer_trains/README.md | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/library/lattice/c/include/tetengo/lattice/vocabulary.h b/library/lattice/c/include/tetengo/lattice/vocabulary.h index aebb6b12..376766e9 100644 --- a/library/lattice/c/include/tetengo/lattice/vocabulary.h +++ b/library/lattice/c/include/tetengo/lattice/vocabulary.h @@ -50,7 +50,7 @@ typedef struct tetengo_lattice_vocabulary_tag tetengo_lattice_vocabulary_t; \param p_connections A pointer to connections. \param connection_count A connection count. \param p_entry_hash A pointer to a hash function for an entry. - \param p_entry_equal_to A pointer to a eqaul_to function for an entry. + \param p_entry_equal_to A pointer to an eqaul_to function for an entry. \return A pointer to an unordered_map vocabulary. Or NULL when p_entries and/or p_connections are NULL, and entry_count and/or connection_count are greater diff --git a/library/lattice/cpp/include/tetengo/lattice/unordered_map_vocabulary.hpp b/library/lattice/cpp/include/tetengo/lattice/unordered_map_vocabulary.hpp index 5b494fcc..3c39ad7e 100644 --- a/library/lattice/cpp/include/tetengo/lattice/unordered_map_vocabulary.hpp +++ b/library/lattice/cpp/include/tetengo/lattice/unordered_map_vocabulary.hpp @@ -39,7 +39,7 @@ namespace tetengo::lattice \param entries Entries. \param connections Connections. \param entry_hash A hash function for an entry. - \param entry_equal_to A eqaul_to function for an entry. + \param entry_equal_to An eqaul_to function for an entry. */ unordered_map_vocabulary( std::vector>> entries, diff --git a/library/text/c/include/tetengo/text/graphemeSplitter.h b/library/text/c/include/tetengo/text/graphemeSplitter.h index 0104c1ba..b9a9320e 100644 --- a/library/text/c/include/tetengo/text/graphemeSplitter.h +++ b/library/text/c/include/tetengo/text/graphemeSplitter.h @@ -28,7 +28,7 @@ typedef struct tetengo_text_graphemeSplitter_tag tetengo_text_graphemeSplitter_t */ typedef struct tetengo_text_grapheme_tag { - /*! A offset in the UTF-8 string. */ + /*! An offset in the UTF-8 string. */ size_t offset; /*! A width when using a monospace font. */ diff --git a/sample/json2timetable/src/arrayList.h b/sample/json2timetable/src/arrayList.h index 99c50100..60832e06 100644 --- a/sample/json2timetable/src/arrayList.h +++ b/sample/json2timetable/src/arrayList.h @@ -57,7 +57,7 @@ size_t arrayList_size(const arrayList_t* p_array_list); \brief Returns the element. \param p_array_list A pointer to an array list. - \param index A index. + \param index An index. \return A pointer to the element. Or NULL when p_array_list is NULL or index is greater than the size. */ @@ -67,7 +67,7 @@ const void* arrayList_at(const arrayList_t* p_array_list, size_t index); \brief Returns the mutable element. \param p_array_list A pointer to an array list. - \param index A index. + \param index An index. \return A pointer to the mutable element. Or NULL when p_array_list is NULL or index is greater than the size. */ diff --git a/sample/make_dict/README.md b/sample/make_dict/README.md index 81bcf849..b055dea2 100644 --- a/sample/make_dict/README.md +++ b/sample/make_dict/README.md @@ -1,7 +1,7 @@ make_dict ========= -Makes a index file of UniDic lex.csv. +Makes an index file of UniDic lex.csv. Synopsis -------- diff --git a/sample/transfer_trains/README.md b/sample/transfer_trains/README.md index 11d6e57c..2401fdb6 100644 --- a/sample/transfer_trains/README.md +++ b/sample/transfer_trains/README.md @@ -13,7 +13,7 @@ transfer_trains timetable.txt Description ----------- -At first, this program asks you a departure station and time, and a arrival +At first, this program asks you a departure station and time, and an arrival station. Then, this program lists trains. Some list items have several trains. That