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.



Love this tool and have used it successfully before.

I am now having a similar problem as a previous user.

Cannot open '..\doc\overview-frame.html'. You should select index.html in API folder, for instance \docs\api\index.html.

The issue is my javadocs folder does not have an overview-frame html. It works fine from a browser though. It is a single package javadoc created by Java 1.7.05 (using eclipse IDE).

If it is a single package javadoc does it still work with 1.7? Is having "overview-frame.html" a prerequisite for the conversion to work?


Could you please post your javadoc zipped to I will fix it but I need something to reproduce the problem.

Hi Jan, Sent that to your email a few days back. Let me know if you need any more info. Thanks.

Please test with new version. Your javadoc doesn't include index file(s), so no index is generated, but otherwise it works fine. Let me know, Jan

I have used your product 2 or 3 times over the years and really appreciate it.

My latest project might have some issues however - conversion of JavaFx2.2.7 JavaDocs
I am getting about 20 warnings from the Help Compiler about invalid html tags in the source.

Is this something I could fix up by going into the files and changing them or should I ignore these warnings?
The CHM looks good otherwise.

THanks and regards/Jon

Thank you for your feedback. The Help Compiler complains about not valid HTML file, for instance when the javadoc file contains characters like '>' or '<' as in Java sample code. They need to be written as html entities instead. You can ignore those warnings, the compiler is able to recover from the problem. You may want to report problems like that to the Javadoc authors.

Thanks for your help - and thanks for a great product

First, many thanks for this great tool!
With Java 8 API docs there is a problem, see for example interface MemoryMXBean (in package, which does not appear in the chm index (it appears as entry "an class=", as many other entries). You can only get to this entry by going to the package entry or from another page which links to it, but you can't find it by searching it in the index (which is the most common way of searching for help).
Again, thanks for this amazing tool and for your support.

Thanks for your bug report, I will look into that and let you know.

(EDIT) Done, please test with new version.

Thank you very much!