Commits

shl...@6a489e09-e8c2-0310-a3fb-a128a961c0b2  committed 6dcf62f

Added the note that input_board should handle all cases.

  • Participants
  • Parent commits 70d1f56

Comments (0)

Files changed (1)

File lib/Games/LMSolve/Base.pm

 the puzzle and its initial state. It should place the board in the object's
 keys, and return the initial state. (in unpacked format).
 
+Note that $file_spec can be either a filename (if it's a string) or a reference
+to a filehandle, or a refernce to the text of the board. input_board() should
+handle all cases.
+
 =cut
 
 sub input_board
     return $move;
 }
 
-sub set_run_time_states_display
-{
-    my $self = shift;
-    my $states_display = shift;
+=head1 API
 
-    if (! $states_display)
-    {
-        $self->{'cmd_line'}->{'rt_states_display'} = undef;
-    }
-    else
-    {
-        $self->{'cmd_line'}->{'rt_states_display'} = 1;
-        $self->{'run_time_display_callback'} = $states_display;
-    }
-
-    return 0;
-}
+=cut
 
 sub solve_brfs_or_dfs
 {
     $self->display_solution(@ret);
 }
 
+sub set_run_time_states_display
+{
+    my $self = shift;
+    my $states_display = shift;
+
+    if (! $states_display)
+    {
+        $self->{'cmd_line'}->{'rt_states_display'} = undef;
+    }
+    else
+    {
+        $self->{'cmd_line'}->{'rt_states_display'} = 1;
+        $self->{'run_time_display_callback'} = $states_display;
+    }
+
+    return 0;
+}
+
+
 1;