diff options
| author | Michael Stahl <mstahl@redhat.com> | 2017-09-19 17:43:55 +0200 |
|---|---|---|
| committer | Michael Stahl <mstahl@redhat.com> | 2017-09-19 17:49:18 +0200 |
| commit | 055456b075c0c953cd6216d518b5a92e8f5b54bf (patch) | |
| tree | 4c4582bd5c9656a1fa53d04b5f7b06af9e9db472 /odk | |
| parent | 98e69875f91fb4d44659b8e48388364ac6f27147 (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
Diffstat (limited to 'odk')
| -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. + |