From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 10975 invoked by alias); 17 Mar 2014 00:38:18 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Received: (qmail 10961 invoked by uid 89); 17 Mar 2014 00:38:17 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-1.6 required=5.0 tests=AWL,BAYES_00 autolearn=ham version=3.3.2 X-HELO: relay1.mentorg.com Received: from relay1.mentorg.com (HELO relay1.mentorg.com) (192.94.38.131) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Mon, 17 Mar 2014 00:38:16 +0000 Received: from svr-orw-exc-10.mgc.mentorg.com ([147.34.98.58]) by relay1.mentorg.com with esmtp id 1WPLZE-0003JR-MV from Yao_Qi@mentor.com ; Sun, 16 Mar 2014 17:38:12 -0700 Received: from SVR-ORW-FEM-03.mgc.mentorg.com ([147.34.97.39]) by SVR-ORW-EXC-10.mgc.mentorg.com with Microsoft SMTPSVC(6.0.3790.4675); Sun, 16 Mar 2014 17:38:12 -0700 Received: from qiyao.dyndns.org (147.34.91.1) by svr-orw-fem-03.mgc.mentorg.com (147.34.97.39) with Microsoft SMTP Server id 14.2.247.3; Sun, 16 Mar 2014 17:38:11 -0700 Message-ID: <53264370.2000201@codesourcery.com> Date: Mon, 17 Mar 2014 00:38:00 -0000 From: Yao Qi User-Agent: Mozilla/5.0 (X11; Linux i686; rv:17.0) Gecko/20130110 Thunderbird/17.0.2 MIME-Version: 1.0 To: Doug Evans CC: gdb-patches Subject: Re: [RFC] Stop putting function comments in foo.h References: In-Reply-To: Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 8bit X-IsSubscribed: yes X-SW-Source: 2014-03/txt/msg00355.txt.bz2 On 03/16/2014 03:45 AM, Doug Evans wrote: > Hi. > > I'd like to start a discussion. > With doxygen is there still as much value to putting function comments > in foo.h instead of foo.c? > > I ask because every time I find a "See foo.h." comment I get depressed > and disappointed. They're just getting in my way, and I'm wondering > if it's just me. > No, it isn't. I dislike the "See foo.h" comment either. Since we had all source code available, it is convenient to read function comments in foo.c when we are editing it. -- Yao (齐尧)