Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.java.programmer > #8522

Re: @see scope

Show all headers | View raw

On 10/4/2011 4:20 AM, Andreas Leitgeb wrote:
> Roedy Green<see_website@mindprod.com.invalid>  wrote:
>> Are you supposed to be able to put a @see SomeClass#someMethod
>> to another class's private method?
>
> Did you tell javadoc to generate docs for private entities
> (including the referred-to item) in the first place?
>
> But even if you do, I fail to see the sense of referring to
> something, that the one who reads the javadocs likely isn't
> able to make use of, anyway.
>

I often put javadoc comments on everything, and generate private docs
for my own use during development. In that situation, it might make
sense to document in detail an algorithm that is used only in private
methods in one of them, and @see from the rest.

I don't think it would be a good idea to @see from public to private,
because someone reading the public docs may well lack access to the
private ones.

Patricia

Back to comp.lang.java.programmer | Previous | Next — Previous in thread | Next in thread | Find similar

Thread

@see scope Roedy Green <see_website@mindprod.com.invalid> - 2011-10-04 02:26 -0700
  Re: @see scope Andreas Leitgeb <avl@gamma.logic.tuwien.ac.at> - 2011-10-04 11:20 +0000
    Re: @see scope Patricia Shanahan <pats@acm.org> - 2011-10-04 06:57 -0700
      Re: @see scope Andreas Leitgeb <avl@gamma.logic.tuwien.ac.at> - 2011-10-04 16:36 +0000
  Re: @see scope Roedy Green <see_website@mindprod.com.invalid> - 2011-10-04 10:28 -0700
    Re: @see scope Lew <lewbloch@gmail.com> - 2011-10-04 12:15 -0700
      Re: @see scope Paul Cager <paul.cager@googlemail.com> - 2011-10-05 03:20 -0700
        Re: @see scope Patricia Shanahan <pats@acm.org> - 2011-10-05 05:45 -0700
  Re: @see scope Jan Burse <janburse@fastmail.fm> - 2011-10-05 15:05 +0200

csiph-web