Generating documentation from code with Team Build

re: Generating documentation from code with Team Build

Tue, 25 May 2010 10:57:34 GMT

re: Generating documentation from code with Team Build

Tim Dallmann — Wed, 07 Feb 2007 21:30:39 GMT

I currently have doc generation running as part of my nightly build. I looked at all the MSBuild scripts people had created, but none seemed simple enough to implement and maintain (especially since I'm a consultant at a client, and I won't be around forever!)

The solution I came up with works really well however. It's based around the Sandcastle Help File Builder tool at http://www.codeplex.com/Wiki/View.aspx?ProjectName=SHFB. The GUI is used on the client against the helper's configuration file, which is housed in the VS.Net solution, so developers can always maintain how docs are produced.

To generate the docs from the build, all I do is add the following targets:

</Target>

</CreateItem>

</CreateItem>

<Copy SourceFiles="@(NewDocFiles)"

DestinationFolder="\\DocServer\Code Documentation\ProjectName\%(NewDocFiles.RecursiveDir)" />

</Target>

This creates the docs based on the config maintained in the solution, and then copies them to a doc server, where I can access them through our team project portal.

re: Generating documentation from code with Team Build

Anders Ljusberg — Wed, 07 Feb 2007 12:15:04 GMT

Hi, I'm the author of the CodePlex-project you mention.

I've been thinking about this for quite some time now but just haven't gotten around to looking at it yet. If there is enough interest I'd be happy to have a look at it!

Vote on the issue here:

http://www.codeplex.com/MSBuildSandcastle/WorkItem/View.aspx?WorkItemId=8045

Regards,

Anders Ljusberg

VSTS Links - 02/06/2007

Team System News — Tue, 06 Feb 2007 17:20:21 GMT

Brian Harry on Daylight Savings Time Changes Coming and Our First Orcas perf results at load. Scott...

Generating documentation from code with Team Build

Mighell's blog — Sat, 03 Feb 2007 22:22:41 GMT

Molto interessante: Brian Keller replied to an internal email thread discussing generating documentation