Link to home
Start Free TrialLog in
Avatar of karelog
karelogFlag for Chile

asked on

Create CHM file using Doxygen

Hello everybody!

I have developed an ASP.NET Web site using Visual Studio 2008 and .NET Framework 3.5 SP1.
I commented all methods, functions, classes and properties using ///<summary>

Now I need to create the documentation of that code. I'm trying to use Doxygen which I think is pretty cool.

Now I need to make a CHM file using Doxygen.

Do anyone know how to achieve this?

In advance, many thanks.

PS: I already tried using SandCastle but it haves a lot of problems with web-sites.
PS2: I was able to create an XML Documentation file using SandCastle. How do I use that XML to create a CHM file? App-Code.y714fmxm.xml
Avatar of hjgode
hjgode
Flag of Germany image

Hello

look at your doxygen control file. I have

...
# If the GENERATE_HTMLHELP tag is set to YES, additional index files
# will be generated that can be used as input for tools like the
# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
# of the generated HTML documentation.

GENERATE_HTMLHELP      = YES

# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
# be used to specify the file name of the resulting .chm file. You
# can add a path in front of the file if the result should not be
# written to the html output directory.

CHM_FILE               = CUSBkeyCS.chm

# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
# be used to specify the location (absolute path including file name) of
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
# the HTML help compiler on the generated index.hhp.

HHC_LOCATION           = "/home/hgode/.wine/drive_c/Program Files/HTML Help Workshop/hhc.exe"
...

You can also access this in doxygen wizard gui: see EXPERT-HTML-Generate_HTMLHELP and tick the checkbox. For CHM_FILE select a folder and file name for the chm file to generate. In HHC help enter the path to the html workshop HHC application on your windows system.

regards from germany

Josef
ASKER CERTIFIED SOLUTION
Avatar of hjgode
hjgode
Flag of Germany image

Link to home
membership
This solution is only available to members.
To access this solution, you must be a member of Experts Exchange.
Start Free Trial
Avatar of karelog

ASKER

Many thanks!

You solved my problem ^^