From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 6091 invoked by alias); 27 Jan 2004 19:43:43 -0000 Mailing-List: contact gcc-help@gcc.gnu.org; run by ezmlm Precedence: bulk List-Archive: List-Post: List-Help: Sender: gcc-owner@gcc.gnu.org Received: (qmail 6047 invoked from network); 27 Jan 2004 19:43:41 -0000 Received: from unknown (HELO kiruna.synopsys.com) (198.182.44.80) by sources.redhat.com with SMTP; 27 Jan 2004 19:43:41 -0000 Received: from mother.synopsys.com (mother.synopsys.com [146.225.100.171]) by kiruna.synopsys.com (Postfix) with ESMTP id C87D6F429; Tue, 27 Jan 2004 11:43:37 -0800 (PST) Received: from piper.synopsys.com (localhost [127.0.0.1]) by mother.synopsys.com (8.9.1/8.9.1) with ESMTP id LAA02468; Tue, 27 Jan 2004 11:43:39 -0800 (PST) Received: (from jbuck@localhost) by piper.synopsys.com (8.11.6/8.11.6) id i0RJhdD30957; Tue, 27 Jan 2004 11:43:39 -0800 X-Authentication-Warning: piper.synopsys.com: jbuck set sender to Joe.Buck@synopsys.com using -f Date: Tue, 27 Jan 2004 19:44:00 -0000 From: Joe Buck To: Richard Kenner Cc: gcc@gcc.gnu.org Subject: Re: "Documentation by paper" Message-ID: <20040127114339.A30879@synopsys.com> References: <10401271850.AA29985@vlsi1.ultra.nyu.edu> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.2.5.1i In-Reply-To: <10401271850.AA29985@vlsi1.ultra.nyu.edu>; from kenner@vlsi1.ultra.nyu.edu on Tue, Jan 27, 2004 at 01:50:36PM -0500 X-SW-Source: 2004-01/txt/msg02037.txt.bz2 On Tue, Jan 27, 2004 at 01:50:36PM -0500, Richard Kenner wrote: > This should simply be: > > /* This function searches a sequence for a matching sub-sequence. > FIRST1, LAST1, FIRST2 and LAST2 are all forward iterators. > The first iterator J in the range [FIRST1,LAST1-(LAST2-FIRST2)) such that > *(J+N) == *(FIRST2+N) for each @c N in the range [0,LAST2-FIRST2) is > returned, or LAST1 if no such iterator exists. */ > > That's a *lot* cleaner and easier to read. Fine, doxygen is cool with that. If you write it as /** This function searches a sequence for a matching sub-sequence. FIRST1, LAST1, FIRST2 and LAST2 are all forward iterators. The first iterator J in the range [FIRST1,LAST1-(LAST2-FIRST2)) such that *(J+N) == *(FIRST2+N) for each @c N in the range [0,LAST2-FIRST2) is returned, or LAST1 if no such iterator exists. */ it will be treated as a doxygen comment, with the first sentence as the brief description and the whole paragraph as the long description. All I changed was the extra * character.