From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 16266 invoked by alias); 18 Mar 2014 15:59:54 -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 16249 invoked by uid 89); 18 Mar 2014 15:59:53 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-2.9 required=5.0 tests=AWL,BAYES_00,RCVD_IN_DNSWL_LOW,SPF_PASS,T_RP_MATCHES_RCVD autolearn=ham version=3.3.2 X-HELO: mail-vc0-f169.google.com Received: from mail-vc0-f169.google.com (HELO mail-vc0-f169.google.com) (209.85.220.169) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with (AES128-SHA encrypted) ESMTPS; Tue, 18 Mar 2014 15:59:51 +0000 Received: by mail-vc0-f169.google.com with SMTP id ik5so7520151vcb.14 for ; Tue, 18 Mar 2014 08:59:49 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:in-reply-to:references:date :message-id:subject:from:to:cc:content-type; bh=UOfFss8urVYfBWxNVMVo7QzqPjc1r+CcPRuSFVoL96Y=; b=OZMDxdyxtbSs3I+Cvoo0K43V5LYPmxnl9GB69Dcxa4bbxJxlPjA0+KmSz3hP9owU8n 63u4rqHBt4iD7vOHcWujbFH6YAX+MmRrVoL+KRLx/cJqqaK4z3xj6Re860bjqvsLfaad KCkFIKIEIWKcqQJQQmVt9hKt9hN9MgAtyYMiJqClJbzkfUx6V/n+eSyFUIZvnr47tSjy WS9VTUFC4m/JlDMttoFOIPWaawtNLTPt1kO1LhtQs4ngKpR1HnyLP+0hv1l1q+WCFJq8 yKCYhlvK/EesAdYgNl4WsqHgysEqXFh6PwxJgtJwxmfDe0rdfegDKRUdYq0GUwrjxI7o dT7w== X-Gm-Message-State: ALoCoQnOv3K7VPZ+OmBEhh+9BcbCh6GN3lughkBeSNTYPuoKVs9++zEBAoGUTZwqmwiM1MfkW7hWQYH4DP4BMbu/WlTnIiW31yjOEW/gFqaXm/usFFcOsmABPSA8OtlUN+Xm2WH/SfK7p/CVB/9kgWcImy/HLIHeUMYuM88/cINenSTbavCL53kyqshRfCrRF7tV4ihA427fIu+3k7o5usLR5rkknNqEvg== MIME-Version: 1.0 X-Received: by 10.220.139.198 with SMTP id f6mr846408vcu.47.1395158389501; Tue, 18 Mar 2014 08:59:49 -0700 (PDT) Received: by 10.52.13.101 with HTTP; Tue, 18 Mar 2014 08:59:49 -0700 (PDT) In-Reply-To: <53271DC0.3050405@redhat.com> References: <53271DC0.3050405@redhat.com> Date: Tue, 18 Mar 2014 15:59:00 -0000 Message-ID: Subject: Re: [RFC] Stop putting function comments in foo.h From: Doug Evans To: Pedro Alves Cc: gdb-patches Content-Type: text/plain; charset=UTF-8 X-IsSubscribed: yes X-SW-Source: 2014-03/txt/msg00416.txt.bz2 On Mon, Mar 17, 2014 at 9:07 AM, Pedro Alves wrote: > IMO, a module's API documentation should be in its header file, as > that's where the module's "public" contract is defined. > Needing to peek at the module's implementation feels wrong to me. > If the function's documentation isn't clear without looking > at the function's body, something is already wrong with > the comment. It use to be that M-. took me to the function definition and its documentation. I'm curious what other emacs+etags users do now.