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 anyway. > The narrative description can go in the class javadoc to describe > how/what/why etc. > > > -----Original Message----- > From: Brett Porter [mailto:[EMAIL PROTECTED] > Sent: Sunday, September 09, 2007 10:50 PM > To: Maven Developers List > Subject: Re: code documentation was: For anyone trying to fix > configuration bugs in 2.1 (and some notes on how Maven 2.1 works) > > 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 this, and the rest > of the mail could go into the MavenExecutionRequest javadoc) > - package javadoc for things a whole package does > - a couple of APTs for things the whole module does, tying the > javadocs together with a more wholistic overview. > > WDYT? > > Cheers > Brett > > On 10/09/2007, at 9:34 AM, Jason van Zyl wrote: > > > Hi, > > > > I have made a great attempt to push all configuration of anything > > possible to configure in Maven to this class: > > > > http://svn.apache.org/repos/asf/maven/components/trunk/maven- > > embedder/src/main/java/org/apache/maven/embedder/execution/ > > DefaultMavenExecutionRequestPopulator.java > > > > For anyone not familiar with the core in 2.1, we populate a > > MavenExecutionRequest and that is used in the MavenEmbedder.execute > > ( request ) method to carry out what you know Maven to do. The > > Maven CLI for 2.1.x uses the MavenEmbedder along with the IDE > > integration. The class above takes care of populating any defaults > > in the request before it is passed to the embedder. So if anyone is > > interested in trying to track down bugs with: > > > > - settings > > - profiles > > - update policies > > - checksum policies > > - wagon configurations: servers, proxies > > > > Then you can look in the request class and you will also want to > > look in the CLI class to see how the request is populated from > > command line options: > > > > http://svn.apache.org/repos/asf/maven/components/trunk/maven- > > embedder/src/main/java/org/apache/maven/cli/MavenCli.java > > > > Between these two (at least for command line use) you should be > > able track down some of the easier configuration problems or bugs. > > There's still all sorts operations going on in the core like the > > merging of profiles, plugin configurations and what not, but the > > initial configuration is now all located in one place if anyone > > wants to take a shot of fixing anything here: > > > > http://jira.codehaus.org/secure/IssueNavigator.jspa? > > mode=hide&requestId=12412 > > > > Thanks, > > > > Jason > > > > ---------------------------------------------------------- > > Jason van Zyl > > Founder and PMC Chair, Apache Maven > > jason at sonatype dot com > > ---------------------------------------------------------- > > > > > > > > > > --------------------------------------------------------------------- > > To unsubscribe, e-mail: [EMAIL PROTECTED] > > For additional commands, e-mail: [EMAIL PROTECTED] > > -- > Brett Porter - [EMAIL PROTECTED] > Blog: http://www.devzuz.org/blogs/bporter/ > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] > > --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
