Changeset 3350 for pjproject

Timestamp:

Oct 20, 2010 9:54:45 AM (14 years ago)

Author:

bennylp

Message:

Misc (re #1134): enable doxygen documentation for pj_actievsock_set_iphone_os_bg()

File:

• pjproject/trunk/pjlib/include/pj/activesock.h (modified) (3 diffs)

pjproject/trunk/pjlib/include/pj/activesock.h

@@ -303 +303 @@
 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
@@ -310 +311 @@
  * 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.
@@ -324 +328 @@
  * 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.