From d5766ed9ac9c01221f34cd64311ab244c5002165 Mon Sep 17 00:00:00 2001
From: Jan Travnicek <Jan.Travnicek@fit.cvut.cz>
Date: Tue, 6 Mar 2018 22:20:09 +0100
Subject: [PATCH] documentation of visibly pushdown PDAs

---
 alib2data/src/automaton/PDA/VisiblyPushdownDPDA.h | 11 +++++------
 alib2data/src/automaton/PDA/VisiblyPushdownNPDA.h | 10 +++++-----
 2 files changed, 10 insertions(+), 11 deletions(-)

diff --git a/alib2data/src/automaton/PDA/VisiblyPushdownDPDA.h b/alib2data/src/automaton/PDA/VisiblyPushdownDPDA.h
index b06b14bcae..793440171b 100644
--- a/alib2data/src/automaton/PDA/VisiblyPushdownDPDA.h
+++ b/alib2data/src/automaton/PDA/VisiblyPushdownDPDA.h
@@ -70,7 +70,7 @@ class InitialState;
  * G (PushdownStoreAlphabet) = finite set of pushdown store symbol - having this empty makes the automaton equivalent to DFA
  * I (InitialState) = initial state,
  * Z (BottomOfTheStackSymbol) = initial pushdown store symbol
- * \delta is split to three disjoint parts 
+ * \delta is split to three disjoint parts
  *   - \delta_{call} of the form A \times c -> B \times g, where A, B \in Q, a \in C, and g \in G
  *   - \delta_{return} of the form A \times r \times g -> B, where A, B \in Q, r \in C, and g \in G
  *   - \delta_{local} of the form A \times l -> B, where A, B \in Q, a \in C
@@ -82,7 +82,6 @@ class InitialState;
  * $|\delta_{local} (q, l)| \leq 1$, $\forall q \in Q, l \in R$
  *
  * \tparam InputSymbolType used for the terminal alphabet
- * \tparam EpsilonSymbolType used for the epsilon in the automaton
  * \tparam PushdownSymbolType used for the pushdown store alphabet
  * \tparam StateType used to the states, and the initial state of the automaton.
  */
@@ -568,7 +567,7 @@ public:
 	 * \details The transition is in a form A \times a \times g -> B, where A, B \in Q, a \in C, and g \in G
 	 *
 	 * \param from the source state (A)
-	 * \param input the call input symbol (a)
+	 * \param input the return input symbol (a)
 	 * \param pop symbol to be poped to the pushdown store on the transition use (g)
 	 * \param to the target state (B)
 	 *
@@ -584,7 +583,7 @@ public:
 	 * \details The transition is in a form A \times a -> B, where A, B \in Q and a \in C
 	 *
 	 * \param from the source state (A)
-	 * \param input the call input symbol (a)
+	 * \param input the local input symbol (a)
 	 * \param to the target state (B)
 	 *
 	 * \throws AutomatonException when transition contains state or symbol not present in the automaton components or when the transition would cause nondeterminism
@@ -615,7 +614,7 @@ public:
 	 * \details The transition is in a form A \times a \times g -> B, where A, B \in Q, a \in C, and g \in G
 	 *
 	 * \param from the source state (A)
-	 * \param input the call input symbol (a)
+	 * \param input the return input symbol (a)
 	 * \param pop symbol to be poped to the pushdown store on the transition use (g)
 	 * \param to the target state (B)
 	 *
@@ -631,7 +630,7 @@ public:
 	 * \details The transition is in a form A \times a -> B, where A, B \in Q and a \in C
 	 *
 	 * \param from the source state (A)
-	 * \param input the call input symbol (a)
+	 * \param input the local input symbol (a)
 	 * \param to the target state (B)
 	 *
 	 * \throws AutomatonException when removed transition left hand side was found but the right hand side did not match.
diff --git a/alib2data/src/automaton/PDA/VisiblyPushdownNPDA.h b/alib2data/src/automaton/PDA/VisiblyPushdownNPDA.h
index 81eec4e6dd..58aefaffbc 100644
--- a/alib2data/src/automaton/PDA/VisiblyPushdownNPDA.h
+++ b/alib2data/src/automaton/PDA/VisiblyPushdownNPDA.h
@@ -70,7 +70,7 @@ class InitialStates;
  * G (PushdownStoreAlphabet) = finite set of pushdown store symbol - having this empty makes the automaton equivalent to DFA
  * I (InitialStates) = set of initial states,
  * Z (BottomOfTheStackSymbol) = initial pushdown store symbol
- * \delta is split to three disjoint parts 
+ * \delta is split to three disjoint parts
  *   - \delta_{call} of the form A \times c -> B \times g, where A, B \in Q, a \in C, and g \in G
  *   - \delta_{return} of the form A \times r \times g -> B, where A, B \in Q, r \in C, and g \in G
  *   - \delta_{local} of the form A \times l -> B, where A, B \in Q, a \in C
@@ -573,7 +573,7 @@ public:
 	 * \details The transition is in a form A \times a \times g -> B, where A, B \in Q, a \in C, and g \in G
 	 *
 	 * \param from the source state (A)
-	 * \param input the call input symbol (a)
+	 * \param input the return input symbol (a)
 	 * \param pop symbol to be poped to the pushdown store on the transition use (g)
 	 * \param to the target state (B)
 	 *
@@ -589,7 +589,7 @@ public:
 	 * \details The transition is in a form A \times a -> B, where A, B \in Q and a \in C
 	 *
 	 * \param from the source state (A)
-	 * \param input the call input symbol (a)
+	 * \param input the local input symbol (a)
 	 * \param to the target state (B)
 	 *
 	 * \throws AutomatonException when transition contains state or symbol not present in the automaton components
@@ -619,7 +619,7 @@ public:
 	 * \details The transition is in a form A \times a \times g -> B | C | ..., where A, B, C ... \in Q, a \in C, and g \in G
 	 *
 	 * \param from the source state (A)
-	 * \param input the call input symbol (a)
+	 * \param input the return input symbol (a)
 	 * \param pop symbol to be poped to the pushdown store on the transition use (g)
 	 * \param targets the set of target states (B, C, ...)
 	 *
@@ -635,7 +635,7 @@ public:
 	 * \details The transition is in a form A \times a -> B | C | ..., where A, B, C, ... \in Q and a \in C
 	 *
 	 * \param from the source state (A)
-	 * \param input the call input symbol (a)
+	 * \param input the local input symbol (a)
 	 * \param targets the set of target states (B, C, ...)
 	 *
 	 * \throws AutomatonException when transition contains state or symbol not present in the automaton components
-- 
GitLab