This is an automated email from the ASF dual-hosted git repository.
kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-doxia.git
The following commit(s) were added to refs/heads/master by this push:
new e6190a9a [DOXIA-754] Clarify method order for nested lists (#243)
e6190a9a is described below
commit e6190a9aa5121bfda9bb4efac3acd4cbbfee5880
Author: Konrad Windszus <k...@apache.org>
AuthorDate: Sat Oct 26 18:45:05 2024 +0200
[DOXIA-754] Clarify method order for nested lists (#243)
---
.../java/org/apache/maven/doxia/sink/Sink.java | 31 ++++++++++++++++++----
1 file changed, 26 insertions(+), 5 deletions(-)
diff --git a/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/Sink.java
b/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/Sink.java
index 4e86588d..f92e045b 100644
--- a/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/Sink.java
+++ b/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/Sink.java
@@ -716,7 +716,7 @@ public interface Sink extends AutoCloseable {
* <p>
* Supported attributes are the {@link SinkEventAttributes base
attributes}.
* </p>
- *
+ * A list must contain at least one {@link #listItem(SinkEventAttributes)}
or {@link #listItem()} as direct successor of this method.
* @param attributes A set of {@link SinkEventAttributes}, may be
<code>null</code>.
* @since 1.1
*/
@@ -740,7 +740,18 @@ public interface Sink extends AutoCloseable {
* <p>
* Supported attributes are the {@link SinkEventAttributes base
attributes}.
* </p>
- *
+ * Nested lists must have the following Sink method sequence:
+ * <ol>
+ * <li>{@link #listItem(int,SinkEventAttributes)} or {@link
#listItem(int)}</li>
+ * <li>{@link #list(int,SinkEventAttributes)} or {@link #list(int)}</li>
+ * <li>{@link #listItem(int,SinkEventAttributes)} or {@link
#listItem(int)}</li>
+ * <li>{@code ...}</li>
+ * <li>{@link #listItem_()}</li>
+ * <li>{@link #list_()}</li>
+ * <li>{@code ...}</li>
+ * <li>{@link #listItem_()}</li>
+ * <li>{@link #list_()}</li>
+ * </ol>
* @param attributes A set of {@link SinkEventAttributes}, may be
<code>null</code>.
* @since 1.1
*/
@@ -761,11 +772,10 @@ public interface Sink extends AutoCloseable {
/**
* Starts an ordered list element.
- *
* <p>
* Supported attributes are the {@link SinkEventAttributes base
attributes}.
* </p>
- *
+ * A list must contain at least one {@link
#numberedListItem(SinkEventAttributes)} or {@link #numberedListItem()} as
direct successor of this method.
* @param numbering the numbering style.
* @param attributes A set of {@link SinkEventAttributes}, may be
<code>null</code>.
* @since 1.1
@@ -795,7 +805,18 @@ public interface Sink extends AutoCloseable {
* <p>
* Supported attributes are the {@link SinkEventAttributes base
attributes}.
* </p>
- *
+ * Nested lists must have the following Sink method sequence:
+ * <ol>
+ * <li>{@link #numberedListItem(int,SinkEventAttributes)} or {@link
#numberedListItem(int)}</li>
+ * <li>{@link #numberedList(int,SinkEventAttributes)} or {@link
#numberedList(int)}</li>
+ * <li>{@link #numberedListItem(int,SinkEventAttributes)} or {@link
#numberedListItem(int)}</li>
+ * <li>{@code ...}</li>
+ * <li>{@link #numberedListItem_()}</li>
+ * <li>{@link #numberedList_()}</li>
+ * <li>{@code ...}</li>
+ * <li>{@link #numberedListItem_()}</li>
+ * <li>{@link #numberedList_()}</li>
+ * </ol>
* @param attributes A set of {@link SinkEventAttributes}, may be
<code>null</code>.
* @since 1.1
*/
