On Wed, 14 Dec 2005, Philip M. Gollucci wrote:
Is it worth fixing these ?usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:40: Warning: Member APREQ_DECLARE(d) of file apreq.h is not documented. /usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:41: Warning: Member APREQ_DECLARE_NONSTD(d) of file apreq.h is not documented. /usr/home/pgollucci/dev/repos/asf/httpd/apreq/trunk/include/apreq.h:42: Warning: Member APREQ_DECLARE_DATA of file apreq.h is not documented.
Steal/Tweak some documentation for these for APR.
Attached. ------------------------------------------------------------------------ "Love is not the one you can picture yourself marrying, but the one you can't picture the rest of your life without." "It takes a minute to have a crush on someone, an hour to like someone, and a day to love someone, but it takes a lifetime to forget someone..." Philip M. Gollucci ([EMAIL PROTECTED]) 301.254.5198 Consultant / http://p6m7g8.net/Resume/resume.shtml Senior Software Engineer - TicketMaster - http://ticketmaster.com
Index: include/apreq.h =================================================================== --- include/apreq.h (revision 357313) +++ include/apreq.h (working copy) @@ -37,8 +37,38 @@ */ #ifndef WIN32 +/** + * The public APREQ functions are declared with APREQ_DECLARE(), so they may + * use the most appropriate calling convention. Public APR functions with + * variable arguments must use APR_DECLARE_NONSTD(). + * + * @remark Both the declaration and implementations must use the same macro. + * @example + */ +/** APREQ_DECLARE(rettype) apeq_func(args) + */ #define APREQ_DECLARE(d) APR_DECLARE(d) +/** + * The public APEQ functions using variable arguments are declared with + * APEQ_DECLARE_NONSTD(), as they must follow the C language calling convention. + * @see APEQ_DECLARE @see APEQ_DECLARE_DATA + * @remark Both the declaration and implementations must use the same macro. + * @example + */ +/** APEQ_DECLARE_NONSTD(rettype) apr_func(args, ...); + */ #define APREQ_DECLARE_NONSTD(d) APR_DECLARE_NONSTD(d) +/** + * The public APREQ variables are declared with APREQ_DECLARE_DATA. + * This assures the appropriate indirection is invoked at compile time. + * @see APREQ_DECLARE @see APREQ_DECLARE_NONSTD + * @remark Note that the declaration and implementations use different forms, + * but both must include the macro. + * @example + */ +/** extern APREQ_DECLARE_DATA type apr_variable;\n + * APREQ_DECLARE_DATA type apr_variable = value; + */ #define APREQ_DECLARE_DATA #else #define APREQ_DECLARE(type) __declspec(dllexport) type __stdcall
