Path: csiph.com!x330-a1.tempe.blueboxinc.net!newsfeed.hal-mli.net!feeder1.hal-mli.net!border3.nntp.dca.giganews.com!Xl.tags.giganews.com!border1.nntp.dca.giganews.com!nntp.giganews.com!local2.nntp.dca.giganews.com!nntp.earthlink.com!news.earthlink.com.POSTED!not-for-mail
NNTP-Posting-Date: Tue, 04 Oct 2011 08:57:49 -0500
Date: Tue, 04 Oct 2011 06:57:50 -0700
From: Patricia Shanahan <pats@acm.org>
User-Agent: Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.2.22) Gecko/20110902 Thunderbird/3.1.14
MIME-Version: 1.0
Newsgroups: comp.lang.java.programmer
Subject: Re: @see scope
References: <97kl87pgsfv7f3klmucsso1bikkcicj3hj@4ax.com> <slrnj8lr0q.6gl.avl@gamma.logic.tuwien.ac.at>
In-Reply-To: <slrnj8lr0q.6gl.avl@gamma.logic.tuwien.ac.at>
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit
Message-ID: <AaydndkcRNlAjRbTnZ2dnUVZ_uWdnZ2d@earthlink.com>
Lines: 24
X-Usenet-Provider: http://www.giganews.com
NNTP-Posting-Host: 70.230.204.200
X-Trace: sv3-Y18PRmTa+NOtgPEX30OoOWYZCDz2P/TbMtiPxweRbUfW8seU65FA/C48gW157dl4aJbu/YUjJGHFLCt!102Nivwvr5AcylSzkkvHTE1gPLb45B0jY51L4uSe0kOC/NxDx0s5OS085Ks2xgSjU2ymz3HeZu1O!Kp08j96z6t/VBydLlRMWRi8FXN8oEyDnxfLV7Ja37PmKvZo=
X-Abuse-and-DMCA-Info: Please be sure to forward a copy of ALL headers
X-Abuse-and-DMCA-Info: Otherwise we will be unable to process your complaint properly
X-Postfilter: 1.3.40
X-Original-Bytes: 2154
Xref: x330-a1.tempe.blueboxinc.net comp.lang.java.programmer:8522

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