windows runtime - Simplest way to add XML doc to a WinRT project -

windows runtime - Simplest way to add XML doc to a WinRT project -

we have grouping of developers moving c++ c# , winrt. used d'oxygen part of our c++ developer builds, , i'd go on have document generation part of developer build in c#/winrt.

it's easy turn on xml doc generation, , believe provide warnings malformed tags, without actual html output, think our developers missing valuable feedback.

looks ndoc defunct, , took quick @ sandcastle, found rather complex. ideally, i'm looking doesn't unduly burden developers, or require them remember steps edit, build, test, , commit. in other words, best solution "just happens", post-build step, , doesn't add together each developer's build time.

if has had experience doing in c#/winrt, i'd sure advice.

thanks in advance!

get sandcastle help file builder. create help project library in visual studio solution. remove build check mark debug solution configuration build documentation project in release configurations, since debug used during development. release build testing or performance testing can either create solution configuration or switch alternative , forth. build documentation once include documentation file in solution shows in pending changes window when file changes. kindly inquire developers build release configuration updates documentation before check-in or utilize other policy require updating documentation.

i don't think makes sense build documentation time, helps create easy when need updated version - can build quickly.

you can create sure utilize fxcop or stylecop (forgot which) , configure treat missing xml documentation warnings errors - @ to the lowest degree in release builds. doing debug configurations might slow downwards development , create changes hard since developers want seek things out before committing final implementation worth documenting.

edit*

sandcastle provides various output formats shown in project properties:

windows-runtime sandcastle ndoc xmldoc