Skip to content

Commit

Permalink
Karee libraries documentation completed.
Browse files Browse the repository at this point in the history
  • Loading branch information
Fenyep authored and Fenyep committed Mar 22, 2023
1 parent bac34c5 commit 362b48d
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion lib/annotations.dart
@@ -1,5 +1,5 @@
/// ## Karee Annotation
/// This library help you to know all annotations used by Karee.
/// This library helps you to know all the annotations used by Karee.
/// Each of them are useful and works with code generation.
/// ## Annotations exposed
/// - [Autowired]
Expand Down
18 changes: 9 additions & 9 deletions lib/core.dart
@@ -1,15 +1,15 @@
///
/// Karee lib is a Dart library
/// Karee lib is a Dart library.
///
/// To take full advantage of Karee, you should know what it offers to you
/// To take full advantage of Karee, you should know what it offers to you.
///
/// Karee library a dart lib very useful to
/// - Organize your project's files and folders
/// - Manage your files and classes names
/// - Manage your application's navigation with custom constants
/// - Manage all your stateless and stateful screens with names
/// - Manage all your controllers
/// - Organize your application routes with various structure
/// Karee library is a dart lib very useful to
/// - Organize your project's files and folders.
/// - Manage your files and classes names.
/// - Manage your application navigation with custom constants.
/// - Manage all your stateless and stateful screens with names.
/// - Manage all your controllers.
/// - Organize your application routes with various structures.
///
library karee.core;
Expand Down
12 changes: 6 additions & 6 deletions lib/internationalization.dart
@@ -1,17 +1,17 @@
///
/// Karee internationalization.
/// Karee Internationalization.
///
/// Karee provides this library as a simplest way to work with
/// internationalization, this lib gives you translation support trough the
/// internationalization. This lib gives you translation support trough the
/// string extension defined and named [StringTranslator] by adding two methods
/// [StringTranslator.translate] and [StringTranslator.translateWithParams].
///
/// To define you translation dictionary, get open file in
/// {@PROJECT_DIR@/resources/i18n/locale.json}.
///
/// Karee Internationalization also provides a simplest way to change lang in
/// your application, you need to call [KareeInternationalization.changeLanguage]
/// with Locale that matches with you dictionary files.
/// Karee Internationalization also provides a simplest way to change language in
/// your application. You need to call [KareeInternationalization.changeLanguage]
/// with Locale that matches with your dictionary files.
///
/// eg:
/// ```dart
Expand Down Expand Up @@ -56,7 +56,7 @@ extension StringTranslator on String {
///
/// Method that considers a string as a key from i18n and replace all the
/// translation parameters [params] with their values and return the
/// translated string
/// translated string.
///
String translateWithParams(Map<String, String> params) {
String self = KareeInternationalization
Expand Down
2 changes: 1 addition & 1 deletion lib/navigation.dart
@@ -1,7 +1,7 @@
/// ## Karee Navigation
///
/// This library contains the set of tools used to manage navigation
/// in Karee Application
/// in Karee Applications.
/// ## Modules
/// - KareeRouter
/// - Route
Expand Down
2 changes: 1 addition & 1 deletion lib/src/karee.core.dart
@@ -1,4 +1,4 @@
/// `Karee Core` Base library for Karee
/// `Karee Core` Base library for Karee.
library karee.core;

export 'constances/library.dart';
Expand Down
2 changes: 1 addition & 1 deletion lib/widgets.dart
@@ -1,5 +1,5 @@
/// ## Karee Widget
/// `Karee Core Widget` Library for all important widgets
/// `Karee Core Widget` Library for all important widgets.
/// ## Widgets exposed
/// - [Bucket]
/// - [BucketActionButton]
Expand Down

0 comments on commit 362b48d

Please sign in to comment.