Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Auto-generate documentation for single c# file in asp.net project? [closed]

I'm trying to figure out how to automatically generate documentation for a single c# file in an ASP.NET project. I'm using VS 2010, and I have SandCastle, but I'm starting to get the impression it can only be used for a full project. The problem is that our entire project is huge and nothing but that one file needs documentation (it's the only one with functionality our clients use - everything else is internal)

I could do a batch script, but I'd rather not if there's a better way of going about this!

Does anybody have any ideas? Thanks very much in advance!

(as a side note, I saw this already and it did not help: Generating XML Documentation for single VB Class in WebSite Project )

like image 804
Katherine Williams Avatar asked May 14 '12 17:05

Katherine Williams


1 Answers

I recommend using Sandcastle.

http://shfb.codeplex.com/

One thing you could do is have a post build task that pulls that portion of XML from the documentation file and then run Sandcastle or doxygen against your new XML file.

like image 200
Derek Smalls Avatar answered Sep 27 '22 20:09

Derek Smalls