Doxygen: Generating CHM

Compressed HTML (CHM) files are a convenient medium to view and browse through documentation on Windows. Doxygen can produce documentation of source code in the CHM format. Here is how to configure Doxywizard to produce CHM files:

  1. In Wizard β†’ Output, choose the Output Format as Prepare for compressed HTML (.chm). Configure the rest of the Wizard settings as usual.
  2. In Expert β†’ HTML, provide the CHM filename you want in the CHM_FILE field and the full path of the Microsoft HTML Help Compiler (hhc.exe) tool in the HHC_LOCATION field. This is typically C:\Program Files (x86)\HTML Help Workshop\hhc.exe
  3. In the Run section choose Run Doxygen and a freshly compressed copy of your CHM documentation will be prepared for you by Doxygen! πŸ™‚

4 thoughts on “Doxygen: Generating CHM

  1. It generates a Packages hierarchy, which is a java thing. Any idea how to get it to treat C# namespaces as namespaces, not as packages? Thanks.

    Like

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.