commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Sébastien Brisard (JIRA) <j...@apache.org>
Subject [jira] [Commented] (MATH-903) UTF-8 extended characters are not rendered correctly in the javadoc
Date Mon, 19 Nov 2012 06:48:58 GMT

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

Sébastien Brisard commented on MATH-903:
----------------------------------------

The problem seems to come from the parent {{pom}}, where two properties are defined
{code:xml}
  <properties>
    ...
    <commons.encoding>iso-8859-1</commons.encoding>
    <commons.docEncoding>${commons.encoding}</commons.docEncoding>
    ...
{code}
which are then used
{code:xml}
  <build>
    ...
    <pluginManagement>
      <plugins>
        ...
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-javadoc-plugin</artifactId>
          <version>${commons.javadoc.version}</version>
          <configuration>
            <!-- keep only errors and warnings -->
            <quiet>true</quiet>
            <encoding>${commons.encoding}</encoding>
            <docEncoding>${commons.docEncoding}</docEncoding>
            ...
{code}
Therefore, to fix this bug, it should be sufficient to override {{commons.encoding}} in our
{{pom}}, and remove the following lines
{code:xml}
<properties>
    ...
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    ...
</properties>
{code}
                
> UTF-8 extended characters are not rendered correctly in the javadoc
> -------------------------------------------------------------------
>
>                 Key: MATH-903
>                 URL: https://issues.apache.org/jira/browse/MATH-903
>             Project: Commons Math
>          Issue Type: Bug
>    Affects Versions: 3.1
>            Reporter: Sébastien Brisard
>            Assignee: Sébastien Brisard
>            Priority: Minor
>              Labels: Javadocs, UTF-8, pom
>
> It was recently agreed on the [mailing list|http://markmail.org/thread/bnnjyakdhx7icsj7]
that UTF-8 extended characters should be allowed in the Javadoc comments (in place of {{&...;}}
HTML special characters), in order to increase readability.
> The {{pom.xml}} states
> {code:xml}
>   <properties>
>     ...
>     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
>     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
>     ...
>   </properties> 
> {code}
> which, according to [this FAQ|http://maven.apache.org/plugins/maven-javadoc-plugin/faq.html#What_are_the_values_of_encoding_docencoding_and_charset_parameters],
should be enough to accept UTF-8 encoding in the Javadoc. However, UTF-8 extended characters
are not rendered correctly.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message