Updated documentation

Author: glynos

docs/Doxyfile.in

@@ -794,6 +794,7 @@ WARN_LOGFILE           =
 INPUT                  = @CMAKE_SOURCE_DIR@/include/skyr/config.hpp \
                          @CMAKE_SOURCE_DIR@/include/skyr/domain.hpp \
                          @CMAKE_SOURCE_DIR@/include/skyr/expected.hpp \
+                         @CMAKE_SOURCE_DIR@/include/skyr/filesystem.hpp \
                          @CMAKE_SOURCE_DIR@/include/skyr/ipv4_address.hpp \
                          @CMAKE_SOURCE_DIR@/include/skyr/ipv6_address.hpp \
                          @CMAKE_SOURCE_DIR@/include/skyr/optional.hpp \

docs/filesystem.rst

@@ -0,0 +1,10 @@
+`std::filesystem::path`
+======================
+
+.. doxygennamespace:: skyr::filesystem
+
+.. doxygenfunction:: skyr::filesystem::from_path
+
+.. doxygenfunction:: skyr::filesystem::to_path
+
+.. doxygenenum:: skyr::filesystem::path_errc

docs/unicode.rst

@@ -1,16 +1,18 @@
 Unicode encoding
 ================
 
-.. doxygenfunction:: skyr::wstring_to_bytes
+.. doxygennamespace:: skyr::unicode
 
-.. doxygenfunction:: skyr::wstring_from_bytes
+.. doxygenfunction:: skyr::unicode::wstring_to_bytes
 
-.. doxygenfunction:: skyr::utf16_to_bytes
+.. doxygenfunction:: skyr::unicode::wstring_from_bytes
 
-.. doxygenfunction:: skyr::utf16_from_bytes
+.. doxygenfunction:: skyr::unicode::utf16_to_bytes
 
-.. doxygenfunction:: skyr::utf32_to_bytes
+.. doxygenfunction:: skyr::unicode::utf16_from_bytes
 
-.. doxygenfunction:: skyr::utf32_from_bytes
+.. doxygenfunction:: skyr::unicode::utf32_to_bytes
 
-.. doxygenenum:: skyr::unicode_errc
+.. doxygenfunction:: skyr::unicode::utf32_from_bytes
+
+.. doxygenenum:: skyr::unicode::unicode_errc

include/skyr/filesystem.hpp

@@ -12,16 +12,29 @@
 #include <skyr/url.hpp>
 
 namespace skyr {
+/// \namespace filesystem
+/// Contains functions to convert from filesystem path to URLs and
+/// vice versa
 namespace filesystem {
 enum class path_errc {
   invalid_path=1,
   percent_decoding_error=2,
 };
 
+/// Creates a `std::error_code` given a `skyr::path_errc` value
+/// \param error A filesystem path conversion error
+/// \returns A `std::error_code` object
 std::error_code make_error_code(path_errc error);
 
+/// Converts a path object to a URL with a file protocol. Handles
+/// some processing, including percent encoding
+/// \param path A filesystem path
+/// \returns a url object or an error on failure
 expected<url, std::error_code> from_path(const std::filesystem::path &path);
 
+/// Converts a URL pathname to a filesystem path
+/// \param input A url object
+/// \returns a path object or an error on failure
 expected<std::filesystem::path, std::error_code> to_path(const url &input);
 }  // namespace filesystem
 }  // namespace skyr