This is an automated email from the ASF dual-hosted git repository. slachiewicz pushed a commit to branch DOXIA-614/support-source-reference-in-doxia-parser in repository https://gitbox.apache.org/repos/asf/maven-doxia.git
commit 7df1eaf8853622f987307e43f2c8f4f41310a71b Author: Abel Salgado Romero <[email protected]> AuthorDate: Mon Jun 29 19:51:37 2020 +0200 [DOXIA-614] Fix Doxia JavaDoc comments --- .../main/java/org/apache/maven/doxia/Doxia.java | 33 +++++++++------------- 1 file changed, 14 insertions(+), 19 deletions(-) diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java b/doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java index 5896684..22018e6 100644 --- a/doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java +++ b/doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java @@ -41,13 +41,11 @@ public interface Doxia * 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. - * @param sink A sink that consumes the Doxia events. - * @throws org.apache.maven.doxia.parser.manager.ParserNotFoundException - * if no parser could be found for the given id. - * @throws org.apache.maven.doxia.parser.ParseException if the model could not be parsed. + * @param source not null reader that provides the source document + * @param parserId identifier for the parser to use + * @param sink a sink that consumes the Doxia events + * @throws ParserNotFoundException if no parser could be found for the given id + * @throws ParseException if the model could not be parsed */ void parse( Reader source, String parserId, Sink sink ) throws ParserNotFoundException, ParseException; @@ -56,14 +54,12 @@ public interface Doxia * 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. - * @param sink A sink that consumes the Doxia events. - * @param reference A string containing the reference to the source of the input string (e.g. filename). - * @throws org.apache.maven.doxia.parser.manager.ParserNotFoundException - * if no parser could be found for the given id. - * @throws org.apache.maven.doxia.parser.ParseException if the model could not be parsed. + * @param source not null reader that provides the source document + * @param parserId identifier for the parser to use + * @param sink a sink that consumes the Doxia events + * @param reference string containing the reference to the source (e.g. filename) + * @throws ParserNotFoundException if no parser could be found for the given id + * @throws ParseException if the model could not be parsed */ void parse( Reader source, String parserId, Sink sink, String reference ) throws ParserNotFoundException, ParseException; @@ -71,10 +67,9 @@ public interface Doxia /** * Return a parser for the given <code>parserId</code>. * - * @param parserId Identifier for the parser to use. - * @return the parser defining by parserId. - * @throws org.apache.maven.doxia.parser.manager.ParserNotFoundException - * if no parser could be found for the given id. + * @param parserId identifier for the parser to use + * @return the parser defining by parserId + * @throws ParserNotFoundException if no parser could be found for the given id */ Parser getParser( String parserId ) throws ParserNotFoundException;
