Add documentation

Author: gammasoft71

src/xtd.core/include/xtd/basic_array.hpp

@@ -8,6 +8,9 @@
 
 /// @brief The xtd namespace contains all fundamental classes to access Hardware, Os, System, and more.
 namespace xtd {  
+  /// @name Aliases
+  
+  /// @{
   /// @brief Represents the type to array type.
   /// @par Header
   /// ```cpp
@@ -20,8 +23,9 @@ namespace xtd {
   /// @ingroup xtd_core system
   template<class type_t>
   using type_to_array_t = typename std::conditional<std::is_same<bool, type_t>::value, char, type_t>::type;
+  /// @}
 
-/// @brief Base object that represent array.
+  /// @brief Base object that represent array.
   /// @par Definition
   /// ```cpp
   /// template<class type_t, class allocator_t = xtd::collections::generic::helpers::allocator<type_t>>

src/xtd.core/include/xtd/boolean_object.hpp

@@ -7,6 +7,9 @@
 
 /// @brief The xtd namespace contains all fundamental classes to access Hardware, Os, System, and more.
 namespace xtd {
+  /// @name Aliases
+  
+  /// @{
   /// @brief Represent a boxed bool.
   /// @par Header
   /// ```cpp
@@ -27,4 +30,5 @@ namespace xtd {
   /// console::write_line("result = {}", result); // Display: result = true;
   /// ```
   using boolean_object = box<bool>;
+  /// @}
 }

src/xtd.core/include/xtd/boxing.hpp

@@ -31,6 +31,9 @@
 
 /// @brief The xtd namespace contains all fundamental classes to access Hardware, Os, System, and more.
 namespace xtd {
+  /// @name Static Methods
+  
+  /// @{
   /// @brief Allows to box an object
   /// @param value Value used to initialize object.
   /// @return Boxed object.
@@ -63,6 +66,7 @@ namespace xtd {
   /// @remarks For more information about types, see [Native types, boxing and unboxing](https://gammasoft71.github.io/xtd/docs/documentation/Guides/xtd.core/Types%20overview/types).
   template<class type_t, class ...args_t>
   inline box<type_t> boxing(args_t&& ...args) noexcept {return box<type_t>(args...);}
+  /// @}
 
   /// @cond
   inline const object& boxing(const object& value) noexcept {return value;}

src/xtd.core/include/xtd/collections/generic/helpers/allocator.hpp

@@ -12,6 +12,9 @@ namespace xtd {
     namespace generic {
       /// @brief The xtd::collections::generic::helpers namespace contains helpers for generic collections, sush as comparer, equator an hasher structs.
       namespace helpers {
+        /// @name Aliases
+        
+        /// @{
         /// @brief Represent an allocator alias.
         /// @par Header
         /// ```cpp
@@ -33,6 +36,7 @@ namespace xtd {
         /// ```
         template<class type_t>
         using allocator = std::allocator<type_t>;
+        /// @}
       }
     }
   }

src/xtd.core/include/xtd/collections/generic/helpers/iterator.hpp

@@ -14,6 +14,9 @@ namespace xtd {
     namespace generic {
       /// @brief The xtd::collections::generic::helpers namespace contains helpers for generic collections, sush as comparer, equator an hasher structs.
       namespace helpers {
+        /// @name Aliases
+        
+        /// @{
         /// @brief Represents the value iterator type.
         /// @par Header
         /// ```cpp
@@ -65,6 +68,7 @@ namespace xtd {
         /// @ingroup xtd_core helpers_generic_collections
         template< class input_iterator_t >
         using iterator_to_allocator_t = std::pair<std::add_const_t<iterator_key_t<input_iterator_t>>, iterator_mapped_t<input_iterator_t>>;
+        /// @}
       }
     }
   }

src/xtd.core/include/xtd/register_any_stringer.hpp

@@ -21,6 +21,9 @@ inline std::pair<const std::type_index, std::function<std::string(std::any const
 
 /// @brief The xtd namespace contains all fundamental classes to access Hardware, Os, System, and more.
 namespace xtd {
+  /// @name Static Methods
+  
+  /// @{
   /// @brief Register an any stringer method for a specified type.
   /// @param func Function to register any stringer for specified type.
   /// @par Namespace
@@ -36,4 +39,5 @@ namespace xtd {
     unregister_any_stringer<type_t>();
     __any_stringer__.insert(__to_any_stringer__<type_t>(func));
   }
+  /// @}
 }

src/xtd.core/include/xtd/size_object.hpp

@@ -7,6 +7,9 @@
 
 /// @brief The xtd namespace contains all fundamental classes to access Hardware, Os, System, and more.
 namespace xtd {
+  /// @name Aliases
+  
+  /// @{
   /// @brief Represent a boxed size_t.
   /// @par Namespace
   /// xtd
@@ -23,4 +26,5 @@ namespace xtd {
   /// console::write_line("result = {}", result); // Display: result = 42;
   /// ```
   using size_object = box_integer<size_t>;
+  /// @}
 }

src/xtd.core/include/xtd/string_comparer.hpp

@@ -6,6 +6,9 @@
 
 /// @brief The xtd namespace contains all fundamental classes to access Hardware, Os, System, and more.
 namespace xtd {
+  /// @name Aliases
+  
+  /// @{
   /// @brief Represents a string comparison operation that uses specific case and culture-based or ordinal comparison rules.
   /// @par Definition
   /// ```cpp
@@ -21,4 +24,5 @@ namespace xtd {
   /// xtd.core
   /// @ingroup xtd_core system
   using string_comparer = basic_string_comparer<char>;
+  /// @}
 }

src/xtd.core/include/xtd/u16string_comparer.hpp

@@ -7,6 +7,9 @@
 
 /// @brief The xtd namespace contains all fundamental classes to access Hardware, Os, System, and more.
 namespace xtd {
+  /// @name Aliases
+  
+  /// @{
   /// @brief Represents a u16string comparison operation that uses specific case and culture-based or ordinal comparison rules.
   /// @par Definition
   /// ```cpp
@@ -22,4 +25,5 @@ namespace xtd {
   /// xtd.core
   /// @ingroup xtd_core system
   using u16string_comparer = xtd::basic_string_comparer<xtd::char16>;
+  /// @}
 }

src/xtd.core/include/xtd/u32string_comparer.hpp

@@ -7,6 +7,9 @@
 
 /// @brief The xtd namespace contains all fundamental classes to access Hardware, Os, System, and more.
 namespace xtd {
+  /// @name Aliases
+  
+  /// @{
   /// @brief Represents a u32string comparison operation that uses specific case and culture-based or ordinal comparison rules.
   /// @par Definition
   /// ```cpp
@@ -22,4 +25,5 @@ namespace xtd {
   /// xtd.core
   /// @ingroup xtd_core system
   using u32string_comparer = xtd::basic_string_comparer<xtd::char32>;
+  /// @}
 }