diff options
| author | Michael Stahl <mstahl@redhat.com> | 2017-09-19 17:43:55 +0200 |
|---|---|---|
| committer | Caolán McNamara <caolanm@redhat.com> | 2017-09-24 17:21:26 +0200 |
| commit | 174e8475b912d6b64f424d05f563d2ceff11d621 (patch) | |
| tree | 8de614f2baa80a87293f9d14aec3355563575bb0 | |
| parent | 3766aa5b3232beba4e4989696b6d19103ba0d62f (diff) | |
odk: document what doxygen means by "Protected Member" in IDL
Interfaces and services that are marked as "optional" in IDL are
deliberately tagged as "Protected" by doxygen, while everything else is
"Public", so that in the inheritance diagrams dashed lines are drawn
for "optional" bases and solid lines for non-optional bases.
Unfortunately this also causes doxygen to produce the text "Protected
Members", which appears hard to change, so just document it for now.
Change-Id: Ice878981bac5bbb7a8a33a10f2b5f68c394e4340
(cherry picked from commit 055456b075c0c953cd6216d518b5a92e8f5b54bf)
Reviewed-on: https://gerrit.libreoffice.org/42497
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Caolán McNamara <caolanm@redhat.com>
Tested-by: Caolán McNamara <caolanm@redhat.com>
| -rw-r--r-- | odk/docs/idl/main.dox | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/odk/docs/idl/main.dox b/odk/docs/idl/main.dox index b5d1d755ed0a..5e9a6c8f953b 100644 --- a/odk/docs/idl/main.dox +++ b/odk/docs/idl/main.dox @@ -9,3 +9,12 @@ /// \mainpage /// /// This is a reference documentation for the UNO IDL API. +/// +/// \remark +/// UNO IDL has no concept of "public" or "protected". +/// "Protected Member" or "Protected Attribute" in the context +/// of this IDL documentation actually means +/// "members inherited from optional service or interface", +/// i.e., not every implementation supports these members +/// or attributes. + |