springframework-developer

[Springframework-developer] docs

[Colin S. <col...@ex...>]

All.

I've spent some significant time in completely going over the beans 
(main container) chapter to rewrite for clarity and grammar, re-org, and 
add missing functionality, as needed. I hope the net result is that this 
chapter is pretty well completely up to date now (including new stuff 
like method injection, factory methods, child bean defs, etc), and that 
reading this chapter, which covers the heart of Spring's functionality, 
is a pleasureable experience for new users, although of course it's 
still a reference, not a tutorial. The main thing I'd still like to do 
some time is go through it and link all the class/interface names to the 
actual JavaDoc. The website has been updated.

Doing this made me realize that while we can't always document 
everything right away (i.e. time is an issue for everyone of course) we 
need to stay on top of what needs to be documented or clarified so doc 
tasks don't get lost in the shuffle. Can everyone try to take a look at 
the following Jira issue and modify it to reflect documentation bits 
that you think need to be added or areas that need to be clarified, 
enhanced, etc. I'm sure there's lots of stuff that I didn't think of. It 
may make sense to have separate issues for each task, instead of using 
one task like this, but having the info anywhere is better than nothing.
  http://opensource.atlassian.com/projects/spring/browse/SPR-77

Colin

Re: [Springframework-developer] docs

[Rod J. <rod...@in...>]

Cool stuff. Thanks Colin.

Good point re keeping on top of stuff. I think one issue is enough.

R

----- Original Message ----- 
From: "Colin Sampaleanu" <col...@ex...>
To: <spr...@li...>
Sent: Sunday, July 04, 2004 8:35 PM
Subject: [Springframework-developer] docs


> All.
> 
> I've spent some significant time in completely going over the beans 
> (main container) chapter to rewrite for clarity and grammar, re-org, and 
> add missing functionality, as needed. I hope the net result is that this 
> chapter is pretty well completely up to date now (including new stuff 
> like method injection, factory methods, child bean defs, etc), and that 
> reading this chapter, which covers the heart of Spring's functionality, 
> is a pleasureable experience for new users, although of course it's 
> still a reference, not a tutorial. The main thing I'd still like to do 
> some time is go through it and link all the class/interface names to the 
> actual JavaDoc. The website has been updated.
> 
> Doing this made me realize that while we can't always document 
> everything right away (i.e. time is an issue for everyone of course) we 
> need to stay on top of what needs to be documented or clarified so doc 
> tasks don't get lost in the shuffle. Can everyone try to take a look at 
> the following Jira issue and modify it to reflect documentation bits 
> that you think need to be added or areas that need to be clarified, 
> enhanced, etc. I'm sure there's lots of stuff that I didn't think of. It 
> may make sense to have separate issues for each task, instead of using 
> one task like this, but having the info anywhere is better than nothing.
>   http://opensource.atlassian.com/projects/spring/browse/SPR-77
> 
> Colin
> 
> 
> 
> 
> -------------------------------------------------------
> This SF.Net email sponsored by Black Hat Briefings & Training.
> Attend Black Hat Briefings & Training, Las Vegas July 24-29 - 
> digital self defense, top technical experts, no vendor pitches, 
> unmatched networking opportunities. Visit www.blackhat.com
> _______________________________________________
> Springframework-developer mailing list
> Spr...@li...
> https://lists.sourceforge.net/lists/listinfo/springframework-developer