Skip to content

Commit 8f6f31b

Browse files
committed
Added copyright notices and documentation to added functions
1 parent 2094309 commit 8f6f31b

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

include/libdbc/utils/utils.hpp

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,15 @@ class StreamHandler {
3737
static std::istream& skip_to_next_blank_line(std::istream& stream, std::string& line);
3838
};
3939

40+
/**
41+
* @brief Trims the specified characters from the beginning and end of the given string.
42+
*
43+
* @tparam T The typeparam; must be stringable.
44+
* @param value The string to trim.
45+
* @return A new string with the specified characters trimmed.
46+
*
47+
* @copyright 2025 Procyon Systems Inh. Simon Cahill (s.cahill@procyon-systems.de)
48+
*/
4049
#if __cplusplus >= 201703
4150
# if __cpp_concepts >= 201907
4251
template<procsys_stringable T>
@@ -54,6 +63,16 @@ std::string trim(const T& value) {
5463
return trimmedValue;
5564
}
5665

66+
/**
67+
* @brief Trims the specified characters from the beginning and end of the given string.
68+
*
69+
* @tparam T The typeparam; must be stringable.
70+
* @param value The string to trim.
71+
* @param trimChars The characters to trim from the string.
72+
* @return A new string with the specified characters trimmed.
73+
*
74+
* @copyright 2025 Procyon Systems Inh. Simon Cahill (s.cahill@procyon-systems.de)
75+
*/
5776
#if __cplusplus >= 201703
5877
# if __cpp_concepts >= 201907
5978
template<procsys_stringable T>
@@ -71,6 +90,16 @@ std::string trim(const T& value, const std::initializer_list<char>& trimChars)
7190
return trimmedValue;
7291
}
7392

93+
/**
94+
* @brief Trims the specified characters from the beginning and end of the given string.
95+
*
96+
* @tparam T The typeparam; must be stringable.
97+
* @param value The string to trim.
98+
* @param trimChars The characters to trim from the string.
99+
* @return A new string with the specified characters trimmed.
100+
*
101+
* @copyright 2025 Procyon Systems Inh. Simon Cahill (s.cahill@procyon-systems.de)
102+
*/
74103
#if __cplusplus >= 201703L
75104
# if __cpp_concepts >= 201907
76105
template<procsys_stringable T>
@@ -89,6 +118,8 @@ constexpr auto trim(const T& value, const std::string_view& trimChars) { return
89118
*
90119
* @return true If the string is empty or consists only of whitespace.
91120
* @return false Otherwise.
121+
*
122+
* @copyright 2025 Procyon Systems Inh. Simon Cahill (s.cahill@procyon-systems.de)
92123
*/
93124
template<typename T>
94125
constexpr bool isWhitespaceOrEmpty(const T& str) {

0 commit comments

Comments
 (0)