Added documentation to results.dart

Described all relevant methods
martin-headspace · Feb 18, 2020 · e088b36 · e088b36
1 parent 4d6f95e
commit e088b36
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 14 deletions.
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/eight_queens/lib/results.dart b/eight_queens/lib/results.dart
@@ -1,4 +1,5 @@
 
+import 'package:eight_queens/queens.dart';
 import 'package:flutter/material.dart';
 import 'package:shared_preferences/shared_preferences.dart';
 import 'dart:convert';
@@ -15,6 +16,11 @@ class ResultsPage extends StatefulWidget {
 class _ResultsPageState extends State<ResultsPage> {
   var boards = new List();
 
+  ///
+  /// Retrieves the [QueenResolver] [boards] that were calculated.
+  /// Will call [SharedPreferences] and get [String] for every posible solution.
+  /// Will then append it to [boards] and [setState()]
+  ///
   Future retrieveEightQueensResults() async {
     final prefs = await SharedPreferences.getInstance();
     var _boards = new List();
@@ -36,7 +42,11 @@ class _ResultsPageState extends State<ResultsPage> {
       super.initState();
     });
   }
-
+
+  ///
+  /// Simple Item builder to display a [board]
+  /// Uses [String] concatenation to make it work
+  ///
   Widget ResultItem(BuildContext context, int index) {
     String todisplay = "";
     for(int x = 0; x < boards[index].length; x++ ){