Skip to content

Commit 161b051

Browse files
committed
Add documentation
1 parent c31061b commit 161b051

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

src/xtd.core/include/xtd/stringable.hpp

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313

1414
/// @brief The xtd namespace contains all fundamental classes to access Hardware, Os, System, and more.
1515
namespace xtd {
16+
/// @concept xtd::stringable
1617
/// @brief Concept stringable.
1718
/// @par Definition
1819
/// ```cpp
@@ -21,7 +22,7 @@ namespace xtd {
2122
/// ```
2223
/// @par Header
2324
/// ```cpp
24-
/// #include <xtd/helpers/stringable>
25+
/// #include <xtd/stringable>
2526
/// ```
2627
/// @par Namespace
2728
/// xtd
@@ -30,6 +31,9 @@ namespace xtd {
3031
/// @ingroup xtd_core system concepts
3132
/// @return `true` if value_t is derived from xtd::object, or value_t is derived from xtd::istringable, or value_t is derived from xtd::iformatable, or value_t is derived from std::exception, or value_t is an enum, value_t is std::ranges::range, or value_t has output stream operator `<<`; otherwise `false`.
3233
/// @remarks If a type has only a xtd::to_string specialisation, it is always considered not stringable.
34+
/// @par Examples
35+
/// The following code shows how to use xtd::stringable conceps
36+
/// @include stringable.cpp
3337
template<class value_t>
3438
concept stringable =
3539
std::derived_from<std::remove_cvref_t<value_t>, xtd::object> ||

0 commit comments

Comments
 (0)