Been there, done that ;) See: http://ozgrant.com/2008/02/19/building-sandcastle-documentation-with-team-build/ http://tfsbuild.com/Building%20Sandcastle%20Documentation.ashx
I've since made some enhancements to include namespace descriptions, shared content & images/resources automatically, will get those published soon. You can also get away WITHOUT having a SHFB project file and doing it all as command line parameters. Just use "-new" Regards, Grant Holliday | Team System MVP<https://mvp.support.microsoft.com/profile/Grant.Holliday> Email: [EMAIL PROTECTED]<mailto:[EMAIL PROTECTED]> | Blog: http://ozgrant.com<http://ozgrant.com/> | Mobile: +61 (0)402 414 446 ________________________________ From: [EMAIL PROTECTED] [EMAIL PROTECTED] On Behalf Of William Bartholomew [EMAIL PROTECTED] Sent: Thursday, 8 May 2008 1:24 PM To: [email protected] Subject: RE: [OzTFS] A few little questions The Sandcastle Helper File Builder has a command-line option which you can pass a list of assemblies to (and it supports wildcards). When you install SHFB have a look at the command-line help file. From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Steven Nagy Sent: Thursday, 8 May 2008 1:07 PM To: [email protected] Subject: RE: [OzTFS] A few little questions One of the pain points for us is that we need to dynamically define what assemblies to use. The number of projects is huge, and when devs add new projects and solutions, they are unlikely to notify me. It looks like the Sandcastle project file is restrictive in that you need to specify each assembly and comments file manually. I've briefly read about Sandcastle helper but couldn't see any value for automation... am I missing something? ________________________________ From: [EMAIL PROTECTED] [EMAIL PROTECTED] On Behalf Of William Bartholomew [EMAIL PROTECTED] Sent: Thursday, 8 May 2008 11:56 AM To: [email protected] Subject: RE: [OzTFS] A few little questions Hi Steve, I can help with #2 because I have been looking into this… Unfortunately, if you set it to a static file then each project that is built will override the comments from the previous one, which is not what you want. You will need the doc file to match the name of the assembly but with an .xml extension. This will be done automatically for you if you tick the “Generate XML documentation” checkbox in the project properties. If you don’t trust your developers and want to force this on you may need to write an MSBuild task that modifies the project files before the build runs. You can then modify the sandcastle.config to use a wildcard instead of comments.xml, we actually ended up using the Sandcastle Help File Builder to automate the process. HTH, William From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Steven Nagy Sent: Thursday, 8 May 2008 11:33 AM To: [email protected] Subject: [OzTFS] A few little questions Heyas, As usual, I am the biggest spammer of questions on this list. :) Hope you guys don't mind too much. Here's a couple of (hopefully) easy questions: 1) We don't want 'Partially Succeeded'. For us, this is a fail. I have found some resources around getting build properties out and setting them, but before I implement it, just wondering if there is a quick easy switch somewhere? (maybe a secret var that I can just set to true or something) 2) Has anyone introduced Sandcastle into their builds? I need to find a way to tell my 'SolutionToBuild' entries to output a comments.xml doc (command line is CSC /doc:Comments.xml). How would this work in the ItemGroup? What about multiple items in the group that all specify the same comments.xml? Will the comments append, or overwrite as it builds each one? Or do I really need a seperate comments.xml per assembly, and then call sandcastle against each? Cheers, Steve ______________________________________________________________________ This email has been scanned by the MessageLabs Email Security System. For more information please visit http://www.messagelabs.com/email ______________________________________________________________________ OzTFS.com - to unsubscribe from this list, send a message back to the list with 'unsubscribe' as the subject. View the web archives at http://www.mail-archive.com/[email protected]/ Powered by mailenable.com, supported by www.readify.net ______________________________________________________________________ This email has been scanned by the MessageLabs Email Security System. For more information please visit http://www.messagelabs.com/email ______________________________________________________________________ OzTFS.com - to unsubscribe from this list, send a message back to the list with 'unsubscribe' as the subject. View the web archives at http://www.mail-archive.com/[email protected]/ Powered by mailenable.com, supported by www.readify.net ______________________________________________________________________ This email has been scanned by the MessageLabs Email Security System. For more information please visit http://www.messagelabs.com/email ______________________________________________________________________ OzTFS.com - to unsubscribe from this list, send a message back to the list with 'unsubscribe' as the subject. View the web archives at http://www.mail-archive.com/[email protected]/ Powered by mailenable.com, supported by www.readify.net OzTFS.com - to unsubscribe from this list, send a message back to the list with 'unsubscribe' as the subject. View the web archives at http://www.mail-archive.com/[email protected]/ Powered by mailenable.com, supported by www.readify.net OzTFS.com - to unsubscribe from this list, send a message back to the list with 'unsubscribe' as the subject. View the web archives at http://www.mail-archive.com/[email protected]/ Powered by mailenable.com, supported by www.readify.net
