App Help and Documentation Tools

  • Thread starter Thread starter Felipe T.
  • Start date Start date
F

Felipe T.

Hi,
Im wondering what are the tools available for
generating .chm, help and documentation of a .Net project?

Thx,
Felipe
 
Thx Peter,

Iv tryed NDoc, it works perfectly for DLLs. But i cant get it working on
EXEs.
Anyway, ill keep on trying some other tools.
 
There are a few gotchas regarding NDoc on Compact Framework code when you
use code that is specific to the Compact Framework Microsoft.WindowsCE.*
for example and also when inheriting classes where there are naming
conflicts between methods/properties you add and those available only on the
full desktop framework - this is because NDoc reflects your classes from the
full framework, this is a problem when inheriting from CommonDialog and
other classes which are significantly slimmed down on the Compact Framework.
The only workaround is to use conditional compilation and hide sections of
your source code from NDoc by building a documentation specific version of
the app or dll.

Peter

--
Peter Foot
Windows Embedded MVP
OpenNETCF.org Senior Advisor
www.inthehand.com | www.opennetcf.org
 
Thx!

Peter Foot said:
There are a few gotchas regarding NDoc on Compact Framework code when you
use code that is specific to the Compact Framework Microsoft.WindowsCE.*
for example and also when inheriting classes where there are naming
conflicts between methods/properties you add and those available only on the
full desktop framework - this is because NDoc reflects your classes from the
full framework, this is a problem when inheriting from CommonDialog and
other classes which are significantly slimmed down on the Compact Framework.
The only workaround is to use conditional compilation and hide sections of
your source code from NDoc by building a documentation specific version of
the app or dll.

Peter

--
Peter Foot
Windows Embedded MVP
OpenNETCF.org Senior Advisor
www.inthehand.com | www.opennetcf.org

CHM
(http://www.opennetcf.org/PermaLink.aspx?guid=05650440-2281-4f72-bdb2-fe6343
 
Back
Top