[Libreoffice-commits] core.git: 2 commits - include/osl include/rtl include/sal odk/docs

[Michael Stahl]

 include/osl/diagnose.h      |    3 ++-
 include/osl/file.h          |    2 ++
 include/osl/socket_decl.hxx |    6 +++---
 include/rtl/character.hxx   |    2 +-
 include/sal/log.hxx         |    2 ++
 odk/docs/idl/main.dox       |    9 +++++++++
 6 files changed, 19 insertions(+), 5 deletions(-)

New commits:
commit 055456b075c0c953cd6216d518b5a92e8f5b54bf
Author: Michael Stahl <mstahl at redhat.com>
Date:   Tue Sep 19 17:43:55 2017 +0200

    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

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.
+
commit 98e69875f91fb4d44659b8e48388364ac6f27147
Author: Michael Stahl <mstahl at redhat.com>
Date:   Tue Sep 19 17:23:11 2017 +0200

    sal: fix numerous doxygen warnings
    
    Change-Id: I2fd3fb7b67a62d349ff917466b08c75c19dcbff6

diff --git a/include/osl/diagnose.h b/include/osl/diagnose.h
index 8461daf76ed2..748f0e472dca 100644
--- a/include/osl/diagnose.h
+++ b/include/osl/diagnose.h
@@ -27,7 +27,8 @@
 #include <sal/saldllapi.h>
 #include <sal/types.h>
 
-/** @file Provides simple diagnostic support.
+/** @file
+    Provides simple diagnostic support.
 
     @deprecated
     The facilities provided by this header are deprecated.  True assertions
diff --git a/include/osl/file.h b/include/osl/file.h
index 2e9dfe7ca91e..21a5de488c48 100644
--- a/include/osl/file.h
+++ b/include/osl/file.h
@@ -547,6 +547,8 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_getVolumeDeviceMountPath(
 #define osl_VolumeInfo_Mask_DeviceHandle           0x00000080L
 #define osl_VolumeInfo_Mask_FileSystemCaseHandling 0x00000100L
 
+/** @} */
+
 /** Structure containing information about volumes
 
     @see    osl_getVolumeInformation()
diff --git a/include/osl/socket_decl.hxx b/include/osl/socket_decl.hxx
index c470cd65f26f..e0114c1ee4e1 100644
--- a/include/osl/socket_decl.hxx
+++ b/include/osl/socket_decl.hxx
@@ -89,7 +89,7 @@ namespace osl
 
         /** Converts the address to a (human readable) domain-name.
 
-            @param pResult[out] value of 0 if you are not interested in errors,
+            @param[out] pResult value of 0 if you are not interested in errors,
                            otherwise *pResult contains an error code on failure
                            or osl_Socket_Ok on success
 
@@ -101,7 +101,7 @@ namespace osl
 
         /** Sets the IP address or hostname of the SocketAddress
 
-           @param sDottedIpOrHostname[in]   IP address or hostname
+           @param[in] sDottedIpOrHostname   IP address or hostname
 
            @retval true     success
            @retval false    failure
@@ -116,7 +116,7 @@ namespace osl
 
         /** Sets the port number of the address.
 
-           @param nPort[in] port number
+           @param[in] nPort port number
 
            @retval true     success
            @retval false    failure
diff --git a/include/rtl/character.hxx b/include/rtl/character.hxx
index ee26f4ae1f9a..db3f41f16999 100644
--- a/include/rtl/character.hxx
+++ b/include/rtl/character.hxx
@@ -244,7 +244,7 @@ template<typename T> inline bool isAsciiOctalDigit(T code)
     @param code  A Unicode code point.
 
     @return  True if code is an ASCII white space character as defined by C for
-    isspace in the "C" locale (ASCII ' ', '\f', '\n', '\r', '\t' '\v').
+    isspace in the "C" locale (ASCII ' ', '\\f', '\\n', '\\r', '\\t' '\\v').
 
     @since LibreOffice 5.4
 */
diff --git a/include/sal/log.hxx b/include/sal/log.hxx
index c8d277e0d90f..51b218a2732c 100644
--- a/include/sal/log.hxx
+++ b/include/sal/log.hxx
@@ -346,6 +346,8 @@ inline char const * unwrapStream(SAL_UNUSED_PARAMETER StreamIgnore const &) {
   This macro is meant to be used only while working on code and should never
   exist in production code.
 
+  @param stream input stream
+
   @param backtraceDepth a sal_uInt32 value indicating the maximum backtrace
   depth; zero means no backtrace