commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Gilles Sadowski <gil...@harfang.homelinux.org>
Subject Re: [All] Re: UTF-8 encoding of Javadoc
Date Sat, 17 Nov 2012 00:53:52 GMT
On Fri, Nov 16, 2012 at 08:09:13PM +0100, S├ębastien Brisard wrote:
> Hi,
> 
> 2012/11/16 Gilles Sadowski <gilles@harfang.homelinux.org>
> 
> > Hi.
> >
> > > I think I've spotted the reason why the javadoc does not come out right
> > > with UTF-8 characters.
> > > Our pom.xml defines the following properties
> > >     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
> > >
> > >
> > <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
> > > which should produce the correct result if the default configuration of
> > the
> > > javadoc plugin is used [1].
> > >
> > > However, the parent pom.xml does not use the javadoc plugin default
> > config.
> > > Instead, it uses two properties, namely commons.encoding and
> > > commons.docEncoding
> > >         <plugin>
> > >           <groupId>org.apache.maven.plugins</groupId>
> > >           <artifactId>maven-javadoc-plugin</artifactId>
> > >           ...
> > >           <configuration>
> > >             ...
> > >             <encoding>${commons.encoding}</encoding>
> > >             <docEncoding>${commons.docEncoding}</docEncoding>
> > >             ...
> > >           </configuration>
> > >         </plugin>
> > >
> > > which are defined as follows
> > >     <commons.encoding>iso-8859-1</commons.encoding>
> > >     <commons.docEncoding>${commons.encoding}</commons.docEncoding>
> >
> > I'd think that this should be changed here.
> >
> > What do you mean? In the parent pom? I think this is a radical change;
> maybe not everyone is keen on using UTF-8 encoding.

According to that other thread about the CMS, I assumed that UTF-8 should be
the default here too.

> 
> The changes I propose (they must be validated by others more familiar with
> maven) keep the spirit of our own pom, in which we override the default
> encoding. Only, this default encoding is at the moment not correctly
> overriden.

As you said that it works, and nobody emitted an objection, I assume that
you are free to fix the problem.


Best regards,
Gilles

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message