[ 
https://issues.apache.org/jira/browse/DOXIA-709?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Konrad Windszus resolved DOXIA-709.
-----------------------------------
    Fix Version/s: 2.0.0
         Assignee: Konrad Windszus
       Resolution: Fixed

Fixed in 
https://github.com/apache/maven-doxia/commit/0dfe227b6603151b8b460d2b7cacc8953a512f4f.

> Clarify usage of overlapping Sink methods
> -----------------------------------------
>
>                 Key: DOXIA-709
>                 URL: https://issues.apache.org/jira/browse/DOXIA-709
>             Project: Maven Doxia
>          Issue Type: Improvement
>          Components: Sink API
>            Reporter: Konrad Windszus
>            Assignee: Konrad Windszus
>            Priority: Major
>             Fix For: 2.0.0
>
>
> With Doxia 1.1 new methods have been added taking an additional 
> {{SinkEventAttributes}} parameter. Semantically there is now an overlap, e.g. 
> between {{Sink.sectionTitle1}} and {{Sink.sectionTitle(1, null)}}
> It should be clear from the javadoc when which one is supposed to be called, 
> and also which one is the preferred method now.
> E.g. in {{SinkAdapter}} all new Doxia 1.1 methods taking a 
> {{SinkEventAttributes}} just forward to the equivalent method not taking it. 
> OTOH {{Xhtml5BaseSink}} delegates the other way around (e.g. for 
> {{link(String)}}) or does not delegate at all (e.g. for {{sectionTitle(int, 
> SinkEventAttributes)}} and {{sectionTitle1()}}).
> That leads to the fact that things are often not rendered consistently 
> although from their javadoc they should lead to the same result.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to