elharo commented on a change in pull request #35: URL: https://github.com/apache/maven-doxia/pull/35#discussion_r446678771
########## File path: doxia-core/src/test/java/org/apache/maven/doxia/DefaultDoxiaTest.java ########## @@ -0,0 +1,54 @@ +package org.apache.maven.doxia; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import org.apache.maven.doxia.parser.manager.ParserNotFoundException; +import org.codehaus.plexus.PlexusTestCase; +import org.junit.Test; + +public class DefaultDoxiaTest extends PlexusTestCase +{ + + @Test + public void testCreatesDefaultDoxia() + { + final DefaultDoxia defaultDoxia = new DefaultDoxia(); + + assertNotNull( defaultDoxia ); + } + + @Test + public void testFailsWhenParserIdDoesNotExist() throws Exception + { + final String parserId = "a-parser"; + final Doxia doxia = lookup( Doxia.class ); + + try + { + doxia.getParser( parserId ); + } + catch ( Exception e ) Review comment: just catch ParserNotFoundException rather than asserting the type ########## 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}. Review comment: I'd delete this note. I'd prefer not to encourage extra plexus dependencies ########## File path: doxia-core/src/test/java/org/apache/maven/doxia/DefaultDoxiaTest.java ########## @@ -0,0 +1,54 @@ +package org.apache.maven.doxia; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import org.apache.maven.doxia.parser.manager.ParserNotFoundException; +import org.codehaus.plexus.PlexusTestCase; +import org.junit.Test; + +public class DefaultDoxiaTest extends PlexusTestCase +{ + + @Test + public void testCreatesDefaultDoxia() + { + final DefaultDoxia defaultDoxia = new DefaultDoxia(); + + assertNotNull( defaultDoxia ); + } + + @Test + public void testFailsWhenParserIdDoesNotExist() throws Exception + { + final String parserId = "a-parser"; + final Doxia doxia = lookup( Doxia.class ); + + try + { + doxia.getParser( parserId ); Review comment: test should fail here if exception is not thrown ########## 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. + * @param sink A sink that consumes the Doxia events. Review comment: ditto ########## 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: nit: no caps and no period, per Oracle guidelines ---------------------------------------------------------------- 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
