By default I see that Sandcastle is generating HTML pages and links named with GUIDs. Can somehow this be changed to generate user/SEO friendly names for the pages? Ie. instead of f987d4ff-cabc-10af-86cd-620978605d86.htm I want it create 'namespace.class.method.htm', similar to how the .Net MSDN documentation is generated. ...
I have a set of related components that are basically provide the same functionality for various 'client' environments, like CLR and Java. Currently I'm generating my documentation using Sandcastle for the CLR components and I'm about to start the Java ones. I'd like to keep generating an unified documentation, with consistent look-and-f...
Hello, I'm looking for a decent code documentation generator for C# that can create an html-format documentation straight from source. I don't want to use Sandcastle, because it's too tedious to use and I don't use VS for my work, though Sandcastle's output is exactly what I need. I also need the functionality of Doxygen - just save a...
SandCastle is unable to process our class library because it crashes with an OutOfMemoryException exception during XSL transformation. What can we do about that, except for the obvious, buy more memory? The problem is that this is our developer machines with 3.3GB memory on a 32-bit OS so basically we either have to upgrade to 64-bit an...
We're using Sandcastle to generate our source code documentation with our build process. This is working great for creating API level doc for classes, methods, properties, etc. Additionally, Sandcastle allows you to add summaries to your namespaces as well as "Conceptual Content". We're creating Conceptual Content files for various "H...
Hi, I'm going to be generating API docs using Sandcastle - I couldn't find any guides on how to do this on there website. Does anyone have any quickstart guides they would recommend? ...
Hi, I'm using Sandcastle Help File Builder GUI and I can't seem to get code examples in my comments to appear in the help file output. I'm generating Help 1.x and MSDN-style HTML documentation. The examples look like the following in my code: /// <summary> /// Connects to the server /// </summary> /// <example> Connec...
Does anyone know if it's possible to change the icons in the TOC treeview (the purple books) in Sandcastle compiled chm files? I've searched the SandCastle install folder but could not find these particular icons. I'm now thinking that maybe they are native to chm documents... ...
I have a C# project that uses xml comments. I make chm files from them with Sandcastle via the Sandcastle Help File Builder. One of the member functions in this project makes use of an embedded resource. I want to reference it in the help file. It seems that sandcastle does not support this, but the xml documentation files it parses does...
I can export a class diagram as an image from Visual Studio by right-clicking on the surface and choosing "Export Diagram as Image..." Is there a way to do this through command line? I'd like to be able to generate all of my class diagrams as images so I can include it in the .chm I am building w/ Sandcastle. ...
hi guys, i have generated a help file for my project using sandcastle,a .chm file. but the content can only seen when i open it in my machine. i have gave that file to several friends none of them can see the content of the file. what is the wrong?? how can i resolve it?? any problem with my configurations?? please help me guys!!! rega...
Hi, I'm decorating my C# code with comments so I can produce HTML help files. I often declare and document interfaces. But classes implementing those interfaces can throw specific exceptions depending on the implementation. Sometimes, the client is only aware of the interfaces he's using. Should I document my interfaces by adding the ...
I fired up Sandcastle Help File Builder today to generate documentation for my solution, which has around a dozen projects in it. Since I only want to generate documentation for, and run Sandcastle after, a Release build (which excludes all my test projects), I selected "Release" at the top of the window, just like in VS. Sandcastle ap...
Hi, I'm using Sandcastle Help File Builder to build the documentation for an open source project, and I'm facing two issues : The documentation content is in French. I set the language to French in the SHFB project, but most of the generated text is still in English ("Properties", "Inheritance Hierarchy", "See also"...). I saw that th...
hi guys, our dev team is currently using asp.net 2.0 and after a lot of browsing and cross site referencing i found that the new in thing is the asp.net MVC but found that there's a few things that it can't do such as support asp.net controls, view state. i'm not sure what are the other limitation besides the total change of paradigm w...
I remember an addon for VS.NET which allows you to see the styled preview of an XML code comment when you mouse over. This is quite useful when typing XML comments to ensure that style is correct. I googled but couldn't find it, can anyone remind me what was that addon? Or am I just imagining things? :) ...
For each class in the project SandCastle creates (among others) two pages: the main page, named T_class_full_name, with the description, Syntax, Inheritance Hierarchy and See Also and the members page, named AllMembers_T_class_full_name, with Constructors, Methods, Fields, etc. Is there a way to merge these two together - with the me...
I am visiting some old code, and there are quite a few events declared with delegates manually rather than using EventHandler<T>, like this: /// <summary> /// Delegate for event Added /// </summary> /// <param name="index">Index of the item</param> /// <param name="item">The item itself</param> public delegate void ItemAdded(int index, ...
I'd like to be able to exclude members that, although Public, are decorated with EditorBrowable.Never. I can't see any where to do it in the options. Is there a plug-in out there where you can specify attributes to exclude? Cheers ETA: Looks like I may have found it - the <exclude /> Tag. I'm just testing it now.... ETA2: Yes it work...
Microsoft killed NDoc when they released a CTP/Beta version of Sandcastle. And I rarely see information about new version of a usable version of sandcastle (with an integrated UI for example). The latest realease is the May 2008 release. Is Sandcastle a dead project or will it be included with Visual Studio 2010 ? ...