This is the mail archive of the
gcc@gcc.gnu.org
mailing list for the GCC project.
Re: "Documentation by paper"
- From: Joe Buck <Joe dot Buck at synopsys dot COM>
- To: Richard Kenner <kenner at vlsi1 dot ultra dot nyu dot edu>
- Cc: gcc at gcc dot gnu dot org
- Date: Tue, 27 Jan 2004 11:43:39 -0800
- Subject: Re: "Documentation by paper"
- References: <10401271850.AA29985@vlsi1.ultra.nyu.edu>
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.