elharo commented on a change in pull request #35:
URL: https://github.com/apache/maven-doxia/pull/35#discussion_r447151457
##########
File path: doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java
##########
@@ -41,24 +41,35 @@
* 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;
+ /**
+ * 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
+ * @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;
+
/**
* 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
Review comment:
defining --> defined
or better yet
identified
##########
File path: doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java
##########
@@ -41,24 +41,35 @@
* 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;
+ /**
+ * 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
+ * @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
Review comment:
If --> if
##########
File path:
doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java
##########
@@ -179,15 +178,32 @@ protected File getBasedir()
public void parse( String string, Sink sink )
throws ParseException
{
- parse( new StringReader( string ), sink );
+ this.parse( string, sink, null );
}
-
+
+ /**
+ * {@inheritDoc}
+ *
+ * Convenience method to parse an arbitrary string and emit events into
the given sink.
+ *
+ * @param string A string that provides the source input.
+ * @param sink A sink that consumes the Doxia events.
Review comment:
A --> a
no period
ditto below
##########
File path:
doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java
##########
@@ -100,7 +98,7 @@
private boolean validate = false;
/** {@inheritDoc} */
- public void parse( Reader source, Sink sink )
+ public void parse( Reader source, Sink sink, String reference )
Review comment:
Does this change the public API? I'm not sure these changes are
compatible.
##########
File path: doxia-core/src/main/java/org/apache/maven/doxia/Doxia.java
##########
@@ -41,24 +41,35 @@
* 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;
+ /**
+ * 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
+ * @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
Review comment:
If --> if
----------------------------------------------------------------
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:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@maven.apache.org
For additional commands, e-mail: dev-h...@maven.apache.org
