Merge pull request #13 from LonelyCpp/documentation

Documentation & readme update

Author: Ananthu P Kanive

README.md

@@ -5,6 +5,7 @@ This is my first project on my journey to learning and understanding flutter and
 
 ![android](./screenshots/android.png?raw=true 'android')
 ![ios](./screenshots/ios.gif?raw=true 'ios')
+![ios](./screenshots/ios_chart.gif?raw=true 'ios')
 
 ## Features
 - :white_check_mark: Beautiful minimal UI
@@ -14,6 +15,7 @@ This is my first project on my journey to learning and understanding flutter and
 - :white_check_mark: 5 day forecast
 - :white_check_mark: Beautifully animated transitions
 - :white_check_mark: BLoC pattern for API calls
+- :white_check_mark: Line graph to show temperature variance
 
 ## Getting Started
 

lib/src/api/http_exception.dart

@@ -1,3 +1,6 @@
+/// represents an error state from an network API request
+/// [code] represents the HTTP response code
+/// string [message] reason if any
 class HTTPException implements Exception {
  final int code;
  final String message;
@@ -8,5 +11,4 @@ class HTTPException implements Exception {
  String toString() {
  return 'HTTPException{code: $code, message: $message}';
  }
-
 }

lib/src/api/weather_api_client.dart

@@ -4,6 +4,8 @@ import 'package:flutter_weather/src/model/weather.dart';
 import 'package:meta/meta.dart';
 import 'package:http/http.dart' as http;
 
+/// Wrapper around the open weather map api
+/// https://openweathermap.org/current
 class WeatherApiClient {
  static const baseUrl = 'http://api.openweathermap.org';
  final apiKey;

lib/src/bloc/weather_bloc.dart

@@ -23,8 +23,10 @@ class WeatherBloc extends Bloc<WeatherEvent, WeatherState> {
  if (event is FetchWeather) {
  yield WeatherLoading();
  try {
- final Weather weather =
- await weatherRepository.getWeather(event.cityName, latitude: event.latitude, longitude: event.longitude);
+ final Weather weather = await weatherRepository.getWeather(
+ event.cityName,
+ latitude: event.latitude,
+ longitude: event.longitude);
  yield WeatherLoaded(weather: weather);
  } catch (exception) {
  print(exception);

lib/src/repository/weather_repository.dart

@@ -7,9 +7,11 @@ class WeatherRepository {
  WeatherRepository({@required this.weatherApiClient})
  : assert(weatherApiClient != null);
 
- Future<Weather> getWeather(String cityName, {double latitude, double longitude}) async {
- if(cityName == null){
- cityName = await weatherApiClient.getCityNameFromLocation(latitude: latitude, longitude: longitude);
+ Future<Weather> getWeather(String cityName,
+ {double latitude, double longitude}) async {
+ if (cityName == null) {
+ cityName = await weatherApiClient.getCityNameFromLocation(
+ latitude: latitude, longitude: longitude);
  }
  var weather = await weatherApiClient.getWeatherData(cityName);
  var weathers = await weatherApiClient.getForecast(cityName);

lib/src/screens/settings_screen.dart

@@ -15,7 +15,6 @@ class SettingsScreen extends StatelessWidget {
  padding: EdgeInsets.only(left: 10, right: 10, top: 15),
  color: AppStateContainer.of(context).theme.primaryColor,
  child: ListView(
-// crossAxisAlignment: CrossAxisAlignment.start,
  children: <Widget>[
  Padding(
  padding: const EdgeInsets.all(8.0),

lib/src/screens/weather_screen.dart

@@ -232,7 +232,6 @@ class _WeatherScreenState extends State<WeatherScreen>
 
  Position position = await Geolocator()
  .getCurrentPosition(desiredAccuracy: LocationAccuracy.low);
- print(position);
  _weatherBloc.dispatch(FetchWeather(
  longitude: position.longitude, latitude: position.latitude));
  }
@@ -253,7 +252,7 @@ class _WeatherScreenState extends State<WeatherScreen>
  style: TextStyle(color: Colors.green, fontSize: 16),
  ),
  onPressed: () {
- permissionHandler.openAppSettings().then((val) => print(val));
+ permissionHandler.openAppSettings();
  Navigator.of(context).pop();
  },
  ),

lib/src/utils/WeatherIconMapper.dart

@@ -7,7 +7,10 @@ class _IconData extends IconData {
  fontFamily: 'WeatherIcons',
  );
 }
-
+/// Exposes specific weather icons
+/// Has all weather conditions specified by open weather maps API
+/// https://openweathermap.org/weather-conditions
+// hex values and ttf file from https://erikflowers.github.io/weather-icons/
 class WeatherIcons {
  static const IconData clear_day = const _IconData(0xf00d);
  static const IconData clear_night = const _IconData(0xf02e);

lib/src/widgets/current_conditions.dart

@@ -3,10 +3,9 @@ import 'package:flutter_weather/main.dart';
 import 'package:flutter_weather/src/model/weather.dart';
 import 'package:flutter_weather/src/widgets/value_tile.dart';
 
+/// Renders Weather Icon, current, min and max temperatures
 class CurrentConditions extends StatelessWidget {
-
  final Weather weather;
-
  const CurrentConditions({Key key, this.weather}) : super(key: key);
 
  @override
@@ -33,16 +32,14 @@ class CurrentConditions extends StatelessWidget {
  ValueTile("max",
  '${this.weather.maxTemperature.as(AppStateContainer.of(context).temperatureUnit).round()}°'),
  Padding(
- padding: const EdgeInsets.only(left: 20, right: 20),
+ padding: const EdgeInsets.only(left: 15, right: 15),
  child: Center(
  child: Container(
- width: 1,
- height: 30,
- color: AppStateContainer.of(context)
- .theme
- .accentColor
- .withAlpha(50),
- )),
+ width: 1,
+ height: 30,
+ color:
+ AppStateContainer.of(context).theme.accentColor.withAlpha(50),
+ )),
  ),
  ValueTile("min",
  '${this.weather.minTemperature.as(AppStateContainer.of(context).temperatureUnit).round()}°'),

lib/src/widgets/forecast_horizontal_widget.dart

@@ -4,6 +4,9 @@ import 'package:flutter_weather/src/model/weather.dart';
 import 'package:flutter_weather/src/widgets/value_tile.dart';
 import 'package:intl/intl.dart';
 
+/// Renders a horizontal scrolling list of weather conditions
+/// Used to show forecast
+/// Shows DateTime, Weather Condition icon and Temperature
 class ForecastHorizontal extends StatelessWidget {
  const ForecastHorizontal({
  Key key,