You are here

javadoc to chm conversion


javadoc2chm is a conversion tool which translates Javadoc documentation to CHM, Microsoft Compiled HTML Help file.

Why to convert JavaDoc to CHM? You may find that user experience with plain HTML javadoc is boring. Converting Javadoc to CHM you will gain: built-in search engine, index, bookmarking and more.


Operating system
Windows XP/Vista/Win7/Win8 with Internet Explorer 4.0 and better
automatic installation and uninstallation
Supported languages
Latest version
Size of installation


version 1.3.1 (Jun 30, 2014)

  • bugfix - some index entries were ommited

version 1.3.0 (Feb 25, 2014)

  • new feature - index compacted
  • bugfix - major speed improvement

version 1.2.1 (Oct 13, 2012)

  • bugfix - support for javadoc generated by JDK 7.0

version 1.2.0 (Jan 21, 2012)

  • bugfix - support for JDK 7.0

version 1.1.0 (May 8, 2007)

  • javadoc2chm works also for Javadoc of single package
  • bugfix - in groovy-1.0 javadoc, CRT crashes when vsprintf_s format string contains "% %"
  • bugfix - anchor was removed from index links

version 1.0.2

Fixed compilation bug, better feedback during index creation

version 1.0.1

Test presence of HHA.DLL, customize title of CHM file

version 1.0.0

First public version.


You have to select the index.html in docs/api folder, this tool processes only API documentation, not the collateral stuff.

Sorry about this misunderstanding. I know every document generated from javadoc.exe as "Javadoc", not only the java-dokumentation from sun/oracle.
I used your tool to convert successfully some Javadocs, which I had generated by JDK1.5. This worked perfekt! But if I want to convert an other Javadoc generated by JDK1.7 I get this error message. I would be disappointed if you tell me, your tool is not able to convert my own dokuments.

Could you post your javadoc zipped to

unable to convert Javadoc Html files to chm

It gives following Error
Cannot open 'C:\..\docs\overview-frame.html'. You should select index.html in API folder, for instance \docs\api\index.html.

I generated in x64 system with JDK7 as mentioned in one of post in this mail chain

Any suggestions?

Sorry for late reply, I was on vacations. I assume that you specified the index.html as the starting file as suggested by the error. Could you email me your javadoc files? If that file is present but my tool cannot open it, there is something strange going on.

Works great! Thanks for the update.

This is in reply to my request for the java7 update. For some reason it's not putting my reply in the right spot.

Just wanted to say the update works great! Thanks for the update.

nice tool!
Does it have command-line interface?

No, why you need one?

with command-line interface,the javadoc and winhelp can be Automatically generated everyday.
It does save a lot of time!