> No.  That is probably reasonable.  My issue was being unable to access
the
> public methods.

Do you mean that completion didn't show some publicly accessible
methods? Can you provide me with an example?

Best regards,
Mike Aizatsky.
------------------------------
IntelliJ Software, "Develop with pleasure!" http://www.intellij.com


> -----Original Message-----
> From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED]]
On
> Behalf Of Michael Kirby
> Sent: Monday, February 18, 2002 7:47 PM
> To: [EMAIL PROTECTED]
> Subject: RE: [Eap-list] @link question
> 
> No.  That is probably reasonable.  My issue was being unable to access
the
> public methods.
> The only case I can think of that it would be reasonable, is if the
> purpose of the javadoc is
> for internal maintenance, not external consumption.  In which case the
> javadoc may contain
> references to internal implementation for the purposes of guiding a
> maintenance
> programmer.
> 
> But I could make the argument that if they need this internal
information
> at this point in the
> javadoc to understand the code, then there is a severe breakage of
> enapsulation.  Perhaps I
> should look at re-designing rather than fixing documentation.
> 
> Mike
> 
> 
> On 18 Feb 2002 at 17:04, Mike Aizatsky wrote:
> 
> > Mike,
> >
> > We think here that referencing methods/fields which can't be visible
> > from the point you are writing JavaDoc is not a good practice. Do
you
> > really think you should reference private visible fields? Can you
give
> > an example?
> >
> > Best regards,
> > Mike Aizatsky.
> > ------------------------------
> > IntelliJ Software, "Develop with pleasure!" http://www.intellij.com
> >
> >
> > > -----Original Message-----
> > > From: [EMAIL PROTECTED]
> > > [mailto:[EMAIL PROTECTED]]
> > On
> > > Behalf Of Michael Kirby
> > > Sent: Saturday, February 16, 2002 6:40 PM
> > > To: [EMAIL PROTECTED]
> > > Subject: RE: [Eap-list] @link question
> > >
> > > One more note.  Auto-completion in comments should always display
> > > all fields and methods in a class, regardless of whether or not
the
> > > are accessible.  In other words, all static , Non static, public,
> > > private, protected methods & fields.
> > >
> > > Mike
> > >
> > >
> > > On 16 Feb 2002 at 17:33, Mike Aizatsky wrote:
> > >
> > > > Mike,
> > > >
> > > > We'll think about such approach.
> > > >
> > > > Best regards,
> > > > Mike Aizatsky.
> > > > ------------------------------
> > > > IntelliJ Software, "Develop with pleasure!"
> > > > http://www.intellij.com
> > > >
> > > >
> > > > > -----Original Message-----
> > > > > From: [EMAIL PROTECTED]
> > [mailto:[EMAIL PROTECTED]]
> > > > On
> > > > > Behalf Of Michael Kirby
> > > > > Sent: Saturday, February 16, 2002 5:21 PM
> > > > > To: [EMAIL PROTECTED]
> > > > > Subject: RE: [Eap-list] @link question
> > > > >
> > > > > I figured it out.  It shouldn't be bar.foo, it should be
> > > > > bar#foo.
> > You
> > > > > know...The autocompletion
> > > > > feature in the javadoc, is a little misleading in that it
> > > > auto-completes
> > > > > illegal javadoc.  Perhaps
> > > > > after auto-completing it could substitute in a default
> > > > > formatting
> > that
> > > > > conforms with:
> > > > >
> > > > >
> > > >
> >
http://java.sun.com/products/jdk/1.2/docs/tooldocs/win32/javadoc.html#
> > sp > > ec > > > ifyingname > > > > > > For example, if I type: > > >
>
> > > > bar.f<autocomplete>, and it would normally create bar.foo (the
one
> > > > with > > > the boolean, > > > because that is what I selected
from
> > the list), if it is an @see or > > @link > > > tag it would
substitute
> > > > > in: > > > > > > @link bar#foo(boolean b) <cursor now here> > >
>
> > > > > > > > > > > Mike > > > > > > > > > On 16 Feb 2002 at 16:00,
Mike
> > Aizatsky wrote: > > > > > > > Michael, > > > > > > > > @link is an
> > inline doc tag. You shold write it in braces: {@ling > > > >
bar.foo}.
> > > > > > > > > > Best regards, > > > > Mike Aizatsky. > > > >
> > ------------------------------ > > > > IntelliJ Software, "Develop
> > with pleasure!" http://www.intellij.com > > > > > > > > > > > > >
> > -----Original Message----- > > > > > From:
[EMAIL PROTECTED]
> > > > [mailto:[EMAIL PROTECTED]] > > > > On > > > > > Behalf
> > Of Michael Kirby > > > > > Sent: Saturday, February 16, 2002 3:37 PM
>
> > > > > > To: [EMAIL PROTECTED] > > > > > Subject: [Eap-list]
@link
> > question > > > > > > > > > > How do I make an @link to a method in a
> > local class? > > > > > > > > > > For example: > > > > > > > > > > >
>
> > > > > File.java: > > > > > > > > > > /** > > > > > @link bar.foo() >
>
> > > > > class foo > > > > > { > > > > > } > > > > > > > > > > class
bar
> > > > > > > { > > > > >    public void foo() > > > > >    { > > > > >
> > } > > > > > } > > > > > > > > > > I can't seem to get the red error
> > highlighting to go away. when I > > use > > > > the > > > > >
javadoc
> > completion, > > > > > it only gives me the static methods. (of
course,
> > in code this > > makes > > > > sense, > > > > > but in javadoc, it >
>
> > > > > gets in the way :-) ) > > > > > > > > > > Mike > > > > > > > >
>
> > > --- > > > > > [EMAIL PROTECTED] > > > > > To obtain my PGP
> > public key, mail "SEND PUB KEY" in the > > > > > subject to
> > "[EMAIL PROTECTED]" > > > > > > > > > > > > > > >
> > _______________________________________________ > > > > > Eap-list
> > mailing list > > > > > [EMAIL PROTECTED] > > > > >
> > http://www.intellij.com/mailman/listinfo/eap-list > > > > > > > > >
>
> > > > _______________________________________________ > > > > Eap-list
> > mailing list > > > > [EMAIL PROTECTED] > > > >
> > http://www.intellij.com/mailman/listinfo/eap-list > > > > > > > > >
>
> > --- > > > [EMAIL PROTECTED] > > > To obtain my PGP public key,
> > mail "SEND PUB KEY" in the > > > subject to "[EMAIL PROTECTED]"
>
> > > > > > > > > > _______________________________________________ > >
>
> > Eap-list mailing list > > > [EMAIL PROTECTED] > > >
> > http://www.intellij.com/mailman/listinfo/eap-list > > > > > >
> > _______________________________________________ > > Eap-list mailing
> > list > > [EMAIL PROTECTED] > >
> > http://www.intellij.com/mailman/listinfo/eap-list > > > > --- >
> > [EMAIL PROTECTED] > To obtain my PGP public key, mail "SEND PUB
> > KEY" in the > subject to "[EMAIL PROTECTED]" > > >
> > _______________________________________________ > Eap-list mailing
> > list > [EMAIL PROTECTED] >
> > http://www.intellij.com/mailman/listinfo/eap-list
> >
> >
> > _______________________________________________
> > Eap-list mailing list
> > [EMAIL PROTECTED]
> > http://www.intellij.com/mailman/listinfo/eap-list
> >
> 
> ---
> [EMAIL PROTECTED]
> To obtain my PGP public key, mail "SEND PUB KEY" in the
> subject to "[EMAIL PROTECTED]"
> 
> 
> _______________________________________________
> Eap-list mailing list
> [EMAIL PROTECTED]
> http://www.intellij.com/mailman/listinfo/eap-list


_______________________________________________
Eap-list mailing list
[EMAIL PROTECTED]
http://www.intellij.com/mailman/listinfo/eap-list

Reply via email to