Add notes

analysis_options.yaml

@@ -0,0 +1,118 @@
+# This file allows you to configure the Dart analyzer.
+#
+# The commented part below is just for inspiration. Read the guide here:
+#   https://www.dartlang.org/guides/language/analysis-options
+
+analyzer:
+  exclude:
+    - test/issues/**
+
+linter:
+  rules:
+  #     # see catalog here: http://dart-lang.github.io/linter/lints/
+  - always_declare_return_types
+  - always_put_control_body_on_new_line
+  - always_put_required_named_parameters_first
+  - always_require_non_null_named_parameters
+  - always_specify_types
+  - annotate_overrides
+  - avoid_as
+  - avoid_bool_literals_in_conditional_expressions
+  - avoid_catches_without_on_clauses
+  - avoid_double_and_int_checks
+  - avoid_empty_else
+  - avoid_field_initializers_in_const_classes
+  - avoid_function_literals_in_foreach_calls
+  - avoid_init_to_null
+  - avoid_js_rounded_ints
+  - avoid_null_checks_in_equality_operators
+  - avoid_positional_boolean_parameters
+  - avoid_private_typedef_functions
+  - avoid_relative_lib_imports
+  - avoid_renaming_method_parameters
+  - avoid_return_types_on_setters
+  - avoid_returning_null
+  - avoid_single_cascade_in_expression_statements
+  - avoid_slow_async_io
+  - avoid_types_as_parameter_names
+  - avoid_unused_constructor_parameters
+  - await_only_futures
+  - camel_case_types
+  - cancel_subscriptions
+  - comment_references
+  - constant_identifier_names
+  - control_flow_in_finally
+  - curly_braces_in_flow_control_structures
+  - directives_ordering
+  - empty_catches
+  - empty_constructor_bodies
+  - empty_statements
+  - file_names
+  - hash_and_equals
+  - implementation_imports
+  - invariant_booleans
+  - iterable_contains_unrelated_type
+  - join_return_with_assignment
+  - library_names
+  - library_prefixes
+  - list_remove_unrelated_type
+  - literal_only_boolean_expressions
+  - no_adjacent_strings_in_list
+  - no_duplicate_case_values
+  - non_constant_identifier_names
+  - null_closures
+  - only_throw_errors
+  - overridden_fields
+  - package_api_docs
+  - package_names
+  - package_prefixed_library_names
+  - parameter_assignments
+  - prefer_adjacent_string_concatenation
+  - prefer_asserts_in_initializer_lists
+  - prefer_conditional_assignment
+  - prefer_const_constructors
+  - prefer_const_constructors_in_immutables
+  - prefer_const_declarations
+  - prefer_const_literals_to_create_immutables
+  - prefer_constructors_over_static_methods
+  - prefer_contains
+  - prefer_equal_for_default_values
+  - prefer_expression_function_bodies
+  - prefer_final_locals
+  - prefer_foreach
+  - prefer_function_declarations_over_variables
+  - prefer_generic_function_type_aliases
+  - prefer_initializing_formals
+  - prefer_interpolation_to_compose_strings
+  - prefer_is_empty
+  - prefer_is_not_empty
+  - prefer_iterable_whereType
+  - prefer_single_quotes
+  - prefer_typing_uninitialized_variables
+  - public_member_api_docs
+  - recursive_getters
+  - slash_for_doc_comments
+  - sort_constructors_first
+  - sort_unnamed_constructors_first
+  - test_types_in_equals
+  - throw_in_finally
+  - type_annotate_public_apis
+  - type_init_formals
+  - unawaited_futures
+  - unnecessary_brace_in_string_interps
+  - unnecessary_const
+  - unnecessary_getters_setters
+  - unnecessary_lambdas
+  - unnecessary_new
+  - unnecessary_null_aware_assignments
+  - unnecessary_null_in_if_null_operators
+  - unnecessary_overrides
+  - unnecessary_parenthesis
+  - unnecessary_statements
+  - unnecessary_this
+  - unrelated_type_equality_checks
+  - use_rethrow_when_possible
+  - use_setters_to_change_properties
+  - use_string_buffers
+  - use_to_and_as_if_applicable
+  - valid_regexps

lib/country.dart

@@ -1,17 +1,19 @@
 
 import 'package:flutter/foundation.dart';
 
+/// Model object to hold the Country data
 class Country {
+  /// Instantiates an [Country] with the specified [name], and [countryCode]
+  const Country({
+    @required this.name,
+    @required this.countryCode,
+  });
 
   /// the 2-letter ISO code
   final String countryCode;
 
   /// Country name
   final String name;
 
-  /// Instantiates an [Country] with the specified [name], and [countryCode]
-  const Country({
-    @required this.name,
-    @required this.countryCode,
-  });
+
 }

lib/iso_countries.dart

@@ -3,15 +3,12 @@ import 'dart:async';
 import 'package:flutter/services.dart';
 import 'package:iso_countries/country.dart';
 
+/// Platform channel claa to fetch the country info
 class IsoCountries {
   static const MethodChannel _channel =
       const MethodChannel('com.anoop4real.iso_countries');
 
-  static Future<String> get platformVersion async {
-    final String version = await _channel.invokeMethod('getPlatformVersion');
-    return version;
-  }
-
+  /// Function to get the country data in English
   static Future<List<Country>> get iso_countries async {
     final List<Country> isoCountries = [];
     final List countries = await _channel.invokeMethod('getISOCountries');
@@ -23,6 +20,7 @@ class IsoCountries {
     return isoCountries;
   }
 
+  /// Function to get the country data in the language code passed in
   static Future<List<Country>> iso_countries_for_locale(locale_identifier) async {
     final List<Country> isoCountries = [];
     final List countries = await _channel.invokeMethod('getISOCountriesForLocale',{'locale_identifier' : locale_identifier});

test/iso_countries_test.dart

@@ -1,6 +1,5 @@
 import 'package:flutter/services.dart';
 import 'package:flutter_test/flutter_test.dart';
-import 'package:iso_countries/iso_countries.dart';
 
 void main() {
   const MethodChannel channel = MethodChannel('iso_countries');
@@ -16,8 +15,4 @@ void main() {
   tearDown(() {
     channel.setMockMethodCallHandler(null);
   });
-
-  test('getPlatformVersion', () async {
-    expect(await IsoCountries.platformVersion, '42');
-  });
 }