Paint.Net Code Docs

[Bob]

Already answered here:

http://paintdotnet.12.forumer.com/viewtopic.php?t=225

In one word: NO.

[Rick Brewster]

Nope, no docs. The code is the docs.

[.NUB]

Hi! Is there any documentation on the source code. What is what etc.

Thanks

You're supposed to learn from the code itself. No spoonfeeding nubs!

[pseabury]

I saw that you answered before that "the code is the docs"... which is actually quite true. But if you were to comment at least the public API in the code you could then use NDoc to make some nice MSDN-style documentation that never goes out of date because you can generate it as a post-build event. At least that's what we do for some of our projects that require API docs. I'm sure you're already aware of that, but I thought I'd mention it since nobody had yet (at least that I saw). NDoc doesn't quite do all of .NET 2.0 yet though.

Paul

[Bob]

The problem with documentation of this kind is that it's immediately out of date. Adding new features or implementing new optimizations can radically change the code and design, at which point the documentation would have to be painstakingly poured over and/or rewritten.

[pseabury]

I saw that you answered before that "the code is the docs"... which is actually quite true. But if you were to comment at least the public API in the code you could then use NDoc to make some nice MSDN-style documentation that never goes out of date because you can generate it as a post-build event. At least that's what we do for some of our projects that require API docs. I'm sure you're already aware of that, but I thought I'd mention it since nobody had yet (at least that I saw). NDoc doesn't quite do all of .NET 2.0 yet though.

Paul

Every time you build it...assuming you've even made API changes, the docs auto update.