From dev-return-21716-apmail-apr-dev-archive=apr.apache.org@apr.apache.org Thu May 07 14:44:40 2009 Return-Path: Delivered-To: apmail-apr-dev-archive@www.apache.org Received: (qmail 63535 invoked from network); 7 May 2009 14:44:40 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.3) by minotaur.apache.org with SMTP; 7 May 2009 14:44:40 -0000 Received: (qmail 95964 invoked by uid 500); 7 May 2009 14:44:39 -0000 Delivered-To: apmail-apr-dev-archive@apr.apache.org Received: (qmail 95869 invoked by uid 500); 7 May 2009 14:44:39 -0000 Mailing-List: contact dev-help@apr.apache.org; run by ezmlm Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Id: Delivered-To: mailing list dev@apr.apache.org Received: (qmail 95861 invoked by uid 99); 7 May 2009 14:44:39 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 07 May 2009 14:44:39 +0000 X-ASF-Spam-Status: No, hits=2.2 required=10.0 tests=HTML_MESSAGE,SPF_PASS X-Spam-Check-By: apache.org Received-SPF: pass (nike.apache.org: domain of trawick@gmail.com designates 72.14.220.153 as permitted sender) Received: from [72.14.220.153] (HELO fg-out-1718.google.com) (72.14.220.153) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 07 May 2009 14:44:30 +0000 Received: by fg-out-1718.google.com with SMTP id e21so1341185fga.22 for ; Thu, 07 May 2009 07:44:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:mime-version:received:in-reply-to:references :date:message-id:subject:from:to:content-type; bh=X83u9JmhltVliXiBzXB5DrCaZq297z9XbPmghxdwMjI=; b=kjXx4ahmrVNcXOrj6AgnUGsVHqjA/xTFIlsIMfi4EjkfQalP3ha6WJPvIPsgcE/Rk8 cnbdS6wvWmlXlgKeSMVddzy2BzUz+/v5qCp0w97bxEDGLTR431bIcKKOZs9GVDsBkjuS B1kdLuewx9VflBzRHSH0Hf+gsqIqMuV/A0quM= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :content-type; b=GnwOH5OaQLsH9QNgV9iJb78Ma4CMG4YGiM2vqJUOZ4dtkCqITDj08xV6OJYE942lTX +cGquC3D5BjbT89F6XrU6QH3YW+Mdi1Tb03uPk7QzlAwsgK5DLgZAOz9WnKEaYl4QmX3 VS6mqv9coBrIV9alga7t6aUBAecfxXRS8bRAA= MIME-Version: 1.0 Received: by 10.86.65.18 with SMTP id n18mr2639704fga.25.1241707449911; Thu, 07 May 2009 07:44:09 -0700 (PDT) In-Reply-To: <4A02E663.2020700@kdtc.net> References: <4A02E663.2020700@kdtc.net> Date: Thu, 7 May 2009 10:44:09 -0400 Message-ID: Subject: Re: apr_pools.h docstring help From: Jeff Trawick To: dev@apr.apache.org Content-Type: multipart/alternative; boundary=000e0cd247747789630469538b39 X-Virus-Checked: Checked by ClamAV on apache.org --000e0cd247747789630469538b39 Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit On Thu, May 7, 2009 at 9:47 AM, Edmund Wong wrote: > Given the following declaration: > > #define APR_POOL_DECLARE_ACCESSOR(type) \ > APR_DECLARE(apr_pool_t *) apr_##type##_pool_get \ > (const apr_##type##_t *the##type) > > In the docstring above it, it says: > > APR_POOL_DECLARE_ACCESSOR() is used in a header file to declare the > * accessor function. A typical usage and result would be: > * 
>  *    APR_POOL_DECLARE_ACCESSOR(file);
>  * becomes:
>  *    APR_DECLARE(apr_pool_t *) apr_file_pool_get(apr_file_t *ob);
>  *
> > Shouldn't APR_POOL_DECLARE_ACCESSOR(file) become > > APR_DECLARE(apr_pool_t *) apr_file_pool_get(apr_file_t *thefile); ? yes, it does; so that part of the comment is incorrect (perhaps someone will care to adjust the doc; note that the name of the dummy parameter isn't important) --000e0cd247747789630469538b39 Content-Type: text/html; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable
On Thu, May 7, 2009 at 9:47 AM, Edmund Wong <ed@kdtc.net>= wrote:
Given the following declaration:

#define APR_POOL_DECLARE_ACCESSOR(type) \
=A0 =A0APR_DECLARE(apr_pool_t *) apr_##type##_pool_get \
=A0 =A0 =A0 =A0(const apr_##type##_t *the##type)

In the docstring above it, it says:

APR_POOL_DECLARE_ACCESSOR() is used in a header file to declare the
=A0* accessor function. A typical usage and result would be:
=A0* <pre>
=A0* =A0 =A0APR_POOL_DECLARE_ACCESSOR(file);
=A0* becomes:
=A0* =A0 =A0APR_DECLARE(apr_pool_t *) apr_file_pool_get(apr_file_t *ob); =A0* </pre>

Shouldn't APR_POOL_DECLARE_ACCESSOR(file) become

APR_DECLARE(apr_pool_t *) apr_file_pool_get(apr_file_t *thefile); ?

yes, it does; so that part of the comment is incorrect

(perhaps someone will care to adjust the doc; note that the na= me of the dummy parameter isn't important)

--000e0cd247747789630469538b39--