From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 10893 invoked by alias); 27 Jan 2004 20:11:24 -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 10873 invoked from network); 27 Jan 2004 20:11:24 -0000 Received: from unknown (HELO vlsi1.ultra.nyu.edu) (128.122.140.213) by sources.redhat.com with SMTP; 27 Jan 2004 20:11:24 -0000 Received: by vlsi1.ultra.nyu.edu (4.1/1.34) id AA01115; Tue, 27 Jan 04 15:13:46 EST Date: Tue, 27 Jan 2004 20:13:00 -0000 From: kenner@vlsi1.ultra.nyu.edu (Richard Kenner) Message-Id: <10401272013.AA01115@vlsi1.ultra.nyu.edu> To: Joe.Buck@synopsys.com Subject: Re: "Documentation by paper" Cc: gcc@gcc.gnu.org X-SW-Source: 2004-01/txt/msg02045.txt.bz2 Fine, doxygen is cool with that. If you write it as ... 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. The issue I had was the annotations used to describe the parameters and return value. I certainly have no problem with the above, except if it's viewed as replacing proper high-level documentation.