kinow commented on issue #428: change <docEncoding> to <docencoding>
URL: https://github.com/apache/commons-lang/pull/428#issuecomment-498119170
 
 
   The `master` branch of lang is using [Commons Parent 
48](https://github.com/apache/commons-lang/blob/7ddbace445ab1df207b2829a2044ef22f91fa70d/pom.xml#L25)
 ATM.
   
   Commons Parent 48 [is 
configured](https://github.com/apache/commons-parent/blob/f613ac722733b5e10a7028a635b7717d30fbb162/pom.xml#L1644)
 to use the javadoc maven plugin version 3.1.0 (and lang is not overriding this 
value).
   
   The current version of the javadoc maven plugin is 3.1.0, and their site is 
up to date. So we can just use their documentation as reference for this issue.
   
   It seems that the 
[correct](https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#docencoding)
 is to be `docencoding` and not `docEncoding`. And its documentation states 
that if not present, then it will be UTF-8, but that's because it uses 
`${project.reporting.outputEncoding}`.
   
   
![image](https://user-images.githubusercontent.com/304786/58777980-d90d8f80-8624-11e9-960a-6b338b8fc191.png)
   
   This value is used for the [`docencoding` parameter of the `javadoc` 
utility](https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#docencoding).
 And if omitted, then it defaults to the `encoding` value.
   
   
![image](https://user-images.githubusercontent.com/304786/58778044-11ad6900-8625-11e9-81cd-3a591bf186ea.png)
   
   Apache Commons Lang is [configured with a build source encoding of 
ISO-8859-1](https://github.com/apache/commons-lang/blob/7ddbace445ab1df207b2829a2044ef22f91fa70d/pom.xml#L565).
   
   So I think the typo fix was correct. As for omitting these two values, and 
falling back to the `iSO-8859-1`, I'm neutral to this change, as I have no idea 
if there was a reason for using ISO-8859-1 to build the source, but UTF-8 to 
produce the javadocs :+1: 
   
   And thanks for the contribution!
   Bruno

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
[email protected]


With regards,
Apache Git Services

Reply via email to