Declare createList API as experimental
MODIFY
CHANGELOG.adoc
CHANGELOG.adoc
@@ -22,11 +22,8 @@ Improvement::
Bug Fixes::
- * Add missing factory methods to create Lists (@glisicivan) (#916)
-
-Build::
-
- * Upgrade jruby-gradle-plugin to 2.0.0-alpha.7 and load Gems directly from rubygems.org instead of using torquebox Maven proxy.
+ * Add missing factory methods to create Lists. (@glisicivan) (#916)
+ The API `Processor.createList()` is experimental and may change with any release until declared to be stable.
Documentation::
@@ -37,6 +34,10 @@ Build::
* Upgrade to jruby-gradle-plugin 2.0.0
+Known Limitations:
+
+ * The createList() and createListItem() API is not able to create DescriptionLists.
+
== 2.2.0 (2019-12-17)
Improvement::

MODIFY
asciidoctorj-api/src/main/java/org/asciidoctor/extension/Processor.java
asciidoctorj-api/src/main/java/org/asciidoctor/extension/Processor.java
@@ -82,15 +82,33 @@ public interface Processor {
Document createDocument(Document parentDocument);
/**
- * Creates a new List
+ * Creates a new List.
+ * This method is experimental and may change in future minor releases until declared to be stable.
* @param parent The block to which the parsed content should be added as children.
* @param context Either {@code "olist"}, {@code ulist}, {@code colist} or {@code dlist}
- * @return
+ * @return A List node that can be added to the AST of a document.
*/
org.asciidoctor.ast.List createList(StructuralNode parent, String context);
+ /**
+ * Creates a new List.
+ * This method is experimental and may change in future minor releases until declared to be stable.
+ * @param parent The block to which the parsed content should be added as children.
+ * @param context Either {@code "olist"}, {@code ulist}, {@code colist} or {@code dlist}
+ * @param attributes Additional attributes to be set on the new list node, e.g. <code>Collections.singletonMap("start", "2")</code>.
+ * @param options Additional options to be set on the new list node.
+ * @return A List node that can be added to the AST of a document.
+ */
org.asciidoctor.ast.List createList(StructuralNode parent, String context, Map<String, Object> attributes, Map<Object, Object> options);
+ /**
+ * Creates a new List.
+ * This method is experimental and may change in future minor releases until declared to be stable.
+ * @param parent The block to which the parsed content should be added as children.
+ * @param context Either {@code "olist"}, {@code ulist}, {@code colist} or {@code dlist}
+ * @param options Additional options to be set on the new list node.
+ * @return A List node that can be added to the AST of a document.
+ */
org.asciidoctor.ast.List createList(StructuralNode parent, String context, Map<Object, Object> options);
ListItem createListItem(final org.asciidoctor.ast.List parent, final String text);

Declare createList API as experimental