From cd346c2976e33d6e5ba1c29c830c73492c7b084d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Pablo=20Rodr=C3=ADguez=20Mier?=
 <pablo.rodriguez.mier@usc.es>
Date: Sat, 8 Nov 2014 14:52:06 +0100
Subject: [PATCH] IDAStar iterator Javadoc improved. Close #97 [skip ci]

---
 .../main/java/es/usc/citius/hipster/algorithm/IDAStar.java  | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/hipster-core/src/main/java/es/usc/citius/hipster/algorithm/IDAStar.java b/hipster-core/src/main/java/es/usc/citius/hipster/algorithm/IDAStar.java
index 8beb8de..402e520 100644
--- a/hipster-core/src/main/java/es/usc/citius/hipster/algorithm/IDAStar.java
+++ b/hipster-core/src/main/java/es/usc/citius/hipster/algorithm/IDAStar.java
@@ -74,6 +74,12 @@ private class StackFrameNode {
         }
     }
 
+    /**
+     * IDA iterator. It expands the next state to be explored. Backtracking
+     * is automatically performed so if the state reaches a dead-end the next
+     * call to {@code iterator.next()} returns the next state after performing
+     * backtracking.
+     */
     public class Iterator implements java.util.Iterator<N> {
         private Stack<StackFrameNode> stack = new Stack<StackFrameNode>();
         private C fLimit;