Docu

[Will Shaver]

http://blog.jagregory.com/2009/03/19/introducing-docu-simple-doc-gen-for-net/

Should we do something like this for nhforge? Seems easy enough...

[Fabio Maulo]

2009/3/19 Will Shaver <will....@gmail.com>

http://blog.jagregory.com/2009/03/19/introducing-docu-simple-doc-gen-for-net/

Should we do something like this for nhforge? Seems easy enough...

Yes we can.

[Stephen Bohlen]

That's an interesting project; FYI my company has successfully used with repeated results the DocProject VS toolset available right here...

http://www.codeplex.com/DocProject

The advantage of this approach is that its output format isn't limited to just one output type (web-based HTML help) but can also produce CHM content, VS-integrated help content (for folding into F1-help in VS), and others.

Just an alt suggestion to consider...

-Steve B.

--
Steve Bohlen
sbo...@gmail.com
http://blog.unhandled-exceptions.com
http://twitter.com/sbohlen

[Fabio Maulo]

Ok.

Who have time to study each possible solution, present pro-cons here in dev-list, and then implement all needs before NH2.1.0GA ?

Few months ago I was asking for the remotion of "Documentation" folder; I don't remember who, but somebody said "no please" but after that there was no commits related to that folder.

What I mean is : from a user we can accept a proposal and a JIRA but from a team member we should expect proposal and time to spent on it.

Somebody available to accept this task ?

2009/3/19 Stephen Bohlen <sbo...@gmail.com>

--
Fabio Maulo

[Stephen Bohlen]

I will step up to this task; I agree 100% with your point.

As I am intrigued by comparing the viability of this other (non-DocProject) approach and am already familiar with the DocProject system, I will do this and report results of my comparison.

-Steve B.

---

From: Fabio Maulo
Date: Thu, 19 Mar 2009 13:46:08 -0300
To: <nhibernate-...@googlegroups.com>
Subject: [nhibernate-development] Re: Docu

[Will Shaver]

Generating documentation out of the source has the advantage of:
1) being easy to keep accurate
2) encouraging people to comment their work in the source

-Will

[Stephen Bohlen]

Agreed; auto-generation of api reference from code comments is part of what we do on most all of our work (typically) for exactly all of those reasons.

-Steve B.
-----Original Message-----
From: Will Shaver <will....@gmail.com>

Date: Thu, 19 Mar 2009 09:58:29