Clarify javadoc about compatibility bridge

apache · Dec 14, 2023 · 74260d3 · 74260d3
1 parent 539e015
commit 74260d3
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractSink.java b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/AbstractSink.java
@@ -20,10 +20,12 @@
 
 import org.apache.maven.doxia.markup.Markup;
 import org.apache.maven.doxia.sink.Sink;
+import org.apache.maven.doxia.sink.SinkEventAttributes;
 
 /**
  * An abstract base class that defines some convenience methods for sinks.
- * Also acts as compatibility bridge for Doxia 1.0 methods which have overridden variants in Doxia > 1.0
+ * Also acts as compatibility bridge for Doxia 1.0 methods which have overloaded variants in Doxia > 1.0 (taking an additional argument {@link SinkEventAttributes}).
+ * This implementation just delegates the former to the latter with argument {@link SinkEventAttributes} being {@code null}.
  *
  * @author ltheussl
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>