How to generate javadoc documentation with umlauts?

Question

I am trying to generate Java documentation in Eclipse. The source files are UTF-8 encoded and contain some umlauts. The resulting HTML files do not specify an encoding and do not use HTML entities, so the umlauts aren't displayed correctly in any browser.

What can I do to change this?

score 57 · Answer 1 · edited Jul 06 '11 at 12:46

57

Modified from Eclipse javadoc in utf-8:

Project -> Generate Javadoc -> Next -> on the last page, in Extra Javadoc options write:

-encoding UTF-8 -charset UTF-8 -docencoding UTF-8

edited Jul 06 '11 at 12:46

Paŭlo Ebermann

73,284
20
146
210

answered Jul 05 '11 at 07:24

FeelGood

5,594
2
25
22

I don't see an *export* option in my Eclipse. Where would one find this? – Paŭlo Ebermann Jul 05 '11 at 15:23
In Eclipse 3.6.2, this would be in the Project menu. Which Eclipse version are you using? Also, better put these arguments to *Javadoc options* instead of *VM options*. – Paŭlo Ebermann Jul 05 '11 at 15:26

score 38 · Accepted Answer · edited Jul 05 '11 at 15:19

38

See the -charset, -encoding and -docencoding flags for the javadoc command.

-encoding specifies the input encoding
-docencoding specifies the output encoding
-charset makes javadoc include a meta tag with encoding info

edited Jul 05 '11 at 15:19

Paŭlo Ebermann

73,284
20
146
210

answered Aug 23 '09 at 22:14

robinr

4,376
2
20
18

Thanks for your answer. I thought there must be some easy way to do this in eclipse, since eclipse already knows the encoding of the input files. – Kim Stebel Aug 24 '09 at 08:24
3

It is really annoying that there are both `-charset` and `-docencoding` options - I can not imagine a case where these two would be set different (or one would be set and the other one not). – Paŭlo Ebermann Jul 05 '11 at 15:16

score 2 · Answer 3 · answered Jun 22 '12 at 10:09

2

If you generate your javadoc with an ant task and you use UTF-8 you can do:

<javadoc encoding="UTF-8" charset="UTF-8" docencoding="UTF-8" sourcepath="yoursources" destdir="yourdocdir" />

answered Jun 22 '12 at 10:09

Heiner

131
1
8

score 1 · Answer 4 · answered Jan 24 '19 at 20:10

1

When generating the javadoc with Gradle add the following to your build.gradle file:

javadoc {
    options.encoding = 'UTF-8'
    options.docEncoding = 'UTF-8'
    options.charSet = 'UTF-8'
}

answered Jan 24 '19 at 20:10

xtian

2,908
2
30
43

How to generate javadoc documentation with umlauts?

4 Answers4

Related