[
https://issues.apache.org/jira/browse/DOXIASITETOOLS-336?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17839264#comment-17839264
]
ASF GitHub Bot commented on DOXIASITETOOLS-336:
-----------------------------------------------
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`.
> Make SiteRenderingContext#siteDirectories editable aware
> --------------------------------------------------------
>
> Key: DOXIASITETOOLS-336
> URL: https://issues.apache.org/jira/browse/DOXIASITETOOLS-336
> Project: Maven Doxia Sitetools
> Issue Type: Improvement
> Components: Site renderer
> Affects Versions: 2.0.0-M16
> Reporter: Michael Osipov
> Assignee: Michael Osipov
> Priority: Major
> Fix For: 2.0.0, 2.0.0-M18
>
>
> Right now you cannot qualify a {{siteDirectory}} whether the content is
> editable or generated. You need to perform multiple calls with distinct
> {{SiteRenderingContexts}}. This causes computational overhead is hacks like
> MSITE-723.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
