fixing javadocs

Author: wooshrow

.gitignore

@@ -1,5 +1,6 @@
 /bin/
 /target/
+/javadocs/
 /.settings/
 /.idea/
 /mylog*.txt

src/main/java/eu/iv4xr/framework/extensions/ltl/BuchiModelChecker.java

@@ -72,7 +72,7 @@ public SATVerdict sat(LTL<IExplorableState> phi) {
 	 * execution that would be accepted by the given Buchi automaton. If so SAT is
 	 * returned, and else UNSAT. <b>Be careful</b> that this method may not
 	 * terminate if the target program has an infinite state space. Use
-	 * {@link #sat(Predicate, int)} instead.
+	 * {@link #sat(Buchi, int)} instead.
 	 */
 	public SATVerdict sat(Buchi buchi) {
 		return sat(buchi, Integer.MAX_VALUE) ; 

src/main/java/eu/iv4xr/framework/extensions/ltl/LTL.java

@@ -331,7 +331,7 @@ public String toString() {
 
     /**
      * For representing "phi || psi". We could define this as
-     * a derived operator "not(not phi && not psi)", but for
+     * a derived operator "not(not phi ∧ not psi)", but for
      * e.g. translation to Buchi we need to be able to structurally
      * identify the "phi || psi" pattern. So we add this explicit
      * representation.
@@ -701,7 +701,7 @@ public static <State>  Not<State> ltlNot(LTL<State> phi) {
     }
 
     /**
-     * ltlAnd(phi1, ..., phin ) constructs the LTL formula "phi1 && phi2 ... && phin".
+     * ltlAnd(phi1, ..., phin ) constructs the LTL formula "phi1 &and; phi2 ... &and; phin".
      */
     public static <State>  And<State> ltlAnd(LTL<State>... phis) {
         if (phis == null)

src/main/java/eu/iv4xr/framework/extensions/ltl/LTL2Buchi.java

@@ -13,7 +13,7 @@
  * exclude the following patterns:
  * 
  *    <ol>
- *    <li> The translator does not handle conjunctions "phi && psi";
+ *    <li> The translator does not handle conjunctions "phi &and; psi";
  *    <li> also does not handle left-recursive until and weak-until.
  *         E.g. "(p U q) U r" cannot be handled.
  *    </ol>     
@@ -23,10 +23,10 @@
  * 
  *    <ol>
  *    <li> "not X phi" to "X not phi"
- *    <li> "not(phi && psi)" to "(not phi) || (not psi)"  
- *    <li> "not(phi || psi)" to "(not phi) && (not psi)"  
- *    <li> "not(phi U psi) to "(phi && not psi) W (not phi && not psi)"
- *    <li> "not(phi W psi) to "(phi && not psi) U (not phi && not psi)"  
+ *    <li> "not(phi &and; psi)" to "(not phi) || (not psi)"  
+ *    <li> "not(phi || psi)" to "(not phi) &and; (not psi)"  
+ *    <li> "not(phi U psi) to "(phi &and; not psi) W (not phi &and; not psi)"
+ *    <li> "not(phi W psi) to "(phi &and; not psi) U (not phi &and; not psi)"  
  *    </ol>
  * 
  * After the normalization, a Buchi automaton is constructed recursively.
@@ -57,7 +57,7 @@
  *    the combined Buchi. We remove S2, and change every transition that goes
  *    from or to S2 to go from/to S1.
  *    
- *    <li> phi && psi. Not implemented. TODO.
+ *    <li> phi &and; psi. Not implemented. TODO.
  *    
  *    </ol>
  * 
@@ -161,7 +161,7 @@ public static <State> Not<State> isNotNot(LTL<State> psi) {
 	}
 
 	/**
-	 * Recognize "not(p && ... && q)" . Returns "p && ... && q".
+	 * Recognize "not(p &and; ... &and; q)" . Returns "p &and; ... &and; q".
 	 */
 	public static <State> And<State> isNotAnd(LTL<State> psi) {
 		var f = isNotPhi(psi) ;
@@ -606,16 +606,16 @@ private static <A> Pair<A,A> swap(Pair<A,A> pair) {
 	 * rewrite rules:
 	 * 
 	 * <ul>
-	 *    <li> p && q         =  (\s -> p(s) && q(s))
-	 *    <li> f && (g || h)  = (f && g) || (f && h)
-	 *    <li> p && (f U g)   = (p && g) || (p && f && X(f U g))
-	 *    <li> p && (f W g)   = (p && g) || (p && f && X(f W g))
-	 *    <li> Xf && Xg       = X(f && g)
-	 *    <li> (*) Xf && (g U h)  = (Xf && h) || (g && X(f && (g U h))
-	 *    <li> (*) Xf && (g W h)  = (Xf && h) || (g && X(f && (g W h)))
-	 *    <li> (a U b)  && (f U g)  = (a && f  U  (b && (f U g)))  ||  (a && f  U  (g && (a U b)))
-	 *    <li> (a U b)  && (f W g)  = (a && f  U  (b && (f W g)))  ||  (a && f  U  (g && (a U b)))  ... notice that two U in the middle. They are correct.
-	 *    <li> (a W b)  && (f W g)  = (a && f  W  (b && (f W g)))  ||  (a && f  W  (g && (a U b)))
+	 *    <li> p &and; q         =  (\s -> p(s) &and; q(s))
+	 *    <li> f &and; (g || h)  = (f &and; g) || (f &and; h)
+	 *    <li> p &and; (f U g)   = (p &and; g) || (p &and; f &and; X(f U g))
+	 *    <li> p &and; (f W g)   = (p &and; g) || (p &and; f &and; X(f W g))
+	 *    <li> Xf &and; Xg       = X(f &and; g)
+	 *    <li> (*) Xf &and; (g U h)  = (Xf &and; h) || (g &and; X(f &and; (g U h))
+	 *    <li> (*) Xf &and; (g W h)  = (Xf &and; h) || (g &and; X(f &and; (g W h)))
+	 *    <li> (a U b)  &and; (f U g)  = (a &and; f  U  (b &and; (f U g)))  ||  (a &and; f  U  (g &and; (a U b)))
+	 *    <li> (a U b)  &and; (f W g)  = (a &and; f  U  (b &and; (f W g)))  ||  (a &and; f  U  (g &and; (a U b)))  ... notice that two U in the middle. They are correct.
+	 *    <li> (a W b)  &and; (f W g)  = (a &and; f  W  (b &and; (f W g)))  ||  (a &and; f  W  (g &and; (a U b)))
 	 * </ul>
 	 * 
 	 * IMPORTANT: the rewrites in (*) unroll the U/W into a X-formula. This 
@@ -791,7 +791,7 @@ private static <State> LTL<State> andRewrite(LTL<State> f1, Or<State> f2) {
 
 	/**
 	 * Check if the cunjunction is irreducible. It is irreducible if it is of the form
-	 * p && Xphi. Such a form cannot be further rewritten.
+	 * p &and; Xphi. Such a form cannot be further rewritten.
 	 */
 	public static <State>  boolean isIrreducibleConj(And<State> phi) {
 		if (phi.conjuncts.length != 2) return false ;

src/main/java/eu/iv4xr/framework/extensions/ltl/SequencePredicate.java

@@ -34,7 +34,7 @@
  *           invoke {@link #endChecking()}
  *   <li>(d) invoke {@link #sat()} to get the result.
  *   </ol>
- * </ol>
+ * </ul>
  * 
  * @author Wish
  */

src/main/java/eu/iv4xr/framework/extensions/pathfinding/Sparse2DTiledSurface_NavGraph.java

@@ -14,7 +14,7 @@
  * These are tiles that block movement through them. There are two types: Wall and
  * Door. A wall is always non-navigable. A door can be made blocking/unblocking.
  * 
- * <p>The class also implements {@link Xnavigatable}, so it offers methods to do
+ * <p>The class also implements {@link XPathfinder}, so it offers methods to do
  * pathfinding and exploration over the world.
  * 
  * @author Wish

src/main/java/eu/iv4xr/framework/goalsAndTactics/Sa1Solver.java

@@ -135,10 +135,11 @@ public enum Policy { NEAREST_TO_AGENT, NEAREST_TO_TARGET, RANDOM }
 	 *   <li> Else, the agent check if there is a reachable entity e whose properties satisfy 
 	 *   the given selector, and not yet tried before. If there is such an e, the agent
 	 *   moves to it and interacts with it. Then it repeats from step-1.
-	 *   <li> If there is no such e in step-3, the agent checks if there the world has some
+	 *   <li> If there is no such e in step-3, the agent checks if the world has some
 	 *   unvisited place (has some area to explore). If so, the agent explores for some budget,
-	 *   then we 
-	 * it should be a "switch"). This e is interacted
+	 *   then we go back to step-3.
+	 *   <li> If there is no more place to explore, the search fails.
+	 * </ol>
 	 */
 
 	public GoalStructure solver(BasicAgent agent, 

src/main/java/eu/iv4xr/framework/mainConcepts/IEmotionState.java

@@ -6,7 +6,7 @@
  * A generic interface for representing the emotional state of an agent. Since
  * this is only an interface, you need to provide a concrete implementation of
  * it. To use it, attach it to an emotional-test-agent using
- * {@link EmotiveTestAgent#attachEmptionState(IEmotionState)}. Then, whenever
+ * {@link EmotiveTestAgent#attachEmotionState(IEmotionState)}. Then, whenever
  * the agent is updated (through a call to its {@link EmotiveTestAgent#update()}
  * method), it will also update the emotion-state attached to it by calling the
  * method {@link #updateEmotion(EmotiveTestAgent)}.

src/main/java/eu/iv4xr/framework/mainConcepts/Iv4xrAgentState.java

@@ -18,7 +18,7 @@
  * {@link WorldModel}. And, along with it it can also hold a navigation graph to
  * facilitate automated navigation over the target world.
  * 
- * @param NavgraphNode The type of the nodes in {@link #worldNavigation}, or the type
+ * The type paremeter NavgraphNode represents the type of the nodes in {@link #worldNavigation}, or the type
  * that is used to identify the nodes.
  * 
  * @author Wish

src/main/java/eu/iv4xr/framework/spatial/meshes/Face.java

@@ -253,7 +253,7 @@ public float distFromPoint(Vec3 w, ArrayList<Vec3> concreteVertices) {
     }
 
     /**
-     * Clamping x between 0 and 1. That is, if x<=0, we return 0, if x>=1 we return
+     * Clamping x between 0 and 1. That is, if x&le;0, we return 0, if x&ge;1 we return
      * 1, and else the original x is returned.
      */
     static float clamp(float x) {