https://github.com/brandonc/curtsy

A hyperlinked, readable, C#-to-annotated-html documentation generator.
https://github.com/brandonc/curtsy

Last synced: 3 months ago
JSON representation

A hyperlinked, readable, C#-to-annotated-html documentation generator.

• Host: GitHub
• URL: https://github.com/brandonc/curtsy
• Owner: brandonc
• License: mit
• Created: 2011-07-13T20:03:40.000Z (almost 14 years ago)
• Default Branch: master
• Last Pushed: 2013-06-07T03:26:22.000Z (almost 12 years ago)
• Last Synced: 2024-12-28T16:26:50.734Z (5 months ago)
• Language: C#
• Homepage: http://brandoncroft.com/curtsy
• Size: 802 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Curtsy](https://s3.amazonaws.com/brandonc-img/curtsy.png)

> A hyperlinked, readable, c#-to-annotated-html documentation generator.

[See example output][pages]

Curtsy is a fork of [nocco][] that does some lexical analysis in order to provide type hyperlinking for c#.

Running this: curtsy ClassLibrary1.csproj

will generate linked HTML documentation for the named source files, saving it into a new folder called "docs".

### Caveats ###

This is a work in progress.

### To do ###

1. Type mapping is weak because namespace scope isn't taken into account.

2. Hyperlinks within same file between sections

3. Test weirder code and code with syntax errors

[docco]: http://jashkenas.github.com/docco/

[nocco]: http://dontangg.github.com/nocco/

[pages]: http://brandoncroft.com/curtsy/