# javadoc.chm

**Repository Path**: robot/javadoc.chm

## Basic Information

- **Project Name**: javadoc.chm
- **Description**: No description available
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2015-11-05
- **Last Updated**: 2020-12-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# What's this?

This software generates an Microsoft HTML Help(CHM) from generic javadoc style API documents.
It's a easy way to search something from javadoc with pre-compiled full text index.

Javadoc.chm can identify the new doc style for java 8.0+.

# Requirements

* [Java](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
* [HTML Help Workshop](http://msdn.microsoft.com/en-us/library/ms669985.aspx)

# How to

Download binary jar

https://github.com/subchen/javadoc.chm/raw/master/dist/javadoc.chm-2.1.0.jar

Generates HTML Help project files

```
java -Xms256m -Xmx512m -jar javadoc.chm-xxx.jar <javadoc-api-dir> <file-encoding>
```

Compile the HTML Help

```
build.bat
```

To change the default language option of hhp file, modify htmlhelp.hhp.

```
"Language=0x409 English (U.S.)"
```