Umbraco documentation generated by Sandcastle

June 04th, 2007

I am pleased to announce the first draft of the automated documentation generated by Sandcastle from Microsoft.

You can now easily see what kind of library methods you can use in your xslt

Full HTML version online
At some point I will remove the HTML version from my website, since when it is out of the draft state, it will be moved to www.umbraco.org, the total html documentation is 47 MB.

CHM version (5 MB)

HTML and CHM compressed (rar) into one file (15 MB)

The files have been generated with Sandcastle Help File Builder which really helped me out, I did the first try in the start of the year, but back then I gave up. Thanks to new releases from Sandcastle (March 2007 CTP) and from Sandcastle Help File Builder (1.4.0.1, March 2007) everything worked out fine without big problems.

The next step is to summary the namespaces, and it would be nice to see some examples on the library methods, a pretty simple task (volunteers is welcome).

You can get info on Sandcastle and how to document class libraries in Visual Studio via SandcastleDocs.com

Tags: Umbraco

Comments

#1 - Casey Neehouse on June 05, 2007 00:53

Thanks..

Now to get everything commented correctly...

#2 - bob baty-barr on June 05, 2007 03:40

holy crap! that is a ton of stuff :) Nice work!

#3 - Kenneth Solberg on June 05, 2007 07:56

Nice work!

#4 - Warren Buckley on June 05, 2007 10:12

Excellent work - this will really help me out.

Warren :)

#5 - Duckie on June 05, 2007 11:42

"Now to get everything commented correctly..."

My excuse for the webservices, is that they are self-commenting :-D .. I better get to work :-)

#6 - Casey Neehouse on June 05, 2007 15:18

"My excuse for the webservices, is that they are self-commenting :-D .. I better get to work :-)"

Most things are. There were a few things that I noticed that could have better comments/descriptions.

#7 - Christian Palm on June 05, 2007 16:25

For documenting class libraries, I can recommend the Visual Studio plug-in GhostDoc
http://www.roland-weigelt.de/ghostdoc/

Taken from GhostDoc:
GhostDoc is a free add-in for Visual Studio that automatically generates XML
documentation comments for C#. Either by using existing documentation inherited
from base classes or implemented interfaces, or by deducing comments from
name and type of e.g. methods, properties or parameters.

#8 - chuck fischer on June 05, 2007 17:52

Holy Beans Batman, thems a lot of docs. GREAT WORK!!!! you is die bombe

#9 - Kalle Wibeck on June 06, 2007 22:09

Christian!
This was so very needed! Thanks to your work / research we're now going to get great docs for every updates in the future (at least if all coders make some decent comments ;)...

What can I say!? You simply rock, man !!

#10 - Roni Biran on June 07, 2007 18:46

tres tres cool....

#11 - kipusoep on October 27, 2009 19:35

Thanks a lot!

#12 - http://buypillsshop.info on December 06, 2009 23:32

http://buypillsshop.info

#13 - download tech house on January 20, 2010 20:22

download mp3

Create a new comment