Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

C# class documentation in a printable form [closed]

Our C# source code is comprehensively documented using the usual Sandcastle/XML notation. We use SHFB to compile this into a MSDN-style documentation website.

We now need to*1compile the documentation into a printable form. Ideally, we would like a PDF document but the specific format is less important than its printability. It is important, but not critical, that the documentation looks relatively professional and can be branded with the corporate logos, etc.

Is there a mostly pain-free way to do this? I don't think individually printing every page of the documentation website is a practical choice. The intermediate XML documentation files can, in principle, be transformed into a useable format but maybe there is already a viable and maintained solution for this task?



*1 - for reasons that I don't fully comprehend.

like image 249
Stewart Avatar asked Nov 13 '22 13:11

Stewart


1 Answers

Is there a mostly pain-free way to do this?

No, DO not do it. It makes zero sense for a class level documentation - noone will ever read it. TAll hyperlinks do not work, would have to be changed to page references.

Our C# source code is comprehensively documented using the usual Sandcastle/XML notation.

No, it is not. It is documented the normal XML documentation notation. Sandcastle did not invent it.

NOw, if you really have to do it:

http://www.innovasys.com/products/dx2011/csdocumentation.aspx?cpid=gawdxcs&gclid=COiJq5To8qwCFQGHDgod900o0g

is pretty much the best you can get to. The are specialized in exactly that (multi target stuff). They also handle the additional pages etc. which is needed - the pure clas reference, without index, jsut printed, with hyperlinks instead of page references is basically tree destruction without any sense.

like image 84
TomTom Avatar answered Nov 16 '22 04:11

TomTom