maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Hervé Boutemy (JIRA) <j...@apache.org>
Subject [jira] [Commented] (DOXIA-536) AptParser does not force linebreak in Sink after a comment is written
Date Tue, 28 Mar 2017 20:02:41 GMT

    [ https://issues.apache.org/jira/browse/DOXIA-536?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15945837#comment-15945837
] 

Hervé Boutemy commented on DOXIA-536:
-------------------------------------

because of DOXIA-482: comments are not rendered any more

did I miss some use case?

> AptParser does not force linebreak in Sink after a comment is written
> ---------------------------------------------------------------------
>
>                 Key: DOXIA-536
>                 URL: https://issues.apache.org/jira/browse/DOXIA-536
>             Project: Maven Doxia
>          Issue Type: Bug
>          Components: Module - Apt
>    Affects Versions: 1.6
>            Reporter: Michael Osipov
>            Priority: Minor
>
> Consider this comment block:
> {noformat}
> ~~ Copyright 2012 Michael Osipov
> ~~
> ~~ Licensed under the Apache License, Version 2.0 (the "License");
> ~~ you may not use this file except in compliance with the License.
> ~~ You may obtain a copy of the License at
> ~~
> ~~     http://www.apache.org/licenses/LICENSE-2.0
> ~~
> ~~ Unless required by applicable law or agreed to in writing, software
> ~~ distributed under the License is distributed on an "AS IS" BASIS,
> ~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
> ~~ See the License for the specific language governing permissions and
> ~~ limitations under the License.
> {noformat}
> Apt's comment syntax goes to the end of the line which would mean that if the {{AptParser}}
hits a comment it has to create a line break with the target {{Sink}} too. Unfortunately,
the result in, e.g., HTML is:
> {noformat}
> <!-- Copyright 2012 Michael Osipov --><!--  --><!-- Licensed under the
Apache License, Version 2.0 (the "License"); --><!-- you may not use this file except
in compliance with the License. --><!-- You may obtain a copy of the License at --><!--
 --><!-- http://www.apache.org/licenses/LICENSE-2.0 --><!--  --><!-- Unless
required by applicable law or agreed to in writing, software --><!-- distributed under
the License is distributed on an "AS IS" BASIS, --><!-- WITHOUT WARRANTIES OR CONDITIONS
OF ANY KIND, either express or implied. --><!-- See the License for the specific language
governing permissions and --><!-- limitations under the License. -->
> {noformat}
> This is ugly doesn't make the comment readible at all. Investigate how we can send a
{{line.separator}}, i.e., pretty-print the output.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

Mime
View raw message