From fb66eeb8524d0eca53928b08b2ee8b3a74e534ce Mon Sep 17 00:00:00 2001 From: Simon Rozman Date: Mon, 11 Sep 2023 16:12:22 +0200 Subject: [PATCH] Make inout param designations XCode-friendly --- include/stdex/base64.hpp | 16 +++++----- include/stdex/hex.hpp | 14 ++++----- include/stdex/interval.hpp | 8 ++--- include/stdex/math.hpp | 2 +- include/stdex/sgml.hpp | 54 +++++++++++++++++----------------- include/stdex/unicode.hpp | 16 +++++----- include/stdex/vector_queue.hpp | 4 +-- 7 files changed, 57 insertions(+), 57 deletions(-) diff --git a/include/stdex/base64.hpp b/include/stdex/base64.hpp index 0e66e76a8..8908794a0 100644 --- a/include/stdex/base64.hpp +++ b/include/stdex/base64.hpp @@ -34,10 +34,10 @@ namespace stdex /// /// Encodes one block of information, and _appends_ it to the output /// - /// \param[out] out Output - /// \param[in ] data Data to encode - /// \param[in ] size Length of `data` in bytes - /// \param[in ] is_last Is this the last block of data? + /// \param[in,out] out Output + /// \param[in] data Data to encode + /// \param[in] size Length of `data` in bytes + /// \param[in] is_last Is this the last block of data? /// template void encode(_Inout_ std::basic_string<_Elem, _Traits, _Ax> &out, _In_bytecount_(size) const void *data, _In_ size_t size, _In_opt_ bool is_last = true) @@ -172,10 +172,10 @@ namespace stdex /// /// Decodes one block of information, and _appends_ it to the output /// - /// \param[out] out Output - /// \param[in ] is_last Was this the last block of data? - /// \param[in ] data Data to decode - /// \param[in ] size Length of `data` in bytes + /// \param[in,out] out Output + /// \param[in] is_last Was this the last block of data? + /// \param[in] data Data to decode + /// \param[in] size Length of `data` in bytes /// template void decode(_Inout_ std::vector<_Ty, _Ax> &out, _Out_ bool &is_last, _In_z_count_(size) const _Tchr *data, _In_ size_t size) diff --git a/include/stdex/hex.hpp b/include/stdex/hex.hpp index bba4d1052..432fdccdb 100644 --- a/include/stdex/hex.hpp +++ b/include/stdex/hex.hpp @@ -31,9 +31,9 @@ namespace stdex /// /// Encodes one block of information, and _appends_ it to the output /// - /// \param[out] out Output - /// \param[in ] data Data to encode - /// \param[in ] size Length of `data` in bytes + /// \param[in,out] out Output + /// \param[in] data Data to encode + /// \param[in] size Length of `data` in bytes /// template void encode(_Inout_ std::basic_string<_Elem, _Traits, _Ax> &out, _In_bytecount_(size) const void *data, _In_ size_t size) @@ -89,10 +89,10 @@ namespace stdex /// /// Decodes one block of information, and _appends_ it to the output /// - /// \param[inout] out Output - /// \param[out ] is_last Was this the last block of data? Actually, is this block of data complete? - /// \param[in ] data Data to decode - /// \param[in ] size Length of `data` in bytes + /// \param[in,out] out Output + /// \param[out] is_last Was this the last block of data? Actually, is this block of data complete? + /// \param[in] data Data to decode + /// \param[in] size Length of `data` in bytes /// template void decode(_Inout_ std::vector<_Ty, _Ax> &out, _Out_ bool &is_last, _In_z_count_(size) const _Tchr *data, _In_ size_t size) diff --git a/include/stdex/interval.hpp b/include/stdex/interval.hpp index 1a2b760fc..67530b2bd 100644 --- a/include/stdex/interval.hpp +++ b/include/stdex/interval.hpp @@ -105,7 +105,7 @@ inline stdex::interval operator+(_In_ const stdex::interval& i, _In_ const /// /// Moves interval towards the end by one /// -/// \param[in] i Interval to move +/// \param[in,out] i Interval to move /// /// \returns Moved interval /// @@ -120,7 +120,7 @@ inline stdex::interval operator++(_Inout_ stdex::interval& i) /// /// Moves interval towards the end by one /// -/// \param[in] i Interval to move +/// \param[in,out] i Interval to move /// /// \returns Original interval /// @@ -164,7 +164,7 @@ inline stdex::interval operator-(_In_ const stdex::interval& i, _In_ const /// /// Moves interval towards the begginning by one /// -/// \param[in] i Interval to move +/// \param[in,out] i Interval to move /// /// \returns Moved interval /// @@ -179,7 +179,7 @@ inline stdex::interval operator--(_Inout_ stdex::interval& i) /// /// Moves interval towards the begginning by one /// -/// \param[in] i Interval to move +/// \param[in,out] i Interval to move /// /// \returns Original interval /// diff --git a/include/stdex/math.hpp b/include/stdex/math.hpp index 73427a34d..c42c59aee 100644 --- a/include/stdex/math.hpp +++ b/include/stdex/math.hpp @@ -1,4 +1,4 @@ -/* +/* SPDX-License-Identifier: MIT Copyright © 2023 Amebis */ diff --git a/include/stdex/sgml.hpp b/include/stdex/sgml.hpp index bf216e4a7..f9d581e5b 100644 --- a/include/stdex/sgml.hpp +++ b/include/stdex/sgml.hpp @@ -82,12 +82,12 @@ namespace stdex /// /// Convert SGML string to Unicode (UTF-16 on Windows) and append to string /// - /// \param[inout] dst String to append Unicode to + /// \param[in,out] dst String to append Unicode to /// \param[in] src SGML string /// \param[in] count_src SGML string character count limit /// \param[in] skip Bitwise flag of stdex::sgml_* constants that list SGML entities to skip converting /// \param[in] offset Logical starting offset of source and destination strings. Unused when map parameter is nullptr. - /// \param[out] map The vector to append index mapping between source and destination string to. + /// \param[in,out] map The vector to append index mapping between source and destination string to. /// template inline void sgml2wstrcat( @@ -186,11 +186,11 @@ namespace stdex /// /// Convert SGML string to Unicode (UTF-16 on Windows) and append to string /// - /// \param[inout] dst String to append Unicode to + /// \param[in,out] dst String to append Unicode to /// \param[in] src SGML string /// \param[in] skip Bitwise flag of stdex::sgml_* constants that list SGML entities to skip converting /// \param[in] offset Logical starting offset of source and destination strings. Unused when map parameter is nullptr. - /// \param[out] map The vector to append index mapping between source and destination string to. + /// \param[in,out] map The vector to append index mapping between source and destination string to. /// /// \return Unicode string /// @@ -219,13 +219,13 @@ namespace stdex /// /// Convert SGML string to Unicode (UTF-16 on Windows) and append to string /// - /// \param[inout] dst String to append Unicode to + /// \param[in,out] dst String to append Unicode to /// \param[in] count_dst Unicode string character count limit. Function throws std::invalid_argument if there is not enough space in Unicode string (including space for zero-terminator). /// \param[in] src SGML string /// \param[in] count_src SGML string character count limit /// \param[in] skip Bitwise flag of stdex::sgml_* constants that list SGML entities to skip converting /// \param[in] offset Logical starting offset of source and destination strings. Unused when map parameter is nullptr. - /// \param[out] map The vector to append index mapping between source and destination string to. + /// \param[in,out] map The vector to append index mapping between source and destination string to. /// /// \return Final length of SGML string in code points excluding zero-terminator /// @@ -337,12 +337,12 @@ namespace stdex /// /// Convert SGML string to Unicode (UTF-16 on Windows) /// - /// \param[inout] dst String to write Unicode to + /// \param[in,out] dst String to write Unicode to /// \param[in] src SGML string /// \param[in] count_src SGML string character count limit /// \param[in] skip Bitwise flag of stdex::sgml_* constants that list SGML entities to skip converting /// \param[in] offset Logical starting offset of source and destination strings. Unused when map parameter is nullptr. - /// \param[out] map The vector to write index mapping between source and destination string to. + /// \param[in,out] map The vector to write index mapping between source and destination string to. /// template inline void sgml2wstrcpy( @@ -361,11 +361,11 @@ namespace stdex /// /// Convert SGML string to Unicode (UTF-16 on Windows) /// - /// \param[inout] dst String to write Unicode to + /// \param[in,out] dst String to write Unicode to /// \param[in] src SGML string /// \param[in] skip Bitwise flag of stdex::sgml_* constants that list SGML entities to skip converting /// \param[in] offset Logical starting offset of source and destination strings. Unused when map parameter is nullptr. - /// \param[out] map The vector to write index mapping between source and destination string to. + /// \param[in,out] map The vector to write index mapping between source and destination string to. /// template inline void sgml2wstrcpy( @@ -381,13 +381,13 @@ namespace stdex /// /// Convert SGML string to Unicode (UTF-16 on Windows) /// - /// \param[inout] dst String to write Unicode to + /// \param[in,out] dst String to write Unicode to /// \param[in] count_dst Unicode string character count limit. Function throws std::invalid_argument if there is not enough space in Unicode string (including space for zero-terminator). /// \param[in] src SGML string /// \param[in] count_src SGML string character count limit /// \param[in] skip Bitwise flag of stdex::sgml_* constants that list SGML entities to skip converting /// \param[in] offset Logical starting offset of source and destination strings. Unused when map parameter is nullptr. - /// \param[out] map The vector to write index mapping between source and destination string to. + /// \param[in,out] map The vector to write index mapping between source and destination string to. /// /// \return Final length of SGML string in code points excluding zero-terminator /// @@ -410,11 +410,11 @@ namespace stdex /// /// Convert SGML string to Unicode string (UTF-16 on Windows) /// - /// \param[in] src SGML string - /// \param[in] count_src SGML string character count limit - /// \param[in] skip Bitwise flag of stdex::sgml_* constants that list SGML entities to skip converting - /// \param[in] offset Logical starting offset of source and destination strings. Unused when map parameter is nullptr. - /// \param[out] map The vector to append index mapping between source and destination string to. + /// \param[in] src SGML string + /// \param[in] count_src SGML string character count limit + /// \param[in] skip Bitwise flag of stdex::sgml_* constants that list SGML entities to skip converting + /// \param[in] offset Logical starting offset of source and destination strings. Unused when map parameter is nullptr. + /// \param[in,out] map The vector to append index mapping between source and destination string to. /// /// \return Unicode string /// @@ -433,10 +433,10 @@ namespace stdex /// /// Convert SGML string to Unicode string (UTF-16 on Windows) /// - /// \param[in] src SGML string - /// \param[in] skip Bitwise flag of stdex::sgml_* constants that list SGML entities to skip converting - /// \param[in] offset Logical starting offset of source and destination strings. Unused when map parameter is nullptr. - /// \param[out] map The vector to append index mapping between source and destination string to. + /// \param[in] src SGML string + /// \param[in] skip Bitwise flag of stdex::sgml_* constants that list SGML entities to skip converting + /// \param[in] offset Logical starting offset of source and destination strings. Unused when map parameter is nullptr. + /// \param[in,out] map The vector to append index mapping between source and destination string to. /// /// \return Unicode string /// @@ -482,7 +482,7 @@ namespace stdex /// /// Convert Unicode string (UTF-16 on Windows) to SGML and append to string /// - /// \param[inout] dst String to append SGML to + /// \param[in,out] dst String to append SGML to /// \param[in] src Unicode string /// \param[in] count_src Unicode string character count limit /// \param[in] what Bitwise flag of stdex::sgml_* constants that force extra characters otherwise not converted to SGML @@ -593,7 +593,7 @@ namespace stdex /// /// Convert Unicode string (UTF-16 on Windows) to SGML and append to string /// - /// \param[inout] dst String to append SGML to + /// \param[in,out] dst String to append SGML to /// \param[in] src Unicode string /// \param[in] what Bitwise flag of stdex::sgml_* constants that force extra characters otherwise not converted to SGML /// @@ -616,7 +616,7 @@ namespace stdex /// /// Convert Unicode string (UTF-16 on Windows) to SGML and append to string /// - /// \param[inout] dst String to append SGML to + /// \param[in,out] dst String to append SGML to /// \param[in] count_dst SGML string character count limit. Function throws std::invalid_argument if there is not enough space in SGML string (including space for zero-terminator). /// \param[in] src Unicode string /// \param[in] count_src Unicode string character count limit @@ -756,7 +756,7 @@ namespace stdex /// /// Convert Unicode string (UTF-16 on Windows) to SGML /// - /// \param[inout] dst String to write SGML to + /// \param[in,out] dst String to write SGML to /// \param[in] src Unicode string /// \param[in] count_src Unicode string character count limit /// \param[in] what Bitwise flag of stdex::sgml_* constants that force extra characters otherwise not converted to SGML @@ -773,7 +773,7 @@ namespace stdex /// /// Convert Unicode string (UTF-16 on Windows) to SGML /// - /// \param[inout] dst String to write SGML to + /// \param[in,out] dst String to write SGML to /// \param[in] src Unicode string /// \param[in] what Bitwise flag of stdex::sgml_* constants that force extra characters otherwise not converted to SGML /// @@ -788,7 +788,7 @@ namespace stdex /// /// Convert Unicode string (UTF-16 on Windows) to SGML /// - /// \param[inout] dst String to write SGML to + /// \param[in,out] dst String to write SGML to /// \param[in] count_dst SGML string character count limit. Function throws std::invalid_argument if there is not enough space in SGML string (including space for zero-terminator). /// \param[in] src Unicode string /// \param[in] count_src Unicode string character count limit diff --git a/include/stdex/unicode.hpp b/include/stdex/unicode.hpp index 08866c95d..cbc34bb57 100644 --- a/include/stdex/unicode.hpp +++ b/include/stdex/unicode.hpp @@ -27,7 +27,7 @@ namespace stdex /// /// Convert string to Unicode (UTF-16 on Windows) and append to string /// - /// \param[inout] dst String to append Unicode to + /// \param[in,out] dst String to append Unicode to /// \param[in] src String /// \param[in] count_src String character count limit /// \param[in] charset Charset (stdex::charset_id::default - system default) @@ -74,7 +74,7 @@ namespace stdex /// /// Convert string to Unicode (UTF-16 on Windows) and append to string /// - /// \param[inout] dst String to append Unicode to + /// \param[in,out] dst String to append Unicode to /// \param[in] src String /// \param[in] charset Charset (stdex::charset_id::default - system default) /// @@ -99,7 +99,7 @@ namespace stdex /// /// Convert string to Unicode (UTF-16 on Windows) /// - /// \param[inout] dst String to write Unicode to + /// \param[in,out] dst String to write Unicode to /// \param[in] src String /// \param[in] count_src String character count limit /// \param[in] charset Charset (stdex::charset_id::default - system default) @@ -118,7 +118,7 @@ namespace stdex /// /// Convert string to Unicode (UTF-16 on Windows) /// - /// \param[inout] dst String to write Unicode to + /// \param[in,out] dst String to write Unicode to /// \param[in] src String /// \param[in] charset Charset (stdex::charset_id::default - system default) /// @@ -185,7 +185,7 @@ namespace stdex /// /// Convert Unicode string (UTF-16 on Windows) to SGML and append to string /// - /// \param[inout] dst String to append SGML to + /// \param[in,out] dst String to append SGML to /// \param[in] src Unicode string /// \param[in] count_src Unicode string character count limit /// \param[in] charset Charset (stdex::charset_id::default - system default) @@ -231,7 +231,7 @@ namespace stdex /// /// Convert Unicode string (UTF-16 on Windows) to SGML and append to string /// - /// \param[inout] dst String to append SGML to + /// \param[in,out] dst String to append SGML to /// \param[in] src Unicode string /// \param[in] charset Charset (stdex::charset_id::default - system default) /// @@ -254,7 +254,7 @@ namespace stdex /// /// Convert Unicode string (UTF-16 on Windows) to SGML /// - /// \param[inout] dst String to write SGML to + /// \param[in,out] dst String to write SGML to /// \param[in] src Unicode string /// \param[in] count_src Unicode string character count limit /// \param[in] charset Charset (stdex::charset_id::default - system default) @@ -271,7 +271,7 @@ namespace stdex /// /// Convert Unicode string (UTF-16 on Windows) to SGML /// - /// \param[inout] dst String to write SGML to + /// \param[in,out] dst String to write SGML to /// \param[in] src Unicode string /// \param[in] charset Charset (stdex::charset_id::default - system default) /// diff --git a/include/stdex/vector_queue.hpp b/include/stdex/vector_queue.hpp index 1e8fbab13..e0305c0d4 100644 --- a/include/stdex/vector_queue.hpp +++ b/include/stdex/vector_queue.hpp @@ -89,7 +89,7 @@ namespace stdex /// /// Moves existing queue. /// - /// \param[inout] other Queue to move + /// \param[in,out] other Queue to move /// vector_queue(_Inout_ vector_queue &&other) : m_data (std::move(other.m_data )), @@ -131,7 +131,7 @@ namespace stdex /// /// Moves existing queue. /// - /// \param[inout] other Queue to move + /// \param[in,out] other Queue to move /// vector_queue& operator=(_Inout_ vector_queue &&other) {