Sandcastle - Documentation Compiler for Managed Class Libraries

  •        123

Sandcastle produces accurate, MSDN style, comprehensive documentation by reflecting over the source assemblies and optionally integrating XML Documentation Comments. Sandcastle has the following key features: * Works with or without authored comments * Supports Generics and .NET

http://sandcastle.codeplex.com/

Tags
Implementation
License
Platform

   




Related Projects

Sandcastle Assist

  •    

Sandcastle Assist project aims to provide a .NET library that will make it easier to use the Sandcastle tool, a documentation compiler for managed libraries from Microsoft.

Sandcastle Help File Builder

  •    

A standalone GUI and Visual Studio integration package providing full configuration and extensibility for building help files with the Sandcastle tools.

DocProject for Sandcastle

  •    DotNet

DocProject drives the Sandcastle help generation tools using the power of Visual Studio 2005/2008 and MSBuild. Choose from various Visual Studio project templates that build compiled help 1.x, 2.x, or an ASP.NET help web site for all project references and external sources.

Sandcastle Extensions

  •    

A set of components that provide some missing features in original Sandcastle distribution.

DocMounter, visual tool to document .NET libraries using Sandcastle

  •    DotNet

DocMounter is a handy visual tool to document your .NET assemblies and produce HxS (MSHelp2) help solutions, HTML manuals and standard XML documentation files using the Sandcastle compiler. Very simple but effective, no need to learn special documentation languages such as MAML.


SHFB - Sandcastle Help File Builder (SHFB)

  •    CSharp

Welcome to the Sandcastle Help File Builder project.This project is composed of two separate parts that work together: the Sandcastle tools and the Sandcastle Help File Builder. The Sandcastle tools are used to create help files for managed class libraries containing both conceptual and API reference topics. API reference topics are created by combining the XML comments that are embedded in your source code with the syntax and structure of the types which is acquired by reflecting against the associated .NET Framework assemblies. Conceptual topics are created by converting XML documents that you author containing Microsoft Assistance Markup Language (MAML). The Sandcastle tools are command-line based and have no GUI front-end, project management features, or an automated build process.

ShoBiz - BizTalk Documentation Tool for Sandcastle

  •    

BizTalk tool that generates Sandcastle documentation from BizTalk artifacts deployed into the databases. Promotes documentation as part of the solution lifecycle. Documentation structure mimics the Admin Console and extracts documentation comments from all sources.

DotNetNuke Developers Help File

  •    DotNet

MSDN Style help based upon inline code comments in de DotNetNuke Source Modules. The help files are generated using SandCastle and the SandCastle Help File Builder using the unmodified sources from DotNetNuke, which can be downloaded from www.DotNetNuke.com

XML Schema Documenter

  •    CSharp

XML Schema Documenter is a Sandcastle Help File Builder plug-in that allows you to integrate reference documentation for XML schemas in your help files.

Visual Studio 2005 Add-In Suite

  •    

The current Sandcastle release isn't very user friendly. Capturing all the functionality in a Visual Studio 2005 Add-In makes more sense.

Docy

  •    

Docy is a tool for producing the MSDN script-free look for .NET documentation, using XML comments. It produces static html, wiki markup and also has an MVC site. It uses the Razor view engine and Jolt.

Wiki to Maml

  •    

This project enables you to write wiki syntax and have it converted into MAML syntax for Sandcastle documentation projects.

yard - YARD is a Ruby Documentation tool. The Y stands for "Yay!"

  •    Ruby

YARD is a documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions. Below is a summary of some of YARD's notable features. 1. RDoc/SimpleMarkup Formatting Compatibility: YARD is made to be compatible with RDoc formatting. In fact, YARD does no processing on RDoc documentation strings, and leaves this up to the output generation tool to decide how to render the documentation.

grunt-jsdoc - A grunt plugin to generate javascript doc by running jsdoc3 on your grunt projects.

  •    Javascript

This plugin enables you to integrate the generation of comments based documentation into your Grunt build. This plugin is a wrapper around jsdoc3. Please refer to the documentation for the documentation details.

Emotiv Engine Client

  •    DotNet

Provides an event-driven .NET framework wrapper around the managed Emotiv EPOC neuroheadset API.

codox - Clojure documentation tool

  •    Clojure

A tool for generating API documentation from Clojure or ClojureScript source code. This will generate API documentation in the "target/doc" subdirectory (or wherever your project :target-path is set to).

react-docgen - A CLI and toolbox to extract information from React component files for documentation generation purposes

  •    Javascript

react-docgen is a CLI and toolbox to help extracting information from React components, and generate documentation from it.It uses recast and babylon to parse the source into an AST and provides methods to process this AST to extract the desired information. The output / return value is a JSON blob / JavaScript object.

prmd - JSON Schema tools and doc generation for HTTP APIs

  •    Ruby

JSON Schema tooling: scaffold, verify, and generate documentation from JSON Schema documents. JSON Schema provides a great way to describe an API. prmd provides tools for bootstrapping a description like this, verifying its completeness, and generating documentation from the specification.

SQLDoc

  •    CSharp

SQLDoc Sharp, an interactive tool designed to generate the SQL Server 2005/2008 documentation. It supports, export of documentation to CHM format. If you want to export the generated documentation to Excel, Pdf or XML then look at turtle.codeplex.com

cli - The official command line tooling for Aurelia

  •    Javascript

This library is part of the Aurelia platform and contains its CLI implementation. To keep up to date on Aurelia, please visit and subscribe to the official blog and our email list. We also invite you to follow us on twitter. If you have questions look around our Discourse forums, chat in our community on Gitter or use stack overflow. Documentation can be found in our developer hub. If you would like to have deeper insight into our development process, please install the ZenHub Chrome or Firefox Extension and visit any of our repository's boards. You can read documentation on the cli here. If you would like to help improve this documentation, the source for the above can be found in the doc folder within the framework repository.