iox-eclipse-iceoryx#1942 Add description for all semantic strings

Signed-off-by: Christian Eltzschig <[email protected]>
ApexAI · Apr 3, 2023 · 59e29aa · 59e29aa
1 parent 84d9f09
commit 59e29aa
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 0 deletions.
diff --git a/iceoryx_hoofs/posix/vocabulary/include/iox/file_name.hpp b/iceoryx_hoofs/posix/vocabulary/include/iox/file_name.hpp
@@ -27,6 +27,8 @@ bool file_name_does_contain_invalid_characters(const string<platform::IOX_MAX_FI
 bool file_name_does_contain_invalid_content(const string<platform::IOX_MAX_FILENAME_LENGTH>& value) noexcept;
 } // namespace details
 
+/// @brief Represents a single file name. It is not allowed to contain any path elements
+///        like "./some_file" or "path/to/file". Just a plain old simple "my_file.bla".
 class FileName : public SemanticString<FileName,
                                        platform::IOX_MAX_FILENAME_LENGTH,
                                        details::file_name_does_contain_invalid_content,

diff --git a/iceoryx_hoofs/posix/vocabulary/include/iox/file_path.hpp b/iceoryx_hoofs/posix/vocabulary/include/iox/file_path.hpp
@@ -27,6 +27,9 @@ bool file_path_does_contain_invalid_characters(const string<platform::IOX_MAX_PA
 bool file_path_does_contain_invalid_content(const string<platform::IOX_MAX_PATH_LENGTH>& value) noexcept;
 } // namespace details
 
+/// @brief Represents a path to a file. It is not allowed to end with a path separator
+///        since this would then be a path to a directory. A valid file path is for
+///        instance "path/to/file" but not "path/to/file/".
 class FilePath : public SemanticString<FilePath,
                                        platform::IOX_MAX_PATH_LENGTH,
                                        details::file_path_does_contain_invalid_content,

diff --git a/iceoryx_hoofs/posix/vocabulary/include/iox/group_name.hpp b/iceoryx_hoofs/posix/vocabulary/include/iox/group_name.hpp
@@ -28,6 +28,7 @@ bool group_name_does_contain_invalid_characters(const string<platform::MAX_GROUP
 bool group_name_does_contain_invalid_content(const string<platform::MAX_GROUP_NAME_LENGTH>& value) noexcept;
 } // namespace details
 
+/// @brief Represents a POSIX group name
 class GroupName : public SemanticString<GroupName,
                                         platform::MAX_GROUP_NAME_LENGTH,
                                         details::group_name_does_contain_invalid_content,

diff --git a/iceoryx_hoofs/posix/vocabulary/include/iox/path.hpp b/iceoryx_hoofs/posix/vocabulary/include/iox/path.hpp
@@ -27,6 +27,7 @@ namespace details
 bool path_does_contain_invalid_content(const string<platform::IOX_MAX_PATH_LENGTH>& value) noexcept;
 } // namespace details
 
+/// @brief Represents a path to a file or a directory.
 class Path : public SemanticString<Path,
                                    platform::IOX_MAX_PATH_LENGTH,
                                    details::path_does_contain_invalid_content,

diff --git a/iceoryx_hoofs/posix/vocabulary/include/iox/user_name.hpp b/iceoryx_hoofs/posix/vocabulary/include/iox/user_name.hpp
@@ -27,6 +27,7 @@ bool user_name_does_contain_invalid_characters(const string<platform::MAX_USER_N
 bool user_name_does_contain_invalid_content(const string<platform::MAX_USER_NAME_LENGTH>& value) noexcept;
 } // namespace details
 
+/// @brief Represents a POSIX user name
 class UserName : public SemanticString<UserName,
                                        platform::MAX_USER_NAME_LENGTH,
                                        details::user_name_does_contain_invalid_content,