apr-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jeff Trawick <traw...@gmail.com>
Subject Re: apr_pools.h docstring help
Date Thu, 07 May 2009 14:44:09 GMT
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) \
>    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:
>  * <pre>
>  *    APR_POOL_DECLARE_ACCESSOR(file);
>  * becomes:
>  *    APR_DECLARE(apr_pool_t *) apr_file_pool_get(apr_file_t *ob);
>  * </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 name of the
dummy parameter isn't important)

Mime
View raw message