This is an automated email from the ASF dual-hosted git repository.
olabusayo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/daffodil.git
The following commit(s) were added to refs/heads/main by this push:
new 33229d8 Fix Incorrect isError Scaladoc
33229d8 is described below
commit 33229d879007a37724f0409ee30d7307d500777c
Author: olabusayoT <[email protected]>
AuthorDate: Mon Jan 31 14:56:40 2022 -0500
Fix Incorrect isError Scaladoc
- scaladoc described opposite behavior of isError
DAFFODIL-2641
---
daffodil-japi/src/main/scala/org/apache/daffodil/japi/Daffodil.scala | 4 ++--
daffodil-sapi/src/main/scala/org/apache/daffodil/sapi/Daffodil.scala | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git
a/daffodil-japi/src/main/scala/org/apache/daffodil/japi/Daffodil.scala
b/daffodil-japi/src/main/scala/org/apache/daffodil/japi/Daffodil.scala
index 5b50045..af3840b 100644
--- a/daffodil-japi/src/main/scala/org/apache/daffodil/japi/Daffodil.scala
+++ b/daffodil-japi/src/main/scala/org/apache/daffodil/japi/Daffodil.scala
@@ -399,7 +399,7 @@ abstract class WithDiagnostics private[japi] (wd:
SWithDiagnostics)
/**
* Determine if any errors occurred in the creation of the parent object.
*
- * @return true if no errors occurred, false otherwise
+ * @return true if it represents an error, false otherwise
*/
def isError() = wd.isError
@@ -879,7 +879,7 @@ class ParseResult private[japi] (pr: SParseResult,
deprecatedOutput: Maybe[JDOMI
* Determine if any processing errors occurred. isError() will always return
* true if this returns true.
*
- * @return true if any processing errors occured, false otherwise.
+ * @return true if any processing errors occurred, false otherwise.
*/
def isProcessingError(): Boolean = pr.isProcessingError
diff --git
a/daffodil-sapi/src/main/scala/org/apache/daffodil/sapi/Daffodil.scala
b/daffodil-sapi/src/main/scala/org/apache/daffodil/sapi/Daffodil.scala
index fe2e9af..fac600f 100644
--- a/daffodil-sapi/src/main/scala/org/apache/daffodil/sapi/Daffodil.scala
+++ b/daffodil-sapi/src/main/scala/org/apache/daffodil/sapi/Daffodil.scala
@@ -361,7 +361,7 @@ abstract class WithDiagnostics private[sapi] (wd:
SWithDiagnostics)
/**
* Determine if any errors occurred in the creation of the parent object.
*
- * @return true if no errors occurred, false otherwise
+ * @return true if it represents an error, false otherwise
*/
def isError() = wd.isError
@@ -814,7 +814,7 @@ class ParseResult private[sapi] (pr: SParseResult,
deprecatedOutput: Maybe[Scala
* Determine if any processing errors occurred. isError() will always return
* true if this returns true.
*
- * @return true if any processing errors occured, false otherwise.
+ * @return true if any processing errors occurred, false otherwise.
*/
def isProcessingError(): Boolean = pr.isProcessingError