summaryrefslogtreecommitdiff
path: root/odk
diff options
context:
space:
mode:
authorMike Kaganski <mike.kaganski@collabora.com>2024-03-18 11:33:09 +0500
committerMike Kaganski <mike.kaganski@collabora.com>2024-03-18 14:09:10 +0100
commit26fcbe463c2f91353463bd826f570ca7945c8987 (patch)
treeb90dfd5e36170ce364f05e93d2e16475b6f69537 /odk
parentc454dfe6affa295156bfa8dd272a770433649d9f (diff)
Add a notice about "published" to the IDL API documentation main page
Users don't realize that they may see not only published interfaces there. Seen e.g. on https://ask.libreoffice.org/t/103621 Change-Id: Id93bb12c1871fcfe85b71be01be0995ee2a83ded Reviewed-on: https://gerrit.libreoffice.org/c/core/+/164962 Tested-by: Jenkins Reviewed-by: Mike Kaganski <mike.kaganski@collabora.com>
Diffstat (limited to 'odk')
-rw-r--r--odk/docs/idl/main.dox5
1 files changed, 5 insertions, 0 deletions
diff --git a/odk/docs/idl/main.dox b/odk/docs/idl/main.dox
index 5e9a6c8f953b..70c79d933144 100644
--- a/odk/docs/idl/main.dox
+++ b/odk/docs/idl/main.dox
@@ -17,4 +17,9 @@
/// "members inherited from optional service or interface",
/// i.e., not every implementation supports these members
/// or attributes.
+///
+/// \remark
+/// Only interfaces marked "published" are part of the published
+/// UNO API. Interfaces that haven't "published" mark, may be
+/// changed at any time. Do not use them in macros / scripts.