Changeset 63247 in vbox for trunk

Timestamp:

Aug 10, 2016 10:56:20 AM (8 years ago)

Author:

vboxsync

Message:

iprt/cdefs.h: Clarification of RTDECL*() and the general XXXX_DECL* macro scheme we use.

File:

• trunk/include/iprt/cdefs.h (modified) (6 diffs)

trunk/include/iprt/cdefs.h

@@ -1402 +1402 @@
 /** @def IN_RT_STATIC
  * Used to indicate whether we're linking against a static IPRT
- * or not. The IPRT symbols will be declared as hidden (if
- * supported). Note that this define has no effect without setting
- * IN_RT_R0, IN_RT_R3 or IN_RT_RC indicators are set first.
+ * or not.
+ *
+ * The IPRT symbols will be declared as hidden (if supported).  Note that this
+ * define has no effect without also setting one of the IN_RT_R0, IN_RT_R3 or
+ * IN_RT_RC indicators.
  */
 
 /** @def IN_RT_R0
- * Used to indicate whether we're inside the same link module as
- * the HC Ring-0 Runtime Library.
+ * Used to indicate whether we're inside the same link module as the host
+ * context ring-0 Runtime Library.
  */
 /** @def RTR0DECL(type)
- * Runtime Library HC Ring-0 export or import declaration.
+ * Runtime Library host context ring-0 export or import declaration.
  * @param   type    The return type of the function declaration.
+ * @remarks This is only used inside IPRT.  Other APIs need to define their own
+ *          XXXX_DECL macros for dealing with import/export/static visibility.
  */
 #ifdef IN_RT_R0
@@ -1426 +1430 @@
 
 /** @def IN_RT_R3
- * Used to indicate whether we're inside the same link module as
- * the HC Ring-3 Runtime Library.
+ * Used to indicate whether we're inside the same link module as the host
+ * context ring-3 Runtime Library.
  */
 /** @def RTR3DECL(type)
- * Runtime Library HC Ring-3 export or import declaration.
+ * Runtime Library host context ring-3 export or import declaration.
  * @param   type    The return type of the function declaration.
+ * @remarks This is only used inside IPRT.  Other APIs need to define their own
+ *          XXXX_DECL macros for dealing with import/export/static visibility.
  */
 #ifdef IN_RT_R3
@@ -1450 +1456 @@
  * Runtime Library raw-mode context export or import declaration.
  * @param   type    The return type of the function declaration.
+ * @remarks This is only used inside IPRT.  Other APIs need to define their own
+ *          XXXX_DECL macros for dealing with import/export/static visibility.
  */
 #ifdef IN_RT_RC
@@ -1465 +1473 @@
  * Functions declared using this macro exists in all contexts.
  * @param   type    The return type of the function declaration.
+ * @remarks This is only used inside IPRT.  Other APIs need to define their own
+ *          XXXX_DECL macros for dealing with import/export/static visibility.
  */
 #if defined(IN_RT_R3) || defined(IN_RT_RC) || defined(IN_RT_R0)
@@ -1480 +1490 @@
  * Data declared using this macro exists in all contexts.
  * @param   type    The data type.
+ * @remarks This is only used inside IPRT.  Other APIs need to define their own
+ *          XXXX_DECL macros for dealing with import/export/static visibility.
  */
 /** @def RT_DECL_DATA_CONST(type)
  * Definition of a const variable. See DECL_HIDDEN_CONST.
  * @param   type    The const data type.
+ * @remarks This is only used inside IPRT.  Other APIs need to define their own
+ *          XXXX_DECL macros for dealing with import/export/static visibility.
  */
 #if defined(IN_RT_R3) || defined(IN_RT_RC) || defined(IN_RT_R0)
@@ -1504 +1518 @@
 /** @def RT_DECL_CLASS
  * Declares an class living in the runtime.
+ * @remarks This is only used inside IPRT.  Other APIs need to define their own
+ *          XXXX_DECL macros for dealing with import/export/static visibility.
  */
 #if defined(IN_RT_R3) || defined(IN_RT_RC) || defined(IN_RT_R0)