[GitHub] [daffodil] stevedlawrence commented on a diff in pull request #829: All InfosetOutputter functions now return Unit

[GitBox <gi...@apache.org>]

stevedlawrence commented on code in PR #829:
URL: https://github.com/apache/daffodil/pull/829#discussion_r947978302


##########
daffodil-japi/src/main/scala/org/apache/daffodil/japi/infoset/Infoset.scala:
##########
@@ -123,85 +123,85 @@ abstract class InfosetOutputter extends SInfosetOutputter {
   /**
    * Called by Daffodil internals to signify the beginning of the infoset.
    *
-   * @return true on sucess, false if there was an error and Daffodil should stop all
-   *         future calls to the InfosetOutputter
+   * @throws Exception if there was an error and Daffodil should stop parsing
    */
-  def startDocument(): Boolean
+  @throws[Exception]

Review Comment:
   Yeah, I can't figure it out. Seems to be a known issue with scaladoc--I've found lot's of other people with similar issues and no solution. Though it's not clear to me why it works for some exceptions types but not others. For now, I've just removed the `@throws` in the comments.
   
   This will probably go away once we add a custom exception. My initial goal here is to just fix the sax/exi regressions as quickly as possible since I know of active development/testing around that.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@daffodil.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org