NDoc had the ability to produce intellisense output from the raw intellisense xml doc produced by the compiler. There was the option to remove all internal members from it, which was really useful. I'm writing .NET components, and all classes that I do not want to expose to the public are internal, hence the documentation of those classes should not appear in the intellisense docs, because it could e.g. reveal sensitive information about used algorithms, and it bloats the intellisense doc unnecessarily.

Is this possible with Sandcastle yet? Couldn't find the option so far. (If not, please do not hesitate to cram it in the February CTP :-) )

Thanks,

Wout

Wout,

Sandcastle plays no part in intellisense process. As you mention the /// markup to document yourAPIs, the comment file produced by using the compiler's /doc switch is an intellisense file. How did nDoc provide this feature? Was this a post process?

Anand..

I think it's a separate build type in NDoc. I believe all that NDoc does is strip out all of the internal and private member commentsfrom the XML comments files leaving just the public stuff. In the case of Sandcastle, you'd get a list of types and members from the reflection.xml file and then scan the XML comments files removing the members if they didn't appear in the reflection file. Something like that could be implemented as a separate utility unless it can be done with an XSL transformation.

Eric

Indeed Eric. Would be nice if SandCastle did it, so we have one nicely integrated toolkit to work with (I don't know about SandCastle's design, so I don't know if it would fit architecturally, my guess would be that XLST can handle this type of transformation).

Wout

Wout,

I am looking at ways to support this. Currently we use an intellisense component(see below) in our internal build I will modify this to support your scenario. However this will be after our February CTP.

<!-- Write out intellisense -->
<component type="Microsoft.Ddue.Tools.IntellisenseComponent" assembly="..\..\ProductionTools\BuildComponents\BuildComponents.dll">
<output directory="Intellisense" />
</component>

Anand..

Anand,

That's awesome! Sounds like you already had something internally.

I assume by after February you mean not in the February CTP. No big hurry, as long as it's done quick :-)

Wout