Improve documentation

Change-Id: I13683f971bf56f6c5e226d749e60ccb25af559a5

1 files changed, 9 insertions, 7 deletions

diff --git a/include/sal/types.h b/include/sal/types.h
index 86c7c730c073..5614c99d1d9c 100644
--- a/include/sal/types.h
+++ b/include/sal/types.h
@@ -502,13 +502,15 @@ template< typename T1, typename T2 > inline T1 static_int_cast(T2 n) {
 #endif
 
 /**
-   This macro is used to tag interfaces that are deprecated for both
-   internal and external API users, but where we are still writing
-   out the internal usage. Ultimately these should be replaced by
-   SAL_DEPRECATED, and then removed.
-
-   Use as follows:
-        SAL_DEPRECATED_INTERNAL("Don't use, it's evil.") void doit(int nPara);
+   This macro is used in cppumaker-generated include files, to tag entities that
+   are marked as @deprecated in UNOIDL.
+
+   It causes deprecation warnings to be generated in external code, but for now
+   is silenced in internal code.  It would need some substantial clean-up of
+   internal code to fix all warnings/errors generated by it.  (Once that is
+   done, it can become a synonym for SAL_DEPRECATED under LIBO_INTERNAL_ONLY,
+   too.  Completely removing the macro then would be incompatible, in case thare
+   are include files still around generated with a cppumaker that emitted it.)
  */
 #ifdef LIBO_INTERNAL_ONLY
 #    define SAL_DEPRECATED_INTERNAL(message)