Return-Path: Delivered-To: apmail-lucene-java-dev-archive@www.apache.org Received: (qmail 98318 invoked from network); 30 Aug 2009 15:44:59 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.3) by minotaur.apache.org with SMTP; 30 Aug 2009 15:44:59 -0000 Received: (qmail 35346 invoked by uid 500); 30 Aug 2009 15:44:59 -0000 Delivered-To: apmail-lucene-java-dev-archive@lucene.apache.org Received: (qmail 35244 invoked by uid 500); 30 Aug 2009 15:44:58 -0000 Mailing-List: contact java-dev-help@lucene.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: java-dev@lucene.apache.org Delivered-To: mailing list java-dev@lucene.apache.org Received: (qmail 35236 invoked by uid 99); 30 Aug 2009 15:44:58 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 30 Aug 2009 15:44:58 +0000 X-ASF-Spam-Status: No, hits=1.2 required=10.0 tests=SPF_NEUTRAL X-Spam-Check-By: apache.org Received-SPF: neutral (nike.apache.org: local policy) Received: from [85.25.71.29] (HELO mail.troja.net) (85.25.71.29) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 30 Aug 2009 15:44:47 +0000 Received: from localhost (localhost.localdomain [127.0.0.1]) by mail.troja.net (Postfix) with ESMTP id 042EAD36003 for ; Sun, 30 Aug 2009 17:44:27 +0200 (CEST) X-Virus-Scanned: Debian amavisd-new at mail.troja.net Received: from mail.troja.net ([127.0.0.1]) by localhost (megaira.troja.net [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id ibhw7ALZb7Ab for ; Sun, 30 Aug 2009 17:44:16 +0200 (CEST) Received: from VEGA (port-83-236-62-3.dynamic.qsc.de [83.236.62.3]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) by mail.troja.net (Postfix) with ESMTPSA id 8F62CD36002 for ; Sun, 30 Aug 2009 17:44:16 +0200 (CEST) From: "Uwe Schindler" To: References: <1654500732.1251627452755.JavaMail.jira@brutus> <4A9A9CDC.7040003@gmail.com> Subject: RE: [jira] Updated: (LUCENE-1875) Javadoc of TokenStream.end() somehow confusing Date: Sun, 30 Aug 2009 17:44:15 +0200 Message-ID: <4114BAC5552F4E4A991138557D2CCB34@VEGA> MIME-Version: 1.0 Content-Type: text/plain; charset="US-ASCII" Content-Transfer-Encoding: 7bit X-Mailer: Microsoft Office Outlook 11 In-Reply-To: <4A9A9CDC.7040003@gmail.com> Thread-Index: Acoph/rj9MjmX+ZAR6ybiVDu7krMngAAEs/A X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.5579 X-Virus-Checked: Checked by ClamAV on apache.org No problem, see my other mail! I can revert the @link changes. By the way, I noticed shortly, that @code is Java 5 only. So I could replace it by . For me the whole class Javadocs were a little bit over-linkified with links pointing to the same class itself. I only wanted to remove links (as the guide from sun notes), that are somehow pointing to the exact same class the description is about (in the class description). I am a real fan of linking everything, so links between methods is very important! ----- Uwe Schindler H.-H.-Meier-Allee 63, D-28213 Bremen http://www.thetaphi.de eMail: uwe@thetaphi.de > -----Original Message----- > From: Mark Miller [mailto:markrmiller@gmail.com] > Sent: Sunday, August 30, 2009 5:38 PM > To: java-dev@lucene.apache.org > Subject: Re: [jira] Updated: (LUCENE-1875) Javadoc of TokenStream.end() > somehow confusing > > To add to my argument (and I'm not trying to get you to change this > patch by the way - its just javadoc, and I'm more interested in the > argument than the results this morning ;) ) > > You could make a similar argument that links from one method referencing > another in the same class are unneeded - you are already at the page. > But they nicely scroll you to what you want to see. Same with the class > link itself - if you are at the bottom of a long class and click the > class link, it takes you to the top and definition of the class - the > same way that when I am in next(), I can click a link to get to the > increment() definition. > > - Mark > > Mark Miller wrote: > > That depends - the links may end up in summaries on different pages > > (first sentence as an exaple) - it also provides a consistent > > formatting for class names so that they pop silmialry everywhere. I > > don't agree with "it makes no sense." I'd make every classname > > everywhere a link if I could. > > > > - Mark > > > > http://www.lucidimagination.com (mobile) > > > > On Aug 30, 2009, at 6:17 AM, "Uwe Schindler (JIRA)" > > wrote: > > > >> > >> [ > >> https://issues.apache.org/jira/browse/LUCENE- > 1875?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] > >> > >> > >> Uwe Schindler updated LUCENE-1875: > >> ---------------------------------- > >> > >> Attachment: LUCENE-1875.patch > >> > >> Patxh with changed end() javadocs. This patch also removes the {@link > >> TokenStream}s inside TokenStream.java (it does not make sense to link > >> to the same doc page itsself). > >> > >>> Javadoc of TokenStream.end() somehow confusing > >>> ---------------------------------------------- > >>> > >>> Key: LUCENE-1875 > >>> URL: https://issues.apache.org/jira/browse/LUCENE-1875 > >>> Project: Lucene - Java > >>> Issue Type: Bug > >>> Components: Analysis > >>> Affects Versions: 2.9 > >>> Reporter: Uwe Schindler > >>> Assignee: Uwe Schindler > >>> Fix For: 2.9 > >>> > >>> Attachments: LUCENE-1875.patch > >>> > >>> > >>> The Javadocs of TokenStream.end() are somehow confusing, because > >>> they also refer to the old TokenStream API ("after next() returned > >>> null"). But one who implements his TokenStream with the old API > >>> cannot make use of the end() feature, as he would not use attributes > >>> and so cannot update the end offsets (he could, but then he should > >>> rewrite the whole TokenStream). To be conform to the old API, there > >>> must be an end(Token) method, which we will not add. > >>> I would drop the old API from this docs. > >> > >> -- > >> This message is automatically generated by JIRA. > >> - > >> You can reply to this email to add a comment to the issue online. > >> > >> > >> --------------------------------------------------------------------- > >> To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org > >> For additional commands, e-mail: java-dev-help@lucene.apache.org > >> > > > -- > - Mark > > http://www.lucidimagination.com > > > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org > For additional commands, e-mail: java-dev-help@lucene.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: java-dev-unsubscribe@lucene.apache.org For additional commands, e-mail: java-dev-help@lucene.apache.org