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

Added simple comments to improve internal documentation of the app
---
 .idea/workspace.xml        | 10 ++++------
 eight_queens/lib/main.dart | 13 +++++++++----
 2 files changed, 13 insertions(+), 10 deletions(-)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index e50e34e..d2f51d5 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -2,9 +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$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/eight_queens/lib/main.dart" beforeDir="false" afterPath="$PROJECT_DIR$/eight_queens/lib/main.dart" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/eight_queens/pubspec.yaml" beforeDir="false" afterPath="$PROJECT_DIR$/eight_queens/pubspec.yaml" afterDir="false" />
     </list>
     <option name="EXCLUDED_CONVERTED_TO_IGNORED" value="true" />
     <option name="SHOW_DIALOG" value="false" />
@@ -55,8 +53,8 @@
       <file pinned="false" current-in-tab="true">
         <entry file="file://$PROJECT_DIR$/eight_queens/lib/main.dart">
           <provider selected="true" editor-type-id="text-editor">
-            <state relative-caret-position="388">
-              <caret line="92" column="43" selection-start-line="92" selection-start-column="43" selection-end-line="92" selection-end-column="43" />
+            <state relative-caret-position="-1132">
+              <caret line="56" column="81" lean-forward="true" selection-start-line="56" selection-start-column="81" selection-end-line="56" selection-end-column="81" />
               <folding>
                 <element signature="e#0#42#0" expanded="true" />
               </folding>
@@ -378,8 +376,8 @@
     </entry>
     <entry file="file://$PROJECT_DIR$/eight_queens/lib/main.dart">
       <provider selected="true" editor-type-id="text-editor">
-        <state relative-caret-position="388">
-          <caret line="92" column="43" selection-start-line="92" selection-start-column="43" selection-end-line="92" selection-end-column="43" />
+        <state relative-caret-position="-1132">
+          <caret line="56" column="81" lean-forward="true" selection-start-line="56" selection-start-column="81" selection-end-line="56" selection-end-column="81" />
           <folding>
             <element signature="e#0#42#0" expanded="true" />
           </folding>
diff --git a/eight_queens/lib/main.dart b/eight_queens/lib/main.dart
index 83642c0..0573db0 100644
--- a/eight_queens/lib/main.dart
+++ b/eight_queens/lib/main.dart
@@ -52,6 +52,10 @@ class _MyHomePageState extends State<MyHomePage> {
     super.dispose();
   }
 
+  ///
+  /// Creates a simple Dialog to show a message
+  /// Receives a [String] title and a [String] message to display a [AlertDialog]
+  ///
   void _showDialogBuilder(String title, String message) {
     showDialog(context: context,builder: (BuildContext context){
       return AlertDialog(
@@ -79,10 +83,11 @@ class _MyHomePageState extends State<MyHomePage> {
     super.initState();
   }
 
-  /**
-   * Retrieve the board number and pass it to the eight queens controller
-   * TODO: Create the Responsible class in Dart
-   */
+  ///
+  /// This method retrieves the [boardController.text] and checks if [isNumeric] and [boardController.text.isEmpty].
+  /// Then, it shows a [ProgressDialog] element while [QueenResolver] is executed.
+  /// Once a [count] is retrieved, we [Navigator.push] to [ResultsPage]
+  ///
   void _startProcessing() async {
 
     if(boardController.text.isEmpty){