Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gammasoft71 committed Feb 25, 2025
1 parent 3ff8fcc commit af81e2b
Show file tree
Hide file tree
Showing 142 changed files with 408 additions and 408 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@
* Free and open-source ([MIT License](https://gammasoft71.github.io/xtd/docs/documentation/license));
* a collection of native C++ classes libraries, to **extend** std;
* API close to the .net API with a modern C++ approach and full integration with the std standard;
* xtd is designed to manage GUI controls and dialogs in pure [native mode](https://gammasoft71.github.io/xtd/docs/documentation/Guides/xtd.forms/Overview/control_appearance) or with [CSS styles](https://gammasoft71.github.io/xtd/docs/documentation/Guides/xtd.forms/Style%20sheets/style_sheets_overview).
* xtd is designed to manage GUI controls and dialogs in pure [native mode](https://gammasoft71.github.io/xtd/docs/documentation/guides/xtd.forms/Overview/control_appearance) or with [CSS styles](https://gammasoft71.github.io/xtd/docs/documentation/guides/xtd.forms/Style%20sheets/style_sheets_overview).
* written in efficient, modern [C++17/20](https://en.cppreference.com/w/) with [RAII](https://en.cppreference.com/w/cpp/language/raii) programming idiom;
* and [highly portable](https://gammasoft71.github.io/xtd/docs/documentation/portability) and available on [many different platforms](https://gammasoft71.github.io/xtd/docs/documentation/portability);
* See [features](https://gammasoft71.github.io/xtd/docs/documentation/features) for more informations.

## xtd libraries architecture

[![architecture_logo](https://github.com/gammasoft71/xtd/blob/master/docs/pictures/block_diagram_onion.png)](https://gammasoft71.github.io/xtd/docs/documentation/Guides/Overview/Libraries/hierarchy)
[![architecture_logo](https://github.com/gammasoft71/xtd/blob/master/docs/pictures/block_diagram_onion.png)](https://gammasoft71.github.io/xtd/docs/documentation/guides/Overview/Libraries/hierarchy)

xtd is composed of several libraries.

Expand All @@ -55,7 +55,7 @@ The [xtd.tunit](https://gammasoft71.github.io/xtd/reference_guides/latest/group_
## Getting Started

* [Installation](https://gammasoft71.github.io/xtd/docs/downloads) provides download, install and uninstall documentation.
* [Guides](https://gammasoft71.github.io/xtd/docs/documentation/Guides) provides xtd guides and tutorials.
* [Guides](https://gammasoft71.github.io/xtd/docs/documentation/guides) provides xtd guides and tutorials.
* [Examples](https://github.com/gammasoft71/xtd/blob/master/examples/README.md) provides over 800 examples to help you use xtd, grouped by libraries and topics.

## Development status
Expand Down
8 changes: 4 additions & 4 deletions docs/doxygen/doxygen/main_page.dox
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@
/// * Free and open-source ([MIT License](https://gammasoft71.github.io/xtd/docs/documentation/license));
/// * a collection of native C++ classes libraries, to complete std;
/// * API close to the .net API with a modern C++ approach and full integration with the std standard;
/// * xtd is designed to manage GUI controls and dialogs in pure [native mode](https://gammasoft71.github.io/xtd/docs/documentation/Guides/xtd.forms/Overview/control_appearance) or with [CSS styles](https://gammasoft71.github.io/xtd/docs/documentation/Guides/xtd.forms/Style%20sheets/style_sheets_overview).
/// * xtd is designed to manage GUI controls and dialogs in pure [native mode](https://gammasoft71.github.io/xtd/docs/documentation/guides/xtd.forms/Overview/control_appearance) or with [CSS styles](https://gammasoft71.github.io/xtd/docs/documentation/guides/xtd.forms/Style%20sheets/style_sheets_overview).
/// * written in efficient, modern [C++ 17/20](https://en.cppreference.com/w/) with [RAII](https://en.cppreference.com/w/cpp/language/raii) programming idiom;
/// * and [highly](https://gammasoft71.github.io/xtd/docs/documentation/portability) portable and available on [many different platforms](https://gammasoft71.github.io/xtd/docs/documentation/portability) (Windows, macOS, Linux, iOS and android);
/// * See [features](https://gammasoft71.github.io/xtd/docs/documentation/features) for more informations.
///
/// @section xtdLibrariesArchitectureSection xtd libraries architecture
///
/// [![](block_diagram_onion.png)](https://gammasoft71.github.io/xtd/docs/documentation/Guides/Overview/Libraries/hierarchy)
/// [![](block_diagram_onion.png)](https://gammasoft71.github.io/xtd/docs/documentation/guides/Overview/Libraries/hierarchy)
///
/// xtd is composed of several libraries.
///
Expand All @@ -38,11 +38,11 @@
/// [![](xtd.tunit.png)](https://gammasoft71.github.io/xtd/reference_guides/latest/group__xtd__tunit.html)
/// The [xtd.tunit](https://gammasoft71.github.io/xtd/reference_guides/latest/group__xtd__tunit.html) library is a unit-testing framework for modern C++17/20 inspired by [Microsoft.VisualStudio.TestTools.Cpp](https://docs.microsoft.com/en-us/visualstudio/test/microsoft-visualstudio-testtools-cppunittestframework-api-reference).
///
/// See [xtd libraries hierarchy](https://gammasoft71.github.io/xtd/docs/documentation/Guides/Overview/Libraries/hierarchy).
/// See [xtd libraries hierarchy](https://gammasoft71.github.io/xtd/docs/documentation/guides/Overview/Libraries/hierarchy).
///
/// @section GettingStartedSection Getting Started
/// * [Installation](https://gammasoft71.github.io/xtd/docs/downloads) provides download, install and uninstall documentation.
/// * [Guide](https://gammasoft71.github.io/xtd/docs/documentation/Guides) provides xtd guides and tutorials.
/// * [Guide](https://gammasoft71.github.io/xtd/docs/documentation/guides) provides xtd guides and tutorials.
/// * [Examples](https://github.com/gammasoft71/xtd/blob/master/examples/README.md) provides over 800 examples to help you use xtd, grouped by libraries and topics.
///
/// @section ExamplesSection Examples
Expand Down
8 changes: 4 additions & 4 deletions docs/doxygen/doxygen_developer/main_page.dox
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@
/// * Free and open-source ([MIT License](https://gammasoft71.github.io/xtd/docs/documentation/license));
/// * a collection of native C++ classes libraries, to complete std;
/// * API close to the .net API with a modern C++ approach and full integration with the std standard;
/// * xtd is designed to manage GUI controls and dialogs in pure [native mode](https://gammasoft71.github.io/xtd/docs/documentation/Guides/xtd.forms/Overview/control_appearance) or with [CSS styles](https://gammasoft71.github.io/xtd/docs/documentation/Guides/xtd.forms/Style%20sheets/style_sheets_overview).
/// * xtd is designed to manage GUI controls and dialogs in pure [native mode](https://gammasoft71.github.io/xtd/docs/documentation/guides/xtd.forms/Overview/control_appearance) or with [CSS styles](https://gammasoft71.github.io/xtd/docs/documentation/guides/xtd.forms/Style%20sheets/style_sheets_overview).
/// * written in efficient, modern [C++ 17/20](https://en.cppreference.com/w/) with [RAII](https://en.cppreference.com/w/cpp/language/raii) programming idiom;
/// * and [highly](https://gammasoft71.github.io/xtd/docs/documentation/portability) portable and available on [many different platforms](https://gammasoft71.github.io/xtd/docs/documentation/portability) (Windows, macOS, Linux, iOS and android);
/// * See [features](https://gammasoft71.github.io/xtd/docs/documentation/features) for more informations.
///
/// @section xtdLibrariesArchitectureSection xtd libraries architecture
///
/// [![](block_diagram_onion.png)](https://gammasoft71.github.io/xtd/docs/documentation/Guides/Overview/Libraries/hierarchy)
/// [![](block_diagram_onion.png)](https://gammasoft71.github.io/xtd/docs/documentation/guides/Overview/Libraries/hierarchy)
///
/// xtd is composed of several libraries.
///
Expand All @@ -38,11 +38,11 @@
/// [![](xtd.tunit.png)](https://gammasoft71.github.io/xtd/reference_guides/latest/group__xtd__tunit.html)
/// The [xtd.tunit](https://gammasoft71.github.io/xtd/reference_guides/latest/group__xtd__tunit.html) library is a unit-testing framework for modern C++17/20 inspired by [Microsoft.VisualStudio.TestTools.Cpp](https://docs.microsoft.com/en-us/visualstudio/test/microsoft-visualstudio-testtools-cppunittestframework-api-reference).
///
/// See [xtd libraries hierarchy](https://gammasoft71.github.io/xtd/docs/documentation/Guides/Overview/Libraries/hierarchy).
/// See [xtd libraries hierarchy](https://gammasoft71.github.io/xtd/docs/documentation/guides/Overview/Libraries/hierarchy).
///
/// @section GettingStartedSection Getting Started
/// * [Installation](https://gammasoft71.github.io/xtd/docs/downloads) provides download, install and uninstall documentation.
/// * [Guide](https://gammasoft71.github.io/xtd/docs/documentation/Guides) provides xtd guides and tutorials.
/// * [Guide](https://gammasoft71.github.io/xtd/docs/documentation/guides) provides xtd guides and tutorials.
/// * [Examples](https://github.com/gammasoft71/xtd/blob/master/examples/README.md) provides over 800 examples to help you use xtd, grouped by libraries and topics.
///
/// @section ExamplesSection Examples
Expand Down
10 changes: 5 additions & 5 deletions scripts/cmake/xtd_commands.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -1867,7 +1867,7 @@ macro(write_resources_file_header)
"namespace ${TARGET_DEFAULT_NAMESPACE}::properties {\n"
" /// @brief A strongly-typed resource class, for looking up localized strings, etc.\n"
" /// @details This class was auto-generated by CMake script. To add or remove a member, edit your CMakeList.txt or properties/resources.cmake file then rerun cmake tools.\n"
" /// @remarks See [Resources](https://gammasoft71.github.io/xtd/docs/documentation/Guides/xtd.core/resources) for more informations.\n"
" /// @remarks See [Resources](https://gammasoft71.github.io/xtd/docs/documentation/guides/xtd.core/resources) for more informations.\n"
" class resources final static_ {\n"
" public:\n"
" /// @name Public Static Properties\n"
Expand Down Expand Up @@ -1985,7 +1985,7 @@ macro(write_settings_file_header)
"namespace ${TARGET_DEFAULT_NAMESPACE}::properties {\n"
" /// @brief A strongly typed settings class, for storing user and system settings\n"
" /// @details This class was auto-generated by CMake script. To add or remove a member, edit your CMakeList.txt or properties/settings.cmake file then rerun cmake tools.\n"
" /// @remarks See [Settings](https://gammasoft71.github.io/xtd/docs/documentation/Guides/xtd.core/settings) for more informations.\n"
" /// @remarks See [Settings](https://gammasoft71.github.io/xtd/docs/documentation/guides/xtd.core/settings) for more informations.\n"
" class settings : public xtd::object {\n"
" public:\n"
" /// @name Public Constructors\n"
Expand Down Expand Up @@ -2050,7 +2050,7 @@ macro(write_settings_file_header)
"\n"
" /// @{\n"
" /// @brief Reload all properties with the last saved values.\n"
" /// @remarks See [Settings](https://gammasoft71.github.io/xtd/docs/documentation/Guides/xtd.core/settings) for more informations.\n"
" /// @remarks See [Settings](https://gammasoft71.github.io/xtd/docs/documentation/guides/xtd.core/settings) for more informations.\n"
" void reload() noexcept {\n"
)

Expand All @@ -2068,7 +2068,7 @@ macro(write_settings_file_header)

file(APPEND ${SETTINGS_FILE_HEADER}
" /// @brief Reset all properties to their default values.\n"
" /// @remarks See [Settings](https://gammasoft71.github.io/xtd/docs/documentation/Guides/xtd.core/settings) for more informations.\n"
" /// @remarks See [Settings](https://gammasoft71.github.io/xtd/docs/documentation/guides/xtd.core/settings) for more informations.\n"
" void reset() noexcept {\n"
" settings_.reset();\n"
" *this = settings {false};\n"
Expand All @@ -2078,7 +2078,7 @@ macro(write_settings_file_header)

file(APPEND ${SETTINGS_FILE_HEADER}
" /// @brief Save all properties.\n"
" /// @remarks See [Settings](https://gammasoft71.github.io/xtd/docs/documentation/Guides/xtd.core/settings) for more informations.\n"
" /// @remarks See [Settings](https://gammasoft71.github.io/xtd/docs/documentation/guides/xtd.core/settings) for more informations.\n"
" void save() noexcept {\n"
)

Expand Down
2 changes: 1 addition & 1 deletion src/xtd.core/include/xtd/boolean.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ namespace xtd {
/// @par Library
/// xtd.core
/// @ingroup xtd_core types
/// @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).
/// @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).
using boolean = bool;
/// @}
}
2 changes: 1 addition & 1 deletion src/xtd.core/include/xtd/box.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ namespace xtd {
/// @remarks Use xtd::boxing to box an object.
/// @remarks Use xtd::unboxing to unbox an object.
/// @remarks The boxed object must implement operator == and operator < because a xtd::box implement xtd::icomparable and xtd::iequatable interfaces.
/// @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).
/// @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).
/// @par Examples
/// The following example shows how to create and use xtd::box<bool>.
/// ```cpp
Expand Down
2 changes: 1 addition & 1 deletion src/xtd.core/include/xtd/box_char.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ namespace xtd {
/// @remarks You can use xtd::box to represent a class or structure that does not inherit from xtd::object. Typically used for integral types.
/// @remarks Use xtd::boxing to box an object.
/// @remarks Use xtd::unboxing to unbox an object.
/// @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).
/// @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).
/// @par Examples
/// The following example shows how to create and use xtd::box_char<char8>.
/// ```cpp
Expand Down
2 changes: 1 addition & 1 deletion src/xtd.core/include/xtd/box_floating_point.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ namespace xtd {
/// @remarks You can use xtd::box to represent a class or structure that does not inherit from xtd::object. Typically used for integral types.
/// @remarks Use xtd::boxing to box an object.
/// @remarks Use xtd::unboxing to unbox an object.
/// @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).
/// @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).
/// @par Examples
/// The following example shows how to create and use xtd::box_floating_point<float>.
/// ```cpp
Expand Down
2 changes: 1 addition & 1 deletion src/xtd.core/include/xtd/box_integer.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ namespace xtd {
/// @remarks You can use xtd::box to represent a class or structure that does not inherit from xtd::object. Typically used for integral types.
/// @remarks Use xtd::boxing to box an object.
/// @remarks Use xtd::unboxing to unbox an object.
/// @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).
/// @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).
/// @par Examples
/// The following example shows how to create and use xtd::box_integer<int32>.
/// ```cpp
Expand Down
4 changes: 2 additions & 2 deletions src/xtd.core/include/xtd/boxing.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ namespace xtd {
/// @par Library
/// xtd.core
/// @ingroup xtd_core system
/// @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).
/// @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>
inline auto boxing(const type_t& value) noexcept {return typename __box_enum_or_object__<type_t, typename std::is_enum<type_t>::type>::type(value);}
/// @brief Allows to box an object
Expand All @@ -63,7 +63,7 @@ namespace xtd {
/// @par Library
/// xtd.core
/// @ingroup xtd_core system
/// @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).
/// @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...);}
/// @}
Expand Down
2 changes: 1 addition & 1 deletion src/xtd.core/include/xtd/byte.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ namespace xtd {
/// @par Library
/// xtd.core
/// @ingroup xtd_core types
/// @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).
/// @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).
using byte = uint8_t;
/// @}
}
2 changes: 1 addition & 1 deletion src/xtd.core/include/xtd/byte_object.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ namespace xtd {
/// @par Library
/// xtd.core
/// @ingroup xtd_core system types
/// @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).
/// @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).
/// @par Examples
/// The following example shows how to create and use xtd::byte_object.
/// ```cpp
Expand Down
2 changes: 1 addition & 1 deletion src/xtd.core/include/xtd/char.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ namespace xtd {
/// xtd.core
/// @ingroup xtd_core types
/// @remarks Represents a 32-bit unicode character on Linux and many other non-Windows systems, but a 16-bit unicode character on Windows.
/// @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).
/// @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).
using char_ = char;
/// @}
}
2 changes: 1 addition & 1 deletion src/xtd.core/include/xtd/char16.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ namespace xtd {
/// @par Library
/// xtd.core
/// @ingroup xtd_core types
/// @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).
/// @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).
using char16 = char16_t;
/// @}
}
2 changes: 1 addition & 1 deletion src/xtd.core/include/xtd/char16_object.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ namespace xtd {
/// @par Library
/// xtd.core
/// @ingroup xtd_core system types
/// @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).
/// @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).
/// @par Examples
/// The following example shows how to create and use xtd::char16_object.
/// ```cpp
Expand Down
2 changes: 1 addition & 1 deletion src/xtd.core/include/xtd/char32.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ namespace xtd {
/// @par Library
/// xtd.core
/// @ingroup xtd_core types
/// @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).
/// @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).
using char32 = char32_t;
/// @}
}
Loading

0 comments on commit af81e2b

Please sign in to comment.