Is there an easy way to produce MSDN-style documentation from the Visual Studio XML output? I'm not patient enough to set up a good xslt for it because I know I'm not the first person to cross this bridge. Also, I tried setting up sandcastle recently, but it really made my eyes cross. Either I was missing something important in the pr...
Does anyone know any tool like NDoc that could generate MSDN-like documentation out of XML comments in the C# code? I need it for .NET 3.5 and C#. Sandcastle maybe? Thanks. ...
I am trying to generate a Sandcastle help file for a website. In the properties window for project, there aren't any options for creating the XML Documentation File required for Sandcastle. The Build tab in the property pages only contains options for: Start Action, Build Solution Action, and Accessibility validation. I don't have any o...
At work we use Sandcastle for creation of help files. I have been using SandCastleGUI for some time and I'm looking for a way to create additional pages in the help file. These pages are written in XML format called MAML. The only problem is that I couldn't find any decent editor for these file format. I'm looking for a WYSIWYG editor...
Hello, I started using Sandcastle some time ago to generate a Documentation Website for one of our projects. It's working quite well but we've always only written documentation for classes, methods, properties (...) in our project and had completely separate documentation for the overall project and project parts/modules/namespaces. It ...
What steps do I need to take to get HTML documentation automatically building via the build step in Visual Studio? I have all the comments in place and the comments.xml file being generated, and Sandcastle installed. I just need to know what to add to the post-build step in order to generate the docs. ...
I need a code documentation tool similar to javadoc or c# xml doc for delphi code. What is the best tool? I prefer a technology, which is in the future compatible to the Microsoft sandcastle project. ...
I need to convert my Sandcastle Help File Builder (SHFB) output that is a Web site (HTML) to Media wiki format Find a way to transfer/include the converted pages directly into the MediaWiki we have set up. Any ideas? we have over 1000 pages of HTML files inthe Website (output of SHFB). I thought of using a html2wiki converter ....
How much code documentation in your .NET source is too much? Some background: I inherited a large codebase that I've talked about in some of the other questions I've posted here on SO. One of the "features" of this codebase is a God Class, a single static class with >3000 lines of code encompassing several dozen static methods. It's eve...
My team is responsible for the development of an API for a large system that we also write. We need to provide example code so that other developers using our API can learn how to use it. We have been documenting the code using the xml document comments. eg. /// <summary>Summary here</summary> /// <example>Here is an example <code>exam...
I have several C# projects along with some internal library components that I'm trying to document together. Sandcastle seems to be the place to go to generate documentation from C#. I would like to know which of the two, DocProject or Sandcastle Help File Builder GUI is better and supports the features I need. I would like to compile...
I am trying to comment an API (.Net) that I am exposing to a customer. I am doing this by using XML comments, and extracting via SandCastle. This is all fine and dandy, however I have unittesting for the API, and thought the code from these would be good to place in the example tags. So does anyone know of a good way to extract unit te...
Is SandCastle the best "free" code document producing tool? Or Is there a more recommended product, that works with .net? ...
I'm very happy with the output from SandCastle, but I would also like to have some search functionality included in the HTML output, is this possible? ...
I am about to write an import to MOSS utility from Sandcastle HTML output. Before I do this I would just like to ask if anyone knows of a tool that can already accomplish this? Oh and if the question gets closed for not being programming related, please just leave a comment. ...
Good morning, afternoon, evening or night (depending on your timezone). This is just a general question about XML commenting within C#. I have never been very big into commenting my programs, I've always been more of a verbose variable/property/method namer and letting the code speak for itself. I do write comments if I'm coding somethi...
In XML documentaiton comments for C#, is there a way to mark two or more functions to be overloads of each other, so that they reference each other automatically? Ideally, they'd also be grouped in the sandcastle-generated documentation somehow. Purpose: Often, I want to link to this group of functions, e.g. in a list of utility functio...
I'm trying to take advantage of Sandcastle to help build out system documentation, but for some odd reason none of my <summary> data shows up in the chm ... has anyone had success w/ the latest build of Sandcastle and VS2008 using VB? ...
We make use of sandcastle (and SHFB) to generate class library documentation from inline XML comments. It's a great tool to maintain complete and professional looking reference + overview documentation, including correct code samples. Unfortunately, it's also dog slow. It's by far the most time consuming step of our automated build, and...
Is it possible to create a CHM file or HTML help (akin to those created by Sandcastle) from an XSD file? Text in the xs:documentation nodes contains, well, the documentation. An example snippet from one of the XSD files I have is <xs:element name="Request" type="RequestType"> <xs:annotation> <xs:documentation> <html:p>The Request...