kwin commented on code in PR #150:
URL:
https://github.com/apache/maven-doxia-sitetools/pull/150#discussion_r1573354321
##########
doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java:
##########
@@ -271,7 +290,7 @@ public void addSiteDirectory(File siteDirectory) {
*
* @return List of site directories files.
*/
- public List<File> getSiteDirectories() {
+ public List<SiteDirectory> getSiteDirectories() {
Review Comment:
Please leave the old method in place, deprecate it and rename the new one
(cannot come up with a good naming proposal right now). But please don't just
break backwards compatibility.
##########
doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderingContext.java:
##########
@@ -260,9 +279,9 @@ public void setTemplateName(String templateName) {
* Add a site directory, expected to have a Doxia Site layout, ie one
directory per Doxia parser module containing
* files with parser extension. Typical values are <code>src/site</code>
or <code>target/generated-site</code>.
*
- * @param siteDirectory a {@link java.io.File} object.
+ * @param siteDirectory a {@link SiteDirectory} object.
*/
- public void addSiteDirectory(File siteDirectory) {
+ public void addSiteDirectory(SiteDirectory siteDirectory) {
Review Comment:
Why breaking backwards compatibility? Just leave the old method taking
`File` in place, deprecate it and just delegate to the new `addSiteDirectory`
For the new method please add `@since`.
--
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: issues-unsubscr...@maven.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
