Giter Club home page Giter Club logo

xdg's Introduction

Table of Contents

XDG: Xml Documentation Generator

https://github.com/seaeagle1/XDG

What is it?

XDG is a tool for converting Xml documentation comments from .NET languages like C# and VB.NET into readable web-based API documentation. It is essentially a very simple replacement for more complex and advanced tools like Sandcastle and Monodoc.

How does it work?

XDG uses Mono.Cecil to reflect a .NET assembly and gather all classes, methods, properties etc. Optionally you can also add the Xml documentation file containing all the documentation comments, XDG will then search that file and add your comments to the type information.

When all this information is gathered, XDG writes out JSON files containing all the information needed to build a documentation page. This JSON object can then be imported in a Javascript, PHP or other scripted template to be displayed in any way you like. Currently we have a pure Javascript/HTML example template using the PURE template system.

How do I use it?

Currently XDG is still very much in its infancy… if you can’t figure it out from the code, you probably shouldn’t use it just yet.

What license does it have?

XDG itself is available under the Mozilla Public License v2.

It also makes use of XmlDocIdLib (CodeProject Open License) and Mono.Cecil (MIT license).

xdg's People

Contributors

seaeagle1 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.