#DOXYGEN GENERATE CHM HOW TO#

First, in most situations where code isn't being packaged and sold, anybody who needs to work with something that's already been written will likely have access to the source code (including comments), so formal documentation isn't absolutely necessary.

(True story - as a brash young developer, I was quick to irritate a business analyst on my team by telling him things like 'documentation costs extra.') If you think about it, this lack of desire to document code kind of makes sense.

Put simply, getting software documented properly after it's written is a pain.ĭevelopers typically don't enjoy preparing documentation, and even if you can get them to document it initially, keeping it updated is always a challenge.

#DOXYGEN GENERATE CHM HOW TO#

CalculateDateByBusinessDays.cs (2.05 kb)Īnd the final output will be this generated CHM file: LucasWorkflowDemo.chm (76.94 kb).Īlthough this sample is focused on documenting an assembly that is used as part of a Dynamics CRM solution, the overall documentation approach and techniques are applicable to any C# project.īefore we look at how to document code using Doxygen, let's step back and take look at the broader problem we need to solve.(Doxygen can actually generate documentation in a variety of different formats, but I'm partial to CHM files because they're entirely self-contained.) For this example, I have a project that consists of these three C# files: In this post I will show how to document a Dynamics CRM 2011 custom workflow activity assembly and use Doxygen to generate a compiled HTML (CHM) help file.

Doxygen generate chm