diff options
| author | Benny Prijono <bennylp@teluu.com> | 2010-10-20 09:54:45 +0000 |
|---|---|---|
| committer | Benny Prijono <bennylp@teluu.com> | 2010-10-20 09:54:45 +0000 |
| commit | a1a71402dc2e0ac10748fef9756515acf47f29d4 (patch) | |
| tree | 86005b686f1e99bea27feb65a14b591c1d704f58 | |
| parent | bc409e2e1664fcd662c6ddd67697b459e50761ad (diff) | |
Misc (re #1134): enable doxygen documentation for pj_actievsock_set_iphone_os_bg()
git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@3350 74dad513-b988-da41-8d7b-12977e46ad98
| -rw-r--r-- | pjlib/include/pj/activesock.h | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/pjlib/include/pj/activesock.h b/pjlib/include/pj/activesock.h index 4d30ac97..49beafe1 100644 --- a/pjlib/include/pj/activesock.h +++ b/pjlib/include/pj/activesock.h @@ -302,14 +302,18 @@ PJ_DECL(pj_status_t) pj_activesock_create_udp(pj_pool_t *pool, */ PJ_DECL(pj_status_t) pj_activesock_close(pj_activesock_t *asock); -#if defined(PJ_IPHONE_OS_HAS_MULTITASKING_SUPPORT) && \ - PJ_IPHONE_OS_HAS_MULTITASKING_SUPPORT!=0 +#if (defined(PJ_IPHONE_OS_HAS_MULTITASKING_SUPPORT) && \ + PJ_IPHONE_OS_HAS_MULTITASKING_SUPPORT!=0) || \ + defined(DOXYGEN) /** * Set iPhone OS background mode setting. Setting to 1 will enable TCP * active socket to receive incoming data when application is in the * background. Setting to 0 will disable it. Default value of this * setting is PJ_ACTIVESOCK_TCP_IPHONE_OS_BG. * + * This API is only available if PJ_IPHONE_OS_HAS_MULTITASKING_SUPPORT + * is set to non-zero. + * * @param asock The active socket. * @param val The value of background mode setting. * @@ -324,6 +328,9 @@ PJ_DECL(void) pj_activesock_set_iphone_os_bg(pj_activesock_t *asock, * active socket, use #pj_activesock_set_iphone_os_bg() instead. * By default, this setting is enabled. * + * This API is only available if PJ_IPHONE_OS_HAS_MULTITASKING_SUPPORT + * is set to non-zero. + * * @param val The value of global background mode setting. * */ |