diff --git a/CHANGELOG.md b/CHANGELOG.md index e8d4005..57fe71c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +## 2.0.2 + +- Fixed formatting + ## 2.0.1 - Fixed the readme diff --git a/lib/src/objects.dart b/lib/src/objects.dart index 2b0943f..f024839 100644 --- a/lib/src/objects.dart +++ b/lib/src/objects.dart @@ -231,6 +231,7 @@ class ExampleResultData { }; } } + /// The main wrapper containing data about the query and whether or not it was successful. class ExampleResults { /// The term that you searched for. @@ -416,7 +417,7 @@ class PhrasePageScrapeResultData { /// Tags associated with this search result. List otherForms; -/// Pronounciation of the search result. + /// Pronounciation of the search result. List audio; /// Notes associated with the search result. @@ -448,7 +449,7 @@ class PhrasePageScrapeResultData { /* -------------------------------------------------------------------------- */ /// Kanji/Furigana pair, or just kana as word. -/// +/// /// Which field acts as kanji and/or kana might be unreliable, which is why both are nullable. class JishoJapaneseWord { /// Usually kanji or kana. @@ -520,9 +521,9 @@ class JishoWordSource { // ignore: public_member_api_docs Map toJson() => { - 'language:': language, - 'word': word, - }; + 'language:': language, + 'word': word, + }; } /// One sense of the word. @@ -645,13 +646,13 @@ class JishoAttribution { /// The main API data class, collecting all information of one result in one place. class JishoResult { /// The main version of the word - /// + /// /// This value might sometimes appear as some kind of hash or encoded version of the word. /// Whenever it happens, the word usually originates taken from dbpedia String slug; /// Whether the word is common. - /// + /// /// Dbpedia sometimes omit this value. bool? isCommon; @@ -710,7 +711,7 @@ class JishoResult { }; } - /// Metadata with result status. +/// Metadata with result status. class JishoResultMeta { /// HTTP status code. int status; diff --git a/lib/src/scraping.dart b/lib/src/scraping.dart index 32f6fce..31309af 100644 --- a/lib/src/scraping.dart +++ b/lib/src/scraping.dart @@ -3,7 +3,7 @@ String removeNewlines(String str) { return str.replaceAll(RegExp(r'(?:\r|\n)'), '').trim(); } -/// Remove alltext between two positions, and remove all newlines +/// Remove all text between two positions, and remove all newlines String getStringBetweenIndicies(String data, int startIndex, int endIndex) { final result = data.substring(startIndex, endIndex); return removeNewlines(result).trim(); diff --git a/pubspec.yaml b/pubspec.yaml index 858bf9f..c00e2d8 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,5 +1,5 @@ name: unofficial_jisho_api -version: 2.0.1 +version: 2.0.2 description: An unofficial api for searching and scraping the japanese dictionary Jisho.org homepage: https://github.com/h7x4ABk3g/unofficial_jisho_api_dart/