Changeset 83994 in vbox for trunk/include/iprt

Timestamp:

Apr 27, 2020 11:01:30 AM (5 years ago)

Author:

vboxsync

Message:

IPRT/string.h: Document status code formatting in IN_RT_STATIC builds and adjusted the formatter to make the best of it.

File:

• trunk/include/iprt/string.h (modified) (2 diffs)

trunk/include/iprt/string.h

@@ -1540 +1540 @@
  *      - \%Rrf             - Takes an integer iprt status code as argument. Will insert the
  *                            full description of the specified status code.
+ *                            Note! Works like \%Rrs when IN_RT_STATIC is defined (so please avoid).
  *      - \%Rra             - Takes an integer iprt status code as argument. Will insert the
  *                            status code define + full description.
+ *                            Note! Reduced output when IN_RT_STATIC is defined (so please avoid).
  *      - \%Rwc             - Takes a long Windows error code as argument. Will insert the status
  *                            code define corresponding to the Windows error code.
  *      - \%Rwf             - Takes a long Windows error code as argument. Will insert the
  *                            full description of the specified status code.
+ *                            Note! Works like \%Rwc when IN_RT_STATIC is defined.
  *      - \%Rwa             - Takes a long Windows error code as argument. Will insert the
  *                            error code define + full description.
+ *                            Note! Reduced output when IN_RT_STATIC is defined (so please avoid).
  *
  *      - \%Rhrc            - Takes a COM/XPCOM status code as argument. Will insert the status
@@ -1553 +1557 @@
  *      - \%Rhrf            - Takes a COM/XPCOM status code as argument. Will insert the
  *                            full description of the specified status code.
+ *                            Note! Works like \%Rhrc when IN_RT_STATIC is
+ *                                  defined on Windows (so please avoid).
  *      - \%Rhra            - Takes a COM/XPCOM error code as argument. Will insert the
  *                            error code define + full description.
+ *                            Note! Reduced output when IN_RT_STATIC is defined on Windows (so please avoid).
  *
  *      - \%Rfn             - Pretty printing of a function or method. It drops the