Path: csiph.com!x330-a1.tempe.blueboxinc.net!usenet.pasdenom.info!weretis.net!feeder4.news.weretis.net!newsfeed.utanet.at!newscore.univie.ac.at!aconews-feed.univie.ac.at!aconews.univie.ac.at!not-for-mail Newsgroups: comp.lang.java.programmer From: Andreas Leitgeb Subject: Re: @see scope References: <97kl87pgsfv7f3klmucsso1bikkcicj3hj@4ax.com> Reply-To: avl@logic.at User-Agent: slrn/pre0.9.9-111 (Linux) Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit Message-ID: Date: 04 Oct 2011 16:36:06 GMT Lines: 25 NNTP-Posting-Host: gamma.logic.tuwien.ac.at X-Trace: 1317746166 tunews.univie.ac.at 11354 128.130.175.3 X-Complaints-To: abuse@tuwien.ac.at Xref: x330-a1.tempe.blueboxinc.net comp.lang.java.programmer:8533 Patricia Shanahan wrote: > On 10/4/2011 4:20 AM, Andreas Leitgeb wrote: >> Roedy Green 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. You mean an algortihm that was separately implemented in several places, rather than in some reuseable method on its own? ;-) > I don't think it would be a good idea to @see from public to private, That was my original interpretation of the question. > because someone reading the public docs may well lack access to the > private ones.