From e088b36aa42e4317b949f24f72228ca8fc85ca50 Mon Sep 17 00:00:00 2001
From: Fernando Martin Garcia Del Angel <martingarciadelangel@me.com>
Date: Mon, 17 Feb 2020 18:15:54 -0600
Subject: [PATCH] Added documentation to results.dart

Described all relevant methods
---
 .idea/workspace.xml           | 32 +++++++++++++++++++-------------
 eight_queens/lib/results.dart | 12 +++++++++++-
 2 files changed, 30 insertions(+), 14 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index f0fbb95..4da9e8b 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -2,7 +2,7 @@
 <project version="4">
   <component name="ChangeListManager">
     <list default="true" id="a23023fe-943e-49fb-aaac-72229e9d9f43" name="Default Changelist" comment="">
-      <change beforePath="$PROJECT_DIR$/eight_queens/lib/queens.dart" beforeDir="false" afterPath="$PROJECT_DIR$/eight_queens/lib/queens.dart" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/eight_queens/lib/results.dart" beforeDir="false" afterPath="$PROJECT_DIR$/eight_queens/lib/results.dart" afterDir="false" />
     </list>
     <option name="EXCLUDED_CONVERTED_TO_IGNORED" value="true" />
     <option name="SHOW_DIALOG" value="false" />
@@ -62,7 +62,7 @@
           </provider>
         </entry>
       </file>
-      <file pinned="false" current-in-tab="true">
+      <file pinned="false" current-in-tab="false">
         <entry file="file://$PROJECT_DIR$/eight_queens/lib/queens.dart">
           <provider selected="true" editor-type-id="text-editor">
             <state relative-caret-position="443">
@@ -74,11 +74,14 @@
           </provider>
         </entry>
       </file>
-      <file pinned="false" current-in-tab="false">
+      <file pinned="false" current-in-tab="true">
         <entry file="file://$PROJECT_DIR$/eight_queens/lib/results.dart">
           <provider selected="true" editor-type-id="text-editor">
-            <state relative-caret-position="370">
-              <caret line="37" column="3" selection-start-line="37" selection-start-column="3" selection-end-line="37" selection-end-column="3" />
+            <state relative-caret-position="352">
+              <caret line="47" column="49" selection-start-line="47" selection-start-column="49" selection-end-line="47" selection-end-column="49" />
+              <folding>
+                <element signature="e#1#43#0" expanded="true" />
+              </folding>
             </state>
           </provider>
         </entry>
@@ -101,12 +104,12 @@
     <option name="CHANGED_PATHS">
       <list>
         <option value="$PROJECT_DIR$/.github/workflows/main.yml" />
-        <option value="$PROJECT_DIR$/eight_queens/lib/results.dart" />
         <option value="$PROJECT_DIR$/eight_queens/test/eight_test.dart" />
         <option value="$PROJECT_DIR$/eight_queens/test/widget_test.dart" />
         <option value="$PROJECT_DIR$/eight_queens/pubspec.yaml" />
         <option value="$PROJECT_DIR$/eight_queens/lib/main.dart" />
         <option value="$PROJECT_DIR$/eight_queens/lib/queens.dart" />
+        <option value="$PROJECT_DIR$/eight_queens/lib/results.dart" />
       </list>
     </option>
   </component>
@@ -328,13 +331,6 @@
   </component>
   <component name="editorHistoryManager">
     <entry file="file://$PROJECT_DIR$/.github/workflows/main.yml" />
-    <entry file="file://$PROJECT_DIR$/eight_queens/lib/results.dart">
-      <provider selected="true" editor-type-id="text-editor">
-        <state relative-caret-position="370">
-          <caret line="37" column="3" selection-start-line="37" selection-start-column="3" selection-end-line="37" selection-end-column="3" />
-        </state>
-      </provider>
-    </entry>
     <entry file="file://$USER_HOME$/flutter/packages/flutter/lib/src/widgets/framework.dart">
       <provider selected="true" editor-type-id="text-editor">
         <state relative-caret-position="572">
@@ -390,5 +386,15 @@
         </state>
       </provider>
     </entry>
+    <entry file="file://$PROJECT_DIR$/eight_queens/lib/results.dart">
+      <provider selected="true" editor-type-id="text-editor">
+        <state relative-caret-position="352">
+          <caret line="47" column="49" selection-start-line="47" selection-start-column="49" selection-end-line="47" selection-end-column="49" />
+          <folding>
+            <element signature="e#1#43#0" expanded="true" />
+          </folding>
+        </state>
+      </provider>
+    </entry>
   </component>
 </project>
\ No newline at end of file
diff --git a/eight_queens/lib/results.dart b/eight_queens/lib/results.dart
index 2b606f0..23e0843 100644
--- 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++ ){