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/06 10:16:00 UTC
[jira] [Updated] (DOXIA-746) MarkdownSink: Comment missing EOLs
[ https://issues.apache.org/jira/browse/DOXIA-746?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Konrad Windszus updated DOXIA-746:
----------------------------------
Description:
The sink API is not clear about whether comments are block or inline elements (although never rendered the question is how they should appear in the markup sources)
In APT [comments|https://maven.apache.org/doxia/references/apt-format.html#comment] always end with the line ending (as there is no dedicated end comment delimiter).
OTOH in markdown/html they have a dedicated end character.
Currently two consecutive comments in APT are emitted as
{code}
sink.comment("comment1")
sink.comment("comment2")
{code}
In APT they are separated by newlines but in Sink API and Markdown/HTML they are not.
was:Comments must be treated as block elements, i.e. if other block elements are following they must be separated by a EOL. Currently e.g. two consecutive comments are emitted without a EOL in between.
> MarkdownSink: Comment missing EOLs
> ----------------------------------
>
> Key: DOXIA-746
> URL: https://issues.apache.org/jira/browse/DOXIA-746
> Project: Maven Doxia
> Issue Type: Bug
> Components: Module - Markdown
> Affects Versions: 2.0.0
> Reporter: Konrad Windszus
> Assignee: Konrad Windszus
> Priority: Major
>
> The sink API is not clear about whether comments are block or inline elements (although never rendered the question is how they should appear in the markup sources)
> In APT [comments|https://maven.apache.org/doxia/references/apt-format.html#comment] always end with the line ending (as there is no dedicated end comment delimiter).
> OTOH in markdown/html they have a dedicated end character.
> Currently two consecutive comments in APT are emitted as
> {code}
> sink.comment("comment1")
> sink.comment("comment2")
> {code}
> In APT they are separated by newlines but in Sink API and Markdown/HTML they are not.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)