Uploaded image for project: 'Maven Doxia'
  1. Maven Doxia
  2. DOXIA-709

Clarify usage of overlapping Sink methods

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Major
    • Resolution: Fixed
    • None
    • 2.0.0, 2.0.0-M9
    • Sink API
    • None

    Description

      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.

      Attachments

        Issue Links

          Activity

            People

              kwin Konrad Windszus
              kwin Konrad Windszus
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: