From bc8d819f2718f4756956ec313638bd07c330e1ad Mon Sep 17 00:00:00 2001 From: Gammasoft Date: Mon, 16 Dec 2024 12:22:23 +0100 Subject: [PATCH] Add documentation --- src/xtd.core/include/xtd/print.hpp | 24 +++++++++++++++++++++--- src/xtd.core/include/xtd/println.hpp | 1 - 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/src/xtd.core/include/xtd/print.hpp b/src/xtd.core/include/xtd/print.hpp index 6c9dec67afc..d26f9262185 100644 --- a/src/xtd.core/include/xtd/print.hpp +++ b/src/xtd.core/include/xtd/print.hpp @@ -19,22 +19,40 @@ namespace xtd { /// @brief Writes the text representation of the specified list of values to the standard output stream using the specified format information. /// @tparam ...args_t Types of the values to write. + /// @param fmt A composite format string. /// @param values Values to write, template void print(const xtd::string& fmt, args_t&& ... values) {xtd::console::write(xtd::string::format(fmt, std::forward(values)...));} - - /// @cond + /// @brief Writes the text representation of the specified list of values to the standard output stream using the specified format information. + /// @tparam ...args_t Types of the values to write. + /// @param fmt A composite format string. + /// @param values Values to write, template void print(const char* fmt, args_t&& ... values) {xtd::console::write(xtd::string::format(xtd::string {fmt}, std::forward(values)...));} #if defined(__xtd__cpp_lib_char8_t) + /// @brief Writes the text representation of the specified list of values to the standard output stream using the specified format information. + /// @tparam ...args_t Types of the values to write. + /// @param fmt A composite format string. + /// @param values Values to write, template void print(const char8_t* fmt, args_t&& ... values) {xtd::console::write(xtd::string::format(xtd::string {fmt}, std::forward(values)...));} #endif + /// @brief Writes the text representation of the specified list of values to the standard output stream using the specified format information. + /// @tparam ...args_t Types of the values to write. + /// @param fmt A composite format string. + /// @param values Values to write, template void print(const char16_t* fmt, args_t&& ... values) {xtd::console::write(xtd::string::format(xtd::string {fmt}, std::forward(values)...));} + /// @brief Writes the text representation of the specified list of values to the standard output stream using the specified format information. + /// @tparam ...args_t Types of the values to write. + /// @param fmt A composite format string. + /// @param values Values to write, template void print(const char32_t* fmt, args_t&& ... values) {xtd::console::write(xtd::string::format(xtd::string {fmt}, std::forward(values)...));} + /// @brief Writes the text representation of the specified list of values to the standard output stream using the specified format information. + /// @tparam ...args_t Types of the values to write. + /// @param fmt A composite format string. + /// @param values Values to write, template void print(const wchar_t* fmt, args_t&& ... values) {xtd::console::write(xtd::string::format(xtd::string {fmt}, std::forward(values)...));} - /// @endcond } diff --git a/src/xtd.core/include/xtd/println.hpp b/src/xtd.core/include/xtd/println.hpp index 684ecbfa47d..41fe27b7da2 100644 --- a/src/xtd.core/include/xtd/println.hpp +++ b/src/xtd.core/include/xtd/println.hpp @@ -26,7 +26,6 @@ namespace xtd { /// @param values Values to write, template void println(const xtd::string& fmt, args_t&& ... values) {xtd::console::write_line(xtd::string::format(fmt, std::forward(values)...));} - /// @brief Writes the text representation of the specified list of values, followed by the current line terminator, to the standard output stream using the specified format information. /// @tparam ...args_t Types of the values to write. /// @param fmt A composite format string.