elharo commented on a change in pull request #35:
URL: https://github.com/apache/maven-doxia/pull/35#discussion_r447236450
##########
File path: doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java
##########
@@ -52,6 +52,22 @@
void parse( Reader source, String parserId, Sink sink )
throws ParserNotFoundException, ParseException;
+ /**
+ * Parses the given source model using a parser with given id,
+ * and emits Doxia events into the given sink.
+ *
+ * @param source not null reader that provides the source document.
+ * You could use <code>newReader</code> methods from {@link
org.codehaus.plexus.util.ReaderFactory}.
+ * @param parserId Identifier for the parser to use.
Review comment:
I assume that's an oversight since it contradicts the language of the
doc and only appears in an example
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
