Add documentation for libraries

This commit is contained in:
Oystein Kristoffer Tveit 2020-06-25 23:40:54 +02:00
parent 37db73f5c9
commit b58c439418
2 changed files with 9 additions and 0 deletions

View File

@ -1,3 +1,7 @@
/// This library provides search functions for searching/scraping Jisho.org.
///
/// It provides a built-in http client and performs async requests to the server
/// for different types of requests.
library unofficial_jisho_api; library unofficial_jisho_api;
import './src/objects.dart'; import './src/objects.dart';
import 'package:http/http.dart' as http; import 'package:http/http.dart' as http;

View File

@ -1,3 +1,8 @@
/// This library provides parsing functions for html pages from Jisho.org,
/// and the associated URI-producing functions.
///
/// This might be useful for using a CORS proxy, or if you have your own system/library
/// for providing HTML.
library unofficial_jisho_parser; library unofficial_jisho_parser;
import './src/objects.dart'; import './src/objects.dart';