On Fri, 23 May 2008 15:44:32 +0900 이희승 (Trustin Lee) <[EMAIL PROTECTED]> wrote:
> On Fri, 23 May 2008 15:38:01 +0900, Julien Vermillard > <[EMAIL PROTECTED]> wrote: > > > On Fri, 23 May 2008 12:31:14 +0900 > > 이희승 (Trustin Lee) <[EMAIL PROTECTED]> wrote: > > > >> On Fri, 23 May 2008 12:21:43 +0900, Emmanuel Lecharny > >> <[EMAIL PROTECTED]> wrote: > >> > >> > 이희승 (Trustin Lee) wrote: > >> >> On Fri, 23 May 2008 12:02:45 +0900, Emmanuel Lecharny > >> >> <[EMAIL PROTECTED]> wrote: > >> >> > >> >>> 이희승 (Trustin Lee) wrote: > >> >>>> Every public methods except for the constructors are > >> >>>> overridden from its supertypes and interfaces. They all got > >> >>>> proper JavaDoc comments. Let me know if I am missing > >> >>>> something. > >> >>> > >> >>> Adding a @see Class#method() in the implementation then should > >> >>> help. When you look at a method javadoc it's better to know > >> >>> where too look at : the intheritance scheme can be feilry > >> >>> complex, and it can be a burden to retreive the associated > >> >>> Javadoc. > >> >>> > >> >>> Something like : > >> >>> /** > >> >>> * @see javax.naming.Context#close() > >> >>> */ > >> >>> public void close() throws NamingException > >> >>> ... > >> >> > >> >> I'd just move the cursor on the method? That shows pretty > >> >> nicely rendered JavaDoc in modern IDEs. > >> > Sometime, you just have to use vi or emacs. Make it simple for > >> > users : add a @see tag. Cost almost nothing, and it helps. > >> > >> I wouldn't bother with vi or emacs. They pay for what they use. > >> Moreover, it's not 'almost nothing'. > >> > > Hi, > > > > Well I use vi sometimes and a @see or @inheritedDoc would help. I > > agree with Emmanuel, I don't feel I need to pay something for using > > vi ;) > > @inheritDoc already has been added as suggested by Mike and Rich. > Now could you let me know how @see helps your vi experience and how > often you use vi to browse the source code seriously? I *sometimes* > even use viewvc to browse the source code and didn't get any help > from @see. > > > And that would make html generated javadoc much readable. > > You mean @see or @inheritDoc? You already get the copy of > supertype's documentation and the links to the supertypes without > @see and @inheritDoc. > I use vi for some old java project using oldish javadoc generation who look like is not copying the inherited javadoc. The generated javadoc from 1.5 for MINA looks correct, my bad. Julien
signature.asc
Description: PGP signature
