You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Konrad Windszus (Jira)" <ji...@apache.org> on 2024/10/22 11:01:00 UTC
[jira] [Updated] (DOXIA-754) Clarify method order for nested lists

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

Konrad Windszus updated DOXIA-754:
----------------------------------
    Description: 
From the [Sink Javadoc of list()|https://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html#list-org.apache.maven.doxia.sink.SinkEventAttributes-] (or the other related list methods) it is not clear how to properly nest lists/list items

There are different options:
{code}
list();
listItem();
text("level 1")
listItem();
text("level 1.1")
listItem_();
listItem_();
list_();
{code}

or
{code}
list();
listItem();
text("level 1")
list();
listItem();
text("level 1.1")
listItem_();
list_();
listItem_();
list_();
{code}
 
This should be clarified, so that it is clear for both Sink impls as well as Sink API users which order to expect/use.

  was:
From the [Sink Javadoc|https://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html#list-org.apache.maven.doxia.sink.SinkEventAttributes-] (or the other related list methods) it is not clear how to properly nest lists/list items

There are different options:
{code}
list();
listItem();
text("level 1")
listItem();
text("level 1.1")
listItem_();
listItem_();
list_();
{code}

or
{code}
list();
listItem();
text("level 1")
list();
listItem();
text("level 1.1")
listItem_();
list_();
listItem_();
list_();
{code}
 
This should be clarified, so that it is clear for both Sink impls as well as Sink API users which order to expect/use.


> Clarify method order for nested lists
> -------------------------------------
>
>                 Key: DOXIA-754
>                 URL: https://issues.apache.org/jira/browse/DOXIA-754
>             Project: Maven Doxia
>          Issue Type: Improvement
>          Components: Core
>            Reporter: Konrad Windszus
>            Priority: Major
>
> From the [Sink Javadoc of list()|https://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html#list-org.apache.maven.doxia.sink.SinkEventAttributes-] (or the other related list methods) it is not clear how to properly nest lists/list items
> There are different options:
> {code}
> list();
> listItem();
> text("level 1")
> listItem();
> text("level 1.1")
> listItem_();
> listItem_();
> list_();
> {code}
> or
> {code}
> list();
> listItem();
> text("level 1")
> list();
> listItem();
> text("level 1.1")
> listItem_();
> list_();
> listItem_();
> list_();
> {code}
>  
> This should be clarified, so that it is clear for both Sink impls as well as Sink API users which order to expect/use.



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