Re: code documentation was: For anyone trying to fix configuration bugs in 2.1 (and some notes on how Maven 2.1 works)

2007-09-11 Thread Vincent Siveton
Sound goods for me. Also, we could use the overview javadoc parameter to specify doc or samples. Cheers, Vincent 2007/9/9, Brian E. Fox [EMAIL PROTECTED]: I would prefer the javadocs so it's self contained. Anyone looking at this detailed level would really want javadocs and not an APT

Re: code documentation was: For anyone trying to fix configuration bugs in 2.1 (and some notes on how Maven 2.1 works)

2007-09-10 Thread Mauro Talevi
Brian E. Fox wrote: I would prefer the javadocs so it's self contained. Anyone looking at this detailed level would really want javadocs and not an APT anyway. The narrative description can go in the class javadoc to describe how/what/why etc. And maybe an APT page pointing to the javadoc - to

Re: code documentation was: For anyone trying to fix configuration bugs in 2.1 (and some notes on how Maven 2.1 works)

2007-09-09 Thread Brett Porter
Cool. This mail has some good content that I'd like to retain in the code documentation. What process should we have for documenting code in Maven core? I kind of like: - as much as possible in the class javadoc that describes just that class (I think the current javadoc for MERP does

RE: code documentation was: For anyone trying to fix configuration bugs in 2.1 (and some notes on how Maven 2.1 works)

2007-09-09 Thread Brian E. Fox
I would prefer the javadocs so it's self contained. Anyone looking at this detailed level would really want javadocs and not an APT anyway. The narrative description can go in the class javadoc to describe how/what/why etc. -Original Message- From: Brett Porter [mailto:[EMAIL PROTECTED]