Amebis/stdex
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Make inout param designations XCode-friendly

Browse Source
This commit is contained in:
Simon Rozman 2023-09-11 16:12:22 +02:00
parent aa4de5aa40
commit fb66eeb852
7 changed files with 57 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/stdex/base64.hpp
View File

@ -34,7 +34,7 @@ namespace stdex
/// ///
/// Encodes one block of information, and _appends_ it to the output /// Encodes one block of information, and _appends_ it to the output
/// ///
/// \param[out] out Output /// \param[in,out] out Output
/// \param[in] data Data to encode /// \param[in] data Data to encode
/// \param[in] size Length of `data` in bytes /// \param[in] size Length of `data` in bytes
/// \param[in] is_last Is this the last block of data? /// \param[in] is_last Is this the last block of data?
@ -172,7 +172,7 @@ namespace stdex
/// ///
/// Decodes one block of information, and _appends_ it to the output /// Decodes one block of information, and _appends_ it to the output
/// ///
/// \param[out] out Output /// \param[in,out] out Output
/// \param[in] is_last Was this the last block of data? /// \param[in] is_last Was this the last block of data?
/// \param[in] data Data to decode /// \param[in] data Data to decode
/// \param[in] size Length of `data` in bytes /// \param[in] size Length of `data` in bytes

4
include/stdex/hex.hpp
View File

@ -31,7 +31,7 @@ namespace stdex
/// ///
/// Encodes one block of information, and _appends_ it to the output /// Encodes one block of information, and _appends_ it to the output
/// ///
/// \param[out] out Output /// \param[in,out] out Output
/// \param[in] data Data to encode /// \param[in] data Data to encode
/// \param[in] size Length of `data` in bytes /// \param[in] size Length of `data` in bytes
/// ///
@ -89,7 +89,7 @@ namespace stdex
/// ///
/// Decodes one block of information, and _appends_ it to the output /// Decodes one block of information, and _appends_ it to the output
/// ///
/// \param[inout] out Output /// \param[in,out] out Output
/// \param[out] is_last Was this the last block of data? Actually, is this block of data complete? /// \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] data Data to decode
/// \param[in] size Length of `data` in bytes /// \param[in] size Length of `data` in bytes

8
include/stdex/interval.hpp
View File

@ -105,7 +105,7 @@ inline stdex::interval<T> operator+(_In_ const stdex::interval<T>& i, _In_ const
/// ///
/// Moves interval towards the end by one /// Moves interval towards the end by one
/// ///
/// \param[in] i Interval to move /// \param[in,out] i Interval to move
/// ///
/// \returns Moved interval /// \returns Moved interval
/// ///
@ -120,7 +120,7 @@ inline stdex::interval<T> operator++(_Inout_ stdex::interval<T>& i)
/// ///
/// Moves interval towards the end by one /// Moves interval towards the end by one
/// ///
/// \param[in] i Interval to move /// \param[in,out] i Interval to move
/// ///
/// \returns Original interval /// \returns Original interval
/// ///
@ -164,7 +164,7 @@ inline stdex::interval<T> operator-(_In_ const stdex::interval<T>& i, _In_ const
/// ///
/// Moves interval towards the begginning by one /// Moves interval towards the begginning by one
/// ///
/// \param[in] i Interval to move /// \param[in,out] i Interval to move
/// ///
/// \returns Moved interval /// \returns Moved interval
/// ///
@ -179,7 +179,7 @@ inline stdex::interval<T> operator--(_Inout_ stdex::interval<T>& i)
/// ///
/// Moves interval towards the begginning by one /// Moves interval towards the begginning by one
/// ///
/// \param[in] i Interval to move /// \param[in,out] i Interval to move
/// ///
/// \returns Original interval /// \returns Original interval
/// ///

2
include/stdex/math.hpp
View File

@ -1,4 +1,4 @@
/* /*
SPDX-License-Identifier: MIT SPDX-License-Identifier: MIT
Copyright © 2023 Amebis Copyright © 2023 Amebis
*/ */

40
include/stdex/sgml.hpp
View File

@ -82,12 +82,12 @@ namespace stdex
/// ///
/// Convert SGML string to Unicode (UTF-16 on Windows) and append to string /// 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] src SGML string
/// \param[in] count_src SGML string character count limit /// \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] 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] 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 <class T> template <class T>
inline void sgml2wstrcat( inline void sgml2wstrcat(
@ -186,11 +186,11 @@ namespace stdex
/// ///
/// Convert SGML string to Unicode (UTF-16 on Windows) and append to string /// 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] src SGML string
/// \param[in] skip Bitwise flag of stdex::sgml_* constants that list SGML entities to skip converting /// \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] 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 /// \return Unicode string
/// ///
@ -219,13 +219,13 @@ namespace stdex
/// ///
/// Convert SGML string to Unicode (UTF-16 on Windows) and append to string /// 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] 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] src SGML string
/// \param[in] count_src SGML string character count limit /// \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] 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] 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 /// \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) /// 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] src SGML string
/// \param[in] count_src SGML string character count limit /// \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] 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] 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 <class T> template <class T>
inline void sgml2wstrcpy( inline void sgml2wstrcpy(
@ -361,11 +361,11 @@ namespace stdex
/// ///
/// Convert SGML string to Unicode (UTF-16 on Windows) /// 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] src SGML string
/// \param[in] skip Bitwise flag of stdex::sgml_* constants that list SGML entities to skip converting /// \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] 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<class _Elem, class _Traits, class _Ax> template<class _Elem, class _Traits, class _Ax>
inline void sgml2wstrcpy( inline void sgml2wstrcpy(
@ -381,13 +381,13 @@ namespace stdex
/// ///
/// Convert SGML string to Unicode (UTF-16 on Windows) /// 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] 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] src SGML string
/// \param[in] count_src SGML string character count limit /// \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] 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] 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 /// \return Final length of SGML string in code points excluding zero-terminator
/// ///
@ -414,7 +414,7 @@ namespace stdex
/// \param[in] count_src SGML string character count limit /// \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] 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] 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 /// \return Unicode string
/// ///
@ -436,7 +436,7 @@ namespace stdex
/// \param[in] src SGML string /// \param[in] src SGML string
/// \param[in] skip Bitwise flag of stdex::sgml_* constants that list SGML entities to skip converting /// \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] 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 /// \return Unicode string
/// ///
@ -482,7 +482,7 @@ namespace stdex
/// ///
/// Convert Unicode string (UTF-16 on Windows) to SGML and append to string /// 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] src Unicode string
/// \param[in] count_src Unicode string character count limit /// \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 /// \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 /// 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] src Unicode string
/// \param[in] what Bitwise flag of stdex::sgml_* constants that force extra characters otherwise not converted to SGML /// \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 /// 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] 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] src Unicode string
/// \param[in] count_src Unicode string character count limit /// \param[in] count_src Unicode string character count limit
@ -756,7 +756,7 @@ namespace stdex
/// ///
/// Convert Unicode string (UTF-16 on Windows) to SGML /// 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] src Unicode string
/// \param[in] count_src Unicode string character count limit /// \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 /// \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 /// 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] src Unicode string
/// \param[in] what Bitwise flag of stdex::sgml_* constants that force extra characters otherwise not converted to SGML /// \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 /// 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] 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] src Unicode string
/// \param[in] count_src Unicode string character count limit /// \param[in] count_src Unicode string character count limit

16
include/stdex/unicode.hpp
View File

@ -27,7 +27,7 @@ namespace stdex
/// ///
/// Convert string to Unicode (UTF-16 on Windows) and append to string /// 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] src String
/// \param[in] count_src String character count limit /// \param[in] count_src String character count limit
/// \param[in] charset Charset (stdex::charset_id::default - system default) /// \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 /// 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] src String
/// \param[in] charset Charset (stdex::charset_id::default - system default) /// \param[in] charset Charset (stdex::charset_id::default - system default)
/// ///
@ -99,7 +99,7 @@ namespace stdex
/// ///
/// Convert string to Unicode (UTF-16 on Windows) /// 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] src String
/// \param[in] count_src String character count limit /// \param[in] count_src String character count limit
/// \param[in] charset Charset (stdex::charset_id::default - system default) /// \param[in] charset Charset (stdex::charset_id::default - system default)
@ -118,7 +118,7 @@ namespace stdex
/// ///
/// Convert string to Unicode (UTF-16 on Windows) /// 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] src String
/// \param[in] charset Charset (stdex::charset_id::default - system default) /// \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 /// 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] src Unicode string
/// \param[in] count_src Unicode string character count limit /// \param[in] count_src Unicode string character count limit
/// \param[in] charset Charset (stdex::charset_id::default - system default) /// \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 /// 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] src Unicode string
/// \param[in] charset Charset (stdex::charset_id::default - system default) /// \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 /// 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] src Unicode string
/// \param[in] count_src Unicode string character count limit /// \param[in] count_src Unicode string character count limit
/// \param[in] charset Charset (stdex::charset_id::default - system default) /// \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 /// 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] src Unicode string
/// \param[in] charset Charset (stdex::charset_id::default - system default) /// \param[in] charset Charset (stdex::charset_id::default - system default)
/// ///

4
include/stdex/vector_queue.hpp
View File

@ -89,7 +89,7 @@ namespace stdex
/// ///
/// Moves existing queue. /// Moves existing queue.
/// ///
/// \param[inout] other Queue to move /// \param[in,out] other Queue to move
/// ///
vector_queue(_Inout_ vector_queue<value_type> &&other) : vector_queue(_Inout_ vector_queue<value_type> &&other) :
m_data (std::move(other.m_data )), m_data (std::move(other.m_data )),
@ -131,7 +131,7 @@ namespace stdex
/// ///
/// Moves existing queue. /// Moves existing queue.
/// ///
/// \param[inout] other Queue to move /// \param[in,out] other Queue to move
/// ///
vector_queue<value_type>& operator=(_Inout_ vector_queue<value_type> &&other) vector_queue<value_type>& operator=(_Inout_ vector_queue<value_type> &&other)
{ {