From 191145f42cd8cde63ae7f524ff0631ce41e1e104 Mon Sep 17 00:00:00 2001
From: Christopher Bohn <bohn@unl.edu>
Date: Wed, 5 Feb 2020 14:50:17 -0600
Subject: [PATCH] Updated JavaDoc to note that a couple of parameters may be
updated
---
.../java/edu/unl/cse/csce361/calculator/Calculator.java | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/src/main/java/edu/unl/cse/csce361/calculator/Calculator.java b/src/main/java/edu/unl/cse/csce361/calculator/Calculator.java
index ecc4a87..17f04aa 100644
--- a/src/main/java/edu/unl/cse/csce361/calculator/Calculator.java
+++ b/src/main/java/edu/unl/cse/csce361/calculator/Calculator.java
@@ -87,8 +87,10 @@ public class Calculator {
*
* @param type the type of token received from the user
* @param token the token received from the user
- * @param stack an array representing the calculator's stack
- * @param stackPointer the value indicating the top of the stack
+ * @param stack an array representing the calculator's stack; this parameter may be updated when the
+ * method returns
+ * @param stackPointer the value indicating the top of the stack; this parameter may be updated when the method
+ * returns
* @return the message to be displayed to the user, or {@code Null} if no message is to be displayed
*/
String calculate(int type, char[] token, double[] stack, AtomicInteger stackPointer) {
--
GitLab