diff --git a/src/xtd.core.native/include/xtd/native/condition_variable.hpp b/src/xtd.core.native/include/xtd/native/condition_variable.hpp index f1cb8d72dc43..2029ff067af0 100644 --- a/src/xtd.core.native/include/xtd/native/condition_variable.hpp +++ b/src/xtd.core.native/include/xtd/native/condition_variable.hpp @@ -51,19 +51,19 @@ namespace xtd { /// @brief Pulse wainting condition variable with specified condition variable handle. /// @param handle The condition variable handle to pulse. - /// @return true if succeed; otherwhise false. + /// @return `true` if succeed; otherwise `false`. static void pulse(intmax_t handle); /// @brief Pulse all waiting condition variable with specified condition variable handle. /// @param handle The condition variable handle to pulse all. - /// @return true if succeed; otherwhise false. + /// @return `true` if succeed; otherwise `false`. static void pulse_all(intmax_t handle); /// @brief Wait`condition variable with specified condition variable handle. /// @param handle The condition variable handle to release. /// @param critical_section_handle The critical section handle associate to the condition variable handle. /// @param milliseconds_timeout The timeout in milliseconds (-1 is infinite timeout). - /// @return true if succeed; otherwhise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool wait(intmax_t handle, intmax_t critical_section_handle, int32_t milliseconds_timeout); /// @} diff --git a/src/xtd.core.native/include/xtd/native/console.hpp b/src/xtd.core.native/include/xtd/native/console.hpp index 3d8f0c08d3c4..cf1a9a402618 100644 --- a/src/xtd.core.native/include/xtd/native/console.hpp +++ b/src/xtd.core.native/include/xtd/native/console.hpp @@ -43,14 +43,14 @@ namespace xtd { static int32_t background_color(); /// @brief Sets the background color of the console. /// @param color the background console color. - /// @return true if successfull; otherwhise false. + /// @return `true` if successfull; otherwise `false`. /// @warning Internal use only static bool background_color(int32_t color); /// @brief Plays the sound of a beep of a specified frequency and duration through the console speaker. /// @param frequency The frequency of the beep, ranging from 37 to 32767 hertz /// @param duration The duration of the beep measured in milliseconds - /// @return true if successfull; otherwhise false. + /// @return `true` if successfull; otherwise `false`. /// @warning Internal use only static bool beep(uint32_t frequency, uint32_t duration); @@ -60,7 +60,7 @@ namespace xtd { static int32_t buffer_height(); /// @brief Sets or sets the height of the buffer area. /// @param height The current height, in rows, of the buffer area. - /// @return true if successfull; otherwhise false. + /// @return `true` if successfull; otherwise `false`. /// @warning Internal use only static bool buffer_height(int32_t height); /// @brief Gets the width of the buffer area. @@ -70,17 +70,17 @@ namespace xtd { static int32_t buffer_width(); /// @brief Sets the width of the buffer area. /// @param width The current width, in columns, of the buffer area. - /// @return true if successfull; otherwhise false. + /// @return `true` if successfull; otherwise `false`. /// @warning Internal use only static bool buffer_width(int32_t width); /// @brief Gets a value indicating whether the CAPS LOCK keyboard toggle is turned on or turned off. - /// @return true if CAPS LOCK is turned on; false if CAPS LOCK is turned off. + /// @return `true` if CAPS LOCK is turned on; false if CAPS LOCK is turned off. /// @warning Internal use only static bool caps_lock(); /// @brief Clears the console buffer and corresponding console window of display information. - /// @return true if successfull; otherwhise false. + /// @return `true` if successfull; otherwise `false`. /// @warning Internal use only static bool clear(); @@ -95,7 +95,7 @@ namespace xtd { static int32_t cursor_size(); /// @brief Sets the height of the cursor within a character cell. /// @param size The size of the cursor expressed as a percentage of the height of a character cell. The property value ranges from 1 to 100. - /// @return true if successfull; otherwhise false. + /// @return `true` if successfull; otherwise `false`. /// @warning Internal use only static bool cursor_size(int32_t size); @@ -110,7 +110,7 @@ namespace xtd { static bool cursor_visible(); /// @brief Sets a value indicating whether the cursor is visible. /// @param visible true if the cursor is visible; otherwise, false. - /// @return true if successfull; otherwhise false. + /// @return `true` if successfull; otherwise `false`. /// @warning Internal use only static bool cursor_visible(bool visible); @@ -125,7 +125,7 @@ namespace xtd { static int32_t foreground_color(); /// @brief Sets the foreground color of the console. /// @param color the foreground console color. - /// @return true if successfull; otherwhise false. + /// @return `true` if successfull; otherwise `false`. /// @warning Internal use only static bool foreground_color(int32_t color); @@ -135,7 +135,7 @@ namespace xtd { static int32_t input_code_page(); /// @brief Sets the code page the console uses to read input. /// @param code_page The code page used to read console input. - /// @return true if successfull; otherwhise false. + /// @return `true` if successfull; otherwise `false`. /// @warning Internal use only static bool input_code_page(int32_t codePage); @@ -164,16 +164,16 @@ namespace xtd { static int32_t output_code_page(); /// @brief Sets the code page the console uses to write output. /// @param code_page The code page used to write console output. - /// @return true if successfull; otherwhise false. + /// @return `true` if successfull; otherwise `false`. /// @warning Internal use only static bool output_code_page(int32_t codePage); /// @brief Obtains the next character or function key pressed by the user. /// @param key_char A bitwise combination of the enumeration values. There is no default value. /// @param key_code A value that identifies the console key that was pressed. - /// @param alt true if alt key modifier is pressed; otherwise false. - /// @param shift true if shift key modifier is pressed; otherwise false. - /// @param ctrl true if control key modifier is pressed; otherwise false. + /// @param alt true if alt key modifier is pressed; otherwise `false`. + /// @param shift true if shift key modifier is pressed; otherwise `false`. + /// @param ctrl true if control key modifier is pressed; otherwise `false`. /// @remarks The five parameters will contains informations on key pressed. /// @warning Internal use only static void read_key(char32_t& key_char, char32_t& key_code, bool& alt, bool& shift, bool& ctrl); @@ -187,14 +187,14 @@ namespace xtd { /// @brief Sets the foreground and background console colors to their defaults. /// @remarks The foreground and background colors are restored to the colors that existed when the current process began. For more information, see the foreground_color and background_color properties. - /// @return true if successfull; otherwhise false. + /// @return `true` if successfull; otherwise `false`. /// @warning Internal use only static bool reset_color(); /// @brief Sets the position of the cursor. /// @param left The column position of the cursor. Columns are numbered from left to right starting at 0. /// @param top The row position of the cursor. Rows are numbered from top to bottom starting at 0. - /// @return true if successfull; otherwhise false. + /// @return `true` if successfull; otherwise `false`. /// @warning Internal use only static bool set_cursor_position(int32_t left, int32_t top); @@ -204,17 +204,17 @@ namespace xtd { static std::string title(); /// @brief Sets the title to display in the console title bar. /// @param title The string to be displayed in the title bar of the console. The maximum length of the title string is 24500 characters. - /// @return true if successfull; otherwhise false. + /// @return `true` if successfull; otherwise `false`. /// @warning Internal use only static bool title(const std::string& title); /// @brief Gets a value indicating whether the combination of the Control modifier key and C console key (Ctrl+C) is treated as ordinary input or as an interruption that is handled by the operating system. - /// @return true if Ctrl+C is treated as ordinary input; otherwise, false. + /// @return `true` if Ctrl+C is treated as ordinary input; otherwise, false. /// @warning Internal use only static bool treat_control_c_as_input(); /// @brief Sets a value indicating whether the combination of the Control modifier key and C console key (Ctrl+C) is treated as ordinary input or as an interruption that is handled by the operating system. /// @param treat_control_c_as_input true if Ctrl+C is treated as ordinary input; otherwise, false. - /// @return true if successfull; otherwhise false. + /// @return `true` if successfull; otherwise `false`. /// @warning Internal use only static bool treat_control_c_as_input(bool treat_control_c_as_input); @@ -224,7 +224,7 @@ namespace xtd { static int32_t window_height(); /// @brief Sets the height of the console window area. /// @param height The height of the console window measured in rows. - /// @return true if successfull; otherwhise false. + /// @return `true` if successfull; otherwise `false`. /// @warning Internal use only static bool window_height(int32_t height); @@ -234,7 +234,7 @@ namespace xtd { static int32_t window_left(); /// @brief Sets the left of the console window area. /// @param left The left of the console window measured in columns. - /// @return true if successfull; otherwhise false. + /// @return `true` if successfull; otherwise `false`. /// @warning Internal use only static bool window_left(int32_t left); @@ -244,7 +244,7 @@ namespace xtd { static int32_t window_top(); /// @brief Sets the top of the console window area. /// @param top The top of the console window measured in rows. - /// @return true if successfull; otherwhise false. + /// @return `true` if successfull; otherwise `false`. /// @warning Internal use only static bool window_top(int32_t top); @@ -254,7 +254,7 @@ namespace xtd { static int32_t window_width(); /// @brief Sets the width of the console window area. /// @param width The width of the console window measured in columns. - /// @return true if successfull; otherwhise false. + /// @return `true` if successfull; otherwise `false`. /// @warning Internal use only static bool window_width(int32_t width); /// @} diff --git a/src/xtd.core.native/include/xtd/native/critical_section.hpp b/src/xtd.core.native/include/xtd/native/critical_section.hpp index 799e9cc8b1a6..d2bae478884b 100644 --- a/src/xtd.core.native/include/xtd/native/critical_section.hpp +++ b/src/xtd.core.native/include/xtd/native/critical_section.hpp @@ -51,12 +51,12 @@ namespace xtd { /// @brief Wait critical section with specified critical section handle. /// @param handle The critical section handle to wait. - /// @return true if succeed; otherwhise false. + /// @return `true` if succeed; otherwise `false`. static void enter(intmax_t handle); /// @brief Attempts to enter critical section with specified critical section handle. /// @param handle The critical section handle to wait. - /// @return true if succeed; otherwhise false. + /// @return `true` if succeed; otherwise `false`. static bool try_enter(intmax_t handle); /// @brief Release`critical section with specified critical section handle. diff --git a/src/xtd.core.native/include/xtd/native/date_time.hpp b/src/xtd.core.native/include/xtd/native/date_time.hpp index 174d01cbb551..ef346d608015 100644 --- a/src/xtd.core.native/include/xtd/native/date_time.hpp +++ b/src/xtd.core.native/include/xtd/native/date_time.hpp @@ -98,7 +98,7 @@ namespace xtd { static time_t utc_offset(std::time_t time); /// @brief Indicates whether the ttime_t is within the daylight saving time range for the current time zone. - /// @return true if the time is within the daylight saving time range for the local time zone; otherwise false. + /// @return `true` if the time is within the daylight saving time range for the local time zone; otherwise `false`. /// @warning Internal use only static bool is_daylight(std::time_t time); /// @} diff --git a/src/xtd.core.native/include/xtd/native/debugger.hpp b/src/xtd.core.native/include/xtd/native/debugger.hpp index 4e2dfb9e878d..5563b42a5b47 100644 --- a/src/xtd.core.native/include/xtd/native/debugger.hpp +++ b/src/xtd.core.native/include/xtd/native/debugger.hpp @@ -45,15 +45,15 @@ namespace xtd { /// @warning Internal use only static void debug_break(); /// @brief Gets a value that indicates whether a debugger is attached to the process. - /// @return true if a debugger is attached; otherwise, false. + /// @return `true` if a debugger is attached; otherwise, false. /// @warning Internal use only static bool is_attached(); /// @brief Checks to see if logging is enabled by an attached debugger. - /// @return true if a debugger is attached and logging is enabled; otherwise, false. + /// @return `true` if a debugger is attached and logging is enabled; otherwise, false. /// @warning Internal use only static bool is_logging(); /// @brief Launches and attaches a debugger to the process. - /// @return true if the startup is successful or if the debugger is already attached; otherwise, false. + /// @return `true` if the startup is successful or if the debugger is already attached; otherwise, false. /// @remarks If a debugger is already attached, nothing happens. /// @remarks Debugger launch is only supported on Windows operating system. On Unix and macOS operating systems, the method returns true without launching a debugger. /// @warning Internal use only diff --git a/src/xtd.core.native/include/xtd/native/directory.hpp b/src/xtd.core.native/include/xtd/native/directory.hpp index e190e7ae22f3..fcaf1a77ab7c 100644 --- a/src/xtd.core.native/include/xtd/native/directory.hpp +++ b/src/xtd.core.native/include/xtd/native/directory.hpp @@ -192,7 +192,7 @@ namespace xtd { static file_and_directory_iterator enumerate_files_and_directories(const std::string& path, const std::string& pattern); /// @brief Check if specified directory exist. /// @param path The diretory path to check. - /// @return true is file exist; otherwise false. + /// @return `true` is file exist; otherwise `false`. /// @warning Internal use only static bool exists(const std::string& path); /// @brief Gets the current directory. diff --git a/src/xtd.core.native/include/xtd/native/drive.hpp b/src/xtd.core.native/include/xtd/native/drive.hpp index 9986f2b31575..8cfb896fceb6 100644 --- a/src/xtd.core.native/include/xtd/native/drive.hpp +++ b/src/xtd.core.native/include/xtd/native/drive.hpp @@ -45,7 +45,7 @@ namespace xtd { /// @param free_bytes Return number of free bytes in bytes. /// @param total_number_of_bytes Return total number of bytes in bytes. /// @param total_number_of_free_bytes Return total number of free bytes in bytes. - /// @return true if succeed; otherwise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool get_available_free_space(const std::string& root_path_name, size_t& free_bytes, size_t& total_number_of_bytes, size_t& total_number_of_free_bytes); /// @brief Gets drive type. @@ -61,13 +61,13 @@ namespace xtd { /// @param root_path_name The root path name of the volume /// @param volume_name The name of the volume. /// @param file_system_name The file system name. - /// @return true if succeed; otherwise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool get_volume_information(const std::string& root_path_name, std::string& volume_name, std::string& file_system_name); /// @brief Sets volume label /// @param root_path_name The root path name of the volume /// @param volume The volume name to set. - /// @return true if succeed; otherwise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool set_Volume_label(const std::string& root_path_name, const std::string& volume_name); /// @} diff --git a/src/xtd.core.native/include/xtd/native/environment.hpp b/src/xtd.core.native/include/xtd/native/environment.hpp index b55149415f66..50493f66c46b 100644 --- a/src/xtd.core.native/include/xtd/native/environment.hpp +++ b/src/xtd.core.native/include/xtd/native/environment.hpp @@ -183,11 +183,11 @@ namespace xtd { /// @warning Internal use only static bool has_shutdown_started(); /// @brief Determines whether the current processor is arm. - /// @return true if the processor is is arm; otherwise, false. + /// @return `true` if the processor is is arm; otherwise, false. /// @warning Internal use only static bool is_processor_arm(); /// @brief Determines whether the current operating system is a 64-bit operating system. - /// @return true if the operating system is 64-bit; otherwise, false. + /// @return `true` if the operating system is 64-bit; otherwise, false. /// @warning Internal use only static bool is_os_64_bit(); /// @brief Gets the newline string defined for this environment. diff --git a/src/xtd.core.native/include/xtd/native/file.hpp b/src/xtd.core.native/include/xtd/native/file.hpp index 57ca9f5f5275..e36503533958 100644 --- a/src/xtd.core.native/include/xtd/native/file.hpp +++ b/src/xtd.core.native/include/xtd/native/file.hpp @@ -48,7 +48,7 @@ namespace xtd { static int32_t copy(const std::string& source_file, const std::string& target_file); /// @brief Check if specified file exist. /// @param path The file path to check. - /// @return true is file exist; otherwise false. + /// @return `true` is file exist; otherwise `false`. /// @warning Internal use only static bool exists(const std::string& path); /// @brief Gets file size of specified path. diff --git a/src/xtd.core.native/include/xtd/native/file_system.hpp b/src/xtd.core.native/include/xtd/native/file_system.hpp index 7ca1139bd5a9..816836d52628 100644 --- a/src/xtd.core.native/include/xtd/native/file_system.hpp +++ b/src/xtd.core.native/include/xtd/native/file_system.hpp @@ -82,7 +82,7 @@ namespace xtd { static std::string get_full_path(const std::string& relative_path); /// @brief Check if specified path is too long for the OS. /// @param path The path to cjheck the size. - /// @return true if path too long; otherwiser false. + /// @return `true` if path too long; otherwiser false. /// @warning Internal use only static bool is_path_too_long(const std::string& path); /// @brief Sets the attributes for the specified file or directory path. diff --git a/src/xtd.core.native/include/xtd/native/named_event_wait_handle.hpp b/src/xtd.core.native/include/xtd/native/named_event_wait_handle.hpp index ba918d9c59cb..f82bf0e214be 100644 --- a/src/xtd.core.native/include/xtd/native/named_event_wait_handle.hpp +++ b/src/xtd.core.native/include/xtd/native/named_event_wait_handle.hpp @@ -65,13 +65,13 @@ namespace xtd { /// @brief Sets the state of the event to signaled, allowing one or more waiting threads to proceed. /// @param handle The event wait handle handle to set. - /// @return true if succeed; otherwhise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool set(intmax_t handle, bool& io_error); /// @brief Sets the state of the event to nonsignaled, causing threads to block. /// @param handle The event wait handle handle to reset. - /// @return true if succeed; otherwhise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool reset(intmax_t handle, bool& io_error); diff --git a/src/xtd.core.native/include/xtd/native/named_mutex.hpp b/src/xtd.core.native/include/xtd/native/named_mutex.hpp index e9a8bb79cf5f..4db70d0f31cf 100644 --- a/src/xtd.core.native/include/xtd/native/named_mutex.hpp +++ b/src/xtd.core.native/include/xtd/native/named_mutex.hpp @@ -64,7 +64,7 @@ namespace xtd { /// @brief Signal named mutex with specified mutex handle. /// @param handle The mutex handle to signal. - /// @return true if succeed; otherwhise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool signal(intmax_t handle, bool& io_error); diff --git a/src/xtd.core.native/include/xtd/native/named_semaphore.hpp b/src/xtd.core.native/include/xtd/native/named_semaphore.hpp index d6e01bf08342..75b222134971 100644 --- a/src/xtd.core.native/include/xtd/native/named_semaphore.hpp +++ b/src/xtd.core.native/include/xtd/native/named_semaphore.hpp @@ -63,7 +63,7 @@ namespace xtd { /// @brief Signal named semaphore with specified semaphore handle. /// @param handle The semaphore handle to signal. - /// @return true if succeed; otherwhise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool signal(intmax_t handle, int32_t release_count, int32_t& previous_count, bool& io_error); diff --git a/src/xtd.core.native/include/xtd/native/process.hpp b/src/xtd.core.native/include/xtd/native/process.hpp index ca2db5fef42a..226a61b10107 100644 --- a/src/xtd.core.native/include/xtd/native/process.hpp +++ b/src/xtd.core.native/include/xtd/native/process.hpp @@ -71,13 +71,13 @@ namespace xtd { static int32_t base_priority(int32_t priority); /// @brief Kill process. /// @param process The process handle to kill. - /// @return true if succeed; otherwise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool kill(intmax_t process); /// @brief Sets the overall priority category for the associated process. /// @param process The process handle to set priority class. /// @param priority The priority category for the associated process, from which the base_priority of the process is calculated. (see priority_class.h file). - /// @return true if succeed; otherwise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool priority_class(intmax_t process, int32_t priority); /// @brief Creates a process with specified file name, specified arguments, specified working directory, specified process creation flags, and specified process window style. @@ -104,7 +104,7 @@ namespace xtd { /// @brief Wait process and close handles. /// @param process The process handle to wait. /// @param exit Receives the process exit code. - /// @return true if succeed; otherwise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool wait(intmax_t process, int32_t& exit_code); /// @} diff --git a/src/xtd.core.native/include/xtd/native/thread.hpp b/src/xtd.core.native/include/xtd/native/thread.hpp index 2443696deed0..db8764595065 100644 --- a/src/xtd.core.native/include/xtd/native/thread.hpp +++ b/src/xtd.core.native/include/xtd/native/thread.hpp @@ -41,7 +41,7 @@ namespace xtd { /// @{ /// @brief Cancel thread with specified handle. /// @param handle The thread handle. - /// @return true if succeed; otherwise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool cancel(intmax_t handle); @@ -55,7 +55,7 @@ namespace xtd { /// @brief Detach thread with specified handle. /// @param handle The thread handle. - /// @return true if succeed; otherwise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool detach(intmax_t handle); @@ -72,26 +72,26 @@ namespace xtd { /// @brief Join thread with specified handle. /// @param handle The thread handle. - /// @return true if succeed; otherwise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool join(intmax_t handle); /// @brief Resume thread with specified handle. /// @param handle The thread handle. - /// @return true if succeed; otherwise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool resume(intmax_t handle); /// @brief Sets the current thread name. /// @param name The current thread name. - /// @return true if succeed; otherwise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool set_current_thread_name(const std::string& name); /// @brief Sets the thread priority. /// @param handle The thread handle. /// @param priority The thread priority. - /// @return true if succeed; otherwise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only /// @remarks Possible values for priority paramter : /// * 0 : lowest @@ -103,18 +103,18 @@ namespace xtd { /// @brief Suspends the current thread for a specified time. /// @param milliseconds_timeout The number of milliseconds for which the thread is blocked. Specify zero (0) to indicate that this thread should be suspended to allow other waiting threads to execute. Specify -1 to block the thread indefinitely. - /// @return true if succeed; otherwise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static void sleep(int32_t milliseconds_timeout); /// @brief Suspend thread with specified handle. /// @param handle The thread handle. - /// @return true if succeed; otherwise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool suspend(intmax_t handle); /// @brief Causes the calling thread to yield execution to another thread that is ready to run on the current processor. - /// @return true if succeed; otherwise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool yield(); /// @} diff --git a/src/xtd.core.native/include/xtd/native/unnamed_event_wait_handle.hpp b/src/xtd.core.native/include/xtd/native/unnamed_event_wait_handle.hpp index 3c27e504af48..091174b05471 100644 --- a/src/xtd.core.native/include/xtd/native/unnamed_event_wait_handle.hpp +++ b/src/xtd.core.native/include/xtd/native/unnamed_event_wait_handle.hpp @@ -54,13 +54,13 @@ namespace xtd { /// @brief Sets the state of the event to signaled, allowing one or more waiting threads to proceed. /// @param handle The event wait handle handle to set. - /// @return true if succeed; otherwhise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool set(intmax_t handle, bool& io_error); /// @brief Sets the state of the event to nonsignaled, causing threads to block. /// @param handle The event wait handle handle to reset. - /// @return true if succeed; otherwhise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool reset(intmax_t handle, bool& io_error); diff --git a/src/xtd.core.native/include/xtd/native/unnamed_mutex.hpp b/src/xtd.core.native/include/xtd/native/unnamed_mutex.hpp index 70e79e9ae093..462cd2839c62 100644 --- a/src/xtd.core.native/include/xtd/native/unnamed_mutex.hpp +++ b/src/xtd.core.native/include/xtd/native/unnamed_mutex.hpp @@ -54,7 +54,7 @@ namespace xtd { /// @brief Signal named mutex with specified mutex handle. /// @param handle The mutex handle to signal. - /// @return true if succeed; otherwhise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool signal(intmax_t handle, bool& io_error); diff --git a/src/xtd.core.native/include/xtd/native/unnamed_semaphore.hpp b/src/xtd.core.native/include/xtd/native/unnamed_semaphore.hpp index 74ee0b5d2b0e..8ef0166ffcce 100644 --- a/src/xtd.core.native/include/xtd/native/unnamed_semaphore.hpp +++ b/src/xtd.core.native/include/xtd/native/unnamed_semaphore.hpp @@ -58,7 +58,7 @@ namespace xtd { /// @brief Signal named semaphore with specified semaphore handle. /// @param handle The semaphore handle to signal. - /// @return true if succeed; otherwhise false. + /// @return `true` if succeed; otherwise `false`. /// @warning Internal use only static bool signal(intmax_t handle, int32_t release_count, int32_t& previous_count, bool& io_error); diff --git a/src/xtd.core/include/xtd/any_object.hpp b/src/xtd.core/include/xtd/any_object.hpp index 9e8852fdb601..fc5794738b56 100644 --- a/src/xtd.core/include/xtd/any_object.hpp +++ b/src/xtd.core/include/xtd/any_object.hpp @@ -54,7 +54,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the current xtd::any_object object has a valid value of its underlying type. - /// @return true if the current xtd::any_object object has a value; false if the current xtd::any_object object has no value. + /// @return `true` if the current xtd::any_object object has a value; false if the current xtd::any_object object has no value. /// @remarks If the xtd::any_object::has_value property is true, the value of the current xtd::any_object object can be accessed with the xtd::any_object::value property. Otherwise, attempting to access its value throws an xtd::invalid_operation_exception exception. bool has_value() const noexcept {return value_ != null;} diff --git a/src/xtd.core/include/xtd/basic_array.hpp b/src/xtd.core/include/xtd/basic_array.hpp index b13de6243f26..fb5b63dbb299 100644 --- a/src/xtd.core/include/xtd/basic_array.hpp +++ b/src/xtd.core/include/xtd/basic_array.hpp @@ -153,7 +153,7 @@ namespace xtd { virtual const_pointer data() const noexcept {return (pointer)data_->items.data();} /// @brief Checks if the container has no elements, i.e. whether xtd::array::begin() == xtd::array::end(). - /// @return true if the container is empty, false otherwise. + /// @return `true` if the container is empty, false otherwise. virtual bool empty() const noexcept {return data_->items.empty();} /// @brief Returns an iterator to the element following the last element of the enumarable. diff --git a/src/xtd.core/include/xtd/basic_string.hpp b/src/xtd.core/include/xtd/basic_string.hpp index b709295d7c7c..e19ba65c64da 100644 --- a/src/xtd.core/include/xtd/basic_string.hpp +++ b/src/xtd.core/include/xtd/basic_string.hpp @@ -1122,11 +1122,11 @@ namespace xtd { /// @brief Returns a value indicating whether a specified char occurs within this basic_string. /// @param value The char to seek. - /// @return true if the value parameter occurs within this basic_string; otherwise, false. + /// @return `true` if the value parameter occurs within this basic_string; otherwise, false. virtual bool contains(value_type value) const noexcept {return find(value) != npos;} /// @brief Returns a value indicating whether a specified substring occurs within this basic_string. /// @param value The basic_string to seek. - /// @return true if the value parameter occurs within this basic_string, or if value is the empty basic_string (""); otherwise, false. + /// @return `true` if the value parameter occurs within this basic_string, or if value is the empty basic_string (""); otherwise, false. virtual bool contains(const basic_string& value) const noexcept {return find(value) != npos;} /// @brief Determines whether this instance and a specified object, which must also be a xtd::basic_string object, have the same value. @@ -1150,19 +1150,19 @@ namespace xtd { /// @brief Determines whether the end of this basic_string matches the specified character. /// @param value The char_t to compare to the substring at the end of this instance. - /// @return true if value matches the end of this instance; otherwise, false. + /// @return `true` if value matches the end of this instance; otherwise, false. bool ends_with(value_type value) const noexcept {return ends_with(value, false);} /// @brief Determines whether the end of this basic_string matches the specified character, ignoring or honoring their case. /// @param value The char_t to compare to the substring at the end of this instance. /// @param ignore_case true to ignore case during the comparison; otherwise, false. - /// @return true if value matches the end of this instance; otherwise, false. + /// @return `true` if value matches the end of this instance; otherwise, false. bool ends_with(value_type value, bool ignore_case) const noexcept { if (ignore_case) return to_lower().rfind(static_cast(tolower(value))) == size() - 1; return rfind(value) == size() - 1; } /// @brief Determines whether the end of this basic_string matches the specified basic_string. /// @param value The basic_string to compare to the substring at the end of this instance. - /// @return true if value matches the end of this instance; otherwise, false. + /// @return `true` if value matches the end of this instance; otherwise, false. bool ends_with(const basic_string& value) const noexcept {return ends_with(value, xtd::string_comparison::ordinal);} /// @brief Determines whether the end of this basic_string instance matches the specified basic_string, ignoring or honoring their case. /// @param value The string to compare to the substring at the end of this instance. @@ -1505,7 +1505,7 @@ namespace xtd { } /// @brief Indicates whether this basic_string is an empty basic_string (""). - /// @return true if the value parameter is null or an empty basic_string (""); otherwise, false. + /// @return `true` if the value parameter is null or an empty basic_string (""); otherwise, false. /// @deprecated Replaced by xtd::basic_string::is_empty(const xtd::basic_string&) - Will be removed in version 0.4.0. [[deprecated("Replaced by xtd::basic_string::is_empty(const xtd::basic_string&) - Will be removed in version 0.4.0.")]] bool is_empty() const noexcept {return is_empty(*this);} @@ -2283,7 +2283,7 @@ namespace xtd { /// @brief Indicates whether the specifeid basic_string is an empty basic_string (""). /// @param string The xtd::basic_string to check if empty. - /// @return true if the value parameter is null or an empty basic_string (""); otherwise, false. + /// @return `true` if the value parameter is null or an empty basic_string (""); otherwise, false. static bool is_empty(const xtd::basic_string& string) noexcept {return !string.length();} /// @brief Concatenates a specified separator basic_string between each element of a specified object array, yielding a single concatenated basic_string. @@ -2412,7 +2412,7 @@ namespace xtd { /// @brief Try to convert a basic_string into a value_t type. /// @param str An xtd::basic_string to convert to value_t /// @param value The value that will contain the parsed xtd::basic_string. - /// @return true if xtd::basic_string:=:try_parse succed; otherwise, false. + /// @return `true` if xtd::basic_string:=:try_parse succed; otherwise, false. template static bool try_parse(const basic_string& str, value_t& value) noexcept { try { diff --git a/src/xtd.core/include/xtd/basic_string_comparer.hpp b/src/xtd.core/include/xtd/basic_string_comparer.hpp index 417129bbc1ab..ca588cce45df 100644 --- a/src/xtd.core/include/xtd/basic_string_comparer.hpp +++ b/src/xtd.core/include/xtd/basic_string_comparer.hpp @@ -160,7 +160,7 @@ namespace xtd { /// @brief Determines whether the specified object is equal to the current object. /// @param obj The object to compare with the current object. - /// @return true if the specified object is equal to the current object. otherwise, false. + /// @return `true` if the specified object is equal to the current object. otherwise, false. /// @par Examples /// The following code example compares the current instance with another object. /// @include object_equals.cpp diff --git a/src/xtd.core/include/xtd/box.hpp b/src/xtd.core/include/xtd/box.hpp index df51fb17cbf1..4301b022cfae 100644 --- a/src/xtd.core/include/xtd/box.hpp +++ b/src/xtd.core/include/xtd/box.hpp @@ -129,7 +129,7 @@ namespace xtd { /// @brief Converts the string to its type_t equivalent. A return value indicates whether the conversion succeeded or failed. /// @param value A string containing a type_t to convert. /// @param result A type_t equivalent to the number contained in value. - /// @return true if s was converted successfully; otherwise, false. + /// @return `true` if s was converted successfully; otherwise, false. static bool try_parse(const xtd::string& value, type_t& result) noexcept {return xtd::try_parse(value.chars(), result);} /// @} diff --git a/src/xtd.core/include/xtd/box_char.hpp b/src/xtd.core/include/xtd/box_char.hpp index 9e0a898fba6a..8219a8faabfb 100644 --- a/src/xtd.core/include/xtd/box_char.hpp +++ b/src/xtd.core/include/xtd/box_char.hpp @@ -50,146 +50,146 @@ namespace xtd { /// @{ /// @brief Returns true if c is an ASCII character ([ U+0000..U+007F ]). /// @param c The character to analyze. - /// @return true if c is an ASCII character; false otherwise. + /// @return `true` if c is an ASCII character; false otherwise. static bool is_ascii(type_t c) noexcept {return c > 0 && c <= 0x7F;} /// @brief Indicates whether the character at the specified position in a specified string is an ASCII character ([ U+0000..U+007F ]). /// @param s A string. /// @param index The position of the character to evaluate in s. - /// @return true if the character at position index in s is n ASCII character; otherwise, false. + /// @return `true` if the character at position index in s is n ASCII character; otherwise, false. /// @exception xtd::argument_out_of_range_exception index is greater than the last position in s. static bool is_ascii(const string& s, size_t index) {return is_ascii(s[index]);} /// @brief Indicates whether the specified Unicode character is categorized as a control character. /// @param c The Unicode character to evaluate. - /// @return true if c is a control character; otherwise, false. + /// @return `true` if c is a control character; otherwise, false. static bool is_control(type_t c) noexcept {return std::iscntrl(c) != 0;} /// @brief Indicates whether the character at the specified position in a specified string is categorized as a control character. /// @param s A string. /// @param index The position of the character to evaluate in s. - /// @return true if the character at position index in s is a control character; otherwise, false. + /// @return `true` if the character at position index in s is a control character; otherwise, false. /// @exception xtd::argument_out_of_range_exception index is greater than the last position in s. static bool is_control(const string& s, size_t index) {return is_control(s[index]);} /// @brief Indicates whether the specified Unicode character is categorized as a decimal digit. /// @param c The Unicode character to evaluate. - /// @return true if c is a decimal digit; otherwise, false. + /// @return `true` if c is a decimal digit; otherwise, false. /// @remarks This method determines whether a type_tis a radix-10 digit. This contrasts with is_number, which determines whether a Char is of any numeric Unicode category. Numbers include characters such as fractions, subscripts, superscripts, Roman numerals, currency numerators, encircled numbers, and script-specific digits. static bool is_digit(type_t c) noexcept {return std::isdigit(c) != 0;} /// @brief Indicates whether the character at the specified position in a specified string is categorized as a decimal digit. /// @param s A string. /// @param index The position of the character to evaluate in s. - /// @return true if the character at position index in s is decimal digit; otherwise, false. + /// @return `true` if the character at position index in s is decimal digit; otherwise, false. /// @exception xtd::argument_out_of_range_exception index is greater than the last position in s. static bool is_digit(const string& s, size_t index) {return is_digit(s[index]);} /// @brief Indicates whether the specified Unicode character is categorized as a Unicode letter. /// @param c The Unicode character to evaluate. - /// @return true if c is a letter; otherwise, false. + /// @return `true` if c is a letter; otherwise, false. static bool is_letter(type_t c) noexcept {return std::isalpha(c) != 0;} /// @brief Indicates whether the character at the specified position in a specified string is categorized as a Unicode letter. /// @param s A string. /// @param index The position of the character to evaluate in s. - /// @return true if the character at position index in s is a letter; otherwise, false. + /// @return `true` if the character at position index in s is a letter; otherwise, false. /// @exception xtd::argument_out_of_range_exception index is greater than the last position in s. static bool is_letter(const string& s, size_t index) {return is_letter(s[index]);} /// @brief Indicates whether a Unicode character is categorized as a letter or a decimal digit. /// @param c The Unicode character to evaluate. - /// @return true if c is a letter or a decimal digit; otherwise, false. + /// @return `true` if c is a letter or a decimal digit; otherwise, false. static bool is_letter_or_digit(type_t c) noexcept {return std::isalnum(c) != 0;} /// @brief Indicates whether the character at the specified position in a specified string is categorized as a letter or a decimal digit. /// @param s A string. /// @param index The position of the character to evaluate in s. - /// @return true if the character at position index in s is a letter or a decimal digit; otherwise, false. + /// @return `true` if the character at position index in s is a letter or a decimal digit; otherwise, false. /// @exception xtd::argument_out_of_range_exception index is greater than the last position in s. static bool is_letter_or_digit(const string& s, size_t index) {return is_letter_or_digit(s[index]);} /// @brief ndicates whether the specified Unicode character is categorized as a lowercase letter. /// @param c The Unicode character to evaluate. - /// @return true if c is a lowercase letter; otherwise, false. + /// @return `true` if c is a lowercase letter; otherwise, false. static bool is_lower(type_t c) noexcept {return std::islower(c) != 0;} /// @brief Indicates whether the character at the specified position in a specified string is categorized as a lowercase letter. /// @param s A string. /// @param index The position of the character to evaluate in s. - /// @return true if the character at position index in s is a lowercase letter; otherwise, false. + /// @return `true` if the character at position index in s is a lowercase letter; otherwise, false. /// @exception xtd::argument_out_of_range_exception index is greater than the last position in s. static bool is_lower(const string& s, size_t index) {return is_lower(s[index]);} /// @brief Indicates whether a Unicode character is categorized as a number. /// @param c The Unicode character to evaluate. - /// @return true if c is a number; otherwise, false. + /// @return `true` if c is a number; otherwise, false. static bool is_number(type_t c) noexcept {return std::isdigit(c) != 0;} /// @brief Indicates whether the character at the specified position in a specified string is categorized as a number. /// @param s A string. /// @param index The position of the character to evaluate in s. - /// @return true if the character at position index in s is a number; otherwise, false. + /// @return `true` if the character at position index in s is a number; otherwise, false. /// @exception xtd::argument_out_of_range_exception index is greater than the last position in s. static bool is_number(const string& s, size_t index) {return is_number(s[index]);} /// @brief Indicates whether the specified Unicode character is categorized as a punctuation mark. /// @param c The Unicode character to evaluate. - /// @return true if c is a punctuation mark; otherwise, false. + /// @return `true` if c is a punctuation mark; otherwise, false. static bool is_punctuation(type_t c) noexcept {return std::ispunct(c) != 0;} /// @brief Indicates whether the character at the specified position in a specified string is categorized as a punctuation mark. /// @param s A string. /// @param index The position of the character to evaluate in s. - /// @return true if the character at position index in s is categorized as a punctuation mark. + /// @return `true` if the character at position index in s is categorized as a punctuation mark. /// @exception xtd::argument_out_of_range_exception index is greater than the last position in s. static bool is_punctuation(const string& s, size_t index) {return is_punctuation(s[index]);} /// @brief Indicates whether the specified Unicode character is categorized as a separator character. /// @param c The Unicode character to evaluate. - /// @return true if c is a separator character; otherwise, false. + /// @return `true` if c is a separator character; otherwise, false. static bool is_separator(type_t c) noexcept {return std::isspace(c) != 0 || c == '\n';} /// @brief Indicates whether the character at the specified position in a specified string is categorized as a separator character. /// @param s A string. /// @param index The position of the character to evaluate in s. - /// @return true if the character at position index in s is categorized as a separator character. + /// @return `true` if the character at position index in s is categorized as a separator character. /// @exception xtd::argument_out_of_range_exception index is greater than the last position in s. static bool is_separator(const string& s, size_t index) {return is_separator(s[index]);} /// @brief Indicates whether the specified Unicode character is categorized as a symbol character. /// @param c The Unicode character to evaluate. - /// @return true if c is a symbol character; otherwise, false. + /// @return `true` if c is a symbol character; otherwise, false. static bool is_symbol(type_t c) noexcept {return std::isgraph(c) != 0 || c == 0x9C;} /// @brief Indicates whether the character at the specified position in a specified string is categorized as a symbol character. /// @param s A string. /// @param index The position of the character to evaluate in s. - /// @return true if the character at position index in s is a symbol character; otherwise, false. + /// @return `true` if the character at position index in s is a symbol character; otherwise, false. /// @exception xtd::argument_out_of_range_exception index is greater than the last position in s. static bool is_symbol(const string& s, size_t index) {return is_symbol(s[index]);} /// @brief Indicates whether the specified Unicode character is categorized as an uppercase letter. /// @param c The Unicode character to evaluate. - /// @return true if c is an uppercase letter; otherwise, false. + /// @return `true` if c is an uppercase letter; otherwise, false. static bool is_upper(type_t c) noexcept {return std::isupper(c) != 0;} /// @brief Indicates whether the character at the specified position in a specified string is categorized as an uppercase letter. /// @param s A string. /// @param index The position of the character to evaluate in s. - /// @return true if the character at position index in s is an uppercase letter; otherwise, false. + /// @return `true` if the character at position index in s is an uppercase letter; otherwise, false. /// @exception xtd::argument_out_of_range_exception index is greater than the last position in s. static bool is_upper(const string& s, size_t index) {return is_upper(s[index]);} /// @brief Indicates whether the specified Unicode character is categorized as white space. /// @param c The Unicode character to evaluate. - /// @return true if c is white space; otherwise, false. + /// @return `true` if c is white space; otherwise, false. static bool is_white_space(type_t c) noexcept {return std::isspace(c) != 0;} /// @brief Indicates whether the character at the specified position in a specified string is categorized as white space. /// @param s A string. /// @param index The position of the character to evaluate in s. - /// @return true if the character at position index in s is white space; otherwise, false. + /// @return `true` if the character at position index in s is white space; otherwise, false. /// @exception xtd::argument_out_of_range_exception index is greater than the last position in s. static bool is_white_space(const string& s, size_t index) {return is_white_space(s[index]);} diff --git a/src/xtd.core/include/xtd/box_floating_point.hpp b/src/xtd.core/include/xtd/box_floating_point.hpp index 0eb63c70ca76..795169276b36 100644 --- a/src/xtd.core/include/xtd/box_floating_point.hpp +++ b/src/xtd.core/include/xtd/box_floating_point.hpp @@ -70,26 +70,26 @@ namespace xtd { /// @{ /// @brief Determines whether the specified value is finite (zero, subnormal, or normal). /// @param value A floating-point number. - /// @return true if the value is finite (zero, subnormal or normal); false otherwise. + /// @return `true` if the value is finite (zero, subnormal or normal); false otherwise. static bool is_finite(type_t value) noexcept {return !is_infinity(value);} /// @brief Returns a value indicating whether the specified number evaluates to negative or positive infinity. /// @param value A floating-point number. - /// @return true if value evaluates to xtd::math::positive_infinity or xtd::math::negative_infinity; otherwise, false. + /// @return `true` if value evaluates to xtd::math::positive_infinity or xtd::math::negative_infinity; otherwise, false. static bool is_infinity(type_t value) noexcept {return is_negative_infinity(value) || is_positive_infinity(value);} /// @brief Returns a value indicating whether the specified number evaluates to negative infinity. /// @param value A floating-point number. - /// @return true if value evaluates to xtd::math::negative_infinity; otherwise, false. + /// @return `true` if value evaluates to xtd::math::negative_infinity; otherwise, false. static bool is_negative_infinity(type_t value) noexcept {return value <= negative_infinity;} /// @brief Returns a value indicating whether the specified number evaluates to positive infinity. /// @param value A floating-point number. - /// @return true if value evaluates to xtd::math::positive_infinity; otherwise, false. + /// @return `true` if value evaluates to xtd::math::positive_infinity; otherwise, false. static bool is_positive_infinity(type_t value) noexcept {return value >= positive_infinity;} /// @brief Returns a value indicating whether the specified number evaluates to not a number. /// @param value A floating-point number. - /// @return true if value evaluates to not a number; otherwise, false. + /// @return `true` if value evaluates to not a number; otherwise, false. static bool is_NaN(type_t value) noexcept {return value != value;} /// @} }; diff --git a/src/xtd.core/include/xtd/collections/generic/dictionary.hpp b/src/xtd.core/include/xtd/collections/generic/dictionary.hpp index 8f26f15a9753..d145cb7b502f 100644 --- a/src/xtd.core/include/xtd/collections/generic/dictionary.hpp +++ b/src/xtd.core/include/xtd/collections/generic/dictionary.hpp @@ -119,7 +119,7 @@ namespace xtd { /// @brief checks if the specified a and b keys are equal. /// @param a The first key to check. /// @param b The second key to check. - /// @return true if keys are equals; otherwise false. + /// @return `true` if keys are equals; otherwise `false`. /// @remarks If key_t inherits from xtd::object, the xtd::object::equals method will be used; otherwise, the [std::equal_to](https://en.cppreference.com/w/cpp/utility/functional/equal_to) object function will be used. bool operator()(const key_t& a, const key_t& b) const { if (&a == &b) return true; @@ -598,12 +598,12 @@ namespace xtd { iterator end() noexcept override {return ienumerable::cend();} /// @brief Gets a value indicating whether the xtd::collections::generic::icollection is read-only. - /// @return true if the xtd::collections::generic::icollection is read-only; otherwise, false. + /// @return `true` if the xtd::collections::generic::icollection is read-only; otherwise, false. /// @remarks A collection that is read-only does not allow the addition or removal of elements after the collection is created. Note that read-only in this context does not indicate whether individual elements of the collection can be modified, since the xtd::collections::generic::icollection interface only supports addition and removal operations. For example, the IsReadOnly property of an array that is cast or converted to an xtd::collections::generic::icollection object returns true, even though individual array elements can be modified. bool is_read_only() const noexcept override {return false;} /// @brief Gets a value indicating whether access to the xtd::collections::generic::icollection is synchronized (thread safe). - /// @return true if access to the xtd::collections::generic::icollection is synchronized (thread safe); otherwise, false. + /// @return `true` if access to the xtd::collections::generic::icollection is synchronized (thread safe); otherwise, false. /// @remarks xtd::collections::generic::icollection::sync_root returns an object, which can be used to synchronize access to the xtd::collections::generic::icollection . /// @remarks Most collection classes in the xtd::collections namespace also implement a `synchronized` method, which provides a synchronized wrapper around the underlying collection. /// @remarks Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. diff --git a/src/xtd.core/include/xtd/collections/generic/enumerator.hpp b/src/xtd.core/include/xtd/collections/generic/enumerator.hpp index 705fffbb2f4e..530a1525470a 100644 --- a/src/xtd.core/include/xtd/collections/generic/enumerator.hpp +++ b/src/xtd.core/include/xtd/collections/generic/enumerator.hpp @@ -68,7 +68,7 @@ namespace xtd { /// @{ /// @brief Advances the enumerator to the next element of the collection. - /// @return true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. + /// @return `true` if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. /// @exception xtd::invalid_operation_exception The collection was modified after the enumerator was created. bool move_next() override {return enumerator_->move_next();} diff --git a/src/xtd.core/include/xtd/collections/generic/extensions/enumerable.hpp b/src/xtd.core/include/xtd/collections/generic/extensions/enumerable.hpp index 790621678e02..23696dd2e879 100644 --- a/src/xtd.core/include/xtd/collections/generic/extensions/enumerable.hpp +++ b/src/xtd.core/include/xtd/collections/generic/extensions/enumerable.hpp @@ -108,7 +108,7 @@ namespace xtd { /// @brief Determines whether all elements of a sequence satisfy a condition. /// @param predicate A function to test each element for a condition. - /// @return true if every element of the source sequence passes the test in the specified predicate, or if the sequence is empty; otherwise, false. + /// @return `true` if every element of the source sequence passes the test in the specified predicate, or if the sequence is empty; otherwise, false. /// @par Examples /// The following code example demonstrates how to use xtd::linq::enumerable::all to determine whether all the elements in a sequence satisfy a condition. Variable all_start_with_B is true if all the pet names start with "B" or if the pets array is empty. /// @include enumerable_all.cpp @@ -117,7 +117,7 @@ namespace xtd { } /// @brief Determines whether a sequence contains any elements. - /// @return true if the source sequence contains any elements; otherwise, false. + /// @return `true` if the source sequence contains any elements; otherwise, false. /// @par Examples /// The following code example demonstrates how to use Any to determine whether a sequence contains any elements. /// @include enumerable_any.cpp @@ -126,7 +126,7 @@ namespace xtd { } /// @brief Determines whether any element of a sequence satisfies a condition. /// @param predicate A function to test each element for a condition. - /// @return true if every element of the source sequence passes the test in the specified predicate, or if the sequence is empty; otherwise, false. + /// @return `true` if every element of the source sequence passes the test in the specified predicate, or if the sequence is empty; otherwise, false. /// @par Examples /// The following code example demonstrates how to use xtd::linq::enumerable::all to determine whether all the elements in a sequence satisfy a condition. Variable all_start_with_B is true if all the pet names start with "B" or if the pets array is empty. /// @include enumerable_any.cpp @@ -187,7 +187,7 @@ namespace xtd { /// @brief Determines whether a sequence contains a specified element by using the default equality comparer. /// @param value The value to locate in the sequence. - /// @return true if the source sequence contains an element that has the specified value; otherwise, false. + /// @return `true` if the source sequence contains an element that has the specified value; otherwise, false. bool contains(const source_t& value) const noexcept { return xtd::linq::enumerable::contains(base(), value); } @@ -195,7 +195,7 @@ namespace xtd { /// @brief Determines whether a sequence contains a specified element by using a specified equality comparer. /// @param value The value to locate in the sequence. /// @param comparer An equality comparer to compare values. - /// @return true if the source sequence contains an element that has the specified value; otherwise, false. + /// @return `true` if the source sequence contains an element that has the specified value; otherwise, false. bool contains(const source_t& value, const xtd::collections::generic::iequality_comparer& comparer) const noexcept { return xtd::linq::enumerable::contains(base(), value, comparer); } diff --git a/src/xtd.core/include/xtd/collections/generic/helpers/equator.hpp b/src/xtd.core/include/xtd/collections/generic/helpers/equator.hpp index fe93a4f9b8b6..44c4ae49765e 100644 --- a/src/xtd.core/include/xtd/collections/generic/helpers/equator.hpp +++ b/src/xtd.core/include/xtd/collections/generic/helpers/equator.hpp @@ -53,7 +53,7 @@ namespace xtd { /// @brief checks if the specified a and b keys are equal. /// @param a The first key to check. /// @param b The second key to check. - /// @return true if keys are equals; otherwise false. + /// @return `true` if keys are equals; otherwise `false`. /// @remarks If key_t inherits from xtd::object, the xtd::object::equals method will be used; otherwise, the [std::equal_to](https://en.cppreference.com/w/cpp/utility/functional/equal_to) object function will be used. result_type operator()(const first_argument_type& a, const second_argument_type& b) const { if (&a == &b) return true; diff --git a/src/xtd.core/include/xtd/collections/generic/icollection.hpp b/src/xtd.core/include/xtd/collections/generic/icollection.hpp index 363d2f0db987..b84ff02ca89d 100644 --- a/src/xtd.core/include/xtd/collections/generic/icollection.hpp +++ b/src/xtd.core/include/xtd/collections/generic/icollection.hpp @@ -62,12 +62,12 @@ namespace xtd { virtual xtd::size count() const noexcept = 0; /// @brief Gets a value indicating whether the xtd::collections::generic::icollection is read-only. - /// @return true if the xtd::collections::generic::icollection is read-only; otherwise, false. + /// @return `true` if the xtd::collections::generic::icollection is read-only; otherwise, false. /// @remarks A collection that is read-only does not allow the addition or removal of elements after the collection is created. Note that read-only in this context does not indicate whether individual elements of the collection can be modified, since the xtd::collections::generic::icollection interface only supports addition and removal operations. For example, the IsReadOnly property of an array that is cast or converted to an xtd::collections::generic::icollection object returns true, even though individual array elements can be modified. virtual bool is_read_only() const noexcept = 0; /// @brief Gets a value indicating whether access to the xtd::collections::generic::icollection is synchronized (thread safe). - /// @return true if access to the xtd::collections::generic::icollection is synchronized (thread safe); otherwise, false. + /// @return `true` if access to the xtd::collections::generic::icollection is synchronized (thread safe); otherwise, false. /// @remarks xtd::collections::generic::icollection::sync_root returns an object, which can be used to synchronize access to the xtd::collections::generic::icollection . /// @remarks Most collection classes in the xtd::collections namespace also implement a `synchronized` method, which provides a synchronized wrapper around the underlying collection. /// @remarks Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. @@ -121,7 +121,7 @@ namespace xtd { /// @brief Determines whether the xtd::collections::generic::icollection contains a specific value. /// @param item The object to locate in the xtd::collections::generic::icollection . - /// @return true if item is found in the xtd::collections::generic::icollection ; otherwise, false. + /// @return `true` if item is found in the xtd::collections::generic::icollection ; otherwise, false. /// @remarks Implementations can vary in how they determine equality of objects; for example, xtd::collections::generic::list uses xtd::collections::generic::compoarer ::default_comparer, whereas xtd::collections::generic::dictionary allows the user to specify the xtd::collections::generic::icompoarer implementation to use for comparing keys. virtual bool contains(const type_t& item) const noexcept = 0; @@ -133,7 +133,7 @@ namespace xtd { /// @brief Removes the first occurrence of a specific object from the xtd::collections::generic::icollection . /// @param item The object to remove from the xtd::collections::generic::icollection . - /// @return true if item was successfully removed from the xtd::collections::generic::icollection ; otherwise, false. This method also returns false if item is not found in the original xtd::collections::generic::icollection . + /// @return `true` if item was successfully removed from the xtd::collections::generic::icollection ; otherwise, false. This method also returns false if item is not found in the original xtd::collections::generic::icollection . /// @exception xtd::not_supported_exception The xtd::collections::generic::icollection is read-only. /// @remarks Implementations can vary in how they determine equality of objects; for example, xtd::collections::generic::list uses xtd::collections::generic::compoarer ::default_comparer, whereas, xtd::collections::generic::dictionary allows the user to specify the xtd::collections::generic::icompoarer implementation to use for comparing keys. /// @remarks In collections of contiguous elements, such as lists, the elements that follow the removed element move up to occupy the vacated spot. If the collection is indexed, the indexes of the elements that are moved are also updated. This behavior does not apply to collections where elements are conceptually grouped into buckets, such as a hash table. diff --git a/src/xtd.core/include/xtd/collections/generic/ienumerator.hpp b/src/xtd.core/include/xtd/collections/generic/ienumerator.hpp index 732222bfc84e..dbd325c45d75 100644 --- a/src/xtd.core/include/xtd/collections/generic/ienumerator.hpp +++ b/src/xtd.core/include/xtd/collections/generic/ienumerator.hpp @@ -107,7 +107,7 @@ namespace xtd { /// @{ /// @brief Advances the enumerator to the next element of the collection. - /// @return true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. + /// @return `true` if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. /// @exception xtd::invalid_operation_exception The collection was modified after the enumerator was created. /// @par Examples /// The following code example demonstrates the implementation of the IEnumerator interfaces for a custom collection. In this example, xtd::collections::generic::ienumerator::move_next is not explicitly called, but it is implemented to support the use of foreach (for each in Visual Basic). This code example is part of a larger example for the IEnumerator interface. diff --git a/src/xtd.core/include/xtd/collections/generic/ilist.hpp b/src/xtd.core/include/xtd/collections/generic/ilist.hpp index c342ee53608e..fda23fcf8131 100644 --- a/src/xtd.core/include/xtd/collections/generic/ilist.hpp +++ b/src/xtd.core/include/xtd/collections/generic/ilist.hpp @@ -60,7 +60,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the xtd::collections::generic::ilist has a fixed size. - /// @return true if the xtd::collections::generic::ilist has a fixed size; otherwise, false. + /// @return `true` if the xtd::collections::generic::ilist has a fixed size; otherwise, false. /// @remarks A collection with a fixed size does not allow the addition or removal of elements after the collection is created, but it allows the modification of existing elements. virtual bool is_fixed_size() const noexcept = 0; /// @} diff --git a/src/xtd.core/include/xtd/collections/generic/key_value_pair.hpp b/src/xtd.core/include/xtd/collections/generic/key_value_pair.hpp index c50ff41b3324..f1fe7046b465 100644 --- a/src/xtd.core/include/xtd/collections/generic/key_value_pair.hpp +++ b/src/xtd.core/include/xtd/collections/generic/key_value_pair.hpp @@ -96,12 +96,12 @@ namespace xtd { /// @brief Determines whether the specified object is equal to the current object. /// @param value The key_value_pair to compare with the current object. - /// @return true if the specified object is equal to the current object; otherwise, false. + /// @return `true` if the specified object is equal to the current object; otherwise, false. bool equals(const key_value_pair& value) const noexcept override {return first == value.first && second == value.second;} /// @brief Determines whether the specified object is equal to the current object. /// @param obj The object to compare with the current object. - /// @return true if the specified object is equal to the current object; otherwise, false + /// @return `true` if the specified object is equal to the current object; otherwise, false bool equals(const object& obj) const noexcept override {return is(obj) && equals(static_cast(obj));} /// @} diff --git a/src/xtd.core/include/xtd/collections/generic/list.hpp b/src/xtd.core/include/xtd/collections/generic/list.hpp index 9fcdc0422362..983571f2ce39 100644 --- a/src/xtd.core/include/xtd/collections/generic/list.hpp +++ b/src/xtd.core/include/xtd/collections/generic/list.hpp @@ -313,7 +313,7 @@ namespace xtd { virtual const_pointer data() const noexcept {return reinterpret_cast(data_->items.data());} /// @brief Checks if the container has no elements, i.e. whether xtd::collections::generic::list::begin() == xtd::collections::generic::list::end(). - /// @return true if the container is empty, false otherwise. + /// @return `true` if the container is empty, false otherwise. virtual bool empty() const noexcept {return data_->items.empty();} /// @brief Returns an iterator to the element following the last element of the enumarable. diff --git a/src/xtd.core/include/xtd/collections/object_model/read_only_collection.hpp b/src/xtd.core/include/xtd/collections/object_model/read_only_collection.hpp index 7db3ca8d2a92..d8b1de0f4276 100644 --- a/src/xtd.core/include/xtd/collections/object_model/read_only_collection.hpp +++ b/src/xtd.core/include/xtd/collections/object_model/read_only_collection.hpp @@ -153,7 +153,7 @@ namespace xtd { /// @{ /// @brief Determines whether an element is in the xtd::collections::object_model::read_only_collection . /// @param item The object to locate in the xtd::collections::object_model::read_only_collection . The value can be null for reference types. - /// @return true if value is found in the xtd::collections::object_model::read_only_collection ; otherwise, false. + /// @return `true` if value is found in the xtd::collections::object_model::read_only_collection ; otherwise, false. /// @par Examples /// The following code example demonstrates several members of the xtd::collections::object_model::read_only_collection class. The code example creates a xtd::collections::generic::list of strings and adds four dinosaur names to it. The code example then wraps the list in a xtd::collections::object_model::read_only_collection . /// diff --git a/src/xtd.core/include/xtd/compiler.hpp b/src/xtd.core/include/xtd/compiler.hpp index 6b5deb273fda..36579c66da31 100644 --- a/src/xtd.core/include/xtd/compiler.hpp +++ b/src/xtd.core/include/xtd/compiler.hpp @@ -33,7 +33,7 @@ namespace xtd { /// @param compiler_id One of xtd::compiler_id values. /// @param version The compiler version. /// @param build_type One of xtd::build_type values. - /// @param is_64_bit true if 64 bits; otherwise false. + /// @param is_64_bit true if 64 bits; otherwise `false`. compiler(xtd::compiler_id compiler_id, const xtd::version& version, xtd::build_type build_type, bool is_64_bit); /// @} @@ -59,11 +59,11 @@ namespace xtd { xtd::compiler_id compiler_id() const noexcept; /// @brief Gets build type is debug. - /// @return true if build type debug; otherwise false. + /// @return `true` if build type debug; otherwise `false`. bool is_build_type_debug() const noexcept; /// @brief Gets is 64 bits. - /// @return true if 64 bits; otherwise false. + /// @return `true` if 64 bits; otherwise `false`. bool is_64_bit() noexcept; /// @brief Gets compiler name. diff --git a/src/xtd.core/include/xtd/configuration/file_settings.hpp b/src/xtd.core/include/xtd/configuration/file_settings.hpp index 262fb07501f9..b7d836865795 100644 --- a/src/xtd.core/include/xtd/configuration/file_settings.hpp +++ b/src/xtd.core/include/xtd/configuration/file_settings.hpp @@ -73,7 +73,7 @@ namespace xtd { /// @{ /// @brief Gets whether save should be called on the xtd::configuration::file_settings destructor. - /// @return true if xtd::configuration::file_settings::save is called on the xtd::configuration::file_settings destructor; otherwise, false. + /// @return `true` if xtd::configuration::file_settings::save is called on the xtd::configuration::file_settings destructor; otherwise, false. /// @remarks The default is false. /// @par Examples /// The following example shows how to create xtd::configuration::file_settings and use xtd::configuration::file_settings::auto_save property, xtd::configuration::file_settings::write methods. @@ -239,7 +239,7 @@ namespace xtd { using object::equals; /// @brief Indicates whether the current object is equal to another object of the same type. /// @param obj An object to compare with this object. - /// @return true if the current object is equal to the other parameter; otherwise, false. + /// @return `true` if the current object is equal to the other parameter; otherwise, false. bool equals(const file_settings& obj) const noexcept override; /// @brief Sets the current settings with parsing the xtd::string in [INI format](https://en.wikipedia.org/wiki/INI_file). diff --git a/src/xtd.core/include/xtd/console.hpp b/src/xtd.core/include/xtd/console.hpp index 439bcae97417..4ca075a311c8 100644 --- a/src/xtd.core/include/xtd/console.hpp +++ b/src/xtd.core/include/xtd/console.hpp @@ -56,7 +56,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the xtd::console::out will flush its buffer to the underlying stream after every call to xtd::console::write and xtd::console::write_line. - /// @return true to force xtd::console::out to flush its buffer; otherwise, false. The default value is true. + /// @return `true` to force xtd::console::out to flush its buffer; otherwise, false. The default value is true. static bool auto_flush_out(); /// @brief Sets a value indicating whether the xtd::console::out will flush its buffer to the underlying stream after every call to xtd::console::write and xtd::console::write_line. /// @param value true to force xtd::console::out to flush its buffer; otherwise, false. The default value is true. @@ -107,7 +107,7 @@ namespace xtd { static void buffer_width(int32 width); /// @brief Gets a value indicating whether the CAPS LOCK keyboard toggle is turned on or turned off. - /// @return true if CAPS LOCK is turned on; false if CAPS LOCK is turned off. + /// @return `true` if CAPS LOCK is turned on; false if CAPS LOCK is turned off. static bool caps_lock(); /// @brief Gets the column position of the cursor within the buffer area. @@ -146,7 +146,7 @@ namespace xtd { static int32 cursor_top(); /// @brief Sets the row position of the cursor within the buffer area. /// @param top The current position, in rows, of the cursor. - /// @return true if cursor top changed; otherwise false. + /// @return `true` if cursor top changed; otherwise `false`. /// @exception xtd::argument_out_of_range_exception The value in a set operation is less than zero
-or-
The value in a set operation is greater than or equal to xtd::console::buffer_height. /// @par Examples /// This example demonstrates the cursor_left and cursor_top properties, and the set_cursor_position and clear methods. The example positions the cursor, which determines where the next write will occur, to draw a 5 character by 5 character rectangle using a combination of "+", "|", and "-" strings. Note that the rectangle could be drawn with fewer steps using a combination of other strings. @@ -154,7 +154,7 @@ namespace xtd { static void cursor_top(int32 top); /// @brief Gets a value indicating whether the cursor is visible. - /// @return true if the cursor is visible; otherwise, false. + /// @return `true` if the cursor is visible; otherwise, false. /// @par Examples /// This example demonstrates the cursor_visible property. The example makes the cursor visible if the first column of input is a '+' character or invisible if the input is a '-' character. /// @include console_cursor_visible.cpp @@ -224,7 +224,7 @@ namespace xtd { static bool is_output_redirected(); /// @brief Gets a value indicating whether a key press is available in the input stream. - /// @return true if a key press is available; otherwise, false. + /// @return `true` if a key press is available; otherwise, false. /// @remarks The key_available method is returned immediately; that is, the key_available method does not block input until a key press is available. /// @remarks Use the key_available method in conjunction with only the read_key method, not the read or read_line methods static bool key_available(); @@ -281,7 +281,7 @@ namespace xtd { static void title(const xtd::string& title); /// @brief Gets a value indicating whether the combination of the Control modifier key and C console key (Ctrl+C) is treated as ordinary input or as an interruption that is handled by the operating system. - /// @return true if Ctrl+C is treated as ordinary input; otherwise, false. + /// @return `true` if Ctrl+C is treated as ordinary input; otherwise, false. /// @remarks If the value of the treat_control_c_as_input property is false and Ctrl+C is pressed, the pressed keys are not stored in the input buffer and the operating system terminates the currently executing process. This is the default value. /// @warning Use this property judiciously because setting it to true has such a dramatic effect. Most users expect Ctrl+C to terminate a console application. If you disable the effect of Ctrl+C, the user must remember to use Ctrl+Break to terminate the application, which is a less familiar key combination. static bool treat_control_c_as_input(); diff --git a/src/xtd.core/include/xtd/console_cancel_event_args.hpp b/src/xtd.core/include/xtd/console_cancel_event_args.hpp index cab5cd0be948..5f268df104fd 100644 --- a/src/xtd.core/include/xtd/console_cancel_event_args.hpp +++ b/src/xtd.core/include/xtd/console_cancel_event_args.hpp @@ -41,7 +41,7 @@ namespace xtd { /// @{ /// @brief Gets a value that indicates whether simultaneously pressing the Control modifier key and the C console key (Ctrl+C) or the Ctrl+Break keys terminates the current process. The default is false, which terminates the current process. - /// @return true if the current process should resume when the event handler concludes; false if the current process should terminate. The default value is false; the current process terminates when the event handler returns. If true, the current process continues. + /// @return `true` if the current process should resume when the event handler concludes; false if the current process should terminate. The default value is false; the current process terminates when the event handler returns. If true, the current process continues. bool cancel() const noexcept; /// @brief Sets a value that indicates whether simultaneously pressing the Control modifier key and the C console key (Ctrl+C) or the Ctrl+Break keys terminates the current process. The default is false, which terminates the current process. diff --git a/src/xtd.core/include/xtd/cpp_language.hpp b/src/xtd.core/include/xtd/cpp_language.hpp index 76cdf7cfab4f..9d0b88d8e7cb 100644 --- a/src/xtd.core/include/xtd/cpp_language.hpp +++ b/src/xtd.core/include/xtd/cpp_language.hpp @@ -42,11 +42,11 @@ namespace xtd { /// @{ /// @brief Gets if is experimental language - /// @return true if is experimental language; otherwise false. + /// @return `true` if is experimental language; otherwise `false`. bool is_experimental_language() const noexcept; /// @brief Gets if is supported by xtd. - /// @return true is supported by xtd; otherwise false. + /// @return `true` is supported by xtd; otherwise `false`. bool is_supported() const noexcept; /// @brief Gets lagnguage id. diff --git a/src/xtd.core/include/xtd/date_time.hpp b/src/xtd.core/include/xtd/date_time.hpp index 5cbb32ec202b..b4137aa1d2f0 100644 --- a/src/xtd.core/include/xtd/date_time.hpp +++ b/src/xtd.core/include/xtd/date_time.hpp @@ -635,7 +635,7 @@ namespace xtd { std::vector get_date_time_formats() const noexcept; /// @brief Indicates whether this instance of xtd::date_time is within the daylight saving time range for the current time zone. - /// @return true if the value of the xtd::date_time::kind property is xtd::date_time_kind::local or xtd::date_time_kind::unspecified and the value of this instance ofxtd::date_time is within the daylight saving time range for the local time zone; false if xtd::date_time::kind is xtd::date_time_kind::utc. + /// @return `true` if the value of the xtd::date_time::kind property is xtd::date_time_kind::local or xtd::date_time_kind::unspecified and the value of this instance ofxtd::date_time is within the daylight saving time range for the local time zone; false if xtd::date_time::kind is xtd::date_time_kind::utc. /// @remarks This method determines whether the current xtd::date_time value falls within the daylight saving time range of the local time zone, which is returned by the xtd::time_zone_info::local property. You can determine whether a time zone supports daylight saving time by retrieving the value of its xtd::time_zone_info::supports_daylight_saving_time property. For time zones that observe daylight saving time, you can determine when the transition to and from daylight saving time occurs by retrieving the xtd::time_zone_info::adjustment_rule array returned by the time zone's xtd::time_zone_info::get_adjustmen_rules property. /// @remarks If the current xtd::date_time value represents either an ambiguous or an invalid time in the local time zone, the method returns false. bool is_daylight_saving_time() const noexcept; @@ -1022,7 +1022,7 @@ namespace xtd { /// @brief Returns an indication whether the specified year is a leap year. /// @param year A 4-digit year. - /// @return true if year is a leap year; otherwise, false. + /// @return `true` if year is a leap year; otherwise, false. /// @exception xtd::argument_out_of_range_exception year is less than 1 or greater than 9999. static bool is_leap_year(uint32 year); @@ -1116,7 +1116,7 @@ namespace xtd { /// @brief Converts the specified string representation of a date and time to its xtd::date_time equivalent and returns a value that indicates whether the conversion succeeded. /// @param s A string containing a date and time to convert. /// @param result When this method returns, contains the xtd::date_time value equivalent to the date and time contained in s, if the conversion succeeded, or xtd::date_time::min_value if the conversion failed. The conversion fails if the s parameter is an empty string (""), or does not contain a valid string representation of a date and time. - /// @return true if the s parameter was converted successfully; otherwise, false. + /// @return `true` if the s parameter was converted successfully; otherwise, false. /// @remarks The xtd::date_time::try_parse method is similar to the xtd::date_time::parse method, except that the xtd::date_time::try_parse method does not throw an exception if the conversion fails. static bool try_parse(const string& s, date_time& result) noexcept; /// @} diff --git a/src/xtd.core/include/xtd/delegate.hpp b/src/xtd.core/include/xtd/delegate.hpp index b3ec4c5b041e..d9090b40f7c7 100644 --- a/src/xtd.core/include/xtd/delegate.hpp +++ b/src/xtd.core/include/xtd/delegate.hpp @@ -114,7 +114,7 @@ namespace xtd { const std::vector& functions() const {return data_->functions;} /// @brief Return if the delegate is empty. - /// @return bool Return true if delegate is empty; otherwise false. + /// @return bool Return true if delegate is empty; otherwise `false`. bool is_empty() const noexcept {return data_->functions.size() == 0;} /// @brief Return the size of invocation list. @@ -546,7 +546,7 @@ namespace xtd { const std::vector& functions() const {return data_->functions;} /// @brief Return if the delegate is empty. - /// @return bool Return true if delegate is empty; otherwise false. + /// @return bool Return true if delegate is empty; otherwise `false`. bool is_empty() const noexcept {return data_->functions.size() == 0 && data_->no_arguments_functions.size() == 0;} /// @brief Return the size of invocation list. diff --git a/src/xtd.core/include/xtd/diagnostics/boolean_switch.hpp b/src/xtd.core/include/xtd/diagnostics/boolean_switch.hpp index ffc18e975e92..5879a29247be 100644 --- a/src/xtd.core/include/xtd/diagnostics/boolean_switch.hpp +++ b/src/xtd.core/include/xtd/diagnostics/boolean_switch.hpp @@ -91,7 +91,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the switch is enabled or disabled. - /// @return true if the switch is enabled; otherwise, false. The default is false. + /// @return `true` if the switch is enabled; otherwise, false. The default is false. /// @remarks By default, this field is set to false (disabled). To enable the switch, assign this field the value of true. To disable the switch, assign the value to false. The value of this property is determined by the value of the base class property xtd::diagnostics::boolean_switch::switch_setting. bool enabled() const; /// @brief Sets a value indicating whether the switch is enabled or disabled. diff --git a/src/xtd.core/include/xtd/diagnostics/data_received_event_args.hpp b/src/xtd.core/include/xtd/diagnostics/data_received_event_args.hpp index d31b54b8a613..e25e91b25ab6 100644 --- a/src/xtd.core/include/xtd/diagnostics/data_received_event_args.hpp +++ b/src/xtd.core/include/xtd/diagnostics/data_received_event_args.hpp @@ -48,7 +48,7 @@ namespace xtd { /// @{ /// @brief Gets the line of characters that was written to a redirected Process output stream. - /// @return true if the current process should resume when the event handler concludes; false if the current process should terminate. The default value is false; the current process terminates when the event handler returns. If true, the current process continues. + /// @return `true` if the current process should resume when the event handler concludes; false if the current process should terminate. The default value is false; the current process terminates when the event handler returns. If true, the current process continues. const xtd::string& data() const noexcept {return data_;} /// @} diff --git a/src/xtd.core/include/xtd/diagnostics/debug.hpp b/src/xtd.core/include/xtd/diagnostics/debug.hpp index 6efab065fb51..7d15a2316dc9 100644 --- a/src/xtd.core/include/xtd/diagnostics/debug.hpp +++ b/src/xtd.core/include/xtd/diagnostics/debug.hpp @@ -69,7 +69,7 @@ namespace xtd { /// @{ /// @brief Gets whether xtd::diagnostics::debug::flush should be called on the xtd::diagnostics::debug::Listeners after every write. - /// @return true if xtd::diagnostics::debug::flush is called on the xtd::diagnostics::debug::listeners after every write; otherwise, false. + /// @return `true` if xtd::diagnostics::debug::flush is called on the xtd::diagnostics::debug::listeners after every write; otherwise, false. /// @remarks The default is false. /// @remarks Flushing the stream will not flush its underlying encoder unless you explicitly call xtd::diagnostics::debug::flush or xtd::diagnostics::debug::close. Setting xtd::diagnostics::debug::auto_flush to true means that data will be flushed from the buffer to the stream. static bool auto_flush() noexcept; @@ -109,7 +109,7 @@ namespace xtd { static void listeners(const listener_collection& listeners) noexcept; /// @brief Gets a value indicating whether the assert dialog should be show. - /// @return true if assert dialog is to be shown; otherwise, false. The default is true. + /// @return `true` if assert dialog is to be shown; otherwise, false. The default is true. /// @remarks The show assert dialog is used when xtd::diagnostics::debug::cassert or xtd::diagnostics::trace::cassert or assert_ is called to ask user to ignore, continue or retry the assert. /// @note The xtd::diagnostics::debug::show_assert_dialog boolean is shared by both the xtd::diagnostics::debug and the xtd::diagnostics::trace classes; updating the boolean to either class modify the show assert dialog to both. /// @deprecated Replaced by xtd::diagnostics::default_trace_listener::assert_ui_enabled - Will be removed in version 0.4.0. @@ -124,7 +124,7 @@ namespace xtd { static void show_assert_dialog(bool show_assert_dialog) noexcept; /// @brief Gets a value indicating whether the global lock should be used. - /// @return true if the global lock is to be used; otherwise, false. The default is true. + /// @return `true` if the global lock is to be used; otherwise, false. The default is true. /// @remarks The global lock is always used if the trace listener is not thread safe, regardless of the value of xtd::diagnostics::debug::use_global_lock. The IsThreadSafe property is used to determine if the listener is thread safe. The global lock is not used only if the value of UseGlobalLock is false and the value of IsThreadSafe is true. The default behavior is to use the global lock. static bool use_global_lock() noexcept; /// @brief Sets a value indicating whether the global lock should be used. diff --git a/src/xtd.core/include/xtd/diagnostics/debugger.hpp b/src/xtd.core/include/xtd/diagnostics/debugger.hpp index 39f4d03b4da6..7b2e3c09a204 100644 --- a/src/xtd.core/include/xtd/diagnostics/debugger.hpp +++ b/src/xtd.core/include/xtd/diagnostics/debugger.hpp @@ -37,7 +37,7 @@ namespace xtd { /// @{ /// @brief Gets a value that indicates whether a debugger is attached to the process. - /// @return true if a debugger is attached; otherwise, false. + /// @return `true` if a debugger is attached; otherwise, false. static bool is_attached(); /// @brief Signals a breakpoint to an attached debugger. @@ -50,11 +50,11 @@ namespace xtd { static void debug_break(); /// @brief Checks to see if logging is enabled by an attached debugger. - /// @return true if a debugger is attached and logging is enabled; otherwise, false. + /// @return `true` if a debugger is attached and logging is enabled; otherwise, false. static bool is_logging(); /// @brief Launches and attaches a debugger to the process. - /// @return true if the startup is successful or if the debugger is already attached; otherwise, false. + /// @return `true` if the startup is successful or if the debugger is already attached; otherwise, false. /// @remarks If a debugger is already attached, nothing happens. /// @remarks Debugger launch is only supported on Windows. On Unix and macOS operating systems, the method returns true without launching a debugger. static bool launch(); diff --git a/src/xtd.core/include/xtd/diagnostics/default_trace_listener.hpp b/src/xtd.core/include/xtd/diagnostics/default_trace_listener.hpp index 048b91d14696..9d2bce017d0f 100644 --- a/src/xtd.core/include/xtd/diagnostics/default_trace_listener.hpp +++ b/src/xtd.core/include/xtd/diagnostics/default_trace_listener.hpp @@ -60,7 +60,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the application is running in user-interface mode. - /// @return true if user-interface mode is enabled; otherwise, false. + /// @return `true` if user-interface mode is enabled; otherwise, false. /// @par Examples /// The following code example calls a function that calls the xtd::diagnostics::default_trace_listener::fail method to log an error message if the function throws an exception. If the xtd::diagnostics::default_trace_listener::assert_ui_enabled property is false, the method also writes the error message to the console. /// ```cpp diff --git a/src/xtd.core/include/xtd/diagnostics/process.hpp b/src/xtd.core/include/xtd/diagnostics/process.hpp index cc097c724719..6ef0335faf93 100644 --- a/src/xtd.core/include/xtd/diagnostics/process.hpp +++ b/src/xtd.core/include/xtd/diagnostics/process.hpp @@ -63,7 +63,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicate if the event is empty. - /// @return true if event does not contains functions; otherwise false. + /// @return `true` if event does not contains functions; otherwise `false`. bool is_empty() const noexcept; /// @} @@ -127,7 +127,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicate if the event is empty. - /// @return true if event does not contains functions; otherwise false. + /// @return `true` if event does not contains functions; otherwise `false`. bool is_empty() const noexcept; /// @} @@ -191,7 +191,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicate if the event is empty. - /// @return true if event does not contains functions; otherwise false. + /// @return `true` if event does not contains functions; otherwise `false`. bool is_empty() const noexcept; /// @} @@ -282,7 +282,7 @@ namespace xtd { int32 base_priority() const; /// @brief Gets whether the xtd::diagnostics::process::exited event should be raised when the process terminates. - /// @return true if the xtd::diagnostics::process::exited event should be raised when the associated process is terminated (through either an exit or a call to xtd::diagnostics::process::kill()); otherwise, false. The default is false. Note that the xtd::diagnostics::process::exited event is raised even if the value of xtd::diagnostics::process::enable_raising_events is false when the process exits during or before the user performs a xtd::diagnostics::process::has_exited check. + /// @return `true` if the xtd::diagnostics::process::exited event should be raised when the associated process is terminated (through either an exit or a call to xtd::diagnostics::process::kill()); otherwise, false. The default is false. Note that the xtd::diagnostics::process::exited event is raised even if the value of xtd::diagnostics::process::enable_raising_events is false when the process exits during or before the user performs a xtd::diagnostics::process::has_exited check. /// @remarks The xtd::diagnostics::process::enable_raising_events property suggests whether the component should be notified when the operating system has shut down a process. The xtd::diagnostics::process::enable_raising_events property is used in asynchronous processing to notify your application that a process has exited. To force your application to synchronously wait for an exit event (which interrupts processing of the application until the exit event has occurred), use the xtd::diagnostics::process::wait_for_exit method. /// @remarks If the component's xtd::diagnostics::process::enable_raising_events value is true, or when xtd::diagnostics::process::enable_raising_events is false and a xtd::diagnostics::process::has_exited check is invoked by the component, the component can access the administrative information for the associated process, which remains stored by the operating system. Such information includes the xtd::diagnostics::process::exit_time and the xtd::diagnostics::process::exit_code. /// @remarks After the associated process exits, the xtd::diagnostics::process::handle of the component no longer points to an existing process resource. Instead, it can only be used to access the operating system's information about the process resource. The operating system is aware that there are handles to exited processes that haven't been released by xtd::diagnostics::process components, so it keeps the xtd::diagnostics::process::exit_time and xtd::diagnostics::process::handle information in memory. @@ -327,7 +327,7 @@ namespace xtd { intptr handle() const; /// @brief Gets a value indicating whether the associated process has been terminated. - /// @return true if the operating system process referenced by the process component has terminated; otherwise, false. + /// @return `true` if the operating system process referenced by the process component has terminated; otherwise, false. /// @exception xtd::invalid_operation_exception There is no process associated with the object. /// @exception xtd::not_supported_exception You are trying to access the xtd::diagnostics::process::has_exited property for a process that is running on a remote computer. This property is available only for processes that are running on the local computer. /// @remarks A value of true for xtd::diagnostics::process::has_exited indicates that the associated process has terminated, either normally or abnormally. You can request or force the associated process to exit by calling xtd::diagnostics::process::close_main_window or xtd::diagnostics::process::kill. If a handle is open to the process, the operating system releases the process memory when the process has exited, but retains administrative information about the process, such as the handle, exit code, and exit time. To get this information, you can use the xtd::diagnostics::process::exit_code and xtd::diagnostics::process::exit_time properties. These properties are populated automatically for processes that were started by this component. The administrative information is released when all the Process components that are associated with the system process are destroyed and hold no more handles to the exited process. @@ -741,7 +741,7 @@ namespace xtd { void kill(); /// @brief Starts (or reuses) the process resource that is specified by the xtd::diagnostics::process::start_info property of this Process component and associates it with the component. - /// @return true if a process resource is started; false if no new process resource is started (for example, if an existing process is reused). + /// @return `true` if a process resource is started; false if no new process resource is started (for example, if an existing process is reused). /// @exception xtd::invalid_operation_exception No file name was specified in the xtd::diagnostics::process component's xtd::diagnostics::process::start_info. /// @par Examples /// The following example populates a StartInfo with the file to execute, the action performed on it and whether it should displays a user interface. For additional examples, refer to the reference pages for properties of the ProcessStartInfo class. diff --git a/src/xtd.core/include/xtd/diagnostics/process_start_info.hpp b/src/xtd.core/include/xtd/diagnostics/process_start_info.hpp index a1425f5b44fb..a40f0518db39 100644 --- a/src/xtd.core/include/xtd/diagnostics/process_start_info.hpp +++ b/src/xtd.core/include/xtd/diagnostics/process_start_info.hpp @@ -77,7 +77,7 @@ namespace xtd { process_start_info& arguments(const xtd::string& value) noexcept; /// @brief Gets a value indicating whether to start the process in a new window. - /// @return true if the process should be started without creating a new window to contain it; otherwise, false. The default is false. + /// @return `true` if the process should be started without creating a new window to contain it; otherwise, false. The default is false. /// @remarks If the xtd::diagnostics::process_start_info::use_shell_execute property is true or the xtd::diagnostics::process_start_info::user_name and xtd::diagnostics::process_start_info::password properties are not empty, the xtd::diagnostics::process_start_info::create_no_window property value is ignored and a new window is created. bool create_no_window() const noexcept; /// @brief Sets a value indicating whether to start the process in a new window. @@ -115,7 +115,7 @@ namespace xtd { std::map& environment_variables() noexcept; /// @brief Gets a value indicating whether an error dialog box is displayed to the user if the process cannot be started. - /// @return true if an error dialog box should be displayed on the screen if the process cannot be started; otherwise, false. The default is false. + /// @return `true` if an error dialog box should be displayed on the screen if the process cannot be started; otherwise, false. The default is false. /// @note xtd::diagnostics::process_start_info::use_shell_execute must be true if you want to set xtd::diagnostics::process_start_info::error_dialog to true. bool error_dialog() const noexcept; /// @brief Sets a value indicating whether an error dialog box is displayed to the user if the process cannot be started. @@ -150,7 +150,7 @@ namespace xtd { /// @endcond /// @brief Gets a value that indicates whether the Windows user profile is to be loaded from the registry. - /// @return true if the Windows user profile should be loaded; otherwise, false. The default is false. + /// @return `true` if the Windows user profile should be loaded; otherwise, false. The default is false. /// @remarks This property is referenced if the process is being started by using the user name, password, and domain. /// @remarks If the value is true, the user's profile in the HKEY_USERS registry key is loaded. Loading the profile can be time-consuming. Therefore, it is best to use this value only if you must access the information in the HKEY_CURRENT_USER registry key. bool load_user_profile() const noexcept; @@ -188,7 +188,7 @@ namespace xtd { process_start_info& password_in_clear_text(const xtd::string& value) noexcept; /// @brief Gets a value that indicates whether the error output of an application is written to the xtd::diagnostics::process::standard_error stream. - /// @return true if error output should be written to xtd::diagnostics::process::standard_error; otherwise, false. The default is false. + /// @return `true` if error output should be written to xtd::diagnostics::process::standard_error; otherwise, false. The default is false. /// @par Examples /// The following example uses the net use command together with a user supplied argument to map a network resource. It then reads the standard error stream of the net command and writes it to console. /// ```cpp @@ -402,7 +402,7 @@ namespace xtd { process_start_info& redirect_standard_error(bool value) noexcept; /// @brief Gets a value indicating whether the input for an application is read from the Process.StandardInput stream. - /// @return true if input should be read from Process.StandardInput; otherwise, false. The default is false. + /// @return `true` if input should be read from Process.StandardInput; otherwise, false. The default is false. /// @par Examples /// The following example illustrates how to redirect the xtd::diagnostics::process::standard_input stream of a process. The example starts the sort command with redirected input. It then prompts the user for text, and passes that to the sort process by means of the redirected xtd::diagnostics::process::standard_input stream. The sort results are displayed to the user on the console. /// ```cpp @@ -784,7 +784,7 @@ namespace xtd { process_start_info& user_name(const xtd::string& value) noexcept; /// @brief Gets a value indicating whether to use the operating system shell to start the process. - /// @return true if the shell should be used when starting the process; false if the process should be created directly from the executable file. The default is true. + /// @return `true` if the shell should be used when starting the process; false if the process should be created directly from the executable file. The default is true. /// @remarks Setting this property to false enables you to redirect input, output, and error streams. /// @note xtd::diagnostics::process_start_info::use_shell_execute must be false if the xtd::diagnostics::process_start_info::user_name property is not an empty string, or an xtd::invalid_operation_exception will be thrown when the xtd::diagnostics::process::start(process_start_info) method is called. /// @remarks When you use the operating system shell to start processes, you can start any document (which is any registered file type associated with an executable that has a default open action) and perform operations on the file, such as printing, by using the Process object. When xtd::diagnostics::process_start_info::use_shell_execute is false, you can start only executables by using the xtd::diagnostics::process object. diff --git a/src/xtd.core/include/xtd/diagnostics/source_switch.hpp b/src/xtd.core/include/xtd/diagnostics/source_switch.hpp index a77896996820..145a79a0a641 100644 --- a/src/xtd.core/include/xtd/diagnostics/source_switch.hpp +++ b/src/xtd.core/include/xtd/diagnostics/source_switch.hpp @@ -62,7 +62,7 @@ namespace xtd { /// @{ /// @brief Determines if trace listeners should be called, based on the trace event type. /// @param event_type One of the trace_event_type values. - /// @return true if the trace listeners should be called; otherwise, false. + /// @return `true` if the trace listeners should be called; otherwise, false. /// @remarks This method is called by the trace methods in the trace_source class to determine whether listeners should be called to write a trace. /// @note Application code should not call this method; it is intended to be called only by methods in the trace_source class. bool should_trace(xtd::diagnostics::trace_event_type event_type) noexcept; diff --git a/src/xtd.core/include/xtd/diagnostics/stopwatch.hpp b/src/xtd.core/include/xtd/diagnostics/stopwatch.hpp index be705f704f95..5e9d8882f355 100644 --- a/src/xtd.core/include/xtd/diagnostics/stopwatch.hpp +++ b/src/xtd.core/include/xtd/diagnostics/stopwatch.hpp @@ -95,7 +95,7 @@ namespace xtd { int64 elapsed_ticks() const noexcept; /// @brief Gets a value indicating whether the stopwatch timer is running. - /// @return true if the xtd::diagnostics::stopwatch instance is currently running and measuring elapsed time for an interval; otherwise, false. + /// @return `true` if the xtd::diagnostics::stopwatch instance is currently running and measuring elapsed time for an interval; otherwise, false. /// @remarks A xtd::diagnostics::stopwatch instance begins running with a call to xtd::diagnostics::stopwatch::start or xtd::diagnostics::stopwatch::start_new. The instance stops running with a call to xtd::diagnostics::stopwatch::stop or xtd::diagnostics::stopwatch::reset. bool is_running() const noexcept; /// @} @@ -108,7 +108,7 @@ namespace xtd { static int64 frequency() noexcept; /// @brief Indicates whether the timer is based on a high-resolution performance counter. This field is read-only. - /// @return true if the timer is based on a high-resolution performance count; otherwise, false. + /// @return `true` if the timer is based on a high-resolution performance count; otherwise, false. /// @remarks The timer used by the xtd::diagnostics::stopwatch class depends on the system hardware and operating system. xtd::diagnostics::stopwatch::is_high_resolution is true if the xtd::diagnostics::stopwatch timer is based on a high-resolution performance counter. Otherwise, xtd::diagnostics::stopwatch::is_high_resolution is false, which indicates that the xtd::diagnostics::stopwatch timer is based on the system timer. /// @remarks Returns always true static bool is_high_resolution() noexcept; diff --git a/src/xtd.core/include/xtd/diagnostics/trace.hpp b/src/xtd.core/include/xtd/diagnostics/trace.hpp index a2238f1962e7..fa1e4fc0e471 100644 --- a/src/xtd.core/include/xtd/diagnostics/trace.hpp +++ b/src/xtd.core/include/xtd/diagnostics/trace.hpp @@ -50,7 +50,7 @@ namespace xtd { /// @{ /// @brief Gets whether Flush should be called on the Listeners after every write. - /// @return true if Flush is called on the Listeners after every write; otherwise, false. + /// @return `true` if Flush is called on the Listeners after every write; otherwise, false. /// @remarks The default is false. /// @remarks Flushing the stream will not flush its underlying encoder unless you explicitly call Flush or Close. Setting AutoFlush to true means that data will be flushed from the buffer to the stream, but the encoder state will not be flushed. This allows the encoder to keep its state (partial characters) so that it can encode the next block of characters correctly. This scenario affects UTF8 and UTF7 where certain characters can only be encoded after the encoder receives the adjacent character or characters. static bool auto_flush() noexcept; @@ -90,14 +90,14 @@ namespace xtd { static void listeners(const listener_collection& listeners) noexcept; /// @brief Gets a value indicating whether the assert dialog should be show. - /// @return true if assert dialog is to be shown; otherwise, false. The default is true. + /// @return `true` if assert dialog is to be shown; otherwise, false. The default is true. /// @remarks The show assert dialog is used when xtd::diagnostics::debug::cassert or xtd::diagnostics::trace::cassert or #assert_ is called to ask user to ignore, continue or retry the assert. /// @note The xtd::diagnostics::debug::show_assert_dialog boolean is shared by both the xtd::diagnostics::debug and the xtd::diagnostics::trace classes; updating the boolean to either class modify the show assert dialog to both. /// @deprecated Replaced by xtd::diagnostics::default_trace_listener::assert_ui_enabled - Will be removed in version 0.4.0. [[deprecated("Replaced by xtd::diagnostics::default_trace_listener::assert_ui_enabled - Will be removed in version 0.4.0.")]] static bool show_assert_dialog() noexcept; /// @brief Sets a value indicating whether the assert dialog should be show. - /// @return true if assert dialog is to be shown; otherwise, false. The default is true. + /// @return `true` if assert dialog is to be shown; otherwise, false. The default is true. /// @remarks The show assert dialog is used when xtd::diagnostics::debug::cassert or xtd::diagnostics::trace::cassert or #assert_ is called to ask user to ignore, continue or retry the assert. /// @note The xtd::diagnostics::debug::show_assert_dialog boolean is shared by both the xtd::diagnostics::debug and the xtd::diagnostics::trace classes; updating the boolean to either class modify the show assert dialog to both. /// @deprecated Replaced by xtd::diagnostics::default_trace_listener::assert_ui_enabled - Will be removed in version 0.4.0. @@ -105,7 +105,7 @@ namespace xtd { static void show_assert_dialog(bool show_assert_dialog) noexcept; /// @brief Gets a value indicating whether the global lock should be used. - /// @return true if the global lock is to be used; otherwise, false. The default is true. + /// @return `true` if the global lock is to be used; otherwise, false. The default is true. /// @remarks The global lock is always used if the trace listener is not thread safe, regardless of the value of UseGlobalLock. The IsThreadSafe property is used to determine if the listener is thread safe. The global lock is not used only if the value of UseGlobalLock is false and the value of IsThreadSafe is true. The default behavior is to use the global lock. static bool use_global_lock() noexcept; /// @brief Sets a value indicating whether the global lock should be used. diff --git a/src/xtd.core/include/xtd/diagnostics/trace_listener.hpp b/src/xtd.core/include/xtd/diagnostics/trace_listener.hpp index c97f0c8188c8..40b17781aa54 100644 --- a/src/xtd.core/include/xtd/diagnostics/trace_listener.hpp +++ b/src/xtd.core/include/xtd/diagnostics/trace_listener.hpp @@ -318,7 +318,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether to indent the output. - /// @return true if the output should be indented; otherwise, false. + /// @return `true` if the output should be indented; otherwise, false. bool need_indent() const noexcept; /// @brief Sets a value indicating whether to indent the output. /// @param need_indent true if the output should be indented; otherwise, false. diff --git a/src/xtd.core/include/xtd/diagnostics/trace_switch.hpp b/src/xtd.core/include/xtd/diagnostics/trace_switch.hpp index 39f1ee6e1e87..a2e9343dfc84 100644 --- a/src/xtd.core/include/xtd/diagnostics/trace_switch.hpp +++ b/src/xtd.core/include/xtd/diagnostics/trace_switch.hpp @@ -59,19 +59,19 @@ namespace xtd { void level(xtd::diagnostics::trace_level level) noexcept; /// @brief Gets a value indicating whether the switch allows error-handling messages. - /// @return true if the xtd::diagnostics::trace_switch::level property is set to xtd::diagnostics::trace_level::error, xtd::diagnostics::trace_level::warning, xtd::diagnostics::trace_level::info, or xtd::diagnostics::trace_level::verbose; otherwise, false. + /// @return `true` if the xtd::diagnostics::trace_switch::level property is set to xtd::diagnostics::trace_level::error, xtd::diagnostics::trace_level::warning, xtd::diagnostics::trace_level::info, or xtd::diagnostics::trace_level::verbose; otherwise, false. bool trace_error() const noexcept; /// @brief Gets a value indicating whether the switch allows informational messages. - /// @return true if the xtd::diagnostics::trace_switch::level property is set to xtd::diagnostics::trace_level::info, or xtd::diagnostics::trace_level::verbose; otherwise, false. + /// @return `true` if the xtd::diagnostics::trace_switch::level property is set to xtd::diagnostics::trace_level::info, or xtd::diagnostics::trace_level::verbose; otherwise, false. bool trace_info() const noexcept; /// @brief Gets a value indicating whether the switch allows all messages. - /// @return true if the xtd::diagnostics::trace_switch::level property is set to xtd::diagnostics::trace_level::verbose; otherwise, false. + /// @return `true` if the xtd::diagnostics::trace_switch::level property is set to xtd::diagnostics::trace_level::verbose; otherwise, false. bool trace_verbose() const noexcept; /// @brief Gets a value indicating whether the switch allows warning messages. - /// @return true if the xtd::diagnostics::trace_switch::level property is set to xtd::diagnostics::trace_level::warning, xtd::diagnostics::trace_level::info, or xtd::diagnostics::trace_level::verbose; otherwise, false. + /// @return `true` if the xtd::diagnostics::trace_switch::level property is set to xtd::diagnostics::trace_level::warning, xtd::diagnostics::trace_level::info, or xtd::diagnostics::trace_level::verbose; otherwise, false. bool trace_warning() const noexcept; /// @} diff --git a/src/xtd.core/include/xtd/enum_object.hpp b/src/xtd.core/include/xtd/enum_object.hpp index c2d26c752f75..7df967e1c619 100644 --- a/src/xtd.core/include/xtd/enum_object.hpp +++ b/src/xtd.core/include/xtd/enum_object.hpp @@ -77,7 +77,7 @@ namespace xtd { /// @{ /// @brief Retrieves an array of the values of the constants in a specified enumeration. /// @param flag An enumeration value. - /// @return true if the bit field or bit fields that are set in flag are also set in the current instance; otherwise, false. + /// @return `true` if the bit field or bit fields that are set in flag are also set in the current instance; otherwise, false. /// @remarks The has_flag method returns the result of the following bool expression : this_instance And flag = flag bool has_flag(enum_type flag) const noexcept {return (to_int(value_) & to_int(flag)) == to_int(flag);} @@ -514,13 +514,13 @@ namespace xtd { /// @brief Returns an indication whether a constant with a specified value exists in a specified enumeration. /// @param fromValue An enumeration value. - /// @return true if a constant in enumType has a value equal to value; otherwise, false. + /// @return `true` if a constant in enumType has a value equal to value; otherwise, false. /// @exception xtd::argument_exception The value is ! a value of enumType. template static bool is_defined(enum_t value) noexcept {return std::find_if(enum_object().entries().begin(), enum_object().entries().end(), [&](auto item)->bool {return item.first == value;}) != enum_object().entries().end();} /// @brief Returns an indication whether a constant with a specified value exists in a specified enumeration. /// @param fromValue An enumeration value. - /// @return true if a constant in enumType has a value equal to value; otherwise, false. + /// @return `true` if a constant in enumType has a value equal to value; otherwise, false. /// @exception xtd::argument_exception The value is ! a value of enumType. template static bool is_defined(enum_object value) noexcept {return std::find_if(enum_object().entries().begin(), enum_object().entries().end(), [&](auto item)->bool {return item.first == value;}) != enum_object().entries().end();} @@ -598,7 +598,7 @@ namespace xtd { /// @brief Converts the xtd::string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. The return value indicates whether the conversion succeeded. /// @param vaue The xtd::string representation of the enumeration name or underlying value to convert. /// @param reslt When this method returns, result contains an object of type TEnum whose value is represented by value if the parse operation succeeds. If the parse operation fails, result contains the default value of the underlying type of TEnum. Note that this value need ! be a member of the TEnum enumeration. This parameter is passed uninitialized. - /// @return true if the value parameter was converted successfully; otherwise, false. + /// @return `true` if the value parameter was converted successfully; otherwise, false. template static bool try_parse(const xtd::string& value, enum_t& result) noexcept {return try_parse(value, false, result);} @@ -606,7 +606,7 @@ namespace xtd { /// @param vaue The xtd::string representation of the enumeration name or underlying value to convert. /// @param ignore_case true to Ignore case; false to regard case. /// @param reslt When this method returns, result contains an object of type TEnum whose value is represented by value if the parse operation succeeds. If the parse operation fails, result contains the default value of the underlying type of TEnum. Note that this value need ! be a member of the TEnum enumeration. This parameter is passed uninitialized. - /// @return true if the value parameter was converted successfully; otherwise, false. + /// @return `true` if the value parameter was converted successfully; otherwise, false. template static bool try_parse(const xtd::string& value, bool ignore_case, enum_t& result) noexcept { try { diff --git a/src/xtd.core/include/xtd/environment.hpp b/src/xtd.core/include/xtd/environment.hpp index 80d3e620ad32..c3bb47132485 100644 --- a/src/xtd.core/include/xtd/environment.hpp +++ b/src/xtd.core/include/xtd/environment.hpp @@ -408,11 +408,11 @@ namespace xtd { static bool has_shutdown_started(); /// @brief Determines whether the current operating system is a 64-bit operating system. - /// @return true if the operating system is 64-bit; otherwise, false. + /// @return `true` if the operating system is 64-bit; otherwise, false. static bool is_64_bit_operating_system() noexcept; /// @brief Determines whether the current process is a 64-bit process. - /// @return true if the process is 64-bit; otherwise, false. + /// @return `true` if the process is 64-bit; otherwise, false. static bool is_64_bit_process() noexcept; /// @brief Gets a copy of the global C++ locale, which is the locale most recently used as the argument to See [std::locale::global](https://en.cppreference.com/w/cpp/locale/locale/locale) or a copy of See [std::locale::classic()](https://en.cppreference.com/w/cpp/locale/locale/locale) if no call to See [std::locale::global](https://en.cppreference.com/w/cpp/locale/locale/locale) has been made. diff --git a/src/xtd.core/include/xtd/event.hpp b/src/xtd.core/include/xtd/event.hpp index 904daf3bc803..197267868e56 100644 --- a/src/xtd.core/include/xtd/event.hpp +++ b/src/xtd.core/include/xtd/event.hpp @@ -25,7 +25,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicate if the event is empty. - /// @return true if evcent does not contains functions; otherwise false. + /// @return `true` if evcent does not contains functions; otherwise `false`. bool is_empty() const noexcept { return handler_t::is_empty(); } diff --git a/src/xtd.core/include/xtd/exception.hpp b/src/xtd.core/include/xtd/exception.hpp index 473132c7a3b6..a81ce47224ce 100644 --- a/src/xtd.core/include/xtd/exception.hpp +++ b/src/xtd.core/include/xtd/exception.hpp @@ -125,10 +125,10 @@ namespace xtd { /// @{ /// @brief Gets if the generation of the stack trace is enabled. - /// @return triue if stack trace enabled; otherwhise false. + /// @return triue if stack trace enabled; otherwise `false`. static bool enable_stack_trace() noexcept; /// @brief Sets if the generation of the stack trace is enabled. - /// @paran enable triue if stack trace enabled; otherwhise false. + /// @paran enable triue if stack trace enabled; otherwise `false`. static void enable_stack_trace(bool enable) noexcept; /// @} diff --git a/src/xtd.core/include/xtd/extensions/comparison_operators.hpp b/src/xtd.core/include/xtd/extensions/comparison_operators.hpp index 4a7eb56a45cf..be9ee087a534 100644 --- a/src/xtd.core/include/xtd/extensions/comparison_operators.hpp +++ b/src/xtd.core/include/xtd/extensions/comparison_operators.hpp @@ -35,7 +35,7 @@ namespace xtd { /// @brief Less than comparison operator with specidied lhs ans rhs values. /// @param lhs The left hand side value to compare. /// @param rhs The right hand side value to compare. - /// @return true if lhs less than rhs; otherwise false. + /// @return `true` if lhs less than rhs; otherwise `false`. friend bool operator <(const type_t& lhs, const type_t& rhs) noexcept { auto rhs_ptr = &rhs; return dynamic_cast(rhs_ptr) && lhs.compare_to(static_cast(rhs)) < 0; @@ -44,7 +44,7 @@ namespace xtd { /// @brief Less than or equal to comparison operator with specidied lhs ans rhs values. /// @param lhs The left hand side value to compare. /// @param rhs The right hand side value to compare. - /// @return true if lhs less than or equal to rhs; otherwise false. + /// @return `true` if lhs less than or equal to rhs; otherwise `false`. friend bool operator <=(const type_t& lhs, const type_t& rhs) noexcept { auto rhs_ptr = &rhs; return dynamic_cast(rhs_ptr) && lhs.compare_to(static_cast(rhs)) <= 0; @@ -53,7 +53,7 @@ namespace xtd { /// @brief Greater than or equal to comparison operator with specidied lhs ans rhs values. /// @param lhs The left hand side value to compare. /// @param rhs The right hand side value to compare. - /// @return true if lhs greater than rhs; otherwise false. + /// @return `true` if lhs greater than rhs; otherwise `false`. friend bool operator >(const type_t& lhs, const type_t& rhs) noexcept { auto rhs_ptr = &rhs; return dynamic_cast(rhs_ptr) && lhs.compare_to(static_cast(rhs)) > 0; @@ -62,7 +62,7 @@ namespace xtd { /// @brief Less than comparison operator with specidied lhs ans rhs values. /// @param lhs The left hand side value to compare. /// @param rhs The right hand side value to compare. - /// @return true if lhs greater than or equal to rhs; otherwise false. + /// @return `true` if lhs greater than or equal to rhs; otherwise `false`. friend bool operator >=(const type_t& lhs, const type_t& rhs) noexcept { auto rhs_ptr = &rhs; return dynamic_cast(rhs_ptr) && lhs.compare_to(static_cast(rhs)) >= 0; diff --git a/src/xtd.core/include/xtd/extensions/equality_operators.hpp b/src/xtd.core/include/xtd/extensions/equality_operators.hpp index cf5bcf99bb72..8377b1136cd4 100644 --- a/src/xtd.core/include/xtd/extensions/equality_operators.hpp +++ b/src/xtd.core/include/xtd/extensions/equality_operators.hpp @@ -32,12 +32,12 @@ namespace xtd { /// @brief Equal to operator with specidied lhs ans rhs values. /// @param lhs The left hand side value to compare. /// @param rhs The right hand side value to compare. - /// @return true if lhs is equal to rhs; otherwise false. + /// @return `true` if lhs is equal to rhs; otherwise `false`. friend bool operator ==(const type_t& lhs, const type_t& rhs) noexcept {return lhs.equals(rhs);} /// @brief Not equal to operator with specidied lhs ans rhs values. /// @param lhs The left hand side value to compare. /// @param rhs The right hand side value to compare. - /// @return true if lhs is not equal to rhs; otherwise false. + /// @return `true` if lhs is not equal to rhs; otherwise `false`. friend bool operator !=(const type_t& lhs, const type_t& rhs) noexcept {return !operator ==(lhs, rhs);} /// @} private: diff --git a/src/xtd.core/include/xtd/iasync_result.hpp b/src/xtd.core/include/xtd/iasync_result.hpp index 44d8345e0341..7754680bffd3 100644 --- a/src/xtd.core/include/xtd/iasync_result.hpp +++ b/src/xtd.core/include/xtd/iasync_result.hpp @@ -47,14 +47,14 @@ namespace xtd { virtual xtd::threading::wait_handle& async_wait_handle() noexcept = 0; /// @brief Gets a value that indicates whether the asynchronous operation completed synchronously. - /// @return true if the asynchronous operation completed synchronously; otherwise, false. + /// @return `true` if the asynchronous operation completed synchronously; otherwise, false. /// @remarks If the synchronous completion of the call is detected in the xtd::async_callback delegate, it is probable that the thread that initiated the asynchronous operation is the current thread. /// @par Notes to Callers /// Use this property to determine if the asynchronous operation completed synchronously. For example, this property can return true for an asynchronous I/O operation if the I/O request was small. virtual bool completed_synchronously() const noexcept = 0; /// @brief Gets a value that indicates whether the asynchronous operation has completed. - /// @return true if the operation is complete; otherwise, false. + /// @return `true` if the operation is complete; otherwise, false. /// @remarks When this property is true, you can assume it is safe to discard any resources you allocate for use by the asynchronous operation. /// @par Notes to Implementers /// Implementers will typically return the value of a private field or internal test as the value of this property. diff --git a/src/xtd.core/include/xtd/io/binary_reader.hpp b/src/xtd.core/include/xtd/io/binary_reader.hpp index 1c0445b0ec37..2175295c5ca0 100644 --- a/src/xtd.core/include/xtd/io/binary_reader.hpp +++ b/src/xtd.core/include/xtd/io/binary_reader.hpp @@ -71,7 +71,7 @@ namespace xtd { std::optional> base_stream() const; /// @brief Gets a value that indicates whether the current stream position is at the end of the stream. - /// @return true if the current stream position is at the end of the stream; otherwise false. + /// @return `true` if the current stream position is at the end of the stream; otherwise `false`. bool end_of_stream() const; /// @} @@ -123,7 +123,7 @@ namespace xtd { virtual size_t read(std::vector& buffer, size_t index, size_t count); /// @brief Reads a boolean value from the current stream and advances the current position of the stream by one byte. - /// @return true if the byte is nonzero; otherwise, false. + /// @return `true` if the byte is nonzero; otherwise, false. /// @exception EndOfStreamException The end of the stream is reached. /// @exception xtd::io::io_exception An I/O error occurred. /// @remarks xtd::io::binary_reader does not restore the file position after an unsuccessful read operation. diff --git a/src/xtd.core/include/xtd/io/directory.hpp b/src/xtd.core/include/xtd/io/directory.hpp index 5a8a1342c2d8..1c6da961a5ba 100644 --- a/src/xtd.core/include/xtd/io/directory.hpp +++ b/src/xtd.core/include/xtd/io/directory.hpp @@ -474,7 +474,7 @@ namespace xtd { /// @brief Determines whether the given path refers to an existing directory on disk. /// @param path The path to test. - /// @return true if path refers to an existing directory; false if the directory does not exist or an error occurs when trying to determine if the specified directory exists. + /// @return `true` if path refers to an existing directory; false if the directory does not exist or an error occurs when trying to determine if the specified directory exists. /// @par rExample /// The following example takes an array of file or directory names on the command line, determines what kind of name it is, and processes it appropriately. /// ```cpp diff --git a/src/xtd.core/include/xtd/io/directory_info.hpp b/src/xtd.core/include/xtd/io/directory_info.hpp index b1a42fa05f4e..f6b76c9f9a85 100644 --- a/src/xtd.core/include/xtd/io/directory_info.hpp +++ b/src/xtd.core/include/xtd/io/directory_info.hpp @@ -289,7 +289,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the directory exists. - /// @return true if the directory exists; otherwise, false. + /// @return `true` if the directory exists; otherwise, false. /// @par Examples /// The following example demonstrates a use of the Exists property in the context of copying a source directory to a target directory. /// ```cpp diff --git a/src/xtd.core/include/xtd/io/drive_info.hpp b/src/xtd.core/include/xtd/io/drive_info.hpp index 14c978048ec0..af2b84d1e3ba 100644 --- a/src/xtd.core/include/xtd/io/drive_info.hpp +++ b/src/xtd.core/include/xtd/io/drive_info.hpp @@ -83,7 +83,7 @@ namespace xtd { xtd::io::drive_type drive_type() const; /// @brief Gets a value that indicates whether a drive is ready. - /// @return true if the drive is ready; false if the drive is not ready. + /// @return `true` if the drive is ready; false if the drive is not ready. /// @par Examples /// The following code example demonstrates the use of the xtd::io::drive_info class to display information about all of the drives on the current system. /// @include drive_info.cpp diff --git a/src/xtd.core/include/xtd/io/file.hpp b/src/xtd.core/include/xtd/io/file.hpp index 36e79db78877..36ee996553f3 100644 --- a/src/xtd.core/include/xtd/io/file.hpp +++ b/src/xtd.core/include/xtd/io/file.hpp @@ -44,7 +44,7 @@ namespace xtd { /// @brief Appends lines to a file, and then closes the file. If the specified file does not exist, this method creates a file, writes the specified lines to the file, and then closes the file. /// @param path The file to write to. /// @param contents The lines to append to the file. - /// @return true if the text appended; otherwise, false. + /// @return `true` if the text appended; otherwise, false. /// @exception xtd::argument_exception path contains one or more of the invalid characters
-or-
The system could not retrieve the absolute path. /// @exception xtd::io::io_exception the handle of the specified file cannot be opened. /// @remarks If the target file already exists, it is overwritten. @@ -58,7 +58,7 @@ namespace xtd { /// @brief Appends lines to a file, and then closes the file. If the specified file does not exist, this method creates a file, writes the specified lines to the file, and then closes the file. /// @param path The file to write to. /// @param contents The lines to append to the file. - /// @return true if the text appended; otherwise, false. + /// @return `true` if the text appended; otherwise, false. /// @exception xtd::argument_exception path contains one or more of the invalid characters
-or-
The system could not retrieve the absolute path. /// @exception xtd::io::io_exception the handle of the specified file cannot be opened. /// @remarks If the target file already exists, it is overwritten. @@ -72,7 +72,7 @@ namespace xtd { /// @brief Appends text to a file, and then closes the file. If the specified file does not exist, this method creates a file, writes the specified lines to the file, and then closes the file. /// @param path The file to write to. /// @param contents The text to append to the file. - /// @return true if the text appended; otherwise, false. + /// @return `true` if the text appended; otherwise, false. /// @exception xtd::argument_exception path contains one or more of the invalid characters
-or-
The system could not retrieve the absolute path. /// @exception xtd::io::io_exception the handle of the specified file cannot be opened. template @@ -121,7 +121,7 @@ namespace xtd { /// @brief Determines whether the specified file exists. /// @param path The file to check. - /// @return true if the caller has the required permissions and path contains the name of an existing file; otherwise, false. + /// @return `true` if the caller has the required permissions and path contains the name of an existing file; otherwise, false. /// @remarks This method also returns false if path is empty or an invalid path. /// @remarks If the caller does not have sufficient permissions to read the specified file, no exception is thrown and the method returns false regardless of the existence of path. static bool exists(const xtd::string& path) noexcept; @@ -168,7 +168,7 @@ namespace xtd { /// @brief Moves a specified file to a new location, providing the option to specify a new file name. /// @param src The name of the file to move. /// @param dest The new path for the file. - /// @return true if the file moved; otherwise, false. + /// @return `true` if the file moved; otherwise, false. /// @exception xtd::argument_exception if dest already exist. /// @exception xtd::io::io_exception if path is empty or an invalid path. /// @exception xtd::io::io_exception if the caller has not the required permissions. @@ -178,7 +178,7 @@ namespace xtd { /// @param src The name of the file to move. /// @param dest The new path for the file. /// @param overwrite true to overwrite the destination file if it already exists; false otherwise. - /// @return true if the file moved; otherwise, false. + /// @return `true` if the file moved; otherwise, false. /// @exception xtd::argument_exception if dest already exist. /// @exception xtd::io::io_exception if path is empty or an invalid path. /// @exception xtd::io::io_exception if the caller has not the required permissions. @@ -247,7 +247,7 @@ namespace xtd { /// @brief Deletes the specified file. /// @param path The name of the file to be deleted. /// @return std::ofstream An unshared std::ofstream that provides access to the specified file, with the specified mode and access. - /// @return true if the file is deleted; otherwise, false. + /// @return `true` if the file is deleted; otherwise, false. static void remove(const xtd::string& path); /// @brief Replaces the contents of a specified file with the contents of another file, deleting the original file, and creating a backup of the replaced file and optionally ignores merge errors. @@ -324,7 +324,7 @@ namespace xtd { /// @brief Writes lines to a file, and then closes the file. If the specified file does not exist, this method creates a file, writes the specified lines to the file, and then closes the file. /// @param path The file to write to. /// @param contents The lines to write to the file. - /// @return true if the text written; otherwise, false. + /// @return `true` if the text written; otherwise, false. /// @exception xtd::argument_exception path contains one or more of the invalid characters
-or-
The system could not retrieve the absolute path. /// @exception xtd::io::io_exception the handle of the specified file cannot be opened. /// @remarks If the target file already exists, it is overwritten. @@ -338,7 +338,7 @@ namespace xtd { /// @brief Writes lines to a file, and then closes the file. If the specified file does not exist, this method creates a file, writes the specified lines to the file, and then closes the file. /// @param path The file to write to. /// @param contents The lines to write to the file. - /// @return true if the text written; otherwise, false. + /// @return `true` if the text written; otherwise, false. /// @exception xtd::argument_exception path contains one or more of the invalid characters
-or-
The system could not retrieve the absolute path. /// @exception xtd::io::io_exception the handle of the specified file cannot be opened. /// @remarks If the target file already exists, it is overwritten. @@ -352,7 +352,7 @@ namespace xtd { /// @brief Writes text to a file, and then closes the file. If the specified file does not exist, this method creates a file, writes the specified lines to the file, and then closes the file. /// @param path The file to write to. /// @param contents The text to write to the file. - /// @return true if the text written; otherwise, false. + /// @return `true` if the text written; otherwise, false. /// @exception xtd::argument_exception path contains one or more of the invalid characters
-or-
The system could not retrieve the absolute path. /// @exception xtd::io::io_exception the handle of the specified file cannot be opened. template diff --git a/src/xtd.core/include/xtd/io/file_info.hpp b/src/xtd.core/include/xtd/io/file_info.hpp index c17b9a14f888..b8a4a2cc3718 100644 --- a/src/xtd.core/include/xtd/io/file_info.hpp +++ b/src/xtd.core/include/xtd/io/file_info.hpp @@ -98,7 +98,7 @@ namespace xtd { xtd::string directory_name() const; /// @brief Gets a value indicating whether a file exists. - /// @return true if the file exists; false if the file does not exist or if the file is a directory. + /// @return `true` if the file exists; false if the file does not exist or if the file is a directory. /// @par Examples /// The following code example uses the xtd::io::file_info::exists property ensure a file exists before opening it. You can use this technique to throw a custom exception when the file is not found. /// ```cpp @@ -133,7 +133,7 @@ namespace xtd { bool exists() const override; /// @brief Gets a value that determines if the current file is read only. - /// @return true if the current file is read only; otherwise, false. + /// @return `true` if the current file is read only; otherwise, false. /// @exception xtd::io::file_not_found_exception The file described by the current xtd::io::file_info object could not be found. /// @exception xtd::io::io_exception An I/O error occurred while opening the file. /// @exception xtd::unauthorized_access_exception This operation is not supported on the current platform.
-or-
The caller does not have the required permission. diff --git a/src/xtd.core/include/xtd/io/file_system_info.hpp b/src/xtd.core/include/xtd/io/file_system_info.hpp index fa4ed197c16b..def5d0c1197c 100644 --- a/src/xtd.core/include/xtd/io/file_system_info.hpp +++ b/src/xtd.core/include/xtd/io/file_system_info.hpp @@ -242,7 +242,7 @@ namespace xtd { xtd::io::file_system_info& creation_time_utc(const xtd::date_time& value); /// @brief Gets a value indicating whether the file or directory exists. - /// @return true if the file or directory exists; otherwise, false. + /// @return `true` if the file or directory exists; otherwise, false. /// @remarks For a list of common I/O tasks, see [Common I/O Tasks](https://gammasoft71.github.io/xtd/docs/documentation/Guides/xtd.core/Common%20I%3AO%20tasks). virtual bool exists() const = 0; diff --git a/src/xtd.core/include/xtd/io/path.hpp b/src/xtd.core/include/xtd/io/path.hpp index f1e4fb3704f0..984bb161e50c 100644 --- a/src/xtd.core/include/xtd/io/path.hpp +++ b/src/xtd.core/include/xtd/io/path.hpp @@ -249,14 +249,14 @@ namespace xtd { /// @brief Determines whether a path includes a file name extension. /// @param path The path to search for an extension. - /// @return true if the characters that follow the last directory separator (\\ or /) + /// @return `true` if the characters that follow the last directory separator (\\ or /) /// @return or volume separator (:) in the path include a period (.) followed by one /// @return or more characters; otherwise, false. static bool has_extension(const xtd::string& path); /// @brief Gets a value indicating whether the specified path string contains absolute or relative path information. /// @param path The path to test. - /// @return true if path contains an absolute path; otherwise, false. + /// @return `true` if path contains an absolute path; otherwise, false. /// @remarks This method also returns false if path is empty or an invalid path. /// @remarks If the caller does not have sufficient permissions to read the specified file, no exception is thrown and the method returns false regardless of the existence of path. static bool is_path_rooted(const xtd::string& path); diff --git a/src/xtd.core/include/xtd/io/stream.hpp b/src/xtd.core/include/xtd/io/stream.hpp index 597fb0f3bcb8..8ae82b3cf30d 100644 --- a/src/xtd.core/include/xtd/io/stream.hpp +++ b/src/xtd.core/include/xtd/io/stream.hpp @@ -104,7 +104,7 @@ namespace xtd { virtual bool can_write() const noexcept = 0; /// @brief Indicates if the stream is closed - /// @return true if the stream is closed, false otherwise + /// @return `true` if the stream is closed, false otherwise virtual bool is_closed() const noexcept; /// @brief When overridden in a derived class, gets the length in bytes of the stream. diff --git a/src/xtd.core/include/xtd/io/stream_reader.hpp b/src/xtd.core/include/xtd/io/stream_reader.hpp index c02b72fd9d6d..b6c0d02a136e 100644 --- a/src/xtd.core/include/xtd/io/stream_reader.hpp +++ b/src/xtd.core/include/xtd/io/stream_reader.hpp @@ -52,7 +52,7 @@ namespace xtd { std::optional> base_stream() const; /// @brief Gets a value that indicates whether the current stream position is at the end of the stream. - /// @return true if the current stream position is at the end of the stream; otherwise false. + /// @return `true` if the current stream position is at the end of the stream; otherwise `false`. bool end_of_stream() const; /// @} diff --git a/src/xtd.core/include/xtd/io/stream_writer.hpp b/src/xtd.core/include/xtd/io/stream_writer.hpp index 0e5cb245a02b..89eb137595ee 100644 --- a/src/xtd.core/include/xtd/io/stream_writer.hpp +++ b/src/xtd.core/include/xtd/io/stream_writer.hpp @@ -58,7 +58,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the xtd::io::stream_writer will flush its buffer to the underlying stream after every call to xtd::io::text_writer::write(char). - /// @return true to force xtd::io::stream_writer to flush its buffer; otherwise, false. + /// @return `true` to force xtd::io::stream_writer to flush its buffer; otherwise, false. /// @remarks Flushing the stream will not flush its underlying encoder unless you explicitly call xtd::io::stream_writer::flush or xtd::io::stream_writer::close. Setting xtd::io::stream_writer::auto_flush to true means that data will be flushed from the buffer to the stream after each write operation, but the encoder state will not be flushed. /// @remarks When xtd::io::stream_writer::auto_flush is set to false, xtd::io::stream_writer will do a limited amount of buffering, both internally and potentially in the encoder from the encoding you passed in. You can get better performance by setting AutoFlush to false, assuming that you always call xtd::io::stream_writer::close (or at least Flush) when you're done writing with a xtd::io::stream_writer. /// @remarks For example, set xtd::io::stream_writer::auto_flush to true when you are writing to a device where the user expects immediate feedback. xtd::console::out is one of these cases: The xtd::io::stream_writer used internally for writing to xtd::console flushes all its internal state except the encoder state after every call to xtd::io::stream_writer::write. diff --git a/src/xtd.core/include/xtd/isynchronize_invoke.hpp b/src/xtd.core/include/xtd/isynchronize_invoke.hpp index 573b9bca74ea..2048f5c6578b 100644 --- a/src/xtd.core/include/xtd/isynchronize_invoke.hpp +++ b/src/xtd.core/include/xtd/isynchronize_invoke.hpp @@ -29,7 +29,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the caller must call Invoke(Delegate, Object[]) when calling an object that implements this interface. - /// @return true if the caller must call xtd::isynchronize_invoke::invoke; otherwise, false. + /// @return `true` if the caller must call xtd::isynchronize_invoke::invoke; otherwise, false. /// @remarks This property determines whether the caller must call xtd::isynchronize_invoke::invoke when making method calls to an object that implements this interface. Such objects are bound to a specific thread and are not thread-safe. If you are calling a method from a different thread, you must use the xtd::isynchronize_invoke::invoke method to marshal the call to the proper thread. virtual bool invoke_required() const noexcept = 0; /// @} diff --git a/src/xtd.core/include/xtd/linq/enumerable.hpp b/src/xtd.core/include/xtd/linq/enumerable.hpp index cb17005ee66a..6531cd141537 100644 --- a/src/xtd.core/include/xtd/linq/enumerable.hpp +++ b/src/xtd.core/include/xtd/linq/enumerable.hpp @@ -168,7 +168,7 @@ namespace xtd { /// @tparam source_t The type of the elements of source. /// @param source An xtd::collections::generic::ienumerable that contains the elements to apply the predicate to. /// @param predicate A function to test each element for a condition. - /// @return true if every element of the source sequence passes the test in the specified predicate, or if the sequence is empty; otherwise, false. + /// @return `true` if every element of the source sequence passes the test in the specified predicate, or if the sequence is empty; otherwise, false. /// @par Examples /// The following code example demonstrates how to use xtd::linq::enumerable::all to determine whether all the elements in a sequence satisfy a condition. Variable all_start_with_B is true if all the pet names start with "B" or if the pets array is empty. /// @include enumerable_all.cpp @@ -183,7 +183,7 @@ namespace xtd { /// @tparam source_t The type of the elements of source. /// @param source The xtd::collections::generic::ienumerable to check for emptiness. /// @param last The last iterator. - /// @return true if the source sequence contains any elements; otherwise, false. + /// @return `true` if the source sequence contains any elements; otherwise, false. /// @par Examples /// The following code example demonstrates how to use Any to determine whether a sequence contains any elements. /// @include enumerable_any.cpp @@ -195,7 +195,7 @@ namespace xtd { /// @tparam source_t The type of the elements of source. /// @param source An xtd::collections::generic::ienumerable that contains the elements to apply the predicate to. /// @param predicate A function to test each element for a condition. - /// @return true if every element of the source sequence passes the test in the specified predicate, or if the sequence is empty; otherwise, false. + /// @return `true` if every element of the source sequence passes the test in the specified predicate, or if the sequence is empty; otherwise, false. /// @par Examples /// The following code example demonstrates how to use xtd::linq::enumerable::all to determine whether all the elements in a sequence satisfy a condition. Variable all_start_with_B is true if all the pet names start with "B" or if the pets array is empty. /// @include enumerable_all.cpp @@ -394,7 +394,7 @@ namespace xtd { /// @tparam source_t The type of the elements of source. /// @param source A sequence in which to locate a value. /// @param value The value to locate in the sequence. - /// @return true if the source sequence contains an element that has the specified value; otherwise, false. + /// @return `true` if the source sequence contains an element that has the specified value; otherwise, false. template static bool contains(const ienumerable& source, const source_t& value) noexcept { for (const auto& item : source) @@ -407,7 +407,7 @@ namespace xtd { /// @param source A sequence in which to locate a value. /// @param value The value to locate in the sequence. /// @param comparer An equality comparer to compare values. - /// @return true if the source sequence contains an element that has the specified value; otherwise, false. + /// @return `true` if the source sequence contains an element that has the specified value; otherwise, false. template static bool contains(const ienumerable& source, const source_t& value, const xtd::collections::generic::iequality_comparer& comparer) noexcept { for (const auto& item : source) diff --git a/src/xtd.core/include/xtd/math.hpp b/src/xtd.core/include/xtd/math.hpp index 2f0b7c7a241c..d46f4f46ed53 100644 --- a/src/xtd.core/include/xtd/math.hpp +++ b/src/xtd.core/include/xtd/math.hpp @@ -311,28 +311,28 @@ namespace xtd { /// @brief Returns a value indicating whether the specified number evaluates to negative or positive infinity. /// @param value A double-precision floating-point number. - /// @return true if value evaluates to xtd::math::positive_infinity or xtd::math::negative_infinity; otherwise, false. + /// @return `true` if value evaluates to xtd::math::positive_infinity or xtd::math::negative_infinity; otherwise, false. /// @deprecated Replaced by xtd::double_object::is_infinity - Will be removed in version 0.4.0. [[deprecated("Replaced by xtd::double_object::is_infinity - Will be removed in version 0.4.0.")]] static bool is_infinity(double value) noexcept; /// @brief Returns a value indicating whether the specified number evaluates to negative infinity. /// @param value A double-precision floating-point number. - /// @return true if value evaluates to xtd::math::negative_infinity; otherwise, false. + /// @return `true` if value evaluates to xtd::math::negative_infinity; otherwise, false. /// @deprecated Replaced by xtd::double_object::is_negative_infinity - Will be removed in version 0.4.0. [[deprecated("Replaced by xtd::double_object::is_negative_infinity - Will be removed in version 0.4.0.")]] static bool is_negative_infinity(double value) noexcept; /// @brief Returns a value indicating whether the specified number evaluates to positive infinity. /// @param value A double-precision floating-point number. - /// @return true if value evaluates to xtd::math::positive_infinity; otherwise, false. + /// @return `true` if value evaluates to xtd::math::positive_infinity; otherwise, false. /// @deprecated Replaced by xtd::double_object::is_positive_infinity - Will be removed in version 0.4.0. [[deprecated("Replaced by xtd::double_object::is_positive_infinity - Will be removed in version 0.4.0.")]] static bool is_positive_infinity(double value) noexcept; /// @brief Returns a value indicating whether the specified number evaluates to not a number. /// @param value A double-precision floating-point number. - /// @return true if value evaluates to not a number; otherwise, false. + /// @return `true` if value evaluates to not a number; otherwise, false. /// @deprecated Replaced by xtd::double_object::is_NaN - Will be removed in version 0.4.0. [[deprecated("Replaced by xtd::double_object::is_NaN - Will be removed in version 0.4.0.")]] static bool is_NaN(double value) noexcept; diff --git a/src/xtd.core/include/xtd/net/ip_address.hpp b/src/xtd.core/include/xtd/net/ip_address.hpp index 9813a8b4c4dc..d8b8d2bc7d83 100644 --- a/src/xtd.core/include/xtd/net/ip_address.hpp +++ b/src/xtd.core/include/xtd/net/ip_address.hpp @@ -105,7 +105,7 @@ namespace xtd { sockets::address_family address_family() const noexcept; /// @brief Gets whether the IP address is an IPv4-mapped IPv6 address. - /// @return true if the IP address is an IPv4-mapped IPv6 address; otherwise, false. + /// @return `true` if the IP address is an IPv4-mapped IPv6 address; otherwise, false. /// @remarks Dual-stack sockets always require IPv6 addresses. The ability to interact with an IPv4 address requires the use of the IPv4-mapped IPv6 address format. Any IPv4 addresses must be represented in the IPv4-mapped IPv6 address format which enables an IPv6 only application to communicate with an IPv4 node. The IPv4-mapped IPv6 address format allows the IPv4 address of an IPv4 node to be represented as an IPv6 address. The IPv4 address is encoded into the low-order 32 bits of the IPv6 address, and the high-order 96 bits hold the fixed prefix 0:0:0:0:0:FFFF. The IPv4-mapped IPv6 address format is specified in RFC 4291. For more information, see www.ietf.org/rfc/rfc4291.txt. bool is_ip_v4_mapped_to_ip_v6() const noexcept; @@ -122,7 +122,7 @@ namespace xtd { bool is_ip_v6_site_local() const noexcept; /// @brief Gets whether the address is an IPv6 Teredo address. - /// @return true if the IP address is an IPv6 Teredo address; otherwise, false. + /// @return `true` if the IP address is an IPv6 Teredo address; otherwise, false. /// @remarks A Teredo address is an IPv6 address with the prefix of 2001::/32. Teredo addresses can be returned through normal DNS name resolution or enumerated as an IPv6 address assigned to a local interface. bool is_ip_v6_teredo() const noexcept; diff --git a/src/xtd.core/include/xtd/net/sockets/linger_option.hpp b/src/xtd.core/include/xtd/net/sockets/linger_option.hpp index e79b6179a092..618772adc52e 100644 --- a/src/xtd.core/include/xtd/net/sockets/linger_option.hpp +++ b/src/xtd.core/include/xtd/net/sockets/linger_option.hpp @@ -63,7 +63,7 @@ namespace xtd { /// @{ /// @brief Gets a value that indicates whether to linger after the xtd::net::sockets::socket is closed. - /// @return true if the xtd::net::sockets::socket should linger after xtd::net::sockets::socket::close is called; otherwise, false. + /// @return `true` if the xtd::net::sockets::socket should linger after xtd::net::sockets::socket::close is called; otherwise, false. /// @remarks You can use the xtd::net::sockets::linger_option::enabled property to determine whether the xtd::net::sockets::socket will linger after closing. Change this value to true or false and pass the altered xtd::net::sockets::linger_option to the xtd::net::sockets::socket::set_socket_option method or set the xtd::net::sockets::socket::linger_state or xtd::net::sockets::tcp_client::linger_state property to disable or enable lingering. /// @remarks The following table describes the behavior on the xtd::net::sockets::socket::close and xtd::net::sockets::tcp_client::close methods based on the possible values of the enable and seconds parameters when an xtd::net::sockets::linger_option instance is created and set in the xtd::net::sockets::socket::linger_state or xtd::net::sockets::socket xtd::net::sockets::tcp_client::linger_state property. /// | enable | seconds | Behavior | diff --git a/src/xtd.core/include/xtd/net/sockets/network_stream.hpp b/src/xtd.core/include/xtd/net/sockets/network_stream.hpp index 1a771684ac49..45ade00e3aee 100644 --- a/src/xtd.core/include/xtd/net/sockets/network_stream.hpp +++ b/src/xtd.core/include/xtd/net/sockets/network_stream.hpp @@ -88,7 +88,7 @@ namespace xtd { bool can_write() const noexcept override; /// @brief Gets a value that indicates whether data is available on the xtd::net::sockets::network_stream to be read. - /// @return true if data is available on the stream to be read; otherwise, false. + /// @return `true` if data is available on the stream to be read; otherwise, false. /// @exception xtd::net::sockets::socket_exception An error occurred when attempting to access the socket. /// @exception xtd::object_closed_exception The xtd::net::sockets::socket has been closed. /// @remarks Use the xtd::net::sockets::network_stream::data_available property to determine if data is ready to be read. If xtd::net::sockets::network_stream::data_available is true, a call to std::iostream::read returns immediately. If the remote host shuts down or closes the connection, xtd::net::sockets::network_stream::data_available may throw a xtd::net::sockets::socket_exception. diff --git a/src/xtd.core/include/xtd/net/sockets/socket.hpp b/src/xtd.core/include/xtd/net/sockets/socket.hpp index f105df5e2928..6dadd5398517 100644 --- a/src/xtd.core/include/xtd/net/sockets/socket.hpp +++ b/src/xtd.core/include/xtd/net/sockets/socket.hpp @@ -205,7 +205,7 @@ namespace xtd { size_t available() const; /// @brief Gets a value that indicates whether the xtd::net::sockets::socket is in blocking mode. - /// @return true if the xtd::net::sockets::socket will block; otherwise, false. The default is true. + /// @return `true` if the xtd::net::sockets::socket will block; otherwise, false. The default is true. /// @exception xtd::net::sockets::socket_exception An error occurred when attempting to access the socket. /// @exception xtd::object_closed_exception The xtd::net::sockets::socket has been closed. /// @remarks The xtd::net::sockets::socket::blocking property indicates whether a xtd::net::sockets::socket is in blocking mode. @@ -223,14 +223,14 @@ namespace xtd { socket& blocking(bool value); /// @brief Gets a value that indicates whether a xtd::net::sockets::socket is connected to a remote host as of the last xtd::net::sockets::socket::send or xtd::net::sockets::socket::receive operation. - /// @return true if the xtd::net::sockets::socket was connected to a remote resource as of the most recent operation; otherwise, false. + /// @return `true` if the xtd::net::sockets::socket was connected to a remote resource as of the most recent operation; otherwise, false. /// @remarks The xtd::net::sockets::socket::connected property gets the connection state of the xtd::net::sockets::socket as of the last I/O operation. When it returns false, the xtd::net::sockets::socket was either never connected, or is no longer connected. xtd::net::sockets::socket::connected is not thread-safe; it may return true after an operation is aborted when the xtd::net::sockets::socket is disconnected from another thread. /// @remarks The value of the xtd::net::sockets::socket::connected property reflects the state of the connection as of the most recent operation. If you need to determine the current state of the connection, make a nonblocking, zero-byte xtd::net::sockets::socket::send call. If the call returns successfully or throws a WAEWOULDBLOCK error code (10035), then the socket is still connected; otherwise, the socket is no longer connected. /// @remarks If you call xtd::net::sockets::socket::connect on a User Datagram Protocol (UDP) socket, the xtd::net::sockets::socket::connected property always returns true; however, this action does not change the inherent connectionless nature of UDP. bool connected() const noexcept; /// @brief Gets a value that specifies whether the xtd::net::sockets::socket allows Internet Protocol (IP) datagrams to be fragmented. - /// @return true if the xtd::net::sockets::socket doesn't allow datagram fragmentation; otherwise, false. The default is true. + /// @return `true` if the xtd::net::sockets::socket doesn't allow datagram fragmentation; otherwise, false. The default is true. /// @exception xtd::not_supported_exception The socket is not in the xtd::net::sockets::address_family::inter_network family. /// @exception xtd::net::sockets::socket_exception An error occurred when attempting to access the socket. /// @exception xtd::object_closed_exception The xtd::net::sockets::socket has been closed. @@ -246,7 +246,7 @@ namespace xtd { socket& dont_fragment(bool value); /// @brief Gets a value that specifies whether the xtd::net::sockets::socket is a dual-mode socket used for both IPv4 and IPv6. - /// @return true if the xtd::net::sockets::socket is a dual-mode socket; otherwise, false. The default is true if the socket was created by calling the xtd::net::sockets::socket(xtd::net::sockets::socket_type, xtd::net::sockets::protocol_type) constructor and the operating system supports IPv6; otherwise, the default is false. + /// @return `true` if the xtd::net::sockets::socket is a dual-mode socket; otherwise, false. The default is true if the socket was created by calling the xtd::net::sockets::socket(xtd::net::sockets::socket_type, xtd::net::sockets::protocol_type) constructor and the operating system supports IPv6; otherwise, the default is false. /// @exception xtd::not_supported_exception The socket is not in the xtd::net::sockets::address_family::inter_network_v6 family. /// @exception xtd::net::sockets::socket_exception An error occurred when attempting to access the socket. /// @exception xtd::object_closed_exception The xtd::net::sockets::socket has been closed. @@ -262,7 +262,7 @@ namespace xtd { socket& dual_mode(bool value); /// @brief Gets a boolean value that specifies whether the xtd::net::sockets::socket can send or receive broadcast packets. - /// @return true if the xtd::net::sockets::socket allows broadcast packets; otherwise, false. The default is false. + /// @return `true` if the xtd::net::sockets::socket allows broadcast packets; otherwise, false. The default is false. /// @exception xtd::net::sockets::socket_exception This option is valid for a datagram socket only. /// @exception xtd::object_closed_exception The xtd::net::sockets::socket has been closed. /// @remarks Broadcasting is limited to a specific subnet, and must use User Datagram Protocol (UDP.) For Internet Protocol version 4, you can broadcast to your local subnet by sending a packet to 255.255.255.255; or you can use the directed broadcast address, which is the network portion of an Internet Protocol (IP) address with all bits set in the host portion. For example, if your IP address is 192.168.1.40 (a Class C address, with a netmask of 255.255.255.0 -- the network portion is the first three octets, and the host portion is the last octet), your directed broadcast address is 192.168.1.255. @@ -280,7 +280,7 @@ namespace xtd { socket& enable_broadcast(bool value); /// @brief Gets a boolean value that specifies whether the xtd::net::sockets::socket allows only one process to bind to a port. - /// @return true if the xtd::net::sockets::socket allows only one socket to bind to a specific port; otherwise, false. The default is true for Windows Server 2003 and Windows XP Service Pack 2, and false for all other versions. + /// @return `true` if the xtd::net::sockets::socket allows only one socket to bind to a specific port; otherwise, false. The default is true for Windows Server 2003 and Windows XP Service Pack 2, and false for all other versions. /// @exception xtd::net::sockets::socket_exception This option is valid for a datagram socket only. /// @exception xtd::object_closed_exception The xtd::net::sockets::socket has been closed. /// @remarks If xtd::net::sockets::socket::exclusive_address_use is false, multiple sockets can use the xtd::net::sockets::socket::bind method to bind to a specific port; however only one of the sockets can perform operations on the network traffic sent to the port. If more than one socket attempts to use the xtd::net::sockets::socket::bind method to bind to a particular port, then the one with the more specific IP address will handle the network traffic sent to that port. @@ -305,7 +305,7 @@ namespace xtd { intptr handle() const noexcept; /// @brief Gets a value that indicates whether the xtd::net::sockets::socket is bound to a specific local port. - /// @return true if the xtd::net::sockets::socket is bound to a local port; otherwise, false. + /// @return `true` if the xtd::net::sockets::socket is bound to a local port; otherwise, false. /// @remarks A socket is considered bound to a local port if it is explicitly bound by calling the xtd::net::sockets::socket::bind method, or implicitly bound by calling members like xtd::net::sockets::socket::connect, xtd::net::sockets::socket::send_to, or xtd::net::sockets::socket::receive_from, which use an ephemeral local port (a free port greater than 1024, selected by the operating system.) Servers use the xtd::net::sockets::socket::bind method to bind to a well-known port so that clients may connect to them. bool is_bound() const noexcept; @@ -355,7 +355,7 @@ namespace xtd { xtd::sptr local_end_point() const; /// @brief Gets a value that specifies whether outgoing multicast packets are delivered to the sending application. - /// @return true if the xtd::net::sockets::socket receives outgoing multicast packets; otherwise, false. + /// @return `true` if the xtd::net::sockets::socket receives outgoing multicast packets; otherwise, false. /// @exception xtd::net::sockets::socket_exception This option is valid for a datagram socket only. /// @exception xtd::object_closed_exception The xtd::net::sockets::socket has been closed. /// @exception xtd::not_supported_exception The xtd::net::sockets::socket is not in the xtd::net::sockets::address_family::inter_network or xtd::net::sockets::address_family::inter_network_v6 families. @@ -504,12 +504,12 @@ namespace xtd { /// @{ /// @brief Indicates whether the underlying operating system and network adaptors support Internet Protocol version 4 (IPv4). - /// @return true if the operating system and network adaptors support the IPv4 protocol; otherwise, false. + /// @return `true` if the operating system and network adaptors support the IPv4 protocol; otherwise, false. /// @remarks The operating system may support both IPv4 and IPv6 protocols. static bool os_supports_ip_v4() noexcept; /// @brief Indicates whether the underlying operating system and network adaptors support Internet Protocol version 6 (IPv6). - /// @return true if the operating system and network adaptors support the IPv6 protocol; otherwise, false. + /// @return `true` if the operating system and network adaptors support the IPv6 protocol; otherwise, false. /// @remarks The operating system may support both IPv4 and IPv6 protocols. static bool os_supports_ip_v6() noexcept; /// @} @@ -531,7 +531,7 @@ namespace xtd { /// @brief Begins an asynchronous operation to accept an incoming connection attempt. /// @param e The xtd::net::sockets::socket::socket_async_event_args object to use for this asynchronous socket operation. - /// @return true if the I/O operation is pending. The Completed event on the e parameter will be raised upon completion of the operation. false if the I/O operation completed synchronously. The Completed event on the e parameter will not be raised and the e object passed as a parameter may be examined immediately after the method call returns to retrieve the result of the operation. + /// @return `true` if the I/O operation is pending. The Completed event on the e parameter will be raised upon completion of the operation. false if the I/O operation completed synchronously. The Completed event on the e parameter will not be raised and the e object passed as a parameter may be examined immediately after the method call returns to retrieve the result of the operation. /// @exception xtd::net::sockets::socket_exception An error occurred when attempting to access the socket. /// @exception xtd::object_closed_exception The xtd::net::sockets::socket has been closed. /// @exception xtd::argument_exception An argument is not valid. This exception occurs if the buffer provided is not large enough. The buffer must be at least 2 * (sizeof(SOCKADDR_STORAGE + 16) bytes. This exception also occurs if multiple buffers are specified, the xtd::net::sockets::socket_async_event_args::buffer_list property is not empty. diff --git a/src/xtd.core/include/xtd/net/sockets/tcp_client.hpp b/src/xtd.core/include/xtd/net/sockets/tcp_client.hpp index 3c4e5001a5de..f6e0fabe7e6a 100644 --- a/src/xtd.core/include/xtd/net/sockets/tcp_client.hpp +++ b/src/xtd.core/include/xtd/net/sockets/tcp_client.hpp @@ -176,7 +176,7 @@ namespace xtd { tcp_client& linger_state(const xtd::net::sockets::linger_option& value); /// @brief Gets a value that disables a delay when send or receive buffers are not full. - /// @return true if the delay is disabled; otherwise, false. The default value is false. + /// @return `true` if the delay is disabled; otherwise, false. The default value is false. /// @exception xtd::net::sockets::socket_exception An error occurred when attempting to access the socket. See the Remarks section for more information. /// @exception xtd::object_closed_exception The xtd::net::sockets::socket has been closed. /// @remarks When xtd::net::sockets::tcp_client::no_delay is false, a xtd::net::sockets::tcp_client does not send a packet over the network until it has collected a significant amount of outgoing data. @@ -344,7 +344,7 @@ namespace xtd { /// @{ /// @brief Gets a value that indicates whether a connection has been made. - /// @return true if the connection has been made; otherwise, false. + /// @return `true` if the connection has been made; otherwise, false. /// @remarks Classes deriving from xtd::net::sockets::tcp_client can use this property to determine if a connection attempt has succeeded. It does not monitor the ongoing connection state of xtd::net::sockets::tcp_client. If the remote host closes the connection, xtd::net::sockets::tcp_client::active will not be updated. If you are deriving from xtd::net::sockets::tcp_client and require closer attention to the connection state, use the xtd::net::sockets::tcp_client::client::connected property of the xtd::net::sockets::socket returned by the xtd::net::sockets::tcp_client::client property. bool active() const noexcept; /// @brief Sets a value that indicates whether a connection has been made. diff --git a/src/xtd.core/include/xtd/net/sockets/tcp_listener.hpp b/src/xtd.core/include/xtd/net/sockets/tcp_listener.hpp index 5d0d9b485e54..b453fde57d25 100644 --- a/src/xtd.core/include/xtd/net/sockets/tcp_listener.hpp +++ b/src/xtd.core/include/xtd/net/sockets/tcp_listener.hpp @@ -102,7 +102,7 @@ namespace xtd { /// @{ /// @brief Gets a bool value that specifies whether the xtd::net::sockets::tcp_listener allows only one underlying socket to listen to a specific port. - /// @return true if the xtd::net::sockets::tcp_listener allows only one xtd::net::sockets::tcp_listener to listen to a specific port; otherwise, false. . + /// @return `true` if the xtd::net::sockets::tcp_listener allows only one xtd::net::sockets::tcp_listener to listen to a specific port; otherwise, false. . /// @exception xtd::invalid_operation_exception The xtd::net::sockets::tcp_listener has been started. Call the xtd::net::sockets::tcp_listener::stop() method and then set the xtd::net::sockets::tcp_listener::exclusive_address_use property. /// @exception xtd::net::sockets::socket_exception An error occurred when attempting to access the socket. /// @exception xtd::object_closed_exception The xtd::net::sockets::socket has been closed. @@ -211,7 +211,7 @@ namespace xtd { bool equals(const tcp_listener& s) const noexcept override; /// @brief Determines if there are pending connection requests. - /// @return true if connections are pending; otherwise, false. + /// @return `true` if connections are pending; otherwise, false. /// @exception xtd::invalid_operation_exception The listener has not been started with a call to xtd::net::sockets::tcp_listener::start. /// @exception xtd::object_closed_exception The xtd::net::sockets::socket has been closed. /// @remarks This non-blocking method determines if there are any pending connection requests. Because the xtd::net::sockets::tcp_listener::accept_socket and xtd::net::sockets::tcp_listener::accept_tcp_client methods block execution until @@ -259,7 +259,7 @@ namespace xtd { /// @{ /// @brief Gets a value that indicates whether xtd::net::sockets::tcp_listener is actively listening for client connections. - /// @return true if xtd::net::sockets::tcp_listener is actively listening; otherwise, false. + /// @return `true` if xtd::net::sockets::tcp_listener is actively listening; otherwise, false. /// @remarks Classes deriving from xtd::net::sockets::tcp_listener can use this property to determine if the xtd::net::sockets::socket is currently listening for incoming connection attempts. /// @remarks The Active property can be used to avoid redundant xtd::net::sockets::tcp_listener::start attempts. bool active() const noexcept; diff --git a/src/xtd.core/include/xtd/net/sockets/udp_client.hpp b/src/xtd.core/include/xtd/net/sockets/udp_client.hpp index a580a6c0f763..fe015ceae1f0 100644 --- a/src/xtd.core/include/xtd/net/sockets/udp_client.hpp +++ b/src/xtd.core/include/xtd/net/sockets/udp_client.hpp @@ -155,7 +155,7 @@ namespace xtd { udp_client& client(const xtd::net::sockets::socket& value) noexcept; /// @brief Gets a boolean value that specifies whether the xtd::net::sockets::udp_client allows Internet Protocol (IP) datagrams to be fragmented. - /// @return true if the xtd::net::sockets::udp_client allows datagram fragmentation; otherwise, false. The default is true. + /// @return `true` if the xtd::net::sockets::udp_client allows datagram fragmentation; otherwise, false. The default is true. /// @exception xtd::net::sockets::socket_exception An error occurred when attempting to access the underlying socket. /// @exception xtd::object_closed_exception The underlying xtd::net::sockets::socket has been closed. /// @remarks Datagrams require fragmentation when their size exceeds the Maximum Transfer Unit (MTU) of the transmission medium. Datagrams may be fragmented by the sending host or by an intermediate router. If a datagram must be fragmented, and the xtd::net::sockets::socket_option_name::dont_fragment option is set, the datagram is discarded, and an Internet Control Message Protocol (ICMP) error message is sent back to the sender of the datagram. @@ -171,7 +171,7 @@ namespace xtd { udp_client& dont_fragment(bool value); /// @brief Gets a boolean value that specifies whether the xtd::net::sockets::udp_client may send or receive broadcast packets. - /// @return true if the xtd::net::sockets::udp_client allows broadcast packets; otherwise, false. The default is false. + /// @return `true` if the xtd::net::sockets::udp_client allows broadcast packets; otherwise, false. The default is false. /// @exception xtd::net::sockets::socket_exception An error occurred when attempting to access the underlying socket. /// @exception xtd::object_closed_exception The underlying xtd::net::sockets::socket has been closed. /// @remarks Broadcasting is limited to a specific subnet. You can broadcast to your local subnet by sending a packet to 255.255.255.255; or, you can use the directed broadcast address, which is the network portion of an Internet Protocol (IP) address with all bits set in the host portion. For example, if your IP address is 192.168.1.40 (a Class C address, with the network portion as the first three octets, and the host portion is the last octet), your directed broadcast address is 192.168.1.255. @@ -187,7 +187,7 @@ namespace xtd { udp_client& enable_broadcast(bool value); /// @brief Gets a boolean value that specifies whether the xtd::net::sockets::udp_client allows only one client to use a port. - /// @return true if the xtd::net::sockets::udp_client allows only one client to use a specific port; otherwise, false. The default is true for Windows Server 2003 and Windows XP Service Pack 2 and later, and false for all other versions. + /// @return `true` if the xtd::net::sockets::udp_client allows only one client to use a specific port; otherwise, false. The default is true for Windows Server 2003 and Windows XP Service Pack 2 and later, and false for all other versions. /// @exception xtd::net::sockets::socket_exception An error occurred when attempting to access the underlying socket. /// @exception xtd::object_closed_exception The underlying xtd::net::sockets::socket has been closed. /// @remarks By default, multiple clients can use a specific port; however, only one of the clients can perform operations on the network traffic sent to the port. You can use the xtd::net::sockets::udp_client::exclusive_address_use property to prevent multiple clients from using a specific port. @@ -205,7 +205,7 @@ namespace xtd { udp_client& exclusive_address_use(bool value); /// @brief Gets a boolean value that specifies whether outgoing multicast packets are delivered to the sending application. - /// @return true if the xtd::net::sockets::udp_client receives outgoing multicast packets; otherwise, false. + /// @return `true` if the xtd::net::sockets::udp_client receives outgoing multicast packets; otherwise, false. /// @exception xtd::net::sockets::socket_exception An error occurred when attempting to access the underlying socket. /// @exception xtd::object_closed_exception The underlying xtd::net::sockets::socket has been closed. /// @remarks Multicast is a scalable method for many-to-many communication on the Internet. If a process subscribes to a multicast address, any packets sent by that process are received by every other process that has subscribed to the multicast address. diff --git a/src/xtd.core/include/xtd/object.hpp b/src/xtd.core/include/xtd/object.hpp index 7afba969b911..e632a3232a2f 100644 --- a/src/xtd.core/include/xtd/object.hpp +++ b/src/xtd.core/include/xtd/object.hpp @@ -62,7 +62,7 @@ namespace xtd { /// @{ /// @brief Determines whether the specified object is equal to the current object. /// @param obj The object to compare with the current object. - /// @return true if the specified object is equal to the current object. otherwise, false. + /// @return `true` if the specified object is equal to the current object. otherwise, false. /// @par Examples /// The following code example compares the current instance with another object. /// @include object_equals.cpp @@ -116,7 +116,7 @@ namespace xtd { /// @brief Determines whether the specified object instances are considered equal. /// @param object_a The first object to compare. /// @param object_b The second object to compare. - /// @return true if object_a is the same instance as object_b or if both are null references or if object_a(object_b) returns true. otherwise, false. + /// @return `true` if object_a is the same instance as object_b or if both are null references or if object_a(object_b) returns true. otherwise, false. /// @par Examples /// The following code example compares different objects. /// @include object_equals2.cpp @@ -130,7 +130,7 @@ namespace xtd { /// @brief Determines whether the specified object instances are the same instance. /// @param object_a The first object to compare. /// @param object_b The second object to compare. - /// @return true if object_a is the same instance as object_b or if both are null references; otherwise, false. + /// @return `true` if object_a is the same instance as object_b or if both are null references; otherwise, false. /// @par Examples /// The following code example uses xtd::object::reference_equals to determine if two objects are the same instance. /// @include object_reference_equals.cpp diff --git a/src/xtd.core/include/xtd/operating_system.hpp b/src/xtd.core/include/xtd/operating_system.hpp index 8a2ea646f1fd..63e595905584 100644 --- a/src/xtd.core/include/xtd/operating_system.hpp +++ b/src/xtd.core/include/xtd/operating_system.hpp @@ -63,7 +63,7 @@ namespace xtd { /// @param service_pack A string, such as "Service Pack 3", that represent the service pack. If no Service Pack has been installed, the string must be empty. /// @param desktop_environment A string, such as "gnome", "kde", "windows", "macos". /// @param desktop_theme A string, such as "Adwaita", "Breeze", "windows dark", "macos dark", ... - /// @param is_64_bit True if Operating System is 64 bits; otherwise false. + /// @param is_64_bit True if Operating System is 64 bits; otherwise `false`. /// @exception ArgumentNullException version is null. /// @exception ArgumentException platform is not a xtd::platform_id enumeration value. operating_system(xtd::platform_id platform, const xtd::version& version, const xtd::string& service_pack, const xtd::string& desktop_environment, const xtd::string& desktop_theme, bool is_64_bit); @@ -73,7 +73,7 @@ namespace xtd { /// @param service_pack A string, such as "Service Pack 3", that represent the service pack. If no Service Pack has been installed, the string must be empty. /// @param desktop_environment A string, such as "gnome", "kde", "windows", "macos". /// @param desktop_theme A string, such as "Adwaita", "Breeze", "windows dark", "macos dark", ... - /// @param is_64_bit True if Operating System is 64 bits; otherwise false. + /// @param is_64_bit True if Operating System is 64 bits; otherwise `false`. /// @param distribution An xtd::distribution that contains the operating system distribution informations. /// @exception ArgumentNullException version is null. /// @exception ArgumentException platform is not a xtd::platform_id enumeration value. @@ -136,75 +136,75 @@ namespace xtd { /// @{ /// @brief Determines whether the current operating system is a 64-bit operating system. - /// @return true if the operating system is 64-bit; otherwise, false. + /// @return `true` if the operating system is 64-bit; otherwise, false. bool is_64_bit() const noexcept; /// @brief Determines whether the current platform is Android. - /// @return true if the current platform is Android; otherwise, false. + /// @return `true` if the current platform is Android; otherwise, false. bool is_android() const noexcept; /// @brief Determines whether the current platform is FreeBSD. - /// @return true if the current platform is Android; otherwise, false. + /// @return `true` if the current platform is Android; otherwise, false. bool is_free_bsd() const noexcept; /// @brief Determines whether the current platform is iOS. - /// @return true if the current platform is iOS; otherwise, false. + /// @return `true` if the current platform is iOS; otherwise, false. bool is_ios() const noexcept; /// @brief Determines whether the current platform is Linux. - /// @return true if the current platform is Linux; otherwise, false. + /// @return `true` if the current platform is Linux; otherwise, false. bool is_linux() const noexcept; /// @brief Determines whether the current platform is macOS. - /// @return true if the current platform is macOS; otherwise, false. + /// @return `true` if the current platform is macOS; otherwise, false. bool is_macos() const noexcept; /// @brief Determines whether the current platform is macOS family. - /// @return true if the current platform is macOS family; otherwise, false. + /// @return `true` if the current platform is macOS family; otherwise, false. bool is_macos_platform() const noexcept; /// @brief Determines whether the current platform is MINGW. - /// @return true if the current platform is MINGW; otherwise, false. + /// @return `true` if the current platform is MINGW; otherwise, false. bool is_mingw() const noexcept; /// @brief Determines whether the current platform is MSYS. - /// @return true if the current platform is MSYS; otherwise, false. + /// @return `true` if the current platform is MSYS; otherwise, false. bool is_msys() const noexcept; /// @brief Determines whether the current platform is Posix. - /// @return true if the current platform is Posix; otherwise, false. + /// @return `true` if the current platform is Posix; otherwise, false. bool is_posix() const noexcept; /// @brief Determines whether the current platform is Posix family. - /// @return true if the current platform is Posix family; otherwise, false. + /// @return `true` if the current platform is Posix family; otherwise, false. bool is_posix_platform() const noexcept; /// @brief Determines whether the current platform is Unix family. - /// @return true if the current platform is Unix family; otherwise, false. + /// @return `true` if the current platform is Unix family; otherwise, false. bool is_unix_platform() const noexcept; /// @brief Determines whether the current platform is tvOS family. - /// @return true if the current platform is macOS family; otherwise, false. + /// @return `true` if the current platform is macOS family; otherwise, false. bool is_tvos() const noexcept; /// @brief Determines whether the current platform is watchOS. - /// @return true if the current platform is watchOS; otherwise, false. + /// @return `true` if the current platform is watchOS; otherwise, false. bool is_watchos() const noexcept; /// @brief Determines whether the current platform is Windows. - /// @return true if the current platform is Windows; otherwise, false. + /// @return `true` if the current platform is Windows; otherwise, false. bool is_windows() const noexcept; /// @brief Determines whether the current platform is Windows CE. - /// @return true if the current platform is Windows CE; otherwise, false. + /// @return `true` if the current platform is Windows CE; otherwise, false. bool is_windows_ce() const noexcept; /// @brief Determines whether the current platform is Windows family. - /// @return true if the current platform is Windows family; otherwise, false. + /// @return `true` if the current platform is Windows family; otherwise, false. bool is_windows_platform() const noexcept; /// @brief Determines whether the current platform is xbox. - /// @return true if the current platform is xbox; otherwise, false. + /// @return `true` if the current platform is xbox; otherwise, false. bool is_xbox() const noexcept; /// @brief Converts the value of this operating_system object to its equivalent string representation. diff --git a/src/xtd.core/include/xtd/processor.hpp b/src/xtd.core/include/xtd/processor.hpp index a03d4256d7da..8a6e560f0675 100644 --- a/src/xtd.core/include/xtd/processor.hpp +++ b/src/xtd.core/include/xtd/processor.hpp @@ -23,7 +23,7 @@ namespace xtd { /// @{ /// @brief Initialise a new instance oof xtd::processor class. /// @param architecture One of xtd::architectuure_id valuues. - /// @param is_64_bit true if 64 bit architecture; otherwise false. + /// @param is_64_bit true if 64 bit architecture; otherwise `false`. /// @param core_count THe number of cores. processor(xtd::architecture_id architecture, bool is_64_bit, uint32 core_count); /// @} @@ -50,7 +50,7 @@ namespace xtd { uint32 core_count() const noexcept; /// @brief Determines whether the current operating system is a 64-bit operating system. - /// @return true if the operating system is 64-bit; otherwise, false. + /// @return `true` if the operating system is 64-bit; otherwise, false. bool is_64_bit() const noexcept; /// @brief Gets the concatenated string representation of the platform identifier. diff --git a/src/xtd.core/include/xtd/read_only_span.hpp b/src/xtd.core/include/xtd/read_only_span.hpp index 3023d634a9a6..cb5e0efb95de 100644 --- a/src/xtd.core/include/xtd/read_only_span.hpp +++ b/src/xtd.core/include/xtd/read_only_span.hpp @@ -97,7 +97,7 @@ namespace xtd { /// @brief Creates an xtd::read_only_span with specified iterator and count. /// @param first The iterator to the first element of the sequence. /// @param count The number of elements in the iteration. - //template + template read_only_span(iterator_t first, xtd::size count) : data_ {&(*first)}, length_ {extent != dynamic_extent ? extent : count} {} */ #if defined(__xtd__cpp_lib_type_identity) @@ -268,7 +268,7 @@ namespace xtd { /// @brief Determines whether the specified object is equal to the current object. /// @param obj The object to compare with the current object. - /// @return true if the specified object is equal to the current object. otherwise, false. + /// @return `true` if the specified object is equal to the current object. otherwise, false. bool equals(const object& obj) const noexcept override {return is>(obj) && equals(static_cast&>(obj));} /// @brief Indicates whether the current object is equal to another object of the same type. /// @param obj An object to compare with this object. diff --git a/src/xtd.core/include/xtd/signal_cancel_event_args.hpp b/src/xtd.core/include/xtd/signal_cancel_event_args.hpp index 7b03b0037d72..9b32d51935c5 100644 --- a/src/xtd.core/include/xtd/signal_cancel_event_args.hpp +++ b/src/xtd.core/include/xtd/signal_cancel_event_args.hpp @@ -37,7 +37,7 @@ namespace xtd { /// @{ /// @brief Gets a value that indicates whether a signal has interrupted the current process. The default is false, which terminates the current process. - /// @return true if the current process should resume when the event handler concludes; false if the current process should terminate. The default value is false; the current process terminates when the event handler returns. If true, the current process continues. + /// @return `true` if the current process should resume when the event handler concludes; false if the current process should terminate. The default value is false; the current process terminates when the event handler returns. If true, the current process continues. bool cancel() const noexcept; /// @brief Sets a value that indicates whether a signal has interrupted the current process. The default is false, which terminates the current process. diff --git a/src/xtd.core/include/xtd/span.hpp b/src/xtd.core/include/xtd/span.hpp index 104f11ae8e1d..0cd26d973bfb 100644 --- a/src/xtd.core/include/xtd/span.hpp +++ b/src/xtd.core/include/xtd/span.hpp @@ -103,7 +103,7 @@ namespace xtd { /// @brief Creates an xtd::span with specified iterator and count. /// @param first The iterator to the first element of the sequence. /// @param count The number of elements in the iteration. - //template + template span(iterator_t first, xtd::size count) : data_ {&(*first)}, length_ {extent != dynamic_extent ? extent : count} {} */ #if defined(__xtd__cpp_lib_type_identity) @@ -313,7 +313,7 @@ namespace xtd { /// @brief Determines whether the specified object is equal to the current object. /// @param obj The object to compare with the current object. - /// @return true if the specified object is equal to the current object. otherwise, false. + /// @return `true` if the specified object is equal to the current object. otherwise, false. bool equals(const object& obj) const noexcept override {return is>(obj) && equals(static_cast&>(obj));} /// @brief Indicates whether the current object is equal to another object of the same type. /// @param obj An object to compare with this object. diff --git a/src/xtd.core/include/xtd/speech/synthesis/prompt_event_args.hpp b/src/xtd.core/include/xtd/speech/synthesis/prompt_event_args.hpp index 28a53349ff22..359f027e96f2 100644 --- a/src/xtd.core/include/xtd/speech/synthesis/prompt_event_args.hpp +++ b/src/xtd.core/include/xtd/speech/synthesis/prompt_event_args.hpp @@ -47,7 +47,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether an asynchronous operation has been canceled. - /// @return true if the background operation has been canceled; otherwise false. The default is false. + /// @return `true` if the background operation has been canceled; otherwise `false`. The default is false. bool cancelled() const noexcept {return cancelled_;} /// @brief Gets a value indicating which error occurred during an asynchronous operation. diff --git a/src/xtd.core/include/xtd/target_type.hpp b/src/xtd.core/include/xtd/target_type.hpp index ed9d89683fbb..3d25264121f6 100644 --- a/src/xtd.core/include/xtd/target_type.hpp +++ b/src/xtd.core/include/xtd/target_type.hpp @@ -34,23 +34,23 @@ namespace xtd { /// @{ /// @brief Gets target id is console application. - /// @return true if target id is console application; otherwise false. + /// @return `true` if target id is console application; otherwise `false`. bool is_console_application() const noexcept; /// @brief Gets target id is gui application. - /// @return true if target id is gui application; otherwise false. + /// @return `true` if target id is gui application; otherwise `false`. bool is_guid_application() const noexcept; /// @brief Gets target id is test application. - /// @return true if target id is test application; otherwise false. + /// @return `true` if target id is test application; otherwise `false`. bool is_test_application() const noexcept; /// @brief Gets target id is shared library. - /// @return true if target id is shared library; otherwise false. + /// @return `true` if target id is shared library; otherwise `false`. bool is_shared_library() const noexcept; /// @brief Gets target id is static library. - /// @return true if target id is static library; otherwise false. + /// @return `true` if target id is static library; otherwise `false`. bool is_static_library() const noexcept; /// @brief Gets target id name. diff --git a/src/xtd.core/include/xtd/threading/barrier.hpp b/src/xtd.core/include/xtd/threading/barrier.hpp index bddb20f19221..0df886d52a08 100644 --- a/src/xtd.core/include/xtd/threading/barrier.hpp +++ b/src/xtd.core/include/xtd/threading/barrier.hpp @@ -123,21 +123,21 @@ namespace xtd { void signal_and_wait(); /// @brief Signals that a participant has reached the barrier and waits for all other participants to reach the barrier as well, using a 32-bit signed integer to measure the timeout. /// @param milliseconds_timeout The number of milliseconds to wait, or xtd::threading::timeout::infinite(-1) to wait indefinitely. - /// @return true if all participants reached the barrier within the specified time; otherwise false. + /// @return `true` if all participants reached the barrier within the specified time; otherwise `false`. /// @exception xtd::argument_out_of_range_exception milliseconds_timeout is a negative number other than -1, which represents an infinite time-out. /// @exception xtd::object_closed_exception The current instance has already been disposed. /// @exception xtd::threading::barrier_post_phase_exception If an exception is thrown from the post phase action of a xtd::threading::barrier after all participating threads have called xtd::threading::barrier::signal_and_wait, the exception will be wrapped in a xtd::threading::barrier_post_phase_exception and be thrown on all participating threads. bool signal_and_wait(int32 milliseconds_timeout); /// @brief Signals that a participant has reached the barrier and waits for all other participants to reach the barrier, while observing a cancellation token. /// @param cancellation_token The xtd::threading::cancellation_token to observe. - /// @return true if all participants reached the barrier within the specified time; otherwise false. + /// @return `true` if all participants reached the barrier within the specified time; otherwise `false`. /// @exception xtd::operation_canceled_exception cancellation_token has been canceled. /// @exception xtd::object_closed_exception The current instance has already been disposed. /// @exception xtd::threading::barrier_post_phase_exception If an exception is thrown from the post phase action of a xtd::threading::barrier after all participating threads have called xtd::threading::barrier::signal_and_wait, the exception will be wrapped in a xtd::threading::barrier_post_phase_exception and be thrown on all participating threads. bool signal_and_wait(const cancellation_token& cancellation_token); /// @brief Signals that a participant has reached the barrier and waits for all other participants to reach the barrier as well, using a xtd::time_span object to measure the time interval. /// @param timout A xtd::time_span that represents the number of milliseconds to wait, or a xtd::time_span that represents -1 milliseconds to wait indefinitely. - /// @return true if all participants reached the barrier within the specified time; otherwise false. + /// @return `true` if all participants reached the barrier within the specified time; otherwise `false`. /// @exception xtd::argument_out_of_range_exception milliseconds_timeout is a negative number other than -1, which represents an infinite time-out. /// @exception xtd::object_closed_exception The current instance has already been disposed. /// @exception xtd::threading::barrier_post_phase_exception If an exception is thrown from the post phase action of a xtd::threading::barrier after all participating threads have called xtd::threading::barrier::signal_and_wait, the exception will be wrapped in a xtd::threading::barrier_post_phase_exception and be thrown on all participating threads. @@ -145,7 +145,7 @@ namespace xtd { /// @brief Signals that a participant has reached the barrier and waits for all other participants to reach the barrier as well, using a 32-bit signed integer to measure the timeout, while observing a cancellation token. /// @param milliseconds_timeout The number of milliseconds to wait, or xtd::threading::timeout::infinite(-1) to wait indefinitely. /// @param cancellation_token The xtd::threading::cancellation_token to observe. - /// @return true if all participants reached the barrier within the specified time; otherwise false. + /// @return `true` if all participants reached the barrier within the specified time; otherwise `false`. /// @exception xtd::argument_out_of_range_exception milliseconds_timeout is a negative number other than -1, which represents an infinite time-out. /// @exception xtd::operation_canceled_exception cancellation_token has been canceled. /// @exception xtd::object_closed_exception The current instance has already been disposed. @@ -154,7 +154,7 @@ namespace xtd { /// @brief Signals that a participant has reached the barrier and waits for all other participants to reach the barrier as well, using a xtd::time_span object to measure the time interval, while observing a cancellation token. /// @param timout A xtd::time_span that represents the number of milliseconds to wait, or a xtd::time_span that represents -1 milliseconds to wait indefinitely. /// @param cancellation_token The xtd::threading::cancellation_token to observe. - /// @return true if all participants reached the barrier within the specified time; otherwise false. + /// @return `true` if all participants reached the barrier within the specified time; otherwise `false`. /// @exception xtd::argument_out_of_range_exception milliseconds_timeout is a negative number other than -1, which represents an infinite time-out. /// @exception xtd::operation_canceled_exception cancellation_token has been canceled. /// @exception xtd::object_closed_exception The current instance has already been disposed. diff --git a/src/xtd.core/include/xtd/threading/cancellation_token.hpp b/src/xtd.core/include/xtd/threading/cancellation_token.hpp index 77eae70ebca1..09e92d5d3f35 100644 --- a/src/xtd.core/include/xtd/threading/cancellation_token.hpp +++ b/src/xtd.core/include/xtd/threading/cancellation_token.hpp @@ -69,11 +69,11 @@ namespace xtd { /// @{ /// @brief Gets whether this token is capable of being in the canceled state. - /// @return true if this token is capable of being in the canceled state; otherwise, false. + /// @return `true` if this token is capable of being in the canceled state; otherwise, false. bool can_be_canceled() const noexcept; /// @brief Gets whether cancellation has been requested for this token. - /// @return true if cancellation has been requested for this token; otherwise, false. + /// @return `true` if cancellation has been requested for this token; otherwise, false. /// @remarks This property indicates whether cancellation has been requested for this token, either through the token initially being constructed in a canceled state, or through calling xtd::threading::cancellation_token_source::cancel on the token's associated xtd::threading::cancellation_token_source. /// @remarks If this property is true, it only guarantees that cancellation has been requested. It does not guarantee that every registered handler has finished executing, nor that cancellation requests have finished propagating to all registered handlers. Additional synchronization may be required, particularly in situations where related objects are being canceled concurrently. bool is_cancellation_requested() const noexcept; diff --git a/src/xtd.core/include/xtd/threading/countdown_event.hpp b/src/xtd.core/include/xtd/threading/countdown_event.hpp index c80c6eb91f1e..1b2c1d1c8637 100644 --- a/src/xtd.core/include/xtd/threading/countdown_event.hpp +++ b/src/xtd.core/include/xtd/threading/countdown_event.hpp @@ -62,7 +62,7 @@ namespace xtd { int32 initial_count() const; /// @brief ndicates whether the xtd::threading::countdown_event object's current count has reached zero. - /// @return true if the current count is zero; otherwise, false. + /// @return `true` if the current count is zero; otherwise, false. /// @exception xtd::object_closed_exception The current instance has already been closed. /// @remarks The xtd::threading::countdown_event does not raise an event when the countdown has reached zero. Instead, the xtd::threading::countdown_event::current_count property equals zero, and the xtd::threading::countdown_event::is_set property equals true. bool is_set() const; @@ -106,24 +106,24 @@ namespace xtd { void reset(int32 count); /// @brief Registers a signal with the xtd::threading::countdown_event, decrementing the value of xtd::threading::countdown_event::current_count. - /// @return true if the signal caused the count to reach zero and the event was set; otherwise, false. + /// @return `true` if the signal caused the count to reach zero and the event was set; otherwise, false. /// @exception xtd::object_closed_exception The current instance has already been closed. /// @exception xtd::nvalid_operation_exception The current instance is already set. bool signal(); /// @brief Registers multiple signals with the xtd::threading::countdown_event, decrementing the value of xtd::threading::countdown_event::current_count by the specified amount. /// @param signal_count The number of signals to register. - /// @return true if the signal caused the count to reach zero and the event was set; otherwise, false. + /// @return `true` if the signal caused the count to reach zero and the event was set; otherwise, false. /// @exception xtd::object_closed_exception The current instance has already been closed. /// @exception xtd::argument_out_of_range_exception signal_count is less than 0. /// @exception xtd::nvalid_operation_exception The current instance is already set. bool signal(int32 signal_count); /// @brief Attempts to increment xtd::threading::countdown_event::current_count by one. - /// @return true if the increment succeeded; otherwise, false. If CurrentCount is already at zero, this method will return false. + /// @return `true` if the increment succeeded; otherwise, false. If CurrentCount is already at zero, this method will return false. bool try_add_count() noexcept; /// @brief Attempts to increment xtd::threading::countdown_event::current_count by by a specified value. /// @param count The value by which to increase xtd::threading::countdown_event::current_count. - /// @return true if the increment succeeded; otherwise, false. If CurrentCount is already at zero, this method will return false. + /// @return `true` if the increment succeeded; otherwise, false. If CurrentCount is already at zero, this method will return false. bool try_add_count(int32 count) noexcept; /// @brief Blocks the current thread until the xtd::threading::countdown_event is set. @@ -132,7 +132,7 @@ namespace xtd { void wait(); /// @brief Blocks the current thread until the xtd::threading::countdown_event is set, using a 32-bit signed integer to measure the timeout. /// @param milliseconds_timeout The number of milliseconds to wait, or xtd::threading::timeout::ifinite (-1) to wait indefinitely. - /// @return true if the xtd::threading::countdown_event was set; otherwise, false. + /// @return `true` if the xtd::threading::countdown_event was set; otherwise, false. /// @exception xtd::object_closed_exception The current instance has already been closed. /// @exception xtd::argument_out_of_range_exception milliseconds_timeout is a negative number other than -1, which represents an infinite time-out.. bool wait(int32 milliseconds_timeout); @@ -144,14 +144,14 @@ namespace xtd { void wait(const cancellation_token& cancellation_token); /// @brief Blocks the current thread until the xtd::threading::countdown_event is set, using a xtd::time_span to measure the timeout. /// @param timeout A xtd::time_span that represents the number of milliseconds to wait, or a xtd::time_span that represents -1 milliseconds to wait indefinitely. - /// @return true if the xtd::threading::countdown_event was set; otherwise, false. + /// @return `true` if the xtd::threading::countdown_event was set; otherwise, false. /// @exception xtd::object_closed_exception The current instance has already been closed. /// @exception xtd::argument_out_of_range_exception milliseconds_timeout is a negative number other than -1, which represents an infinite time-out.. bool wait(const time_span& timeout); /// @brief Blocks the current thread until the xtd::threading::countdown_event is set, using a 32-bit signed integer to measure the timeout, while observing a xtd::threading::cancellation_token. /// @param milliseconds_timeout The number of milliseconds to wait, or xtd::threading::timeout::ifinite (-1) to wait indefinitely. /// @param cancellation_toker The xtd::threading::cancellation_token to observe. - /// @return true if the xtd::threading::countdown_event was set; otherwise, false. + /// @return `true` if the xtd::threading::countdown_event was set; otherwise, false. /// @exception xtd::object_closed_exception The current instance has already been closed. /// @exception xtd::operation_canceled_exception cancellation_token has been canceled. /// @exception xtd::argument_out_of_range_exception milliseconds_timeout is a negative number other than -1, which represents an infinite time-out.. @@ -159,7 +159,7 @@ namespace xtd { /// @brief Blocks the current thread until the xtd::threading::countdown_event is set, using a xtd::time_span to measure the timeout, while observing a xtd::threading::cancellation_token. /// @param timeout A xtd::time_span that represents the number of milliseconds to wait, or a xtd::time_span that represents -1 milliseconds to wait indefinitely. /// @param cancellation_toker The xtd::threading::cancellation_token to observe. - /// @return true if the xtd::threading::countdown_event was set; otherwise, false. + /// @return `true` if the xtd::threading::countdown_event was set; otherwise, false. /// @exception xtd::object_closed_exception The current instance has already been closed. /// @exception xtd::operation_canceled_exception cancellation_token has been canceled. /// @exception xtd::argument_out_of_range_exception milliseconds_timeout is a negative number other than -1, which represents an infinite time-out.. diff --git a/src/xtd.core/include/xtd/threading/event_wait_handle.hpp b/src/xtd.core/include/xtd/threading/event_wait_handle.hpp index 129a2e44b78e..dc32a4b1e390 100644 --- a/src/xtd.core/include/xtd/threading/event_wait_handle.hpp +++ b/src/xtd.core/include/xtd/threading/event_wait_handle.hpp @@ -125,12 +125,12 @@ namespace xtd { bool equals(const event_wait_handle& value) const noexcept override; /// @brief Sets the state of the event to nonsignaled, causing threads to block. - /// @return true if the operation succeeds; otherwise, false. + /// @return `true` if the operation succeeds; otherwise, false. /// @exception xtd::object_closed_exception The xtd::threading::wait_handle::close() method was previously called on this xtd::threading::event_wait_handle. bool reset(); /// @brief Sets the state of the event to signaled, allowing one or more waiting threads to proceed. - /// @return true if the operation succeeds; otherwise, false. + /// @return `true` if the operation succeeds; otherwise, false. /// @exception xtd::object_closed_exception The xtd::threading::wait_handle::close() method was previously called on this xtd::threading::event_wait_handle. /// @remarks For an xtd::threading::event_wait_handle with xtd::threading::event_reset_mode::auto_reset (including xtd::threading:::auto_reset_event), the xtd::threading::event_wait_handle::set method releases a single thread. If there are no waiting threads, the wait handle remains signaled until a thread attempts to wait on it, or until its xtd::threading::event_wait_handle::reset method is called. /// @warning There is no guarantee that every call to the xtd::threading::auto_reset_event::set method will release a thread. If two calls are too close together, so that the second call occurs before a thread has been released, only one thread is released. It's as if the second call did not happen. Also, if xtd::threading::auto_reset_event::set is called when there are no threads waiting and the xtd::threading::auto_reset_event is already signaled, the call has no effect. @@ -157,7 +157,7 @@ namespace xtd { /// @brief Opens the specified named synchronization event, if it already exists, and returns a value that indicates whether the operation succeeded. /// @param name The name of the synchronization object to be opened and shared with other processes. The name is case-sensitive. The backslash character (\) is reserved and may only be used to specify a namespace. For more information on namespaces, see the remarks section. There may be further restrictions on the name depending on the operating system. For example, on Unix-based operating systems, the name after excluding the namespace must be a valid file name. /// @param result When this method returns, contains a The xtd::threading::event_wait_handle object that represents the named synchronization event if the call succeeded, or null if the call failed. This parameter is treated as uninitialized. - /// @return true if the named synchronization event was opened successfully; otherwise, false. In some cases, false may be returned for invalid names. + /// @return `true` if the named synchronization event was opened successfully; otherwise, false. In some cases, false may be returned for invalid names. /// @exception xtd::argument_exception name is an empty string. /// @exception xtd::io::io_exception name is invalid. This can be for various reasons, including some restrictions that may be placed by the operating system, such as an unknown prefix or invalid characters. Note that the name and common prefixes "Global\" and "Local\" are case-sensitive. For some invalid names, the method may return false instead.
-or-
There was some other error. The HResult property may provide more information. /// @exception xtd::io::path_too_long_exception The name is too long. Length restrictions may depend on the operating system or configuration. diff --git a/src/xtd.core/include/xtd/threading/lock_guard.hpp b/src/xtd.core/include/xtd/threading/lock_guard.hpp index b3760e66e73b..08c2bbeb2b83 100644 --- a/src/xtd.core/include/xtd/threading/lock_guard.hpp +++ b/src/xtd.core/include/xtd/threading/lock_guard.hpp @@ -68,7 +68,7 @@ namespace xtd { /// @brief Releases the lock on an object and blocks the current thread until it reacquires the lock. If the specified time-out interval elapses, the thread enters the ready queue. /// @param obj The object on which to wait. /// @param milliseconds_timeout The number of milliseconds to wait before the thread enters the ready queue. - /// @return true if the lock was reacquired before the specified time elapsed; false if the lock was reacquired after the specified time elapsed. The method does not return until the lock is reacquired. + /// @return `true` if the lock was reacquired before the specified time elapsed; false if the lock was reacquired after the specified time elapsed. The method does not return until the lock is reacquired. /// @exception xtd::threading::synchronization_lock_exception xtd::threading::monitor::wait is not invoked from within a synchronized block of code. /// @remarks This method does not return until it reacquires an exclusive lock on the obj parameter. /// @remarks The thread that currently owns the lock on the specified object invokes this method in order to release the object so that another thread can access it. The caller is blocked while waiting to reacquire the lock. This method is called when the caller needs to wait for a state change that will occur as a result of another thread's operations. @@ -83,7 +83,7 @@ namespace xtd { /// @brief Releases the lock on an object and blocks the current thread until it reacquires the lock. If the specified time-out interval elapses, the thread enters the ready queue. /// @param timeout A xtd::time_span representing the amount of time to wait before the thread enters the ready queue. - /// @return true if the lock was reacquired before the specified time elapsed; false if the lock was reacquired after the specified time elapsed. The method does not return until the lock is reacquired. + /// @return `true` if the lock was reacquired before the specified time elapsed; false if the lock was reacquired after the specified time elapsed. The method does not return until the lock is reacquired. /// @exception xtd::threading::synchronization_lock_exception xtd::threading::monitor::wait is not invoked from within a synchronized block of code. /// @remarks This method does not return until it reacquires an exclusive lock on the obj parameter. /// @remarks The thread that currently owns the lock on the specified object invokes this method in order to release the object so that another thread can access it. The caller is blocked while waiting to reacquire the lock. This method is called when the caller needs to wait for a state change that will occur as a result of another thread's operations. @@ -97,7 +97,7 @@ namespace xtd { bool wait(const time_span& timeout); /// @brief Releases the lock on an object and blocks the current thread until it reacquires the lock. - /// @return true if the call returned because the caller reacquired the lock for the specified object. This method does not return if the lock is not reacquired. + /// @return `true` if the call returned because the caller reacquired the lock for the specified object. This method does not return if the lock is not reacquired. /// @exception xtd::threading::synchronization_lock_exception xtd::threading::monitor::wait is not invoked from within a synchronized block of code. /// @remarks This method does not return until it reacquires an exclusive lock on the obj parameter. /// @remarks The thread that currently owns the lock on the specified object invokes this method in order to release the object so that another thread can access it. The caller is blocked while waiting to reacquire the lock. This method is called when the caller needs to wait for a state change that will occur as a result of another thread's operations. diff --git a/src/xtd.core/include/xtd/threading/monitor.hpp b/src/xtd.core/include/xtd/threading/monitor.hpp index 69ad3a7ebac6..ad4603b26886 100644 --- a/src/xtd.core/include/xtd/threading/monitor.hpp +++ b/src/xtd.core/include/xtd/threading/monitor.hpp @@ -184,7 +184,7 @@ namespace xtd { /// @brief Determines whether the current thread holds the lock on the specified object. /// @param obj The object to test. - /// @return true if the current thread holds the lock on obj; otherwise, false. + /// @return `true` if the current thread holds the lock on obj; otherwise, false. /// @remarks This method works only for locks that are acquired by using the methods of the xtd::threading::monitor class, or the xtd::threading::lock_guard class, or by using the #lock_ keyword, which are implemented with xtd::threading::monitor. /// @remarks Use this method with diagnostic tools, such as the xtd::diagnostics::debug::assert method, to debug locking issues that involve the xtd::threading::monitor class. template @@ -364,7 +364,7 @@ namespace xtd { /// @brief Releases the lock on an object and blocks the current thread until it reacquires the lock. If the specified time-out interval elapses, the thread enters the ready queue. /// @param obj The object on which to wait. /// @param milliseconds_timeout The number of milliseconds to wait before the thread enters the ready queue. - /// @return true if the lock was reacquired before the specified time elapsed; false if the lock was reacquired after the specified time elapsed. The method does not return until the lock is reacquired. + /// @return `true` if the lock was reacquired before the specified time elapsed; false if the lock was reacquired after the specified time elapsed. The method does not return until the lock is reacquired. /// @exception xtd::threading::synchronization_lock_exception xtd::threading::monitor::wait is not invoked from within a synchronized block of code. /// @remarks This method does not return until it reacquires an exclusive lock on the obj parameter. /// @remarks The thread that currently owns the lock on the specified object invokes this method in order to release the object so that another thread can access it. The caller is blocked while waiting to reacquire the lock. This method is called when the caller needs to wait for a state change that will occur as a result of another thread's operations. @@ -383,7 +383,7 @@ namespace xtd { /// @brief Releases the lock on an object and blocks the current thread until it reacquires the lock. If the specified time-out interval elapses, the thread enters the ready queue. /// @param obj The object on which to wait. /// @param timeout A xtd::time_span representing the amount of time to wait before the thread enters the ready queue. - /// @return true if the lock was reacquired before the specified time elapsed; false if the lock was reacquired after the specified time elapsed. The method does not return until the lock is reacquired. + /// @return `true` if the lock was reacquired before the specified time elapsed; false if the lock was reacquired after the specified time elapsed. The method does not return until the lock is reacquired. /// @exception xtd::threading::synchronization_lock_exception xtd::threading::monitor::wait is not invoked from within a synchronized block of code. /// @remarks This method does not return until it reacquires an exclusive lock on the obj parameter. /// @remarks The thread that currently owns the lock on the specified object invokes this method in order to release the object so that another thread can access it. The caller is blocked while waiting to reacquire the lock. This method is called when the caller needs to wait for a state change that will occur as a result of another thread's operations. @@ -401,7 +401,7 @@ namespace xtd { /// @brief Releases the lock on an object and blocks the current thread until it reacquires the lock. /// @param obj The object on which to wait. - /// @return true if the call returned because the caller reacquired the lock for the specified object. This method does not return if the lock is not reacquired. + /// @return `true` if the call returned because the caller reacquired the lock for the specified object. This method does not return if the lock is not reacquired. /// @exception xtd::threading::synchronization_lock_exception xtd::threading::monitor::wait is not invoked from within a synchronized block of code. /// @remarks This method does not return until it reacquires an exclusive lock on the obj parameter. /// @remarks The thread that currently owns the lock on the specified object invokes this method in order to release the object so that another thread can access it. The caller is blocked while waiting to reacquire the lock. This method is called when the caller needs to wait for a state change that will occur as a result of another thread's operations. diff --git a/src/xtd.core/include/xtd/threading/mutex.hpp b/src/xtd.core/include/xtd/threading/mutex.hpp index 882bc5034a28..2cdcec1b0856 100644 --- a/src/xtd.core/include/xtd/threading/mutex.hpp +++ b/src/xtd.core/include/xtd/threading/mutex.hpp @@ -131,7 +131,7 @@ namespace xtd { /// @brief Tries to lock the mutex. Returns immediately. On successful lock acquisition returns true, otherwise returns false. /// @param timeout timeout A xtd::time_span that represents the number of milliseconds to wait, or a xtd::time_span that represents -1 milliseconds to wait indefinitely. - /// @return true if the lock was acquired successfully, otherwise false. + /// @return `true` if the lock was acquired successfully, otherwise `false`. /// @remarks This function is allowed to fail spuriously and return false even if the mutex is not currently locked by any other thread. /// @remarks If try_lock is called by a thread that already owns the mutex, the behavior is undefined. /// @remarks Prior unlock() operation on the same mutex synchronizes-with (as defined in std::memory_order) this operation if it returns true. Note that prior lock() does not synchronize with this operation if it returns false. @@ -139,7 +139,7 @@ namespace xtd { /// @brief Tries to lock the mutex. Blocks until specified timeout_duration has elapsed or the lock is acquired, whichever comes first. On successful lock acquisition returns true, otherwise returns false. /// @param timeout minimum duration to block for - /// @return true if the lock was acquired successfully, otherwise false. + /// @return `true` if the lock was acquired successfully, otherwise `false`. /// @remarks If timeout_duration is less or equal timeout_duration.zero(), the function behaves like try_lock(). /// @remarks This function may block for longer than timeout_duration due to scheduling or resource contention delays. /// @remarks The standard recommends that a steady_clock is used to measure the duration. If an implementation uses a system_clock instead, the wait time may also be sensitive to clock adjustments. @@ -150,7 +150,7 @@ namespace xtd { /// @brief Tries to lock the mutex. Blocks until specified timeout_time has been reached or the lock is acquired, whichever comes first. On successful lock acquisition returns true, otherwise returns false. /// @param timeout_time maximum time point to block until - /// @return true if the lock was acquired successfully, otherwise false. + /// @return `true` if the lock was acquired successfully, otherwise `false`. /// @remarks If timeout_time has already passed, this function behaves like try_lock(). /// @remarks Clock must meet the Clock requirements. The program is ill-formed if std::chrono::is_clock_v is false (since C++20). /// @remarks The standard recommends that the clock tied to timeout_time be used, in which case adjustments of the clock may be taken into account. Thus, the duration of the block might be more or less than timeout_time - Clock::now() at the time of the call, depending on the direction of the adjustment and whether it is honored by the implementation. The function also may block until after timeout_time has been reached due to process scheduling or resource contention delays. @@ -179,7 +179,7 @@ namespace xtd { /// @brief Opens the specified named mutex, if it already exists, and returns a value that indicates whether the operation succeeded. /// @param name The name of the synchronization object to be shared with other processes. The name is case-sensitive. The backslash character (\) and (/) are reserved. /// @param result When this method returns, contains a xtd::threading::mutex object that represents the named mutex if the call succeeded. - /// @return true if the named mutex was opened successfully; otherwise, false. In some cases, false may be returned for invalid names. + /// @return `true` if the named mutex was opened successfully; otherwise, false. In some cases, false may be returned for invalid names. static bool try_open_existing(const string& name, mutex& result) noexcept; /// @} diff --git a/src/xtd.core/include/xtd/threading/semaphore.hpp b/src/xtd.core/include/xtd/threading/semaphore.hpp index 1671727ec97f..253c5c59912b 100644 --- a/src/xtd.core/include/xtd/threading/semaphore.hpp +++ b/src/xtd.core/include/xtd/threading/semaphore.hpp @@ -195,7 +195,7 @@ namespace xtd { /// @brief Opens the specified named semaphore, if it already exists, and returns a value that indicates whether the operation succeeded. /// @param name The name of the synchronization object to be shared with other processes. The name is case-sensitive. The backslash character (\) is reserved and may only be used to specify a namespace. For more information on namespaces, see the remarks section. There may be further restrictions on the name depending on the operating system. For example, on Unix-based operating systems, the name after excluding the namespace must be a valid file name. /// @param result When this method returns, contains a xtd::threading::semaphore object that represents the named semaphore if the call succeeded. - /// @return true if the named semaphore was opened successfully; otherwise, false. In some cases, false may be returned for invalid names. + /// @return `true` if the named semaphore was opened successfully; otherwise, false. In some cases, false may be returned for invalid names. /// @remarks If a synchronization object of the requested type exists in the namespace, the existing synchronization object is opened. /// @remarks The xtd::threading::semaphore::open_existing method tries to open the specified named semaphore. To create the system semaphore when it does not already exist, use one of the xtd::threading::semaphore constructors that has a name parameter. /// @remarks Multiple calls to this method that use the same value for name do not necessarily return the same xtd::threading::semaphore object, even though the objects that are returned represent the same named system semaphore. diff --git a/src/xtd.core/include/xtd/threading/spin_lock.hpp b/src/xtd.core/include/xtd/threading/spin_lock.hpp index afda38185975..2d3139336178 100644 --- a/src/xtd.core/include/xtd/threading/spin_lock.hpp +++ b/src/xtd.core/include/xtd/threading/spin_lock.hpp @@ -58,16 +58,16 @@ namespace xtd { /// @{ /// @brief Gets whether the lock is currently held by any thread. - /// @return true if the lock is currently held by any thread; otherwise false. + /// @return `true` if the lock is currently held by any thread; otherwise `false`. bool is_held() const noexcept; /// @brief Gets whether the lock is held by the current thread. - /// @return true if the lock is held by the current thread; otherwise false. + /// @return `true` if the lock is held by the current thread; otherwise `false`. /// @remarks If the lock was initialized to track owner threads, this will return whether the lock is acquired by the current thread. It is invalid to use this property when the lock was initialized to not track thread ownership. bool is_held_by_current_thread() const noexcept; /// @brief Gets whether thread ownership tracking is enabled for this instance. - /// @return true if thread ownership tracking is enabled for this instance; otherwise false. + /// @return `true` if thread ownership tracking is enabled for this instance; otherwise `false`. bool is_thread_owner_tracking_enabled() const noexcept; /// @} diff --git a/src/xtd.core/include/xtd/threading/thread.hpp b/src/xtd.core/include/xtd/threading/thread.hpp index 734f773f8f36..6e09746a9106 100644 --- a/src/xtd.core/include/xtd/threading/thread.hpp +++ b/src/xtd.core/include/xtd/threading/thread.hpp @@ -106,7 +106,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating the current thread wiil be joined when destroyed. - /// @return true if this thread will be joined when destroyed; otherwise, false. + /// @return `true` if this thread will be joined when destroyed; otherwise, false. bool auto_join() const noexcept; /// @brief Sets a value indicating the current thread wiil be joined when destroyed. /// @param value true if this thread will be joined when destroyed; otherwise, false. @@ -118,11 +118,11 @@ namespace xtd { intptr handle() const noexcept; /// @brief Gets a value indicating the execution status of the current thread. - /// @return true if this thread has been started and has not terminated normally or aborted; otherwise, false. + /// @return `true` if this thread has been started and has not terminated normally or aborted; otherwise, false. bool is_alive() const noexcept; /// @brief Gets a value indicating whether or not a thread is a background thread. - /// @return true if this thread is or is to become a background thread; otherwise, false. + /// @return `true` if this thread is or is to become a background thread; otherwise, false. /// @exception xtd::threadng::thread_state_exception The thread is dead. /// @remarks A thread is either a background thread or a foreground thread. Background threads are identical to foreground threads, except that background threads do not prevent a process from terminating. Once all foreground threads belonging to a process have terminated, the system ends the process. Any remaining background threads are stopped and do not complete. /// @remarks By default, the following threads execute in the foreground (that is, their xtd::threading::thread::is_background property returns false): @@ -146,16 +146,16 @@ namespace xtd { thread& is_background(bool value); /// @brief Gets a value indicating the current thread is the main thread. - /// @return true if this thread is the main thread; otherwise, false. + /// @return `true` if this thread is the main thread; otherwise, false. bool is_main_thread() const noexcept; /// @brief Gets a value indicating whether or not a thread belongs to the managed thread pool. - /// @return true if this thread belongs to the managed thread pool; otherwise, false. + /// @return `true` if this thread belongs to the managed thread pool; otherwise, false. /// @remarks For more information see xtd::threading::thread_pool. bool is_thread_pool_thread() const noexcept; /// @brief Gets a value indicating the current thread is joinable. - /// @return true if this thread is joinable; otherwise, false. + /// @return `true` if this thread is joinable; otherwise, false. /// @remarks A thread is joinable if it started, not stopped and if is not a background thread. /// @remarks if the thread is joinable you can call the xtd::threading::thread::join method. bool joinable() const noexcept; @@ -244,14 +244,14 @@ namespace xtd { /// @brief Blocks the calling thread until this thread object terminates or the specified time elapses, while continuing to perform standard COM and SendMessage pumping. /// @param milliseconds_timeout The number of milliseconds to wait for the thread to terminate. - /// @return true if the thread has terminated; false if the thread has not terminated after the amount of time specified by the xtd::milliseconds_timeout parameter has elapsed. + /// @return `true` if the thread has terminated; false if the thread has not terminated after the amount of time specified by the xtd::milliseconds_timeout parameter has elapsed. /// @exception xtd::threading::thread_state_exception The caller attempted to join a thread that is in the xtd::threading::thread_state::unstarted state. /// @exception xtd::argument_out_of_range_rxception milliseconds_timeout is a negative number other than -1, which represents an infinite time-out. bool join(int32 milliseconds_timeout); /// @brief Blocks the calling thread until this thread object terminates or the specified time elapses, while continuing to perform standard COM and SendMessage pumping. /// @param timeout A xtd::time_span set to the amount of time to wait for the thread to terminate. - /// @return true if the thread has terminated; false if the thread has not terminated after the amount of time specified by the xtd::milliseconds_timeout parameter has elapsed. + /// @return `true` if the thread has terminated; false if the thread has not terminated after the amount of time specified by the xtd::milliseconds_timeout parameter has elapsed. /// @exception xtd::threading::thread_state_exception The caller attempted to join a thread that is in the xtd::threading::thread_state::unstarted state. /// @exception xtd::argument_exception timeout is a negative number other than -1 milliseconds, which represents
-or-
timeout is greater than xtd::int32_object::max_value. bool join(const time_span& timeout); @@ -299,14 +299,14 @@ namespace xtd { static void join_all(); /// @brief Blocks the calling thread until all joinable threads terminate or the specified time elapses, while continuing. /// @param milliseconds_timeout The number of milliseconds to wait for all threads to terminate. - /// @return true if all threads have terminated; false if all threads have not terminated after the amount of time specified by the timeout parameter has elapsed. + /// @return `true` if all threads have terminated; false if all threads have not terminated after the amount of time specified by the timeout parameter has elapsed. /// @exception xtd::threading::thread_state_exception The caller attempted to join a thread that is in the xtd::threading::thread_state::unstarted state. /// @remarks If one or more threads are not joinable, they will be skipped. /// @remarks Call xtd::threading::thread_pool::close method to join the end of running worker threads too. static bool join_all(int32 milliseconds_timeout); /// @brief Blocks the calling thread until all joinable threads terminate or the specified time elapses, while continuing. /// @param timeout A xtd::time_span set to the amount of time to wait for all threads to terminate. - /// @return true if all threads have terminated; false if all threads have not terminated after the amount of time specified by the timeout parameter has elapsed. + /// @return `true` if all threads have terminated; false if all threads have not terminated after the amount of time specified by the timeout parameter has elapsed. /// @exception xtd::threading::thread_state_exception The caller attempted to join a thread that is in the xtd::threading::thread_state::unstarted state. /// @remarks If one or more threads are not joinable, they will be skipped. /// @remarks Call xtd::threading::thread_pool::close method to join the end of running worker threads too. @@ -319,7 +319,7 @@ namespace xtd { static void join_all(const collection_t& threads) {join_all(threads, timeout::infinite);} /// @brief Blocks the calling thread until all specified joinable threads collection terminate or the specified time elapses, while continuing. /// @param milliseconds_timeout The number of milliseconds to wait for all threads to terminate. - /// @return true if all threads have terminated; false if all threads have not terminated after the amount of time specified by the timeout parameter has elapsed. + /// @return `true` if all threads have terminated; false if all threads have not terminated after the amount of time specified by the timeout parameter has elapsed. /// @exception xtd::threading::thread_state_exception The caller attempted to join a thread that is in the xtd::threading::thread_state::unstarted state. /// @remarks If one or more threads are not joinable, they will be skipped. template @@ -331,7 +331,7 @@ namespace xtd { } /// @brief Blocks the calling thread until all specified joinable threads collection terminate or the specified time elapses, while continuing. /// @param timeout A xtd::time_span set to the amount of time to wait for all threads to terminate. - /// @return true if all threads have terminated; false if all threads have not terminated after the amount of time specified by the timeout parameter has elapsed. + /// @return `true` if all threads have terminated; false if all threads have not terminated after the amount of time specified by the timeout parameter has elapsed. /// @exception xtd::threading::thread_state_exception The caller attempted to join a thread that is in the xtd::threading::thread_state::unstarted state. /// @remarks If one or more threads are not joinable, they will be skipped. template @@ -355,7 +355,7 @@ namespace xtd { static void spin_wait(int32 iterations); /// @brief Causes the calling thread to yield execution to another thread that is ready to run on the current processor. The operating system selects the thread to yield to. - /// @return true if the operating system switched execution to another thread; otherwise, false. + /// @return `true` if the operating system switched execution to another thread; otherwise, false. /// @remarks If this method succeeds, the rest of the thread's current time slice is yielded. The operating system schedules the calling thread for another time slice, according to its priority and the status of other threads that are available to run. /// @remarks yielding is limited to the processor that is executing the calling thread. The operating system will not switch execution to another processor, even if that processor is idle or is running a thread of lower priority. If there are no other threads that are ready to execute on the current processor, the operating system does not yield execution, and this method returns false. /// @remarks This method is equivalent to using platform invoke to call the native Win32 switch_to_thread function. You should call the xtd::threading::thread::yield method instead of using platform invoke, because platform invoke bypasses any custom threading behavior the host has requested. @@ -562,7 +562,7 @@ namespace xtd { void sleep_until(const xtd::date_time& sleep_time); /// @brief Suggests that the implementation reschedule execution of threads. - /// @return true if the operating system switched execution to another thread; otherwise, false. + /// @return `true` if the operating system switched execution to another thread; otherwise, false. /// @par Header /// ```cpp /// #include diff --git a/src/xtd.core/include/xtd/threading/thread_local_object.hpp b/src/xtd.core/include/xtd/threading/thread_local_object.hpp index dc01f1e32037..8b090ccc18d9 100644 --- a/src/xtd.core/include/xtd/threading/thread_local_object.hpp +++ b/src/xtd.core/include/xtd/threading/thread_local_object.hpp @@ -91,7 +91,7 @@ namespace xtd { /// @{ /// @brief Gets whether xtd::threading::thread_local_object::value is initialized on the current thread. - /// @return true if xtd::threading::thread_local_object::value is initialized on the current thread; otherwise false. + /// @return `true` if xtd::threading::thread_local_object::value is initialized on the current thread; otherwise `false`. bool is_value_created() const noexcept { lock_guard_mutex lock {data_->mutex}; return data_->values.find(thread::current_thread().thread_id()) != data_->values.end(); diff --git a/src/xtd.core/include/xtd/threading/thread_pool.hpp b/src/xtd.core/include/xtd/threading/thread_pool.hpp index 8d56985f922c..1450b43fe5fd 100644 --- a/src/xtd.core/include/xtd/threading/thread_pool.hpp +++ b/src/xtd.core/include/xtd/threading/thread_pool.hpp @@ -140,25 +140,25 @@ namespace xtd { static void join_all(); /// @brief Join all resources and worker threads. /// @param milliseconds_timeout The number of milliseconds to wait for all threads to terminate. - /// @return true if all threads have terminated; false if all threads have not terminated after the amount of time specified by the timeout parameter has elapsed. + /// @return `true` if all threads have terminated; false if all threads have not terminated after the amount of time specified by the timeout parameter has elapsed. /// @remarks If one or more threads are not joinable, they will be skipped. /// @remarks You can use this method to ensure that all pending threads are closed, and that resources are also closed. static bool join_all(int32 milliseconds_timeout); /// @brief Join all resources and worker threads. /// @param timeout A xtd::time_span set to the amount of time to wait for all threads to terminate. - /// @return true if all threads have terminated; false if all threads have not terminated after the amount of time specified by the timeout parameter has elapsed. + /// @return `true` if all threads have terminated; false if all threads have not terminated after the amount of time specified by the timeout parameter has elapsed. /// @remarks If one or more threads are not joinable, they will be skipped. /// @remarks You can use this method to ensure that all pending threads are closed, and that resources are also closed. static bool join_all(const time_span& timeout); /// @brief Queues a method for execution. The method executes when a thread pool thread becomes available. /// @param callback A pointer function that represents the method to be executed. - /// @return true if the method is successfully queued; NotSupportException is thrown if the work item could not be queued + /// @return `true` if the method is successfully queued; NotSupportException is thrown if the work item could not be queued static bool queue_user_work_item(const wait_callback& callback); /// @brief Queues a method for execution. The method executes when a thread pool thread becomes available. /// @param callback A pointer function that represents the method to be executed. /// @param state An object containing data to be used by the method. - /// @return true if the method is successfully queued; NotSupportedException is thrown if the work item could not be queued + /// @return `true` if the method is successfully queued; NotSupportedException is thrown if the work item could not be queued static bool queue_user_work_item(const wait_callback& callback, std::any state); /// @cond @@ -219,13 +219,13 @@ namespace xtd { /// @brief Sets the number of requests to the thread pool that can be active concurrently. All requests above that number remain queued until thread pool threads become available. /// @param worker_threads The maximum number of worker threads in the thread pool. /// @param completion_port_threads The maximum number of asynchronous I/O threads in the thread pool. - /// @return true if the change is successful; otherwise, false. + /// @return `true` if the change is successful; otherwise, false. static bool set_max_threads(size_t worker_threads, size_t completion_port_threads); /// @brief Sets the number of idle threads the thread pool maintains in anticipation of new requests. /// @param worker_threads The new minimum number of idle worker threads to be maintained by the thread pool. /// @param completion_port_threads The new minimum number of idle asynchronous I/O threads to be maintained by the thread pool. - /// @return true if the change is successful; otherwise, false. + /// @return `true` if the change is successful; otherwise, false. static bool set_min_threads(size_t worker_threads, size_t completion_port_threads); /// @} diff --git a/src/xtd.core/include/xtd/threading/wait_handle.hpp b/src/xtd.core/include/xtd/threading/wait_handle.hpp index 37d663a58be9..106e72997a10 100644 --- a/src/xtd.core/include/xtd/threading/wait_handle.hpp +++ b/src/xtd.core/include/xtd/threading/wait_handle.hpp @@ -97,7 +97,7 @@ namespace xtd { virtual void close(); /// @brief Blocks the current thread until the current xtd::threading::wait_handle receives a signal. - /// @return true if the current instance receives a signal. If the current instance is never signaled, xtd::threading::wait_handle.wait_one(int32, bool) never returns. + /// @return `true` if the current instance receives a signal. If the current instance is never signaled, xtd::threading::wait_handle.wait_one(int32, bool) never returns. /// @exception xtd::object_closed_exception the handle is invalid /// @exception xtd::threading::abandoned_mutex_exception The wait completed because a thread exited without releasing a mutex. virtual bool wait_one(); @@ -112,7 +112,7 @@ namespace xtd { /// @brief Blocks the current thread until the current instance receives a signal, using a xtd::time_span to measure the time interval. /// @param timeout A xtd::time_span that represents the number of milliseconds to wait, or a xtd::time_span that represents -1 milliseconds to wait indefinitely. - /// @return true if the current instance receives a signal. If the current instance is never signaled, xtd::threading::wait_handle.wait_one(int32, bool) never returns. + /// @return `true` if the current instance receives a signal. If the current instance is never signaled, xtd::threading::wait_handle.wait_one(int32, bool) never returns. /// @exception xtd::object_closed_exception the handle is invalid /// @exception xtd::threading::abandoned_mutex_exception The wait completed because a thread exited without releasing a mutex. /// @exception xtd::argument_exception milliseconds_timeout is a negative number other than -1, which represents an infinite time-out. @@ -153,7 +153,7 @@ namespace xtd { /// @brief Waits for all the elements in the specified collection to receive a signal. /// @param wait_handles A xtd::threading::wait_handle collection containing the objects for which the current instance will wait. This array cannot contain multiple references to the same object. - /// @return true when every element in wait_handles has received a signal; otherwise the method never returns. + /// @return `true` when every element in wait_handles has received a signal; otherwise the method never returns. /// @exception xtd::object_closed_exception the to_signal and/or to_wait are invalid /// @exception xtd::argument_exception The number of objects in wait_handles is greater than the system permits. /// @exception xtd::threading::abandoned_mutex_exception The wait completed because a thread exited without releasing a mutex. @@ -163,7 +163,7 @@ namespace xtd { /// @brief Waits for all the elements in the specified collection to receive a signal, using an int32 value to measure the time interval. /// @param wait_handles A xtd::threading::wait_handle collection containing the objects for which the current instance will wait. This array cannot contain multiple references to the same object. /// @param milliseconds_timeout The number of milliseconds to wait, or xtd::threading::timeout::infinite (-1) to wait indefinitely. - /// @return true when every element in wait_handles has received a signal; otherwise the method never returns. + /// @return `true` when every element in wait_handles has received a signal; otherwise the method never returns. /// @exception xtd::argument_exception timeout is a negative number other than -1 milliseconds, which represents an infinite time-out.
-or-
The number of objects in wait_handles is greater than the system permits. /// @exception xtd::object_closed_exception the to_signal and/or to_wait are invalid /// @exception xtd::argument_exception The number of objects in wait_handles is greater than the system permits. @@ -179,7 +179,7 @@ namespace xtd { /// @brief Waits for all the elements in the specified collection to receive a signal, using a xtd::time_span value to measure the time interval. /// @param wait_handles A xtd::threading::wait_handle collection containing the objects for which the current instance will wait. This array cannot contain multiple references to the same object. /// @param timeout A xtd::time_span that represents the number of milliseconds to wait, or a xtd::time_span that represents -1 milliseconds, to wait indefinitely. - /// @return true when every element in wait_handles has received a signal; otherwise the method never returns. + /// @return `true` when every element in wait_handles has received a signal; otherwise the method never returns. /// @exception xtd::argument_exception timeout is a negative number other than -1 milliseconds, which represents an infinite time-out.
-or-
The number of objects in wait_handles is greater than the system permits. /// @exception xtd::object_closed_exception the to_signal and/or to_wait are invalid /// @exception xtd::argument_exception The number of objects in wait_handles is greater than the system permits. @@ -302,14 +302,14 @@ namespace xtd { /// @{ /// @brief Releases ownership of the specified wait_handle object. - /// @return true If the function succeeds, false otherwise. + /// @return `true` If the function succeeds, false otherwise. /// @remarks Override this function for all derived object virtual bool signal() = 0; /// @brief wait ownership of the specified mutex object. /// @param handle A valid handle to an open object. /// @param milliseconds_timeout The number of milliseconds to wait, or -1 to wait indefinitely. - /// @return true if the current instance receives a signal; otherwise, false. + /// @return `true` if the current instance receives a signal; otherwise, false. /// @remarks If milliseconds_timeout is zero, the method does not block. It tests the state of the wait handle and returns immediately. /// @remarks Override this function for all derived object virtual bool wait(int32 milliseconds_timeout) = 0; diff --git a/src/xtd.core/include/xtd/time_span.hpp b/src/xtd.core/include/xtd/time_span.hpp index a462d946ac19..c7ea94b357ac 100644 --- a/src/xtd.core/include/xtd/time_span.hpp +++ b/src/xtd.core/include/xtd/time_span.hpp @@ -404,7 +404,7 @@ namespace xtd { /// @brief Returns a value that indicates whether two specified instances of xtd::time_span are equal. /// @param t1 The first time interval to compare. /// @param t2 The second time interval to compare. - /// @return true if the values of t1 and t2 are equal; otherwise, false. + /// @return `true` if the values of t1 and t2 are equal; otherwise, false. static bool equals(time_span t1, time_span t2); /// @brief Returns a xtd::time_span that represents a specified number of days, where the specification is accurate to the nearest millisecond. @@ -526,7 +526,7 @@ namespace xtd { /// @brief Converts the string representation of a time interval to its xtd::time_span equivalent and returns a value that indicates whether the conversion succeeded. /// @param value A string that specifies the time interval to convert. /// @param result When this method returns, contains an object that represents the time interval specified by value, or xtd::time_span::zero if the conversion failed. - /// @return true if s was converted successfully; otherwise, false. This operation returns false if the value parameter is empty (""), has an invalid format, represents a time interval that is less than xtd::time_span::min_value or greater than xtd::time_span::max_value, or has at least one days, hours, minutes, or seconds component outside its valid range. + /// @return `true` if s was converted successfully; otherwise, false. This operation returns false if the value parameter is empty (""), has an invalid format, represents a time interval that is less than xtd::time_span::min_value or greater than xtd::time_span::max_value, or has at least one days, hours, minutes, or seconds component outside its valid range. static bool try_parse(const string& value, time_span& result); /// @} diff --git a/src/xtd.core/include/xtd/time_zone_info.hpp b/src/xtd.core/include/xtd/time_zone_info.hpp index f53628fbdd1b..9ba685cde202 100644 --- a/src/xtd.core/include/xtd/time_zone_info.hpp +++ b/src/xtd.core/include/xtd/time_zone_info.hpp @@ -89,7 +89,7 @@ namespace xtd { xtd::day_of_week day_of_week() const noexcept; /// @brief Gets a value indicating whether the time change occurs at a fixed date and time (such as November 1) or a floating date and time (such as the last Sunday of October). - /// @return true if the time change rule is fixed-date; false if the time change rule is floating-date. + /// @return `true` if the time change rule is fixed-date; false if the time change rule is floating-date. /// @remarks A fixed-date rule indicates that the transition occurs on the same date and time of each year to which the adjustment rule applies. For example, a time change that occurs every November 3 follows a fixed-date rule. A floating-date rule indicates that the transition occurs on a specific day of a specific week of a specific month for each year to which the adjustment rule applies. For example, a time change that occurs on the first Sunday of November follows a floating-date rule. /// @remarks The value of the xtd::time_zone_info::transition_time::is_fixed_date_rule property determines which properties of a xtd::time_zone_info::transition_time object have valid values. The following table indicates which properties are affected by the value of the xtd::time_zone_info::transition_time::is_fixed_date_rule property. /// | transition_time property | is_fixed_date_rule = true | is_fixed_date_rule = false | @@ -333,7 +333,7 @@ namespace xtd { /// @brief Indicates whether a specified date and time falls in the range of daylight saving time for the time zone of the current xtd::time_zone_info object. /// @param date_time A date and time value. - /// @return true if the date_time parameter is a daylight saving time; otherwise, false. + /// @return `true` if the date_time parameter is a daylight saving time; otherwise, false. bool is_daylight_saving_time(const xtd::date_time& date_time) const noexcept; xtd::string to_string() const noexcept override; diff --git a/src/xtd.core/include/xtd/timers/timer.hpp b/src/xtd.core/include/xtd/timers/timer.hpp index 84027fc072d3..fa02bafeff82 100644 --- a/src/xtd.core/include/xtd/timers/timer.hpp +++ b/src/xtd.core/include/xtd/timers/timer.hpp @@ -82,7 +82,7 @@ namespace xtd { /// @{ /// @brief Gets a boolean indicating whether the xtd::timers::timer should raise the xtd::timers::timer::elapsed event only once (false) or repeatedly (true). - /// @return true if the xtd::timers::timer should raise the xtd::timers::timer::elapsed event each time the interval elapses; false if it should raise the xtd::timers::timer::elapsed event only once, after the first time the interval elapses. The default is true. + /// @return `true` if the xtd::timers::timer should raise the xtd::timers::timer::elapsed event each time the interval elapses; false if it should raise the xtd::timers::timer::elapsed event only once, after the first time the interval elapses. The default is true. /// @remarks If the xtd::timers::timer is already enabled when the xtd::timers::timer::start method is called, the interval is reset. If xtd::timers::timer::auto_reset is false, the xtd::timers::timer::start method must be called in order to start the count again. /// @remarks Resetting the interval affects when the xtd::timers::timer::elapsed event is raised. For example, if you set the interval to 5 seconds and then set the xtd::timers::timer::enabled property to true, the count starts at the time xtd::timers::timer::enabled is set. If you reset the interval to 10 seconds when the count is 3 seconds, the xtd::timers::timer::elapsed event is raised for the first time 13 seconds after the xtd::timers::timer::enabled property was set to true. bool auto_reset() const noexcept; @@ -93,7 +93,7 @@ namespace xtd { timer& auto_reset(bool value); /// @brief Gets a value indicating whether the xtd::timers::timer should raise the xtd::timers::timer::elapsed event. - /// @return true if the xtd::timers::timer should raise the xtd::timers::timer::elapsed event; otherwise, false. The default is false. + /// @return `true` if the xtd::timers::timer should raise the xtd::timers::timer::elapsed event; otherwise, false. The default is false. /// @exception xtd::object_closed_exception This property cannot be set because the timer has been closed. /// @exception xtd::argument_exception The xtd::timers::timer::interval property was set to a value greater than xtd::int32_object::max_value before the timer was enabled. /// @remarks Setting xtd::timers::timer::enabled to true is the same as calling xtd::timers::timer::start, while setting xtd::timers::timer::enabled to false is the same as calling xtd::timers::timer::stop. diff --git a/src/xtd.core/include/xtd/uri.hpp b/src/xtd.core/include/xtd/uri.hpp index 341f2d5de36a..f3a090a4d25b 100644 --- a/src/xtd.core/include/xtd/uri.hpp +++ b/src/xtd.core/include/xtd/uri.hpp @@ -639,7 +639,7 @@ namespace xtd { /// @brief Determines whether a specified character is a valid hexadecimal digit. /// @param character The character to validate. - /// @return bool A bool value that is true if the character is a valid hexadecimal digit; otherwise false. + /// @return bool A bool value that is true if the character is a valid hexadecimal digit; otherwise `false`. /// @remarks Hexadecimal digits are the digits 0 to 9 and the letters A-F or a-f. static bool is_hex_digit(char character); diff --git a/src/xtd.core/include/xtd/version.hpp b/src/xtd.core/include/xtd/version.hpp index cc617510ac5f..dcb3241b30e0 100644 --- a/src/xtd.core/include/xtd/version.hpp +++ b/src/xtd.core/include/xtd/version.hpp @@ -281,7 +281,7 @@ namespace xtd { /// @brief Tries to convert the string representation of a version number to an equivalent xtd::version object, and returns a value that indicates whether the conversion succeeded. /// @param input A string that contains a version number to convert. /// @param result When this method returns, contains the xtd::version equivalent of the number that is contained in input, if the conversion succeeded. If input is empty, or if the conversion fails, result is empty when the method returns. - /// @return true if the input parameter was converted successfully; otherwise, false. + /// @return `true` if the input parameter was converted successfully; otherwise, false. /// @remarks The xtd::version::try_parse method is similar to the xtd::version::parse method, except that it doesn't throw an exception if the conversion fails. Instead, it returns false if input is null, has fewer than two or more than four components, has at least one component that is not an integer, has at least one component that is less than zero, or has at least one component that is greater than std::numeric_limits::max(). /// For the parse operation to succeed, the input parameter must be in the following format: /// @verbatim major.minor[.build[.revision]] @endverbatim diff --git a/src/xtd.drawing.native/include/xtd/drawing/native/font.hpp b/src/xtd.drawing.native/include/xtd/drawing/native/font.hpp index 2ce672a7a393..706e4fc03b18 100644 --- a/src/xtd.drawing.native/include/xtd/drawing/native/font.hpp +++ b/src/xtd.drawing.native/include/xtd/drawing/native/font.hpp @@ -38,10 +38,10 @@ namespace xtd { /// @brief Creates font. /// @param family_name A string representation of the font family for the new font. /// @param em_size The em-size of the new font in pixels. - /// @param bold true if font is bold; otherwise false. - /// @param italic true if font is italic; otherwise false. - /// @param underline true if font is underline; otherwise false. - /// @param strikeout true if font is strikeout; otherwise false. + /// @param bold true if font is bold; otherwise `false`. + /// @param italic true if font is italic; otherwise `false`. + /// @param underline true if font is underline; otherwise `false`. + /// @param strikeout true if font is strikeout; otherwise `false`. /// @param gdi_char_set A byte that specifies a GDI character set to use for this font. /// @param gdi_vertical_font A boolean value indicating whether the new xtd::drawing::font is derived from a GDI vertical font. /// @return The created font handle. @@ -74,12 +74,12 @@ namespace xtd { /// @param font The font handle to retrieve informations. /// @param name The font name. /// @param em_size The font em-size. - /// @param bold True is the font is bold; otherwise false. - /// @param italic True is the font is italic; otherwise false. - /// @param underline True is the font is underline; otherwise false. - /// @param strikeout True is the font is strikeout; otherwise false. + /// @param bold True is the font is bold; otherwise `false`. + /// @param italic True is the font is italic; otherwise `false`. + /// @param underline True is the font is underline; otherwise `false`. + /// @param strikeout True is the font is strikeout; otherwise `false`. /// @param gdi_char_set The GDI character set. - /// @param gdi_vertical_font True is the font is GDI vertical font; otherwise false. + /// @param gdi_vertical_font True is the font is GDI vertical font; otherwise `false`. /// | Character set | Value | /// | ------------- | ----- | /// | ANSI | 0 | diff --git a/src/xtd.drawing.native/include/xtd/drawing/native/font_family.hpp b/src/xtd.drawing.native/include/xtd/drawing/native/font_family.hpp index 9d52efe7eca5..44b185855fd5 100644 --- a/src/xtd.drawing.native/include/xtd/drawing/native/font_family.hpp +++ b/src/xtd.drawing.native/include/xtd/drawing/native/font_family.hpp @@ -73,10 +73,10 @@ namespace xtd { /// @brief Gets the cell ascent. /// @param font_family The fontt family handle. /// @param em_height The em-height of the font family in pixels. - /// @param bold true if font family is bold; otherwise false. - /// @param italic true if font family is italic; otherwise false. - /// @param underline true if font family is underline; otherwise false. - /// @param strikeout true if font family is strikeout; otherwise false. + /// @param bold true if font family is bold; otherwise `false`. + /// @param italic true if font family is italic; otherwise `false`. + /// @param underline true if font family is underline; otherwise `false`. + /// @param strikeout true if font family is strikeout; otherwise `false`. /// @return The cell ascent. /// @warning Internal use only static int32 get_cell_ascent(intptr font_family, int32 em_height, bool bold, bool italic, bool underline, bool strikeout); @@ -84,10 +84,10 @@ namespace xtd { /// @brief Gets the cell descent. /// @param font_family The fontt family handle. /// @param em_height The em-height of the font family in pixels. - /// @param bold true if font family is bold; otherwise false. - /// @param italic true if font family is italic; otherwise false. - /// @param underline true if font family is underline; otherwise false. - /// @param strikeout true if font family is strikeout; otherwise false. + /// @param bold true if font family is bold; otherwise `false`. + /// @param italic true if font family is italic; otherwise `false`. + /// @param underline true if font family is underline; otherwise `false`. + /// @param strikeout true if font family is strikeout; otherwise `false`. /// @return The cell descent. /// @warning Internal use only static int32 get_cell_descent(intptr font_family, int32 em_height, bool bold, bool italic, bool underline, bool strikeout); @@ -95,10 +95,10 @@ namespace xtd { /// @brief Gets the line spacing. /// @param font_family The fontt family handle. /// @param em_height The em-height of the font family in pixels. - /// @param bold true if font family is bold; otherwise false. - /// @param italic true if font family is italic; otherwise false. - /// @param underline true if font family is underline; otherwise false. - /// @param strikeout true if font family is strikeout; otherwise false. + /// @param bold true if font family is bold; otherwise `false`. + /// @param italic true if font family is italic; otherwise `false`. + /// @param underline true if font family is underline; otherwise `false`. + /// @param strikeout true if font family is strikeout; otherwise `false`. /// @return The line spacing. /// @warning Internal use only static int32 get_line_spacing(intptr font_family, int32 em_height, bool bold, bool italic, bool underline, bool strikeout); @@ -114,11 +114,11 @@ namespace xtd { /// @brief Gets the style availability. /// @param font_family The fontt family handle. /// @param em_height The em-height of the font family in pixels. - /// @param bold true if font family is bold; otherwise false. - /// @param italic true if font family is italic; otherwise false. - /// @param underline true if font family is underline; otherwise false. - /// @param strikeout true if font family is strikeout; otherwise false. - /// @return True if font family is availlable; otherwise false. + /// @param bold true if font family is bold; otherwise `false`. + /// @param italic true if font family is italic; otherwise `false`. + /// @param underline true if font family is underline; otherwise `false`. + /// @param strikeout true if font family is strikeout; otherwise `false`. + /// @return True if font family is availlable; otherwise `false`. /// @warning Internal use only static bool is_style_available(intptr font_family, bool bold, bool italic, bool underline, bool strikeout); /// @} diff --git a/src/xtd.drawing.native/include/xtd/drawing/native/graphics.hpp b/src/xtd.drawing.native/include/xtd/drawing/native/graphics.hpp index 6b811e05a593..853ea8700fc0 100644 --- a/src/xtd.drawing.native/include/xtd/drawing/native/graphics.hpp +++ b/src/xtd.drawing.native/include/xtd/drawing/native/graphics.hpp @@ -292,7 +292,7 @@ namespace xtd { /// @param line_alignment The alignment of the text (see string_alignments.h for more information). /// @param hot_key_prefix The hotkey prefix value (see hot_key_prefixes.h for more information). /// @param trimming The trimming value for the text (see string_trimmings.h for more information). - /// @param no_wrap True if the text wrapping between lines when formatting within a rectangle is disabled; otherwise false. + /// @param no_wrap True if the text wrapping between lines when formatting within a rectangle is disabled; otherwise `false`. /// @warning Internal use only static void draw_string(intptr handle, const xtd::string& text, intptr font, intptr brush, float x, float y, float width, float height, int32 alignment, int32 line_alignment, int32 hot_key_prefix, int32 trimming, int32 string_formats); diff --git a/src/xtd.drawing.native/include/xtd/drawing/native/region.hpp b/src/xtd.drawing.native/include/xtd/drawing/native/region.hpp index d1cff3b7b4b3..39a5b3f563f1 100644 --- a/src/xtd.drawing.native/include/xtd/drawing/native/region.hpp +++ b/src/xtd.drawing.native/include/xtd/drawing/native/region.hpp @@ -101,25 +101,25 @@ namespace xtd { /// @brief Tests whether the region has an empty interior. /// @param handle The region handle. - /// @return true if the interior of the region is empty; otherwise, false. + /// @return `true` if the interior of the region is empty; otherwise, false. /// @warning Internal use only static bool is_empty(intptr handle); /// @brief Tests whether the region has an empty interior on the specified drawing surface. /// @param handle The region handle. /// @param graphics A graphics handle that represents a drawing surface. - /// @return true if the interior of the region is empty when the transformation associated with graphics is applied; otherwise, false. + /// @return `true` if the interior of the region is empty when the transformation associated with graphics is applied; otherwise, false. /// @warning Internal use only static bool is_empty(intptr handle, intptr grpahics); /// @brief Tests whether the region has an infinite interior. /// @param handle The region handle. - /// @return true if the interior of the region is infinite; otherwise, false. + /// @return `true` if the interior of the region is infinite; otherwise, false. /// @warning Internal use only static bool is_infinite(intptr handle); /// @brief Tests whether the region has an infinite interior on the specified drawing surface. /// @param handle The region handle. /// @param graphics A graphics handle that represents a drawing surface. - /// @return true if the interior of the region is infinite when the transformation associated with graphics is applied; otherwise, false. + /// @return `true` if the interior of the region is infinite when the transformation associated with graphics is applied; otherwise, false. /// @warning Internal use only static bool is_infinite(intptr handle, intptr grpahics); @@ -127,7 +127,7 @@ namespace xtd { /// @param handle The region handle. /// @param x The x-coordinate of the point to test. /// @param y The y-coordinate of the point to test. - /// @return true when the specified point is contained within the region; otherwise, false. + /// @return `true` when the specified point is contained within the region; otherwise, false. /// @warning Internal use only static bool is_visible(intptr handle, float x, float y); /// @brief Tests whether the specified point is contained within the region when drawn using the specified graphics. @@ -135,7 +135,7 @@ namespace xtd { /// @param x The x-coordinate of the point to test. /// @param y The y-coordinate of the point to test. /// @param graphics The graphics handle that represents a draing surface. - /// @return true when the specified point is contained within the region; otherwise, false. + /// @return `true` when the specified point is contained within the region; otherwise, false. /// @warning Internal use only static bool is_visible(intptr handle, float x, float y, intptr grpahics); /// @brief Tests whether any portion of the specified rectangle is contained within the region. @@ -144,7 +144,7 @@ namespace xtd { /// @param y The y-coordinate of the upper-left corner of the rectangle to test. /// @param width The width of the rectangle to test. /// @param height The height of the rectangle to test. - /// @return true when any portion of the specified rectangle is contained within the region; otherwise, false. + /// @return `true` when any portion of the specified rectangle is contained within the region; otherwise, false. /// @warning Internal use only static bool is_visible(intptr handle, float x, float y, float width, float height); /// @brief Tests whether any portion of the specified rectangle is contained within this xtd::drawing::region when drawn using the specified xtd::drawing::graphics. @@ -154,7 +154,7 @@ namespace xtd { /// @param width The width of the rectangle to test. /// @param height The height of the rectangle to test. /// @param graphics A graphics handle that represents a graphics context. - /// @return true when any portion of the specified rectangle is contained within the region; otherwise, false. + /// @return `true` when any portion of the specified rectangle is contained within the region; otherwise, false. /// @warning Internal use only static bool is_visible(intptr handle, float x, float y, float width, float height, intptr grpahics); diff --git a/src/xtd.drawing/include/xtd/drawing/color.hpp b/src/xtd.drawing/include/xtd/drawing/color.hpp index 8db4ef117227..c1fac66aeab7 100644 --- a/src/xtd.drawing/include/xtd/drawing/color.hpp +++ b/src/xtd.drawing/include/xtd/drawing/color.hpp @@ -563,7 +563,7 @@ namespace xtd { intptr handle() const noexcept; /// @brief Gets a value indicating wheter this xtd::drawing::color structure is dark color. - /// @remarks return true if dark color; otherwise false. + /// @remarks return true if dark color; otherwise `false`. bool is_dark() const noexcept; /// @brief Specifies whether this xtd::drawing::color class is uninitialized. @@ -576,7 +576,7 @@ namespace xtd { bool is_known_color() const noexcept; /// @brief Gets a value indicating wheter this xtd::drawing::color structure is light color. - /// @remarks return true if light color; otherwise false. + /// @remarks return true if light color; otherwise `false`. bool is_light() const noexcept; /// @brief Gets a value indicating whether this xtd::drawing::color structure is a named color or a member of the xtd::drawing::known_color enumeration. diff --git a/src/xtd.drawing/include/xtd/drawing/font.hpp b/src/xtd.drawing/include/xtd/drawing/font.hpp index f2794c85ec6b..f03918a74b27 100644 --- a/src/xtd.drawing/include/xtd/drawing/font.hpp +++ b/src/xtd.drawing/include/xtd/drawing/font.hpp @@ -174,7 +174,7 @@ namespace xtd { /// @{ /// @brief Gets a value that indicates whether this xtd::drawing::font is bold. - /// @return true if this xtd::drawing::font is bold; otherwise, false. + /// @return `true` if this xtd::drawing::font is bold; otherwise, false. bool bold() const noexcept; /// @brief Gets the xtd::drawing::font_family associated with this xtd::drawing::font. @@ -210,7 +210,7 @@ namespace xtd { xtd::byte gdi_char_set() const noexcept; /// @brief Gets a Boolean value that indicates whether this xtd::drawing::font is derived from a GDI vertical font. - /// @return true if this xtd::drawing::font is derived from a GDI vertical font; otherwise, false. + /// @return `true` if this xtd::drawing::font is derived from a GDI vertical font; otherwise, false. /// @remarks Use this property to determine if a font is compatible with native Win32 controls on non-Unicode platforms. /// @remarks gdi_vertical_font only returns true if this font was created from a classic GDI font definition, like a LOGFONT or HFONT. bool gdi_vertical_font() const noexcept; @@ -228,12 +228,12 @@ namespace xtd { int32 height() const noexcept; /// @brief Gets a value indicating whether the font is a member of xtd::drawing::system_fonts. - /// @return true if the font is a member of xtd::drawing::system_fonts; otherwise, false. The default is false. + /// @return `true` if the font is a member of xtd::drawing::system_fonts; otherwise, false. The default is false. /// @remarks When the user changes the system font, the is_system_font property could return true, even if the font is not actually a system font. bool is_system_font() const noexcept; /// @brief Gets a value that indicates whether this xtd::drawing::font is italic. - /// @return true if this xtd::drawing::font is italic; otherwise, false. + /// @return `true` if this xtd::drawing::font is italic; otherwise, false. bool italic() const noexcept; /// @brief Gets the face name of this xtd::drawing::font. @@ -253,7 +253,7 @@ namespace xtd { float size_in_points() const noexcept; /// @brief Gets a value that indicates whether this xtd::drawing::font is strikeout. - /// @return true if this xtd::drawing::font is strikeout; otherwise, false. + /// @return `true` if this xtd::drawing::font is strikeout; otherwise, false. bool strikeout() const noexcept; /// @brief Gets style information for this xtd::drawing::font. @@ -261,7 +261,7 @@ namespace xtd { font_style style() const noexcept; /// @brief Gets a value that indicates whether this xtd::drawing::font is underline. - /// @return true if this xtd::drawing::font is underline; otherwise, false. + /// @return `true` if this xtd::drawing::font is underline; otherwise, false. bool underline() const noexcept; /// @brief Gets the unit of measure for this xtd::drawing::font. diff --git a/src/xtd.drawing/include/xtd/drawing/font_family.hpp b/src/xtd.drawing/include/xtd/drawing/font_family.hpp index 334a3e1f11e4..7392bac2ee26 100644 --- a/src/xtd.drawing/include/xtd/drawing/font_family.hpp +++ b/src/xtd.drawing/include/xtd/drawing/font_family.hpp @@ -127,7 +127,7 @@ namespace xtd { /// @brief Indicates whether the specified font_style enumeration is available. /// @param style The font_style to test. - /// @return true if the specified font_style is available; otherwise, false. + /// @return `true` if the specified font_style is available; otherwise, false. bool is_style_available(font_style style) const; /// @brief Converts this font_family to a human-readable string representation. diff --git a/src/xtd.drawing/include/xtd/drawing/graphics.hpp b/src/xtd.drawing/include/xtd/drawing/graphics.hpp index c51b908a7ef7..0ff5a9ff01a0 100644 --- a/src/xtd.drawing/include/xtd/drawing/graphics.hpp +++ b/src/xtd.drawing/include/xtd/drawing/graphics.hpp @@ -1160,43 +1160,43 @@ namespace xtd { /// @brief Indicates whether the rectangle specified by a xtd::drawing::rectangle structure is contained within the visible clip region of this xtd::drawing::graphics. /// @param rect xtd::drawing::rectangle structure to test for visibility. - /// @return true if the rectangle specified by the rect parameter is contained within the visible clip region of this xtd::drawing::graphics; otherwise, false. + /// @return `true` if the rectangle specified by the rect parameter is contained within the visible clip region of this xtd::drawing::graphics; otherwise, false. bool is_visible(const xtd::drawing::rectangle& rect); /// @brief Indicates whether the rectangle specified by a xtd::drawing::rectangle_f structure is contained within the visible clip region of this xtd::drawing::graphics. /// @param rect xtd::drawing::rectangle_f structure to test for visibility. - /// @return true if the rectangle specified by the rect parameter is contained within the visible clip region of this xtd::drawing::graphics; otherwise, false. + /// @return `true` if the rectangle specified by the rect parameter is contained within the visible clip region of this xtd::drawing::graphics; otherwise, false. bool is_visible(const xtd::drawing::rectangle_f& rect); /// @brief Indicates whether the rectangle specified by a pair of coordinates, a width, and a height is contained within the visible clip region of this xtd::drawing::graphics. /// @param x The x-coordinate of the upper-left corner of the rectangle to test for visibility. /// @param y The y-coordinate of the upper-left corner of the rectangle to test for visibility. /// @param width Width of the rectangle to test for visibility. /// @param height Height of the rectangle to test for visibility. - /// @return true if the rectangle defined by the x, y, width, and height parameters is contained within the visible clip region of this xtd::drawing::graphics; otherwise, false. + /// @return `true` if the rectangle defined by the x, y, width, and height parameters is contained within the visible clip region of this xtd::drawing::graphics; otherwise, false. bool is_visible(int32 x, int32 y, int32 width, int32 height); /// @brief Indicates whether the rectangle specified by a pair of coordinates, a width, and a height is contained within the visible clip region of this xtd::drawing::graphics. /// @param x The x-coordinate of the upper-left corner of the rectangle to test for visibility. /// @param y The y-coordinate of the upper-left corner of the rectangle to test for visibility. /// @param width Width of the rectangle to test for visibility. /// @param height Height of the rectangle to test for visibility. - /// @return true if the rectangle defined by the x, y, width, and height parameters is contained within the visible clip region of this xtd::drawing::graphics; otherwise, false. + /// @return `true` if the rectangle defined by the x, y, width, and height parameters is contained within the visible clip region of this xtd::drawing::graphics; otherwise, false. bool is_visible(float x, float y, float width, float height); /// @brief ndicates whether the specified xtd::drawing::point structure is contained within the visible clip region of this xtd::drawing::graphics. /// @param point xtd::drawing::point structure to test for visibility. - /// @return true if the point specified by the point parameter is contained within the visible clip region of this xtd::drawing::graphics; otherwise, false. + /// @return `true` if the point specified by the point parameter is contained within the visible clip region of this xtd::drawing::graphics; otherwise, false. bool is_visible(const xtd::drawing::point& point); /// @brief ndicates whether the specified xtd::drawing::point_f structure is contained within the visible clip region of this xtd::drawing::graphics. /// @param point xtd::drawing::point_f structure to test for visibility. - /// @return true if the point specified by the point parameter is contained within the visible clip region of this xtd::drawing::graphics; otherwise, false. + /// @return `true` if the point specified by the point parameter is contained within the visible clip region of this xtd::drawing::graphics; otherwise, false. bool is_visible(const xtd::drawing::point_f& point); /// @brief Indicates whether the point specified by a pair of coordinates is contained within the visible clip region of this xtd::drawing::graphics. /// @param x The x-coordinate of the point to test for visibility. /// @param y The y-coordinate of the point to test for visibility. - /// @return true if the point defined by the x and y parameters is contained within the visible clip region of this xtd::drawing::graphics; otherwise, false. + /// @return `true` if the point defined by the x and y parameters is contained within the visible clip region of this xtd::drawing::graphics; otherwise, false. bool is_visible(int32 x, int32 y); /// @brief Indicates whether the point specified by a pair of coordinates is contained within the visible clip region of this xtd::drawing::graphics. /// @param x The x-coordinate of the point to test for visibility. /// @param y The y-coordinate of the point to test for visibility. - /// @return true if the point defined by the x and y parameters is contained within the visible clip region of this xtd::drawing::graphics; otherwise, false. + /// @return `true` if the point defined by the x and y parameters is contained within the visible clip region of this xtd::drawing::graphics; otherwise, false. bool is_visible(float x, float y); /// @brief Measures the specified string when drawn with the specified xtd::drawing::font. diff --git a/src/xtd.drawing/include/xtd/drawing/image.hpp b/src/xtd.drawing/include/xtd/drawing/image.hpp index 38fc9b374fda..7fe9fb17e583 100644 --- a/src/xtd.drawing/include/xtd/drawing/image.hpp +++ b/src/xtd.drawing/include/xtd/drawing/image.hpp @@ -299,17 +299,17 @@ namespace xtd { /// @brief Returns a value that indicates whether the pixel format for this xtd::drawing::image contains alpha information. /// @param pixfmt The PixelFormat to test. - /// @return true if pixfmt contains alpha information; otherwise, false. + /// @return `true` if pixfmt contains alpha information; otherwise, false. static bool is_alpha_pixel_format(xtd::drawing::imaging::pixel_format pixfmt) noexcept; /// @brief Returns a value that indicates whether the pixel format is 32 bits per pixel. /// @param pixfmt The PixelFormat to test. - /// @return true if pixfmt is canonical; otherwise, false. + /// @return `true` if pixfmt is canonical; otherwise, false. static bool is_canonical_pixel_format(xtd::drawing::imaging::pixel_format pixfmt) noexcept; /// @brief Returns a value that indicates whether the pixel format is 64 bits per pixel. /// @param pixfmt The PixelFormat to test. - /// @return true if pixfmt is extended; otherwise, false. + /// @return `true` if pixfmt is extended; otherwise, false. static bool is_extended_pixel_format(xtd::drawing::imaging::pixel_format pixfmt) noexcept; /// @} diff --git a/src/xtd.drawing/include/xtd/drawing/point.hpp b/src/xtd.drawing/include/xtd/drawing/point.hpp index fb82112dc52e..cd107be66457 100644 --- a/src/xtd.drawing/include/xtd/drawing/point.hpp +++ b/src/xtd.drawing/include/xtd/drawing/point.hpp @@ -149,7 +149,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether this xtd::drawing::point is empty. - /// @return true if both xtd::drawing::point::x and xtd::drawing::point::y are 0; otherwise, false. + /// @return `true` if both xtd::drawing::point::x and xtd::drawing::point::y are 0; otherwise, false. bool is_empty() const noexcept; /// @brief Gets the x-coordinate of this xtd::drawing::point. diff --git a/src/xtd.drawing/include/xtd/drawing/point_f.hpp b/src/xtd.drawing/include/xtd/drawing/point_f.hpp index c4c0be9244c6..b6031919fb21 100644 --- a/src/xtd.drawing/include/xtd/drawing/point_f.hpp +++ b/src/xtd.drawing/include/xtd/drawing/point_f.hpp @@ -65,7 +65,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether this xtd::drawing::point_f is empty. - /// @return true if both xtd::drawing::point_f::x and xtd::drawing::point_f::y are 0; otherwise, false. + /// @return `true` if both xtd::drawing::point_f::x and xtd::drawing::point_f::y are 0; otherwise, false. bool is_empty() const noexcept; /// @brief Gets the x-coordinate of this xtd::drawing::point_f. diff --git a/src/xtd.drawing/include/xtd/drawing/rectangle.hpp b/src/xtd.drawing/include/xtd/drawing/rectangle.hpp index 5d342d802608..635864781832 100644 --- a/src/xtd.drawing/include/xtd/drawing/rectangle.hpp +++ b/src/xtd.drawing/include/xtd/drawing/rectangle.hpp @@ -168,18 +168,18 @@ namespace xtd { /// @brief Determines if the specified point is contained within this xtd::drawing::rectangle structure. /// @param pt The xtd::drawing::point to test. - /// @return This method returns true if the point represented by pt is contained within this xtd::drawing::rectangle structure; otherwise false. + /// @return This method returns true if the point represented by pt is contained within this xtd::drawing::rectangle structure; otherwise `false`. /// @remarks The containing rectangle must be normalized for this method to return accurate results. bool contains(const xtd::drawing::point& pt) const noexcept; /// @brief Determines if the rectangular region represented by rect is entirely contained within this xtd::drawing::rectangle structure. /// @param rect The xtd::drawing::rectangle to test. - /// @return This method returns true if the rectangular region represented by rect is entirely contained within this xtd::drawing::rectangle structure; otherwise false. + /// @return This method returns true if the rectangular region represented by rect is entirely contained within this xtd::drawing::rectangle structure; otherwise `false`. /// @remarks The containing rectangle must be normalized for this method to return accurate results. bool contains(const xtd::drawing::rectangle& rect) const noexcept; /// @brief Determines if the specified point is contained within this xtd::drawing::rectangle structure. /// @param x The x-coordinate of the point to test. /// @param y The y-coordinate of the point to test. - /// @return This method returns true if the point defined by x and y is contained within this xtd::drawing::rectangle structure; otherwise false. + /// @return This method returns true if the point defined by x and y is contained within this xtd::drawing::rectangle structure; otherwise `false`. /// @remarks The containing rectangle must be normalized for this method to return accurate results. bool contains(int32 x, int32 y) const noexcept; @@ -188,7 +188,7 @@ namespace xtd { /// @brief Determines if this rectangle intersects with rect. /// @param rect The rectangle to test. - /// @return This method returns true if there is any intersection, otherwise false. + /// @return This method returns true if there is any intersection, otherwise `false`. bool intersects_with(const rectangle& rect) const noexcept; /// @brief Replaces this xtd::drawing::rectangle with the intersection of itself and the specified xtd::drawing::rectangle. diff --git a/src/xtd.drawing/include/xtd/drawing/rectangle_f.hpp b/src/xtd.drawing/include/xtd/drawing/rectangle_f.hpp index 2ab553c36d3c..a565ed91894d 100644 --- a/src/xtd.drawing/include/xtd/drawing/rectangle_f.hpp +++ b/src/xtd.drawing/include/xtd/drawing/rectangle_f.hpp @@ -157,18 +157,18 @@ namespace xtd { /// @brief Determines if the specified point is contained within this xtd::drawing::rectangle_f structure. /// @param pt The xtd::drawing::point_f to test. - /// @return This method returns true if the point represented by pt is contained within this xtd::drawing::rectangle_f structure; otherwise false. + /// @return This method returns true if the point represented by pt is contained within this xtd::drawing::rectangle_f structure; otherwise `false`. /// @remarks The containing rectangle must be normalized for this method to return accurate results. bool contains(const point_f& pt) const noexcept; /// @brief Determines if the rectangular region represented by rect is entirely contained within this xtd::drawing::rectangle_f structure. /// @param rect The xtd::drawing::rectangle_f to test. - /// @return This method returns true if the rectangular region represented by rect is entirely contained within this xtd::drawing::rectangle_f structure; otherwise false. + /// @return This method returns true if the rectangular region represented by rect is entirely contained within this xtd::drawing::rectangle_f structure; otherwise `false`. /// @remarks The containing rectangle must be normalized for this method to return accurate results. bool contains(const rectangle_f& rect) const noexcept; /// @brief Determines if the specified point is contained within this xtd::drawing::rectangle_f structure. /// @param x The x-coordinate of the point to test. /// @param y The y-coordinate of the point to test. - /// @return This method returns true if the point defined by x and y is contained within this xtd::drawing::rectangle_f structure; otherwise false. + /// @return This method returns true if the point defined by x and y is contained within this xtd::drawing::rectangle_f structure; otherwise `false`. /// @remarks The containing rectangle must be normalized for this method to return accurate results. bool contains(float x, float y) const noexcept; @@ -188,7 +188,7 @@ namespace xtd { /// @brief Determines if this rectangle intersects with rect. /// @param rect The rectangle to test. - /// @return This method returns true if there is any intersection, otherwise false. + /// @return This method returns true if there is any intersection, otherwise `false`. bool intersects_with(const rectangle_f& rect) const noexcept; /// @brief Replaces this xtd::drawing::rectangle_f with the intersection of itself and the specified xtd::drawing::rectangle_f. diff --git a/src/xtd.drawing/include/xtd/drawing/region.hpp b/src/xtd.drawing/include/xtd/drawing/region.hpp index e3cec91737a0..cbe983b7733f 100644 --- a/src/xtd.drawing/include/xtd/drawing/region.hpp +++ b/src/xtd.drawing/include/xtd/drawing/region.hpp @@ -129,29 +129,29 @@ namespace xtd { void intersect(const xtd::drawing::region& region) noexcept; /// @brief Tests whether this xtd::drawing::region has an empty interior. - /// @return true if the interior of this xtd::drawing::region is empty; otherwise, false. + /// @return `true` if the interior of this xtd::drawing::region is empty; otherwise, false. /// @remarks The current transformation of the graphics context g is used to compute the region interior on the drawing surface. bool is_empty() const noexcept; /// @brief Tests whether this xtd::drawing::region has an empty interior on the specified drawing surface. /// @param g A xtd::drawing::graphics that represents a drawing surface. - /// @return true if the interior of this xtd::drawing::region is empty when the transformation associated with g is applied; otherwise, false. + /// @return `true` if the interior of this xtd::drawing::region is empty when the transformation associated with g is applied; otherwise, false. /// @remarks The current transformation of the graphics context g is used to compute the region interior on the drawing surface. bool is_empty(const xtd::drawing::graphics& g) const noexcept; /// @brief Tests whether this xtd::drawing::region has an infinite interior. - /// @return true if the interior of this xtd::drawing::region is infinite; otherwise, false. + /// @return `true` if the interior of this xtd::drawing::region is infinite; otherwise, false. /// @remarks The current transformation of the graphics context g is used to compute the region interior on the drawing surface. bool is_infinite() const noexcept; /// @brief Tests whether this xtd::drawing::region has an infinite interior on the specified drawing surface. /// @param g A xtd::drawing::graphics that represents a drawing surface. - /// @return true if the interior of this xtd::drawing::region is infinite when the transformation associated with g is applied; otherwise, false. + /// @return `true` if the interior of this xtd::drawing::region is infinite when the transformation associated with g is applied; otherwise, false. /// @remarks The current transformation of the graphics context g is used to compute the region interior on the drawing surface. bool is_infinite(const xtd::drawing::graphics& g) const noexcept; /// @brief Tests whether any portion of the specified xtd::drawing::rectangle_f structure is contained within this xtd::drawing::region when drawn using the specified xtd::drawing::graphics. /// @param rect The xtd::drawing::rectangle_f structure to test. /// @param g A xtd::drawing::graphics that represents a graphics context. - /// @return true when any portion of the rect is contained within this xtd::drawing::region; otherwise, false. + /// @return `true` when any portion of the rect is contained within this xtd::drawing::region; otherwise, false. /// @remarks The current transformation of the graphics context is used to compute the region interior and the rectangle coordinates on the drawing surface. bool is_visible(const xtd::drawing::rectangle_f& rect, const xtd::drawing::graphics& g) const noexcept; /// @brief Tests whether any portion of the specified rectangle is contained within this xtd::drawing::region when drawn using the specified xtd::drawing::graphics. @@ -160,13 +160,13 @@ namespace xtd { /// @param width The width of the rectangle to test. /// @param height The height of the rectangle to test. /// @param g A xtd::drawing::graphics that represents a graphics context. - /// @return true when any portion of the specified rectangle is contained within this xtd::drawing::region; otherwise, false. + /// @return `true` when any portion of the specified rectangle is contained within this xtd::drawing::region; otherwise, false. /// @remarks The current transformation of the graphics context is used to compute the region interior and the rectangle coordinates on the drawing surface. bool is_visible(float x, float y, float width, float height, const xtd::drawing::graphics& g) const noexcept; /// @brief Tests whether any portion of the specified xtd::drawing::rectangle structure is contained within this xtd::drawing::region when drawn using the specified xtd::drawing::graphics. /// @param rect The xtd::drawing::rectangle structure to test. /// @param g A xtd::drawing::graphics that represents a graphics context. - /// @return true when any portion of the rect is contained within this xtd::drawing::region; otherwise, false. + /// @return `true` when any portion of the rect is contained within this xtd::drawing::region; otherwise, false. /// @remarks The current transformation of the graphics context is used to compute the region interior and the rectangle coordinates on the drawing surface. bool is_visible(const xtd::drawing::rectangle& rect, const xtd::drawing::graphics& g) const noexcept; /// @brief Tests whether any portion of the specified rectangle is contained within this xtd::drawing::region when drawn using the specified xtd::drawing::graphics. @@ -175,74 +175,74 @@ namespace xtd { /// @param width The width of the rectangle to test. /// @param height The height of the rectangle to test. /// @param g A xtd::drawing::graphics that represents a graphics context. - /// @return true when any portion of the specified rectangle is contained within this xtd::drawing::region; otherwise, false. + /// @return `true` when any portion of the specified rectangle is contained within this xtd::drawing::region; otherwise, false. /// @remarks The current transformation of the graphics context is used to compute the region interior and the rectangle coordinates on the drawing surface. bool is_visible(int32 x, int32 y, int32 width, int32 height, const xtd::drawing::graphics& g) const noexcept; /// @brief Tests whether any portion of the specified xtd::drawing::rectangle_f structure is contained within this xtd::drawing::region. /// @param rect The xtd::drawing::rectangle_f structure to test. - /// @return true when any portion of rect is contained within this xtd::drawing::region; otherwise, false. + /// @return `true` when any portion of rect is contained within this xtd::drawing::region; otherwise, false. bool is_visible(const xtd::drawing::rectangle_f& rect) const noexcept; /// @brief Tests whether any portion of the specified rectangle is contained within this xtd::drawing::region. /// @param x The x-coordinate of the upper-left corner of the rectangle to test. /// @param y The y-coordinate of the upper-left corner of the rectangle to test. /// @param width The width of the rectangle to test. /// @param height The height of the rectangle to test. - /// @return true when any portion of the specified rectangle is contained within this xtd::drawing::region; otherwise, false. + /// @return `true` when any portion of the specified rectangle is contained within this xtd::drawing::region; otherwise, false. bool is_visible(float x, float y, float width, float height) const noexcept; /// @brief Tests whether any portion of the specified xtd::drawing::rectangle structure is contained within this xtd::drawing::region. /// @param rect The xtd::drawing::rectangle structure to test. - /// @return true when any portion of rect is contained within this xtd::drawing::region; otherwise, false. + /// @return `true` when any portion of rect is contained within this xtd::drawing::region; otherwise, false. bool is_visible(const xtd::drawing::rectangle& rect) const noexcept; /// @brief Tests whether any portion of the specified rectangle is contained within this xtd::drawing::region. /// @param x The x-coordinate of the upper-left corner of the rectangle to test. /// @param y The y-coordinate of the upper-left corner of the rectangle to test. /// @param width The width of the rectangle to test. /// @param height The height of the rectangle to test. - /// @return true when any portion of the specified rectangle is contained within this xtd::drawing::region; otherwise, false. + /// @return `true` when any portion of the specified rectangle is contained within this xtd::drawing::region; otherwise, false. bool is_visible(int32 x, int32 y, int32 width, int32 height) const noexcept; /// @brief Tests whether the specified PointF structure is contained within this xtd::drawing::region when drawn using the specified xtd::drawing::graphics. /// @param pt The PointF structure to test. /// @param g A xtd::drawing::graphics that represents a graphics context. - /// @return true when point is contained within this xtd::drawing::region; otherwise, false. + /// @return `true` when point is contained within this xtd::drawing::region; otherwise, false. /// @remarks The current transformation of the graphics context is used to compute the region interior and the rectangle coordinates on the drawing surface. bool is_visible(xtd::drawing::point_f pt, const xtd::drawing::graphics& g) const noexcept; /// @brief Tests whether the specified point is contained within this xtd::drawing::region when drawn using the specified xtd::drawing::graphics. /// @param x The x-coordinate of the point to test. /// @param y The y-coordinate of the point to test. /// @param g A xtd::drawing::graphics that represents a graphics context. - /// @return true when the specified point is contained within this xtd::drawing::region; otherwise, false. + /// @return `true` when the specified point is contained within this xtd::drawing::region; otherwise, false. /// @remarks The current transformation of the graphics context is used to compute the region interior and the rectangle coordinates on the drawing surface. bool is_visible(float x, float y, const xtd::drawing::graphics& g) const noexcept; /// @brief Tests whether the specified Point structure is contained within this xtd::drawing::region when drawn using the specified xtd::drawing::graphics. /// @param pt The Point structure to test. /// @param g A xtd::drawing::graphics that represents a graphics context. - /// @return true when point is contained within this xtd::drawing::region; otherwise, false. + /// @return `true` when point is contained within this xtd::drawing::region; otherwise, false. /// @remarks The current transformation of the graphics context is used to compute the region interior and the rectangle coordinates on the drawing surface. bool is_visible(xtd::drawing::point pt, const xtd::drawing::graphics& g) const noexcept; /// @brief Tests whether the specified point is contained within this xtd::drawing::region when drawn using the specified xtd::drawing::graphics. /// @param x The x-coordinate of the point to test. /// @param y The y-coordinate of the point to test. /// @param g A xtd::drawing::graphics that represents a graphics context. - /// @return true when the specified point is contained within this xtd::drawing::region; otherwise, false. + /// @return `true` when the specified point is contained within this xtd::drawing::region; otherwise, false. /// @remarks The current transformation of the graphics context is used to compute the region interior and the rectangle coordinates on the drawing surface. bool is_visible(int32 x, int32 y, const xtd::drawing::graphics& g) const noexcept; /// @brief Tests whether the specified PointF structure is contained within this xtd::drawing::region. /// @param pt The PointF structure to test. - /// @return true when point is contained within this xtd::drawing::region; otherwise, false. + /// @return `true` when point is contained within this xtd::drawing::region; otherwise, false. bool is_visible(xtd::drawing::point_f pt) const noexcept; /// @brief Tests whether the specified point is contained within this xtd::drawing::region when drawn using the specified xtd::drawing::graphics. /// @param x The x-coordinate of the point to test. /// @param y The y-coordinate of the point to test. - /// @return true when the specified point is contained within this xtd::drawing::region; otherwise, false. + /// @return `true` when the specified point is contained within this xtd::drawing::region; otherwise, false. bool is_visible(float x, float y) const noexcept; /// @brief Tests whether the specified Point structure is contained within this xtd::drawing::region. /// @param pt The Point structure to test. - /// @return true when point is contained within this xtd::drawing::region; otherwise, false. + /// @return `true` when point is contained within this xtd::drawing::region; otherwise, false. bool is_visible(xtd::drawing::point pt) const noexcept; /// @brief Tests whether the specified point is contained within this xtd::drawing::region when drawn using the specified xtd::drawing::graphics. /// @param x The x-coordinate of the point to test. /// @param y The y-coordinate of the point to test. - /// @return true when the specified point is contained within this xtd::drawing::region; otherwise, false. + /// @return `true` when the specified point is contained within this xtd::drawing::region; otherwise, false. bool is_visible(int32 x, int32 y) const noexcept; /// @brief Initializes this xtd::drawing::region to an empty interior. diff --git a/src/xtd.forms.native/include/xtd/forms/native/application.hpp b/src/xtd.forms.native/include/xtd/forms/native/application.hpp index 4c9db4adf741..881dd1a7fae2 100644 --- a/src/xtd.forms.native/include/xtd/forms/native/application.hpp +++ b/src/xtd.forms.native/include/xtd/forms/native/application.hpp @@ -58,7 +58,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the caller can quit this application. - /// @return true if the caller can quit this application; otherwise, false. + /// @return `true` if the caller can quit this application; otherwise, false. /// @warning Internal use only static bool allow_quit(); /// @brief Cleanup all data, handles, references, ... initialized by initialize() before quit. @@ -72,7 +72,7 @@ namespace xtd { /// @warning Internal use only static void do_idle(); /// @brief Return true if dark mode is enabled for the application; otherwise return false. - /// @return true if dark mode is enabled; otherwise false. + /// @return `true` if dark mode is enabled; otherwise `false`. /// @warning Internal use only static bool dark_mode_enabled(); /// @brief Enables button images for the application. diff --git a/src/xtd.forms.native/include/xtd/forms/native/collapsible_panel.hpp b/src/xtd.forms.native/include/xtd/forms/native/collapsible_panel.hpp index edcb0f021a00..0acd743f4d60 100644 --- a/src/xtd.forms.native/include/xtd/forms/native/collapsible_panel.hpp +++ b/src/xtd.forms.native/include/xtd/forms/native/collapsible_panel.hpp @@ -38,12 +38,12 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the collapsible_panel is in the expanded. /// @param control Collapsible panel window handle. - /// @return true if collapsible_panel is expanded; otherwise false. + /// @return `true` if collapsible_panel is expanded; otherwise `false`. /// @warning Internal use only static bool expanded(intptr handle); /// @brief Sets a value indicating whether the collapsible_panel is in the expanded. /// @param control Collapsible panel window handle. - /// @param expanded true if collapsible_panel is expanded; otherwise false. + /// @param expanded true if collapsible_panel is expanded; otherwise `false`. /// @warning Internal use only static void expanded(intptr handle, bool expanded); /// @} diff --git a/src/xtd.forms.native/include/xtd/forms/native/color_dialog.hpp b/src/xtd.forms.native/include/xtd/forms/native/color_dialog.hpp index a78001ca9027..8d403f886805 100644 --- a/src/xtd.forms.native/include/xtd/forms/native/color_dialog.hpp +++ b/src/xtd.forms.native/include/xtd/forms/native/color_dialog.hpp @@ -46,7 +46,7 @@ namespace xtd { /// @param color A xtd::drawing::color that specifies the color to display. /// @param custom_colors A colors array that contains user custom colors. /// @param options A bitwise combination of the color dialog flags. - /// @return true if the user clicks OK in the dialog box; otherwise, false. + /// @return `true` if the user clicks OK in the dialog box; otherwise, false. /// @remarks If result is true, the color parameter contains the new chosen color. /// @remarks If the title is an empty string, the system uses a default title, which is "Color". /// @warning Internal use only diff --git a/src/xtd.forms.native/include/xtd/forms/native/control.hpp b/src/xtd.forms.native/include/xtd/forms/native/control.hpp index b4443756123c..0b535c7083cf 100644 --- a/src/xtd.forms.native/include/xtd/forms/native/control.hpp +++ b/src/xtd.forms.native/include/xtd/forms/native/control.hpp @@ -260,7 +260,7 @@ namespace xtd { /// @brief Gets a value indicating whether the control can respond to user interaction. /// @param control Control window handle. - /// @return true if the control can respond to user interaction; otherwise, false. + /// @return `true` if the control can respond to user interaction; otherwise, false. /// @warning Internal use only static bool enabled(intptr control); @@ -277,7 +277,7 @@ namespace xtd { /// @brief Gets a value indicating whether the control has input focus. /// @param control Control window handle. - /// @return true if the control has focus; otherwise, false. + /// @return `true` if the control has focus; otherwise, false. /// @warning Internal use only static bool focused(intptr control); @@ -449,7 +449,7 @@ namespace xtd { /// @brief Gets a value indicating whether the control and all its child controls are displayed. /// @param control Control window handle. - /// @return true if the control and all its child controls are displayed; otherwise, false. + /// @return `true` if the control and all its child controls are displayed; otherwise, false. /// @warning Internal use only static bool visible(intptr control); /// @brief Sets a value indicating whether the control and all its child controls are displayed. diff --git a/src/xtd.forms.native/include/xtd/forms/native/file_dialog.hpp b/src/xtd.forms.native/include/xtd/forms/native/file_dialog.hpp index 05858ed85ea6..824b8fbaabe4 100644 --- a/src/xtd.forms.native/include/xtd/forms/native/file_dialog.hpp +++ b/src/xtd.forms.native/include/xtd/forms/native/file_dialog.hpp @@ -54,7 +54,7 @@ namespace xtd { /// @param options A bitwise file dialog flags value. /// @param support_multi_dotted_extensions true if the dialog box supports multiple file name extensions; otherwise, false. The default is false. /// @param title The file dialog box title. - /// @return true if the user clicks OK in the dialog box; otherwise, false. + /// @return `true` if the user clicks OK in the dialog box; otherwise, false. /// @remarks If result is true, the file_name parameter contains the new chosen file name and if option contains OFN_ALLOWMULTISELECT flags, the file_names parameter contains the new chosen file names. /// @warning Internal use only static bool run_open_dialog(intptr hwnd, const xtd::string& default_ext, xtd::string& file_name, std::vector& file_names, const xtd::string& filter, size_t filter_index, const xtd::string& initial_directory, size_t options, bool support_multi_dotted_extensions, const xtd::string& title); @@ -70,7 +70,7 @@ namespace xtd { /// @param options A bitwise file dialog flags value. /// @param support_multi_dotted_extensions true if the dialog box supports multiple file name extensions; otherwise, false. The default is false. /// @param title The file dialog box title. - /// @return true if the user clicks OK in the dialog box; otherwise, false. + /// @return `true` if the user clicks OK in the dialog box; otherwise, false. /// @remarks When dialog closed and if result is true, the file_name parameter contains the new chosen file name and if option contains OFN_ALLOWMULTISELECT flags, the file_names parameter contains the new chosen file names. /// @warning Internal use only static void run_open_sheet(xtd::delegate on_dialog_closed, intptr hwnd, const xtd::string& default_ext, xtd::string& file_name, std::vector& file_names, const xtd::string& filter, size_t filter_index, const xtd::string& initial_directory, size_t options, bool support_multi_dotted_extensions, const xtd::string& title); @@ -85,7 +85,7 @@ namespace xtd { /// @param options A bitwise file dialog flags value. /// @param support_multi_dotted_extensions true if the dialog box supports multiple file name extensions; otherwise, false. The default is false. /// @param title The file dialog box title. - /// @return true if the user clicks OK in the dialog box; otherwise, false. + /// @return `true` if the user clicks OK in the dialog box; otherwise, false. /// @remarks If result is true, the file_name parameter contains the new chosen file name and if option contains OFN_ALLOWMULTISELECT flags, the file_names parameter contains the new chosen file names. /// @warning Internal use only static bool run_save_dialog(intptr hwnd, const xtd::string& default_ext, xtd::string& file_name, std::vector& file_names, const xtd::string& filter, size_t filter_index, const xtd::string& initial_directory, size_t options, bool support_multi_dotted_extensions, const xtd::string& title); @@ -101,7 +101,7 @@ namespace xtd { /// @param options A bitwise file dialog flags value. /// @param support_multi_dotted_extensions true if the dialog box supports multiple file name extensions; otherwise, false. The default is false. /// @param title The file dialog box title. - /// @return true if the user clicks OK in the dialog box; otherwise, false. + /// @return `true` if the user clicks OK in the dialog box; otherwise, false. /// @remarks When dialog closed and if result is true, the file_name parameter contains the new chosen file name and if option contains OFN_ALLOWMULTISELECT flags, the file_names parameter contains the new chosen file names. /// @warning Internal use only static void run_save_sheet(xtd::delegate on_dialog_closed, intptr hwnd, const xtd::string& default_ext, xtd::string& file_name, std::vector& file_names, const xtd::string& filter, size_t filter_index, const xtd::string& initial_directory, size_t options, bool support_multi_dotted_extensions, const xtd::string& title); diff --git a/src/xtd.forms.native/include/xtd/forms/native/folder_browser_dialog.hpp b/src/xtd.forms.native/include/xtd/forms/native/folder_browser_dialog.hpp index cfbe8914e6a2..695db31f04e5 100644 --- a/src/xtd.forms.native/include/xtd/forms/native/folder_browser_dialog.hpp +++ b/src/xtd.forms.native/include/xtd/forms/native/folder_browser_dialog.hpp @@ -46,7 +46,7 @@ namespace xtd { /// @param root_folder One of the environment::special_folder values. /// @param selected_path The path of the folder first selected in the dialog box or the last folder selected by the user. /// @param options A bitwise folder browser dialog flags value. - /// @return true if the user clicks OK in the dialog box; otherwise, false. + /// @return `true` if the user clicks OK in the dialog box; otherwise, false. /// @remarks If result is true, the selected_path parameter contains the new selected path. /// @warning Internal use only static bool run_dialog(intptr hwnd, const xtd::string& description, environment::special_folder root_folder, xtd::string& selected_path, size_t options); @@ -56,7 +56,7 @@ namespace xtd { /// @param root_folder One of the environment::special_folder values. /// @param selected_path The path of the folder first selected in the dialog box or the last folder selected by the user. /// @param options A bitwise folder browser dialog flags value. - /// @return true if the user clicks OK in the dialog box; otherwise, false. + /// @return `true` if the user clicks OK in the dialog box; otherwise, false. /// @remarks When dialog closed and if result is true, the selected_path parameter contains the new selected path. /// @warning Internal use only static void run_sheet(xtd::delegate on_dialog_closed, intptr hwnd, const xtd::string& description, environment::special_folder root_folder, xtd::string& selected_path, size_t options); diff --git a/src/xtd.forms.native/include/xtd/forms/native/font_dialog.hpp b/src/xtd.forms.native/include/xtd/forms/native/font_dialog.hpp index ec75dd342461..fe81b227803a 100644 --- a/src/xtd.forms.native/include/xtd/forms/native/font_dialog.hpp +++ b/src/xtd.forms.native/include/xtd/forms/native/font_dialog.hpp @@ -46,7 +46,7 @@ namespace xtd { /// @param min_size The minimum point size a user can select. /// @param max_size The maximum point size a user can select. /// @param show_color true if the dialog box displays the color choice; otherwise, false. - /// @return true if the user clicks OK in the dialog box; otherwise, false. + /// @return `true` if the user clicks OK in the dialog box; otherwise, false. /// @remarks If result is true, the font parameter contains the new font, and the color parameter contains the now color. /// @warning Internal use only static bool run_dialog(intptr hwnd, drawing::font& font, drawing::color& color, size_t options, size_t min_size, size_t max_size, bool show_color); @@ -57,7 +57,7 @@ namespace xtd { /// @param min_size The minimum point size a user can select. /// @param max_size The maximum point size a user can select. /// @param show_color true if the dialog box displays the color choice; otherwise, false. - /// @return true if the user clicks OK in the dialog box; otherwise, false. + /// @return `true` if the user clicks OK in the dialog box; otherwise, false. /// @remarks When dialog closed and if result is true, the font parameter contains the new font, and the color parameter contains the now color. /// @warning Internal use only static void run_sheet(xtd::delegate on_dialog_closed, intptr hwnd, drawing::font& font, drawing::color& color, size_t options, size_t min_size, size_t max_size, bool show_color); diff --git a/src/xtd.forms.native/include/xtd/forms/native/form.hpp b/src/xtd.forms.native/include/xtd/forms/native/form.hpp index a1fb049cb94d..c4b896e81a91 100644 --- a/src/xtd.forms.native/include/xtd/forms/native/form.hpp +++ b/src/xtd.forms.native/include/xtd/forms/native/form.hpp @@ -52,12 +52,12 @@ namespace xtd { static void end_dialog(intptr control, int32 result); /// @brief Gets a value indicates whether full screen window. /// @param control Control window handle. - /// @return true if form is full screen; otherwise false. + /// @return `true` if form is full screen; otherwise `false`. /// @warning Internal use only static bool full_screen(intptr control); /// @brief Sets a value indicates whether full screen window. /// @param control Control window handle. - /// @param full_screen true if form is full screen; otherwise false. + /// @param full_screen true if form is full screen; otherwise `false`. /// @warning Internal use only static void full_screen(intptr control, bool full_screen); /// @brief Sets the icon for the form. @@ -67,22 +67,22 @@ namespace xtd { static void icon(intptr control, const xtd::drawing::icon& icon); /// @brief Gets a value indicate whether maximized windows. /// @param control Control window handle. - /// @return true if form is full screen; otherwise false. + /// @return `true` if form is full screen; otherwise `false`. /// @warning Internal use only static bool maximize(intptr control); /// @brief Sets a value indicate whether maximized windows. /// @param control Control window handle. - /// @param maximize true if form is maximized; otherwise false. + /// @param maximize true if form is maximized; otherwise `false`. /// @warning Internal use only static void maximize(intptr control, bool maximize); /// @brief Gets a value indicate whether minimized windows. /// @param control Control window handle. - /// @return true if form is full screen; otherwise false. + /// @return `true` if form is full screen; otherwise `false`. /// @warning Internal use only static bool minimize(intptr control); /// @brief Sets a value indicate whether minimized windows. /// @param control Control window handle. - /// @param minimize true if form is full screen; otherwise false. + /// @param minimize true if form is full screen; otherwise `false`. /// @warning Internal use only static void minimize(intptr control, bool minimize); /// @brief Sets the main_menu that is displayed in the form. diff --git a/src/xtd.forms.native/include/xtd/forms/native/input_dialog.hpp b/src/xtd.forms.native/include/xtd/forms/native/input_dialog.hpp index fe47b19ff645..7c9180de514e 100644 --- a/src/xtd.forms.native/include/xtd/forms/native/input_dialog.hpp +++ b/src/xtd.forms.native/include/xtd/forms/native/input_dialog.hpp @@ -44,10 +44,10 @@ namespace xtd { /// @param message A xtd::string that specifies the invite message text to display. /// @param value A xtd::string that specifies the text to display. /// @param character_casting Character casing values (0 : normal, 1 : upper, 2 : lower). - /// @param multiline true for multiline; otherwise false. - /// @param use_system_password_char true if use system password char; otherwise false. - /// @param word_wrap true if word_wrap; otherwise false. - /// @return true if the user clicks OK in the dialog box; otherwise, false. + /// @param multiline true for multiline; otherwise `false`. + /// @param use_system_password_char true if use system password char; otherwise `false`. + /// @param word_wrap true if word_wrap; otherwise `false`. + /// @return `true` if the user clicks OK in the dialog box; otherwise, false. /// @remarks If result is true, the font parameter contains the new font, and the color parameter contains the now color. /// @warning Internal use only static bool run_dialog(intptr hwnd, const xtd::string& text, const xtd::string& message, xtd::string& value, int32 character_casting, bool multiline, bool use_system_password_char, bool word_wrap); @@ -58,10 +58,10 @@ namespace xtd { /// @param message A xtd::string that specifies the invite message text to display. /// @param value A xtd::string that specifies the text to display. /// @param character_casting Character casing values (0 : normal, 1 : upper, 2 : lower). - /// @param multiline true for multiline; otherwise false. - /// @param use_system_password_char true if use system password char; otherwise false. - /// @param word_wrap true if word_wrap; otherwise false. - /// @return true if the user clicks OK in the dialog box; otherwise, false. + /// @param multiline true for multiline; otherwise `false`. + /// @param use_system_password_char true if use system password char; otherwise `false`. + /// @param word_wrap true if word_wrap; otherwise `false`. + /// @return `true` if the user clicks OK in the dialog box; otherwise, false. /// @remarks When dialog closed and if result is true, the value parameter contains the new string value. /// @warning Internal use only static void run_sheet(xtd::delegate on_dialog_closed, intptr hwnd, const xtd::string& text, const xtd::string& message, xtd::string& value, int32 character_casting, bool multiline, bool use_system_password_char, bool word_wrap); diff --git a/src/xtd.forms.native/include/xtd/forms/native/menu_item.hpp b/src/xtd.forms.native/include/xtd/forms/native/menu_item.hpp index 5e4d9ce748da..364f4c356b26 100644 --- a/src/xtd.forms.native/include/xtd/forms/native/menu_item.hpp +++ b/src/xtd.forms.native/include/xtd/forms/native/menu_item.hpp @@ -42,7 +42,7 @@ namespace xtd { /// @{ /// @brief Checked menu item. /// @param menu_item Menu item handle. - /// @param checked true if menu item is checked; otherwise false. + /// @param checked true if menu item is checked; otherwise `false`. /// @warning Internal use only static void checked(intptr menu_item, bool checked); /// @brief Creates menu item with specified menu. @@ -60,7 +60,7 @@ namespace xtd { static void destroy(intptr menu_item); /// @brief Enabled menu item. /// @param menu_item Menu item handle. - /// @param enabled true if menu item is enabled; otherwise false. + /// @param enabled true if menu item is enabled; otherwise `false`. /// @warning Internal use only static void enabled(intptr menu_item, bool enabled); /// @brief Gets menu id. diff --git a/src/xtd.forms.native/include/xtd/forms/native/message_notifier.hpp b/src/xtd.forms.native/include/xtd/forms/native/message_notifier.hpp index 311294f92cc6..f16a2b99e5e0 100644 --- a/src/xtd.forms.native/include/xtd/forms/native/message_notifier.hpp +++ b/src/xtd.forms.native/include/xtd/forms/native/message_notifier.hpp @@ -31,7 +31,7 @@ namespace xtd { /// @param message The message text. /// @param icon The icon associate to the notifier. /// @param style The Style (see ... for more informations). - /// @param close_timeout_enabled true to enable close timeout; otherwhise false. + /// @param close_timeout_enabled true to enable close timeout; otherwise `false`. /// @param close_timeout_interval Interval for close time out in milliseconds. /// @param on_notifier_closed The delagate called when message notifier is closed. /// @warning Internal use only diff --git a/src/xtd.forms.native/include/xtd/forms/native/progress_bar.hpp b/src/xtd.forms.native/include/xtd/forms/native/progress_bar.hpp index f136e82bdea9..5767b2f1dbe0 100644 --- a/src/xtd.forms.native/include/xtd/forms/native/progress_bar.hpp +++ b/src/xtd.forms.native/include/xtd/forms/native/progress_bar.hpp @@ -38,7 +38,7 @@ namespace xtd { /// @{ /// @brief Sets value indicates progress by continuously scrolling a block across a progress_bar in a marquee fashion. /// @param control Control window handle. - /// @param marquee true if progress_bar is marquee; otherwise false. + /// @param marquee true if progress_bar is marquee; otherwise `false`. /// @param animation_speed The time period, in milliseconds, that it takes the progress block to scroll across the progress bar. /// @warning Internal use only static void marquee(intptr control, bool marquee, size_t animation_speed); diff --git a/src/xtd.forms.native/include/xtd/forms/native/progress_dialog.hpp b/src/xtd.forms.native/include/xtd/forms/native/progress_dialog.hpp index 6a9efef81f9a..9ca3807f2d2c 100644 --- a/src/xtd.forms.native/include/xtd/forms/native/progress_dialog.hpp +++ b/src/xtd.forms.native/include/xtd/forms/native/progress_dialog.hpp @@ -43,7 +43,7 @@ namespace xtd { /// @{ /// @brief Gets whether user has clicked on cancel button. /// @param dialog Progress dialog window handle. - /// @return true if user has clicked on cancel button; otherwise false. + /// @return `true` if user has clicked on cancel button; otherwise `false`. /// @warning Internal use only static bool cancelled(intptr dialog); /// @brief Creates progress dialog. @@ -70,7 +70,7 @@ namespace xtd { static void informations(intptr dialog, const std::vector& informations); /// @brief Gets a value that Indicates progress by continuously scrolling a block across a progress_bar in a marquee fashion. /// @param dialog Progress dialog window handle. - /// @param marquee tree is marquee; otherwise false. The default is false. + /// @param marquee tree is marquee; otherwise `false`. The default is false. /// @warning Internal use only static void marquee(intptr dialog, bool marquee, size_t animation_speed); /// @brief Sets the maximum value of the range of the control. @@ -102,7 +102,7 @@ namespace xtd { static void show_sheet(intptr dialog); /// @brief Gets whether user has clicked on skip button. /// @param dialog Progress dialog window handle. - /// @return true if user has clicked on skip button; otherwise false. + /// @return `true` if user has clicked on skip button; otherwise `false`. /// @warning Internal use only static bool skipped(intptr dialog); /// @brief Sets the current position of the progress bar. diff --git a/src/xtd.forms.native/include/xtd/forms/native/screen.hpp b/src/xtd.forms.native/include/xtd/forms/native/screen.hpp index 433ac31d20aa..118aac279b71 100644 --- a/src/xtd.forms.native/include/xtd/forms/native/screen.hpp +++ b/src/xtd.forms.native/include/xtd/forms/native/screen.hpp @@ -73,7 +73,7 @@ namespace xtd { static int32 pixels_per_inch(size_t index); /// @brief Gets a value indicating whether a particular display is the primary device. /// @param index The screen index. - /// @return true if index display is primary; otherwise, false. + /// @return `true` if index display is primary; otherwise, false. /// @warning Internal use only static bool primary(size_t index); /// @brief Gets the scale factor of the display. diff --git a/src/xtd.forms.native/include/xtd/forms/native/status_bar.hpp b/src/xtd.forms.native/include/xtd/forms/native/status_bar.hpp index bba58caebb77..d26a5bcd6e0f 100644 --- a/src/xtd.forms.native/include/xtd/forms/native/status_bar.hpp +++ b/src/xtd.forms.native/include/xtd/forms/native/status_bar.hpp @@ -42,9 +42,9 @@ namespace xtd { /// @param text The panel text. /// @param tool_tip_text The tool tip text. /// @param image The panel image. - /// @param visible true if panel is visible; otherwise false. + /// @param visible true if panel is visible; otherwise `false`. /// @param width The panel width. - /// @param stretchable true if panel is stretchable; otherwise false. + /// @param stretchable true if panel is stretchable; otherwise `false`. /// @warning Internal use only //static intptr add_status_bar_panel(intptr status_bar, int border_style, const xtd::string& text, const xtd::string& tool_tip_text, const xtd::drawing::image& image, bool visible, int width, bool stretchable); static intptr add_status_bar_panel(intptr status_bar, const xtd::string& text, const xtd::string& tool_tip_text, const xtd::drawing::image& image, int32 alignment, int32 auto_size, int32 border_style, int32 min_width, int32 width); @@ -60,7 +60,7 @@ namespace xtd { /// @warning Internal use only static bool set_system_status_bar(intptr control, intptr status_bar); /// @brief Gets a value indicating whether OS displays a sizing grip. - /// @return true if OS displays a sizing grip; otherwise, false. + /// @return `true` if OS displays a sizing grip; otherwise, false. /// @warning Internal use only static bool sizing_grip(); /// @brief Gets the cursor name used by sizing grip. @@ -73,9 +73,9 @@ namespace xtd { /// @param text The panel text. /// @param tool_tip_text The tool tip text. /// @param image The panel image. - /// @param visible true if panel is visible; otherwise false. + /// @param visible true if panel is visible; otherwise `false`. /// @param width The panel width. - /// @param visible true if panel is stretchable; otherwise false. + /// @param visible true if panel is stretchable; otherwise `false`. /// @warning Internal use only static void update_status_bar_item(intptr status_bar, intptr handle, int32 border_style, const xtd::string& text, const xtd::string& tool_tip_text, const xtd::drawing::image& image, bool visible, int32 width, bool stretchable); /// @} diff --git a/src/xtd.forms.native/include/xtd/forms/native/system_information.hpp b/src/xtd.forms.native/include/xtd/forms/native/system_information.hpp index 1dfcddf616b4..d3df9e7f10b4 100644 --- a/src/xtd.forms.native/include/xtd/forms/native/system_information.hpp +++ b/src/xtd.forms.native/include/xtd/forms/native/system_information.hpp @@ -92,10 +92,10 @@ namespace xtd { /// @warning Internal use only static xtd::drawing::size cursor_size(); /// @brief Gets a value indicating whether the operating system is capable of handling double-byte character set (DBCS) characters. - /// @return true if the operating system supports DBCS; otherwise, false. + /// @return `true` if the operating system supports DBCS; otherwise, false. static bool dbcs_enabled(); /// @brief Gets a value indicating whether the debug version of USER.EXE is installed. - /// @return true if the debugging version of USER.EXE is installed; otherwise, false. + /// @return `true` if the debugging version of USER.EXE is installed; otherwise, false. /// @warning Internal use only static bool debug_os(); /// @brief Gets the dimensions, in pixels, of the area within which the user must click twice for the operating system to consider the two clicks a double-click. @@ -107,7 +107,7 @@ namespace xtd { /// @warning Internal use only static int32 double_click_time(); /// @brief Gets a value indicating whether the user has enabled full window drag. - /// @return true if the user has enabled full window drag; otherwise, false. + /// @return `true` if the user has enabled full window drag; otherwise, false. /// @warning Internal use only static bool drag_full_windows(); /// @brief Gets the width and height of a rectangle centered on the point the mouse button was pressed, within which a drag operation will not begin. @@ -131,7 +131,7 @@ namespace xtd { /// @warning Internal use only static xtd::drawing::size frame_border_size(); /// @brief Gets the operating system is natively double buffered. - /// @return true is operating system is natively double buffered; otherwise false. + /// @return `true` is operating system is natively double buffered; otherwise `false`. /// @warning Internal use only static bool is_operating_system_double_buffered(); /// @} diff --git a/src/xtd.forms.native/include/xtd/forms/native/tool_bar.hpp b/src/xtd.forms.native/include/xtd/forms/native/tool_bar.hpp index 9f4fbe1a230c..3f9644a3c0da 100644 --- a/src/xtd.forms.native/include/xtd/forms/native/tool_bar.hpp +++ b/src/xtd.forms.native/include/xtd/forms/native/tool_bar.hpp @@ -42,8 +42,8 @@ namespace xtd { /// @param text The button text /// @param tool_tip_text The tool tip text. /// @param image The button image. - /// @param enabled true if button is enabled; otherwise false. - /// @param visible true if button is visible; otherwise false. + /// @param enabled true if button is enabled; otherwise `false`. + /// @param visible true if button is visible; otherwise `false`. /// @warning Internal use only static intptr add_tool_bar_button(intptr tool_bar, const xtd::string& text, const xtd::string& tool_tip_text, const xtd::drawing::image& image, bool enabled, bool visible); /// @brief Adds tool bar drop down button. @@ -51,8 +51,8 @@ namespace xtd { /// @param text The button text /// @param tool_tip_text The tool tip text. /// @param image The button image. - /// @param enabled true if button is enabled; otherwise false. - /// @param visible true if button is visible; otherwise false. + /// @param enabled true if button is enabled; otherwise `false`. + /// @param visible true if button is visible; otherwise `false`. /// @param drop_down_menu The context menu handle. /// @warning Internal use only static intptr add_tool_bar_drop_down_button(intptr tool_bar, const xtd::string& text, const xtd::string& tool_tip_text, const xtd::drawing::image& image, bool enabled, bool visible, intptr drop_down_menu); @@ -61,9 +61,9 @@ namespace xtd { /// @param text The button text /// @param tool_tip_text The tool tip text. /// @param image The button image. - /// @param pushed true if button is pushed; otherwise false. - /// @param enabled true if button is enabled; otherwise false. - /// @param visible true if button is visible; otherwise false. + /// @param pushed true if button is pushed; otherwise `false`. + /// @param enabled true if button is enabled; otherwise `false`. + /// @param visible true if button is visible; otherwise `false`. /// @warning Internal use only static intptr add_tool_bar_toggle_button(intptr tool_bar, const xtd::string& text, const xtd::string& tool_tip_text, const xtd::drawing::image& image, bool pushed, bool enabled, bool visible); /// @brief Adds tool bar separator. @@ -92,9 +92,9 @@ namespace xtd { /// @param text The button text /// @param tool_tip_text The tool tip text. /// @param image The button image. - /// @param pushed true if button is pushed; otherwise false. - /// @param enabled true if button is enabled; otherwise false. - /// @param visible true if button is visible; otherwise false. + /// @param pushed true if button is pushed; otherwise `false`. + /// @param enabled true if button is enabled; otherwise `false`. + /// @param visible true if button is visible; otherwise `false`. /// @warning Internal use only static void update_tool_bar_item(intptr tool_bar, intptr handle, const xtd::string& text, const xtd::string& tool_tip_text, const xtd::drawing::image& image, bool pushed, bool enabled, bool visible); /// @brief Gets the tool bar item rectangle diff --git a/src/xtd.forms/include/xtd/forms/animation.hpp b/src/xtd.forms/include/xtd/forms/animation.hpp index 74d5cfc177b6..4cd255e4030b 100644 --- a/src/xtd.forms/include/xtd/forms/animation.hpp +++ b/src/xtd.forms/include/xtd/forms/animation.hpp @@ -72,11 +72,11 @@ namespace xtd { virtual animation& frames_per_second(uint32 value); /// @brief Gets a valiue that indicates if the animation is running. - /// @return true if the animation is running; otherwise false. + /// @return `true` if the animation is running; otherwise `false`. virtual bool running() const noexcept; /// @brief Gets a valiue that indicates if the animation is running. - /// @param value true if the animation is running; otherwise false. + /// @param value true if the animation is running; otherwise `false`. virtual animation& running(bool value); /// @} diff --git a/src/xtd.forms/include/xtd/forms/application.hpp b/src/xtd.forms/include/xtd/forms/application.hpp index 407c0ba10706..44c224e61b61 100644 --- a/src/xtd.forms/include/xtd/forms/application.hpp +++ b/src/xtd.forms/include/xtd/forms/application.hpp @@ -54,7 +54,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the caller can quit this application. - /// @return true if the caller can quit this application; otherwise, false. + /// @return `true` if the caller can quit this application; otherwise, false. /// @remarks This method returns false if it is called from a control being hosted within a Web browser. Thus, the control cannot quit the application. static bool allow_quit() noexcept; @@ -64,13 +64,13 @@ namespace xtd { static xtd::forms::application_context& application_context(); /// @brief Gets button images are enabled. - /// @return true if button images aree enabled; otherwise false. + /// @return `true` if button images aree enabled; otherwise `false`. /// @remarks The default value is true. /// @remarks This method has an effect only on linux. static bool button_images() noexcept; /// @brief Gets button images are enabled. - /// @param value true if button images aree enabled; otherwise false. + /// @param value true if button images aree enabled; otherwise `false`. /// @exception xtd::invalid_operation_exception If this method is called after xtd::forms::application::run. /// @remarks The default value is true. /// @remarks This method has an effect only on linux. @@ -102,16 +102,16 @@ namespace xtd { static xtd::string company_name() noexcept; /// @brief Gets a value indicating whether dark mode is enabled for the application. - /// @return True is dark mode enabled; otherwise false. + /// @return True is dark mode enabled; otherwise `false`. static bool dark_mode() noexcept; /// @brief Sets a value indicating whether dark mode is enabled for the application. - /// @param value True is dark mode enabled; otherwise false. + /// @param value True is dark mode enabled; otherwise `false`. /// @exception xtd::invalid_operation_exception If this method is called after xtd::forms::application::run. static void dark_mode(bool value); /// @brief Return true if dark mode is enabled for the application; otherwise return false. - /// @return True is dark mode enabled; otherwise false. + /// @return True is dark mode enabled; otherwise `false`. /// @deprecated Replaced by xtd::application::dark_mode - Will be removed in version 0.4.0. [[deprecated("Replaced by xtd::application::dark_mode - Will be removed in version 0.4.0.")]] static bool dark_mode_enabled() noexcept; @@ -125,7 +125,7 @@ namespace xtd { static xtd::string executable_path() noexcept; /// @brief Gets a value indicating whether font size correction is enabled. - /// @return true if font size correction is enabled; otherwise false. + /// @return `true` if font size correction is enabled; otherwise `false`. /// @exception xtd::invalid_operation_exception If this method is called after xtd::forms::application::run. /// @remarks By default, xtd corrects the size of fonts on non-Windows operating systems so that they have the same aspect ratio as Windows. /// @remarks If you disable this option, you will use the actual native font size of the operating system. @@ -133,7 +133,7 @@ namespace xtd { static bool font_size_correction(); /// @brief Sets a value indicating whether font size correction is enabled. - /// @param value true if font size correction is enabled; otherwise false. + /// @param value true if font size correction is enabled; otherwise `false`. /// @exception xtd::invalid_operation_exception If this method is called after xtd::forms::application::run. /// @remarks By default, xtd corrects the size of fonts on non-Windows operating systems so that they have the same aspect ratio as Windows. /// @remarks If you disable this option, you will use the actual native font size of the operating system. @@ -141,27 +141,27 @@ namespace xtd { static void font_size_correction(bool value); /// @brief Gets a value indicating whether the xtd framework keep cloned control is enabled. - /// @return true if xtd framework keep cloned control is enabled; otherwise false. + /// @return `true` if xtd framework keep cloned control is enabled; otherwise `false`. /// @remarks By default the value is false. static bool keep_cloned_controls() noexcept; /// @brief Sets a value indicating whether the xtd framework keep cloned control is enabled. - /// @param value true if xtd framework keep cloned control is enabled; otherwise false. + /// @param value true if xtd framework keep cloned control is enabled; otherwise `false`. /// @exception xtd::invalid_operation_exception If this method is called after xtd::forms::application::run. /// @remarks By default the value is false. static void keep_cloned_controls(bool value); /// @brief Gets a value indicating whether light mode is enabled for the application. - /// @return True is light mode enabled; otherwise false. + /// @return True is light mode enabled; otherwise `false`. static bool light_mode() noexcept; /// @brief Sets a value indicating whether light mode is enabled for the application. - /// @param value True is light mode enabled; otherwise false. + /// @param value True is light mode enabled; otherwise `false`. /// @exception xtd::invalid_operation_exception If this method is called after xtd::forms::application::run. static void light_mode(bool value); /// @brief Return true if dark mode is enabled for the application; otherwise return false. - /// @return True is light mode enabled; otherwise false. + /// @return True is light mode enabled; otherwise `false`. /// @deprecated Replaced by xtd::application::light_mode - Will be removed in version 0.4.0. [[deprecated("Replaced by xtd::application::light_mode - Will be removed in version 0.4.0.")]] static bool light_mode_enabled() noexcept; @@ -172,20 +172,20 @@ namespace xtd { static std::optional main_form(); /// @brief Gets menu images are enabled. - /// @return true if menu images aree enabled; otherwise false. + /// @return `true` if menu images aree enabled; otherwise `false`. /// @remarks The default value is true. /// @remarks This method has an effect only on linux. static bool menu_images() noexcept; /// @brief Sets menu images ilages are enabled. - /// @param value true if menu images aree enabled; otherwise false. + /// @param value true if menu images aree enabled; otherwise `false`. /// @exception xtd::invalid_operation_exception If this method is called after xtd::forms::application::run. /// @remarks The default value is true. /// @remarks This method has an effect only on linux. static void menu_images(bool value); /// @brief Gets a value indicating whether a message loop exists on this thread. - /// @return true if a message loop exists; otherwise, false. + /// @return `true` if a message loop exists; otherwise, false. static bool message_loop() noexcept; /// @brief Gets a collection of open forms owned by the application. @@ -224,20 +224,20 @@ namespace xtd { static const xtd::forms::style_sheets::style_sheet::style_sheet_names_t& style_sheet_names() noexcept; /// @brief Gets a value indicating whether the system control is enabled. - /// @return true if system control is enabled; otherwise false. + /// @return `true` if system control is enabled; otherwise `false`. /// @remarks By default, xtd uses the standard control (xtd::forms::control_appearance::standard) with this method you can change to force the use of system control (xtd::forms::control_appearance::system) instead. /// @remarks The xtd::forms::control::control_appearance method can still be used to modify the control's appearance on the fly. static bool system_controls() noexcept; /// @brief Sets a value indicating whether the system control is enabled. - /// @param value true if system control is enabled; otherwise false. + /// @param value true if system control is enabled; otherwise `false`. /// @exception xtd::invalid_operation_exception If this method is called after xtd::forms::application::run. /// @remarks By default, xtd uses the standard control (xtd::forms::control_appearance::standard) with this method you can change to force the use of system control (xtd::forms::control_appearance::system) instead. /// @remarks The xtd::forms::control::control_appearance method can still be used to modify the control's appearance on the fly. static void system_controls(bool value); /// @brief Gets a value indicating whether the system font size is enabled. - /// @return true if the system font size is enabled; otherwise false. + /// @return `true` if the system font size is enabled; otherwise `false`. /// @exception xtd::invalid_operation_exception If this method is called after xtd::forms::application::run. /// @remarks By default, xtd automatically limits the system font size to 9 points if it is larger than 9. /// @remarks If you enable this option, you can use the actual font size of the system if it exceeds 9 points and at the same time the default sizes of the different controls will be adapted as well. @@ -245,7 +245,7 @@ namespace xtd { static bool system_font_size() noexcept; /// @brief Sets a value indicating whether the system font size is enabled. - /// @param value true if the system font size is enabled; otherwise false. + /// @param value true if the system font size is enabled; otherwise `false`. /// @exception xtd::invalid_operation_exception If this method is called after xtd::forms::application::run. /// @remarks By default, xtd automatically limits the system font size to 9 points if it is larger than 9. /// @remarks If you enable this option, you can use the actual font size of the system if it exceeds 9 points and at the same time the default sizes of the different controls will be adapted as well. @@ -274,14 +274,14 @@ namespace xtd { */ /// @brief Gets a value that indicates whether visual styles are enabled for the application. - /// @return true if visual styles are enabled; otherwise, false. + /// @return `true` if visual styles are enabled; otherwise, false. /// @remarks The visual styles can be enabled by calling enable_xtd::forms::application::visual_styles. /// @deprecated Replaced by xtd::application::visual_styles - Will be removed in version 0.4.0. [[deprecated("Replaced by xtd::application::visual_styles - Will be removed in version 0.4.0.")]] static bool use_visual_styles() noexcept; /// @brief Gets whether the wait cursor is used for all open forms of the application. - /// @return true is the wait cursor is used for all open forms; otherwise, false. + /// @return `true` is the wait cursor is used for all open forms; otherwise, false. /// @remarks When this property is set to true, the use_wait_cursor property of all open forms in the application will be set to true. This call will not return until this property has been set on all forms. Use this property when you have a long-running operation, and want to indicate in all application forms that the operation is still processing. /// @par Examples /// The following code example demonstrates the use of application use wait cursor property. @@ -296,7 +296,7 @@ namespace xtd { static void use_wait_cursor(bool use_wait_cursor); /// @brief Gets a value that indicates whether visual styles are enabled for the application. - /// @return true if visual styles are enabled; otherwise, false. + /// @return `true` if visual styles are enabled; otherwise, false. /// @remarks This method enables visual styles for the application. Visual styles are the colors, fonts, and other visual elements that form an operating system theme. Controls will draw with visual styles if the control and the operating system support it. To have an effect, enable_visual_styles() must be called before creating any controls in the application; typically, enable_visual_styles() is the first line in the Main function. A separate manifest is not required to enable visual styles when calling enable_visual_styles(). /// @remarks This method has an effect only on Windows. static bool visual_styles() noexcept; diff --git a/src/xtd.forms/include/xtd/forms/background_worker.hpp b/src/xtd.forms/include/xtd/forms/background_worker.hpp index c17c40db0057..2036ae99fa2f 100644 --- a/src/xtd.forms/include/xtd/forms/background_worker.hpp +++ b/src/xtd.forms/include/xtd/forms/background_worker.hpp @@ -51,28 +51,28 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the application has requested cancellation of a background operation. - /// @return true if the application has requested cancellation of a background operation; otherwise, false. The default is false. + /// @return `true` if the application has requested cancellation of a background operation; otherwise, false. The default is false. bool cancellation_pending() const noexcept; /// @brief Gets a value indicating whether the background_worker is running an asynchronous operation. - /// @return true, if the background_worker is running an asynchronous operation; otherwise, false. + /// @return `true`, if the background_worker is running an asynchronous operation; otherwise, false. bool is_busy() const noexcept; /// @brief Gets a value indicating whether the background_worker can report progress updates.Gets or sets a value indicating whether the background_worker can report progress updates. - /// @return true if the background_worker supports progress updates; otherwise false. The default is false. + /// @return `true` if the background_worker supports progress updates; otherwise `false`. The default is false. /// @remarks Set the worker_reports_progress property to true if you want the background_worker to support progress updates. When this property is true, user code can call the report_progress method to raise the progress_changed event. bool worker_reports_progress() const noexcept; /// @brief Sets a value indicating whether the background_worker can report progress updates.Gets or sets a value indicating whether the background_worker can report progress updates. - /// @param value true if the background_worker supports progress updates; otherwise false. The default is false. + /// @param value true if the background_worker supports progress updates; otherwise `false`. The default is false. /// @remarks Set the worker_reports_progress property to true if you want the background_worker to support progress updates. When this property is true, user code can call the report_progress method to raise the progress_changed event. void worker_reports_progress(bool value); /// @brief Gets a value indicating whether the background_worker supports asynchronous cancellation. - /// @return true if the background_worker supports cancellation; otherwise false. The default is false. + /// @return `true` if the background_worker supports cancellation; otherwise `false`. The default is false. /// @remarks Set the worker_supports_cancellation property to true if you want the background_worker to support cancellation. When this property is true, you can call the cancel_async method to interrupt a background operation. bool worker_supports_cancellation() const noexcept; /// @brief Gets a value indicating whether the background_worker supports asynchronous cancellation. - /// @param value true if the background_worker supports cancellation; otherwise false. The default is false. + /// @param value true if the background_worker supports cancellation; otherwise `false`. The default is false. /// @remarks Set the worker_supports_cancellation property to true if you want the background_worker to support cancellation. When this property is true, you can call the cancel_async method to interrupt a background operation. void worker_supports_cancellation(bool value); /// @} diff --git a/src/xtd.forms/include/xtd/forms/button.hpp b/src/xtd.forms/include/xtd/forms/button.hpp index 25554db78bd7..49fdd93ad734 100644 --- a/src/xtd.forms/include/xtd/forms/button.hpp +++ b/src/xtd.forms/include/xtd/forms/button.hpp @@ -68,10 +68,10 @@ namespace xtd { /// @{ /// @brief Gets if this button instance is auto repeat. - /// @return true, if is auto repeat; otherwise false. Default is false. + /// @return `true`, if is auto repeat; otherwise `false`. Default is false. virtual bool auto_repeat() const noexcept; /// @brief Sets if this button instance is auto repeat. - /// @param auto_repeat true, if is auto repeat; otherwise false. Default is false. + /// @param auto_repeat true, if is auto repeat; otherwise `false`. Default is false. /// @return This button. virtual button& auto_repeat(bool auto_repeat); diff --git a/src/xtd.forms/include/xtd/forms/button_base.hpp b/src/xtd.forms/include/xtd/forms/button_base.hpp index 68661dbf19c5..5bc71998dced 100644 --- a/src/xtd.forms/include/xtd/forms/button_base.hpp +++ b/src/xtd.forms/include/xtd/forms/button_base.hpp @@ -42,7 +42,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the ellipsis character (...) appears at the right edge of the control, denoting that the control text extends beyond the specified length of the control. - /// @return true if the additional label text is to be indicated by an ellipsis; otherwise, false. The default is true. + /// @return `true` if the additional label text is to be indicated by an ellipsis; otherwise, false. The default is true. /// @remarks Set auto_ellipsis to true to display text that extends beyond the width of the control when the user passes over the control with the mouse. You must set the control's auto_size property to false if you want AutoEllipsis to be true. If AutoSize is true, the control will grow to fit the text and an ellipsis will not appear. virtual bool auto_ellipsis() const noexcept; @@ -145,7 +145,7 @@ namespace xtd { forms::create_params create_params() const noexcept override; /// @brief Gets a value indicating whether the button control is the default button. - /// @return true if the button control is the default button; otherwise, false. + /// @return `true` if the button control is the default button; otherwise, false. /// @remarks When the xtd::forms::button_base::is_default property is set to true, the button is the default button for the xtd::forms::form. This means that the button is clicked when the ENTER key is pressed if no other button or any other control that captures the ENTER key has focus. /// @remarks To specify the default button of a form, set the xtd::forms::form::accept_button property of the form to the desired button. bool is_default() const noexcept; diff --git a/src/xtd.forms/include/xtd/forms/button_renderer.hpp b/src/xtd.forms/include/xtd/forms/button_renderer.hpp index f3c864f3566c..75f4a11d377e 100644 --- a/src/xtd.forms/include/xtd/forms/button_renderer.hpp +++ b/src/xtd.forms/include/xtd/forms/button_renderer.hpp @@ -62,13 +62,13 @@ namespace xtd { /// @param graphics The xtd::drawing::graphics used to draw a button. /// @param bounds The xtd::drawing::rectangle that specifies the bounds of the button. /// @param button_state The visual state of a button that is drawn with visual styles. - /// @param default_button Sets to tru if the buffon is default; otherwise false. + /// @param default_button Sets to tru if the buffon is default; otherwise `false`. static void draw_button(const style_sheets::style_sheet& style_sheet, xtd::drawing::graphics& graphics, const xtd::drawing::rectangle& bounds, xtd::forms::visual_styles::push_button_state button_state, bool default_button); /// @brief Draws a button in the specified bounds, button style, button state and background color. /// @param graphics The xtd::drawing::graphics used to draw a button. /// @param bounds The xtd::drawing::rectangle that specifies the bounds of the button. /// @param button_state The visual state of a button that is drawn with visual styles. - /// @param default_button Sets to tru if the buffon is default; otherwise false. + /// @param default_button Sets to tru if the buffon is default; otherwise `false`. /// @param back_color The background color for the button control. /// @remarks The parameter back_color is set only if they are different from its default value; otherwise std::nullopt. static void draw_button(xtd::drawing::graphics& graphics, const xtd::drawing::rectangle& bounds, xtd::forms::visual_styles::push_button_state button_state, bool default_button, const std::optional& back_color); @@ -76,7 +76,7 @@ namespace xtd { /// @param graphics The xtd::drawing::graphics used to draw a button. /// @param bounds The xtd::drawing::rectangle that specifies the bounds of the button. /// @param button_state The visual state of a button that is drawn with visual styles. - /// @param default_button Sets to tru if the buffon is default; otherwise false. + /// @param default_button Sets to tru if the buffon is default; otherwise `false`. /// @param back_color The background color for the button control. /// @remarks The parameter back_color is set only if they are different from its default value; otherwise std::nullopt. static void draw_button(const style_sheets::style_sheet& style_sheet, xtd::drawing::graphics& graphics, const xtd::drawing::rectangle& bounds, xtd::forms::visual_styles::push_button_state button_state, bool default_button, const std::optional& back_color); @@ -84,7 +84,7 @@ namespace xtd { /// @param graphics The xtd::drawing::graphics used to draw a button. /// @param bounds The xtd::drawing::rectangle that specifies the bounds of the button. /// @param button_state The visual state of a button that is drawn with visual styles. - /// @param default_button Sets to tru if the buffon is default; otherwise false. + /// @param default_button Sets to tru if the buffon is default; otherwise `false`. /// @param back_color The background color for the button control. /// @param text The text of the button control. /// @param text_flags Contains the display and layout information for text strings. @@ -96,7 +96,7 @@ namespace xtd { /// @param graphics The xtd::drawing::graphics used to draw a button. /// @param bounds The xtd::drawing::rectangle that specifies the bounds of the button. /// @param button_state The visual state of a button that is drawn with visual styles. - /// @param default_button Sets to tru if the buffon is default; otherwise false. + /// @param default_button Sets to tru if the buffon is default; otherwise `false`. /// @param back_color The background color for the button control. /// @param text The text of the button control. /// @param text_flags Contains the display and layout information for text strings. @@ -108,7 +108,7 @@ namespace xtd { /// @param graphics The xtd::drawing::graphics used to draw a button. /// @param bounds The xtd::drawing::rectangle that specifies the bounds of the button. /// @param button_state The visual state of a button that is drawn with visual styles. - /// @param default_button Sets to tru if the buffon is default; otherwise false. + /// @param default_button Sets to tru if the buffon is default; otherwise `false`. /// @param back_color The background color for the button control. /// @param text The text of the button control. /// @param text_flags Contains the display and layout information for text strings. @@ -123,7 +123,7 @@ namespace xtd { /// @param graphics The xtd::drawing::graphics used to draw a button. /// @param bounds The xtd::drawing::rectangle that specifies the bounds of the button. /// @param button_state The visual state of a button that is drawn with visual styles. - /// @param default_button Sets to tru if the buffon is default; otherwise false. + /// @param default_button Sets to tru if the buffon is default; otherwise `false`. /// @param back_color The background color for the button control. /// @param text The text of the button control. /// @param text_flags Contains the display and layout information for text strings. @@ -138,7 +138,7 @@ namespace xtd { /// @param graphics The xtd::drawing::graphics used to draw a button. /// @param bounds The xtd::drawing::rectangle that specifies the bounds of the button. /// @param button_state The visual state of a button that is drawn with visual styles. - /// @param default_button Sets to tru if the buffon is default; otherwise false. + /// @param default_button Sets to tru if the buffon is default; otherwise `false`. /// @param back_color The background color for the button control. /// @param text The text of the button control. /// @param text_flags Contains the display and layout information for text strings. @@ -153,7 +153,7 @@ namespace xtd { /// @param graphics The xtd::drawing::graphics used to draw a button. /// @param bounds The xtd::drawing::rectangle that specifies the bounds of the button. /// @param button_state The visual state of a button that is drawn with visual styles. - /// @param default_button Sets to tru if the buffon is default; otherwise false. + /// @param default_button Sets to tru if the buffon is default; otherwise `false`. /// @param back_color The background color for the button control. /// @param text The text of the button control. /// @param text_flags Contains the display and layout information for text strings. diff --git a/src/xtd.forms/include/xtd/forms/cancel_event_args.hpp b/src/xtd.forms/include/xtd/forms/cancel_event_args.hpp index 440d768ed47c..957d91973f2c 100644 --- a/src/xtd.forms/include/xtd/forms/cancel_event_args.hpp +++ b/src/xtd.forms/include/xtd/forms/cancel_event_args.hpp @@ -41,7 +41,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the event should be canceled. - /// @return true if the event should be canceled; otherwise, false. + /// @return `true` if the event should be canceled; otherwise, false. virtual bool cancel() const noexcept {return cancel_;} /// @brief Sets a value indicating whether the event should be canceled. /// @param cancel true if the event should be canceled; otherwise, false. diff --git a/src/xtd.forms/include/xtd/forms/check_box.hpp b/src/xtd.forms/include/xtd/forms/check_box.hpp index f6f28407f395..dcbdca16c4b8 100644 --- a/src/xtd.forms/include/xtd/forms/check_box.hpp +++ b/src/xtd.forms/include/xtd/forms/check_box.hpp @@ -73,7 +73,7 @@ namespace xtd { virtual check_box& appearance(forms::appearance appearance); /// @brief Gets a value indicating whether the checked or check_state values and the check_box's appearance are automatically changed when the check_box is clicked. - /// @return true if the checked value or check_state value and the appearance of the control are automatically changed on the click event; otherwise, false. The default value is true. + /// @return `true` if the checked value or check_state value and the appearance of the control are automatically changed on the click event; otherwise, false. The default value is true. /// @remarks If auto_check is set to false, you will need to add code to update the checked or check_state values in the click event handler. /// @par Examples /// The following code example demonstrates the use of check_box auto_check. @@ -92,7 +92,7 @@ namespace xtd { virtual check_box& check_align(content_alignment check_align); /// @brief Gets a value indicating whether the check_box is in the checked state. - /// @return true if the check_box is in the checked state; otherwise, false. The default value is false. If the three_state property is set to true, the checked property will return true for either a checked or indeterminate check_state. + /// @return `true` if the check_box is in the checked state; otherwise, false. The default value is false. If the three_state property is set to true, the checked property will return true for either a checked or indeterminate check_state. /// @remarks When the value is true, the check_box portion of the control displays a check mark. If the appearance property is set to button, the control will appear sunken when checked is true and raised like a standard button when false. /// @par Examples /// The following code example demonstrates the use of check_box checked. @@ -130,7 +130,7 @@ namespace xtd { virtual check_box& check_state(forms::check_state check_state); /// @brief Gets a value indicating whether the check_box will allow three check states rather than two. - /// @return true if the check_box is able to display three check states; otherwise, false. The default value is false. + /// @return `true` if the check_box is able to display three check states; otherwise, false. The default value is false. /// @remarks If the three_state property is set to false, the check_state property value can only be set to the indeterminate value of xtd.forms.check_state in code and not by user interaction. /// @par Examples /// The following code example demonstrates the use of check_box three_state. diff --git a/src/xtd.forms/include/xtd/forms/checked_list_box.hpp b/src/xtd.forms/include/xtd/forms/checked_list_box.hpp index f4616f17a07d..77dccb39c433 100644 --- a/src/xtd.forms/include/xtd/forms/checked_list_box.hpp +++ b/src/xtd.forms/include/xtd/forms/checked_list_box.hpp @@ -82,7 +82,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the item is in the checked state. - /// @return true if the item is in the checked state; otherwise, false. The default value is false. If the three_state property is set to true, the checked property will return true for either a checked or indeterminate check_state. + /// @return `true` if the item is in the checked state; otherwise, false. The default value is false. If the three_state property is set to true, the checked property will return true for either a checked or indeterminate check_state. virtual bool checked() const; /// @brief Gets the state of the item. @@ -203,7 +203,7 @@ namespace xtd { /// @brief Returns a value indicating whether the specified item is checked. /// @param index The index of the item. - /// @return true if the item is checked; otherwise, false. + /// @return `true` if the item is checked; otherwise, false. /// @remarks get_item_checked returns true if the value of CheckState is checked or indeterminate for the item. To determine the specific state the item is in, use the get_item_check_state method. bool get_item_checked(size_t index) const; diff --git a/src/xtd.forms/include/xtd/forms/choice.hpp b/src/xtd.forms/include/xtd/forms/choice.hpp index 97cc51f54edc..ed65e5a325a5 100644 --- a/src/xtd.forms/include/xtd/forms/choice.hpp +++ b/src/xtd.forms/include/xtd/forms/choice.hpp @@ -78,7 +78,7 @@ namespace xtd { choice& selected_item(const item& selected_item); /// @brief Gets a value indicating whether the items in the choice are sorted. - /// @return true if the choice is sorted; otherwise, false. The default is false. + /// @return `true` if the choice is sorted; otherwise, false. The default is false. /// @remarks This property specifies whether the choice sorts existing entries and add new entries to the appropriate sorted position in the list. You can use this property to automatically sort items in a choice. As items are added to a sorted choice, the items are moved to the appropriate location in the sorted list. When you set the property to false, new items are added to the end of the existing list. The sort is case-insensitive and in alphabetically ascending order. virtual bool sorted() const noexcept; /// @brief Sets a value indicating whether the items in the choice are sorted. diff --git a/src/xtd.forms/include/xtd/forms/collapsible_panel.hpp b/src/xtd.forms/include/xtd/forms/collapsible_panel.hpp index 2afb331a63d4..51a857a9d7be 100644 --- a/src/xtd.forms/include/xtd/forms/collapsible_panel.hpp +++ b/src/xtd.forms/include/xtd/forms/collapsible_panel.hpp @@ -61,10 +61,10 @@ namespace xtd { virtual collapsible_panel& border_style(std::nullptr_t); /// @brief Gets a value indicating whether the collapsible_panel is in the expanded. - /// @return true if collapsible_panel is expanded; otherwise false. + /// @return `true` if collapsible_panel is expanded; otherwise `false`. bool expanded() const noexcept; /// @brief Sets a value indicating whether the collapsible_panel is in the expanded. - /// @param expanded true if collapsible_panel is expanded; otherwise false. + /// @param expanded true if collapsible_panel is expanded; otherwise `false`. collapsible_panel& expanded(bool expanded); /// @cond diff --git a/src/xtd.forms/include/xtd/forms/color_dialog.hpp b/src/xtd.forms/include/xtd/forms/color_dialog.hpp index 9c75a31b041d..e80118f6d870 100644 --- a/src/xtd.forms/include/xtd/forms/color_dialog.hpp +++ b/src/xtd.forms/include/xtd/forms/color_dialog.hpp @@ -61,21 +61,21 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the dialog box shows alpha values and an opacity selector (slider). - /// @return true if the dialog box shows alpha values and an opacity selector (slider); otherwise, false. The default is true. + /// @return `true` if the dialog box shows alpha values and an opacity selector (slider); otherwise, false. The default is true. bool alpha_color() const noexcept; /// @brief Sets a value indicating whether the user can use the dialog box to define custom colors. /// @param alpha_color true if the dialog box shows alpha values and an opacity selector (slider); otherwise, false. color_dialog& alpha_color(bool alpha_color); /// @brief Gets a value indicating whether the user can use the dialog box to define custom colors. - /// @return true if the user can define custom colors; otherwise, false. The default is true. + /// @return `true` if the user can define custom colors; otherwise, false. The default is true. bool allow_full_open() const noexcept; /// @brief Sets a value indicating whether the user can use the dialog box to define custom colors. /// @param allow_full_open true if the user can define custom colors; otherwise, false. The default is true. color_dialog& allow_full_open(bool allow_full_open); /// @brief Gets a value indicating whether the dialog box displays all available colors in the set of basic colors. - /// @return true if the dialog box displays all available colors in the set of basic colors; otherwise, false. The default value is false. + /// @return `true` if the dialog box displays all available colors in the set of basic colors; otherwise, false. The default value is false. bool any_color() const noexcept; /// @brief Sets a value indicating whether the dialog box displays all available colors in the set of basic colors. /// @param any_color true if the dialog box displays all available colors in the set of basic colors; otherwise, false. The default value is false. @@ -102,7 +102,7 @@ namespace xtd { color_dialog& custom_colors(const colors& custom_colors); /// @brief Gets a value indicating whether the controls used to create custom colors are visible when the dialog box is opened - /// @return true if the custom color controls are available when the dialog box is opened; otherwise, false. The default value is false. + /// @return `true` if the custom color controls are available when the dialog box is opened; otherwise, false. The default value is false. /// @remarks By default, the custom color controls are not visible when the dialog box is first opened. You must click the Custom Colors button to display them. /// @note If allow_full_open is false, then full_open has no effect. bool full_open() const noexcept; @@ -118,14 +118,14 @@ namespace xtd { size_t options() const noexcept; /// @brief Gets a value indicating whether a Help button appears in the color dialog box. - /// @return true if the Help button is shown in the dialog box; otherwise, false. The default value is false. + /// @return `true` if the Help button is shown in the dialog box; otherwise, false. The default value is false. bool show_help() const noexcept; /// @brief Sets a value indicating whether a Help button appears in the color dialog box. /// @param show_help true if the Help button is shown in the dialog box; otherwise, false. color_dialog& show_help(bool show_help); /// @brief Gets a value indicating whether the dialog box will restrict users to selecting solid colors only. - /// @return true if users can select only solid colors; otherwise, false. The default value is false. + /// @return `true` if users can select only solid colors; otherwise, false. The default value is false. /// @remarks This property is applicable to systems with 256 or fewer colors. On these types of systems, some colors are composites of others. bool solid_color_only() const noexcept; /// @brief Sets a value indicating whether the dialog box will restrict users to selecting solid colors only. @@ -157,7 +157,7 @@ namespace xtd { /// @{ /// @brief When overridden in a derived class, specifies a common dialog box. /// @param owner A value that represents the window handle of the owner window for the common dialog box. - /// @return true if the dialog box was successfully run; otherwise, false. + /// @return `true` if the dialog box was successfully run; otherwise, false. bool run_dialog(intptr owner) override; /// @brief When overridden in a derived class, specifies a common dialog box. diff --git a/src/xtd.forms/include/xtd/forms/color_picker.hpp b/src/xtd.forms/include/xtd/forms/color_picker.hpp index da7c5c22d069..139244f72862 100644 --- a/src/xtd.forms/include/xtd/forms/color_picker.hpp +++ b/src/xtd.forms/include/xtd/forms/color_picker.hpp @@ -44,7 +44,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the dialog box shows alpha values and an opacity selector (slider). - /// @return true if the dialog box shows alpha values and an opacity selector (slider); otherwise, false. The default is true. + /// @return `true` if the dialog box shows alpha values and an opacity selector (slider); otherwise, false. The default is true. virtual bool alpha_color() const noexcept; /// @brief Sets a value indicating whether the user can use the dialog box to define custom colors. /// @param alpha_color true if the dialog box shows alpha values and an opacity selector (slider); otherwise, false. diff --git a/src/xtd.forms/include/xtd/forms/combo_box.hpp b/src/xtd.forms/include/xtd/forms/combo_box.hpp index 278c513a6eaf..a0a1f9fe2643 100644 --- a/src/xtd.forms/include/xtd/forms/combo_box.hpp +++ b/src/xtd.forms/include/xtd/forms/combo_box.hpp @@ -54,7 +54,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the combo box is displaying its drop-down portion. - /// @return true if the drop-down portion is displayed; otherwise, false. The default is false. + /// @return `true` if the drop-down portion is displayed; otherwise, false. The default is false. bool dropped_down() const noexcept; /// @brief Sets a value indicating whether the combo box is displaying its drop-down portion. /// @param value true if the drop-down portion is displayed; otherwise, false. The default is false. @@ -97,7 +97,7 @@ namespace xtd { combo_box& selected_item(const item& selected_item); /// @brief Gets a value indicating whether the items in the combo_box are sorted alphabetically. - /// @return true if items in the control are sorted; otherwise, false. The default is false. + /// @return `true` if items in the control are sorted; otherwise, false. The default is false. /// @remarks Use the sorted property to automatically sort strings alphabetically in a combo_box. As items are added to a sorted combo_box, the items are moved to the appropriate location in the sorted list. When adding items to a list_box, it is more efficient to sort the items first and then add new items. virtual bool sorted() const noexcept; /// @brief Sets a value indicating whether the items in the combo_box are sorted alphabetically. diff --git a/src/xtd.forms/include/xtd/forms/common_dialog.hpp b/src/xtd.forms/include/xtd/forms/common_dialog.hpp index 4e7c8d2cf3bd..0d48261d3a5c 100644 --- a/src/xtd.forms/include/xtd/forms/common_dialog.hpp +++ b/src/xtd.forms/include/xtd/forms/common_dialog.hpp @@ -119,12 +119,12 @@ namespace xtd { /// @brief When overridden in a derived class, specifies a common dialog box. /// @param hwnd_owner A value that represents the window handle of the owner window for the common dialog box. - /// @return true if the dialog box was successfully run; otherwise, false. + /// @return `true` if the dialog box was successfully run; otherwise, false. virtual bool run_dialog(intptr hwnd_owner) = 0; /// @brief When overridden in a derived class, specifies a common dialog box. /// @param hwnd_owner A value that represents the window handle of the owner window for the common dialog box. - /// @return true if the dialog box was successfully run; otherwise, false. + /// @return `true` if the dialog box was successfully run; otherwise, false. /// @remarks The result will done in async. Check result_dialog property after dialog box closed to obtain the result. virtual void run_sheet(intptr hwnd_owner) = 0; diff --git a/src/xtd.forms/include/xtd/forms/component.hpp b/src/xtd.forms/include/xtd/forms/component.hpp index b65941e4cf65..1f271d581f22 100644 --- a/src/xtd.forms/include/xtd/forms/component.hpp +++ b/src/xtd.forms/include/xtd/forms/component.hpp @@ -37,12 +37,12 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the component can raise an event. - /// @return true if the component can raise events; otherwise, false. The default is true. + /// @return `true` if the component can raise events; otherwise, false. The default is true. /// @remarks The default implementation of this property always returns true. Classes that inherit from the Component class should override this property to provide the ability to disable the raising of events. virtual bool can_raise_events() const noexcept; /// @brief Gets a value that indicates whether the component is currently in design mode. - /// @return true if the component is in design mode; otherwise, false. + /// @return `true` if the component is in design mode; otherwise, false. bool design_mode() const noexcept; /// @} diff --git a/src/xtd.forms/include/xtd/forms/const_control_ref_less.hpp b/src/xtd.forms/include/xtd/forms/const_control_ref_less.hpp index 3007e451dcd5..f5827216b653 100644 --- a/src/xtd.forms/include/xtd/forms/const_control_ref_less.hpp +++ b/src/xtd.forms/include/xtd/forms/const_control_ref_less.hpp @@ -26,7 +26,7 @@ namespace xtd { /// @brief Compare two specified const_control_ref. /// @param value1 The first value to compare. /// @param value2 The second value to compare. - /// @return true if value1 < value2; otherwise false. + /// @return `true` if value1 < value2; otherwise `false`. bool operator()(const const_control_ref& value1, const const_control_ref& value2) const { return &value1.get() < &value2.get(); } diff --git a/src/xtd.forms/include/xtd/forms/const_tab_page_ref_less.hpp b/src/xtd.forms/include/xtd/forms/const_tab_page_ref_less.hpp index fd502667f0f7..34757910cd5d 100644 --- a/src/xtd.forms/include/xtd/forms/const_tab_page_ref_less.hpp +++ b/src/xtd.forms/include/xtd/forms/const_tab_page_ref_less.hpp @@ -26,7 +26,7 @@ namespace xtd { /// @brief Compare two specified const_tab_page_ref. /// @param value1 The first value to compare. /// @param value2 The second value to compare. - /// @return true if value1 < value2; otherwise false. + /// @return `true` if value1 < value2; otherwise `false`. bool operator()(const const_tab_page_ref& value1, const const_tab_page_ref& value2) const { return &value1.get() < &value2.get(); } diff --git a/src/xtd.forms/include/xtd/forms/control.hpp b/src/xtd.forms/include/xtd/forms/control.hpp index f24f9a77eb91..be2c72ef6ae6 100644 --- a/src/xtd.forms/include/xtd/forms/control.hpp +++ b/src/xtd.forms/include/xtd/forms/control.hpp @@ -391,7 +391,7 @@ namespace xtd { virtual drawing::point auto_scroll_point() const noexcept; /// @brief Gets a value that indicates whether the control resizes based on its contents. - /// @return true if enabled; otherwise, false. + /// @return `true` if enabled; otherwise, false. /// @remarks This property is not relevant for this class. virtual bool auto_size() const noexcept; /// @brief Sets a value that indicates whether the control resizes based on its contents. @@ -457,12 +457,12 @@ namespace xtd { virtual control& bounds(const xtd::drawing::rectangle& bounds); /// @brief Gets a value indicating whether the control can receive focus. - /// @return true if the control can receive focus; otherwise, false. + /// @return `true` if the control can receive focus; otherwise, false. /// @remarks In order for a control to receive input focus, the control must have a handle assigned to it, and the visible and enabled properties must both be set to true for both the control and all its parent controls, and the control must be a form or the control's outermost parent must be a form. virtual bool can_focus() const noexcept; /// @brief Gets a value indicating whether the control can be selected. - /// @return true if the control can be selected; otherwise, false.s + /// @return `true` if the control can be selected; otherwise, false.s /// @remarks This property returns true if the electable value of control_styles is set to true, is contained in another control, the control itself is visible and enabled, and all its parent controls are visible and enabled. /// @remarks The Windows Forms controls in the following list are not selectable and will return a value of false for the can_select property. controls derived from these controls are also not selectable. /// * panel @@ -475,7 +475,7 @@ namespace xtd { virtual bool can_select() const noexcept; /// @brief Determines if events can be raised on the control. - /// @return true if the control can raise events; otherwise, false. + /// @return `true` if the control can raise events; otherwise, false. bool can_raise_events() const noexcept override; /// @brief Gets the rectangle that represents the client area of the control. @@ -539,7 +539,7 @@ namespace xtd { virtual const control_collection& controls() const noexcept; /// @brief Gets a value indicating whether the control has been created. - /// @return true if the control has been created; otherwise, false. + /// @return `true` if the control has been created; otherwise, false. /// @remarks The created property returns true if the control was successfully created even though the control's handle might not have been created or recreated yet. virtual bool created() const noexcept; @@ -581,7 +581,7 @@ namespace xtd { virtual control& dock(xtd::forms::dock_style dock); /// @brief Gets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. - /// @return true if the surface of the control should be drawn using double buffering; otherwise, false. + /// @return `true` if the surface of the control should be drawn using double buffering; otherwise, false. virtual bool double_buffered() const noexcept; /// @brief Sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. /// @param double_buffered true if the surface of the control should be drawn using double buffering; otherwise, false. @@ -589,7 +589,7 @@ namespace xtd { virtual control& double_buffered(bool double_buffered); /// @brief Gets a value indicating whether the control can respond to user interaction. - /// @return true if the control can respond to user interaction; otherwise, false. The default is true. + /// @return `true` if the control can respond to user interaction; otherwise, false. The default is true. virtual bool enabled() const noexcept; /// @brief Sets a value indicating whether the control can respond to user interaction. /// @param enabled true if the control can respond to user interaction; otherwise, false. The default is true. @@ -597,7 +597,7 @@ namespace xtd { virtual control& enabled(bool enabled); /// @brief Gets a value indicating whether the control has input focus. - /// @return true if the control has focus; otherwise, false. + /// @return `true` if the control has focus; otherwise, false. virtual bool focused() const noexcept; /// @brief Gets the font of the text displayed by the control. @@ -640,11 +640,11 @@ namespace xtd { virtual control& height(int32 height); /// @brief Gets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. - /// @return true if the control's xttd::forms::control::handle was created on a different thread than the calling thread (indicating that you must make calls to the control through an invoke method); otherwise, false. + /// @return `true` if the control's xttd::forms::control::handle was created on a different thread than the calling thread (indicating that you must make calls to the control through an invoke method); otherwise, false. bool invoke_required() const noexcept override; /// @brief Gets a value indicating whether the control has a handle associated with it. - /// @return true if a handle has been assigned to the control; otherwise, false. + /// @return `true` if a handle has been assigned to the control; otherwise, false. /// @remarks Use the is_handle_created property to determine whether create_handle has been called. bool is_handle_created() const noexcept; @@ -762,7 +762,7 @@ namespace xtd { virtual xtd::string product_name() const noexcept; /// @brief Gets a value indicating whether the control is currently re-creating its handle. - /// @return true if the control is currently re-creating its handle; otherwise, false. + /// @return `true` if the control is currently re-creating its handle; otherwise, false. bool recreating_handle() const noexcept; /// @brief Gets the window region associated with the control. @@ -846,7 +846,7 @@ namespace xtd { virtual control& style_sheet(std::nullptr_t); /// @brief Gets a value indicating whether the user can give the focus to this control using the TAB key. - /// @return true if the user can give the focus to the control using the TAB key; otherwise, false. The default is true. + /// @return `true` if the user can give the focus to the control using the TAB key; otherwise, false. The default is true. /// @note Note: This property will always return true for an instance of the xtd::forms::form class. /// @remarks When the user presses the TAB key, the input focus is set to the next control in the tab order. Controls with the xtd::forms::control::tab_stop property value of false are not included in the collection of controls in the tab order. The tab order can be manipulated by setting the control's xtd::forms::control::tab_index property value. virtual bool tab_stop() const noexcept; @@ -895,7 +895,7 @@ namespace xtd { virtual std::optional top_level_control() const noexcept; /// @brief Gets a value indicating whether the control and all its child controls are displayed. - /// @return true if the control and all its child controls are displayed; otherwise, false. The default is true. + /// @return `true` if the control and all its child controls are displayed; otherwise, false. The default is true. virtual bool visible() const noexcept; /// @brief Sets a value indicating whether the control and all its child controls are displayed. /// @param visible true if the control and all its child controls are displayed; otherwise, false. The default is true. @@ -915,7 +915,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether to catch calls on the wrong thread that access a xtd::forms::contrtol::handle property when an application is being debugged. - /// @return true if calls on the wrong thread are caught; otherwise, false. + /// @return `true` if calls on the wrong thread are caught; otherwise, false. /// @remarks When a thread other than the creating thread of a control tries to access one of that control's methods or properties, it often leads to unpredictable results. A common invalid thread activity is a call on the wrong thread that accesses the xtd::forms::control::handle property. Set xtd::forms::control::check_for_illegal_cross_thread_calls to true to find and diagnose this thread activity more easily while debugging. /// @warning Be careful, some OS don't support cross-thread UI operations! static bool check_for_illegal_cross_thread_calls() noexcept; @@ -985,7 +985,7 @@ namespace xtd { bool equals(const control& value) const noexcept override; /// @brief Sets input focus to the control. - /// @return true if the input focus request was successful; otherwise, false. + /// @return `true` if the input focus request was successful; otherwise, false. /// @remarks The focus method returns true if the control successfully received input focus. The control can have the input focus while not displaying any visual cues of having the focus. This behavior is primarily observed by the unselectable controls listed below, or any controls derived from them. bool focus(); @@ -1086,12 +1086,12 @@ namespace xtd { /// @param msg The ID number for the message. /// @param wparam The WParam field of the message. /// @param lparam The LParam field of the message. - /// @return true if message posted; otherwhise false. + /// @return `true` if message posted; otherwise `false`. bool post_message(intptr hwnd, int32 msg, intptr wparam, intptr lparam) const; /// @brief Preprocesses keyboard or input messages within the message loop before they are dispatched. /// @param message A xtd::forms::message, passed by reference, that represents the message to process. The possible values are WM_KEYDOWN, WM_SYSKEYDOWN, WM_CHAR, and WM_SYSCHAR. - /// @return true if the message was processed by the control; otherwise, false. + /// @return `true` if the message was processed by the control; otherwise, false. /// @remarks pre_process_message is called by the application's message loop to preprocess input messages before they are dispatched. Possible values for the msg parameter are WM_KEYDOWN, WM_SYSKEYDOWN, WM_CHAR, and WM_SYSCHAR. virtual bool pre_process_message(const xtd::forms::message& message); @@ -1927,7 +1927,7 @@ namespace xtd { /// @brief Retrieves the value of the specified control style bit for the control. /// @param flag The control_styles bit to return the value from. - /// @return true if the specified control style bit is set to true; otherwise, false. + /// @return `true` if the specified control style bit is set to true; otherwise, false. /// @remarks Control style bit flags are used to categorize supported behavior. A control can enable a style by calling the set_style method and passing in the appropriate control_styles bit and the bool value to set the bit to. To determine the value assigned to a specified control_styles bit, use the get_style method and pass in the control_styles member to evaluate. bool get_style(control_styles flag) const noexcept; diff --git a/src/xtd.forms/include/xtd/forms/control_layout_style.hpp b/src/xtd.forms/include/xtd/forms/control_layout_style.hpp index 23624410b58e..e2350b6376f5 100644 --- a/src/xtd.forms/include/xtd/forms/control_layout_style.hpp +++ b/src/xtd.forms/include/xtd/forms/control_layout_style.hpp @@ -35,15 +35,15 @@ namespace xtd { /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. explicit control_layout_style(xtd::forms::size_type size_type); /// @brief Initialises a new instance of control layout style class with specified expanded. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. explicit control_layout_style(bool expanded); /// @brief Initialises a new instance of control layout style class with specified content alignment. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. /// @param align One of the content_alignment values.. explicit control_layout_style(xtd::forms::content_alignment align); /// @brief Initialises a new instance of control layout style class with specified size type and expanded. /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. control_layout_style(xtd::forms::size_type size_type, bool expanded); /// @brief Initialises a new instance of control layout style class with specified size type and content alignment. /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. @@ -51,11 +51,11 @@ namespace xtd { control_layout_style(xtd::forms::size_type size_type, xtd::forms::content_alignment align); /// @brief Initialises a new instance of control layout style class with specified size type, expanded and content alignment. /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. /// @param align One of the content_alignment values. control_layout_style(xtd::forms::size_type size_type, bool expanded, xtd::forms::content_alignment align); /// @brief Initialises a new instance of control layout style class with specified expanded and content alignment. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. /// @param align One of the content_alignment values.. control_layout_style(bool expanded, xtd::forms::content_alignment align); /// @} @@ -77,10 +77,10 @@ namespace xtd { control_layout_style& size_type(xtd::forms::size_type size_type); /// @brief Gets a flag indicating if control is expanded to its containing layout container. - /// @return true if control expanded; otherwise false. The default is false. + /// @return `true` if control expanded; otherwise `false`. The default is false. bool expanded() const noexcept; /// @brief Sets a flag indicating if control is expanded to its containing layout container. - /// @param expanded true if control expanded; otherwise false. The default is false. + /// @param expanded true if control expanded; otherwise `false`. The default is false. control_layout_style& expanded(bool expanded); /// @brief Gets a flag indicating how a control should be align to its containing layout container. diff --git a/src/xtd.forms/include/xtd/forms/control_ref_less.hpp b/src/xtd.forms/include/xtd/forms/control_ref_less.hpp index dcc83d9deae8..65c86657975a 100644 --- a/src/xtd.forms/include/xtd/forms/control_ref_less.hpp +++ b/src/xtd.forms/include/xtd/forms/control_ref_less.hpp @@ -26,7 +26,7 @@ namespace xtd { /// @brief Compare two specified control_ref. /// @param value1 The first value to compare. /// @param value2 The second value to compare. - /// @return true if value1 < value2; otherwise false. + /// @return `true` if value1 < value2; otherwise `false`. bool operator()(const control_ref& value1, const control_ref& value2) const { return &value1.get() < &value2.get(); } diff --git a/src/xtd.forms/include/xtd/forms/domain_up_down.hpp b/src/xtd.forms/include/xtd/forms/domain_up_down.hpp index 401437709abb..ac019090a125 100644 --- a/src/xtd.forms/include/xtd/forms/domain_up_down.hpp +++ b/src/xtd.forms/include/xtd/forms/domain_up_down.hpp @@ -143,7 +143,7 @@ namespace xtd { domain_up_down& selected_item(const item& selected_item); /// @brief Gets a value indicating whether the collection of items continues to the first or last item if the user continues past the end of the list. - /// @return true if the list starts again when the user reaches the beginning or end of the collection; otherwise, false. The default value is false. + /// @return `true` if the list starts again when the user reaches the beginning or end of the collection; otherwise, false. The default value is false. virtual bool wrap() const noexcept; /// @brief Sets a value indicating whether the collection of items continues to the first or last item if the user continues past the end of the list. /// @param value true if the list starts again when the user reaches the beginning or end of the collection; otherwise, false. The default value is false. diff --git a/src/xtd.forms/include/xtd/forms/dot_matrix_display.hpp b/src/xtd.forms/include/xtd/forms/dot_matrix_display.hpp index 5224f9a11bd0..907f2b4c9073 100644 --- a/src/xtd.forms/include/xtd/forms/dot_matrix_display.hpp +++ b/src/xtd.forms/include/xtd/forms/dot_matrix_display.hpp @@ -113,10 +113,10 @@ namespace xtd { virtual dot_matrix_display& matrix_size(const drawing::size& value); /// @brief Gets a value indicate if background dots are shown. - /// @return true if background dots are shown; otherwise false. + /// @return `true` if background dots are shown; otherwise `false`. virtual bool show_back_dot() const noexcept; /// @brief Sets a value indicate if background dots are shown. - /// @param value true if background dots are shown; otherwise false. + /// @param value true if background dots are shown; otherwise `false`. /// @return Current dot_matrix_display. virtual dot_matrix_display& show_back_dot(bool value); @@ -134,16 +134,16 @@ namespace xtd { /// @{ /// @brief Gets specified dot point status. /// @param point dot point location in the matrix. - /// @return true if specified dot point is on; otherwise false. + /// @return `true` if specified dot point is on; otherwise `false`. virtual bool get_dot(const drawing::point& point) const noexcept; /// @brief Sets all dots with specified boolean. - /// @param on true to set all dots to on; otherwise false. + /// @param on true to set all dots to on; otherwise `false`. virtual void set_all_dots(bool on); /// @brief Sets specified dot point status. /// @param point dot point location in the matrix. - /// @param on true if specified dot point is on; otherwise false. + /// @param on true if specified dot point is on; otherwise `false`. virtual void set_dot(const drawing::point& point, bool on); /// @brief Sets specified dots to on. @@ -151,7 +151,7 @@ namespace xtd { virtual void set_dots(const points_collection& points); /// @brief Sets specified dots with specified boolean. /// @param points Dot points collection tha contains locations in the matrix. - /// @param on true to set specified dots points to on; otherwise false. + /// @param on true to set specified dots points to on; otherwise `false`. virtual void set_dots(const points_collection& points, bool on); /// @} @@ -200,25 +200,25 @@ namespace xtd { static dot_matrix_display create(const dots_collection& dots, const drawing::point& location, const drawing::size& size, const xtd::string& name); /// @brief A factory to create an xtd::forms::dot_matrix_display with specified dots, and back_dot visibility. /// @param dots A dots_collection that represent all dots status. - /// @param show_back_dot true if background dots are shown; otherwise false. + /// @param show_back_dot true if background dots are shown; otherwise `false`. /// @return New xtd::forms::dot_matrix_display created. static dot_matrix_display create(const dots_collection& dots, bool show_back_dot); /// @brief A factory to create an xtd::forms::dot_matrix_display with specified dots, back_dot visibility, and location. /// @param dots A dots_collection that represent all dots status. - /// @param show_back_dot true if background dots are shown; otherwise false. + /// @param show_back_dot true if background dots are shown; otherwise `false`. /// @param location A xtd::drawing::point that represent location of the xtd::forms::dot_matrix_display. /// @return New xtd::forms::dot_matrix_display created. static dot_matrix_display create(const dots_collection& dots, bool show_back_dot, const drawing::point& location); /// @brief A factory to create an xtd::forms::dot_matrix_display with specified dots, back_dot visibility, location, and size. /// @param dots A dots_collection that represent all dots status. - /// @param show_back_dot true if background dots are shown; otherwise false. + /// @param show_back_dot true if background dots are shown; otherwise `false`. /// @param location A xtd::drawing::point that represent location of the xtd::forms::dot_matrix_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::dot_matrix_display. /// @return New xtd::forms::dot_matrix_display created. static dot_matrix_display create(const dots_collection& dots, bool show_back_dot, const drawing::point& location, const drawing::size& size); /// @brief A factory to create an xtd::forms::dot_matrix_display with specified dots, back_dot visibility, location, size, and name. /// @param dots A dots_collection that represent all dots status. - /// @param show_back_dot true if background dots are shown; otherwise false. + /// @param show_back_dot true if background dots are shown; otherwise `false`. /// @param location A xtd::drawing::point that represent location of the xtd::forms::dot_matrix_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::dot_matrix_display. /// @param name The name of the xtd::forms::dot_matrix_display. @@ -275,20 +275,20 @@ namespace xtd { /// @brief A factory to create an xtd::forms::dot_matrix_display with specified parent, dots, and back_dot visibility. /// @param parent The parent that contains the new created xtd::forms::dot_matrix_display. /// @param dots A dots_collection that represent all dots status. - /// @param show_back_dot true if background dots are shown; otherwise false. + /// @param show_back_dot true if background dots are shown; otherwise `false`. /// @return New xtd::forms::dot_matrix_display created. static dot_matrix_display create(const control& parent, const dots_collection& dots, bool show_back_dot); /// @brief A factory to create an xtd::forms::dot_matrix_display with specified parent, dots, back_dot visibility, and location. /// @param parent The parent that contains the new created xtd::forms::dot_matrix_display. /// @param dots A dots_collection that represent all dots status. - /// @param show_back_dot true if background dots are shown; otherwise false. + /// @param show_back_dot true if background dots are shown; otherwise `false`. /// @param location A xtd::drawing::point that represent location of the xtd::forms::dot_matrix_display. /// @return New xtd::forms::dot_matrix_display created. static dot_matrix_display create(const control& parent, const dots_collection& dots, bool show_back_dot, const drawing::point& location); /// @brief A factory to create an xtd::forms::dot_matrix_display with specified parent, dots, back_dot visibility, location, and size. /// @param parent The parent that contains the new created xtd::forms::dot_matrix_display. /// @param dots A dots_collection that represent all dots status. - /// @param show_back_dot true if background dots are shown; otherwise false. + /// @param show_back_dot true if background dots are shown; otherwise `false`. /// @param location A xtd::drawing::point that represent location of the xtd::forms::dot_matrix_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::dot_matrix_display. /// @return New xtd::forms::dot_matrix_display created. @@ -296,7 +296,7 @@ namespace xtd { /// @brief A factory to create an xtd::forms::dot_matrix_display with specified parent, dots, back_dot visibility, location, size, and name. /// @param parent The parent that contains the new created xtd::forms::dot_matrix_display. /// @param dots A dots_collection that represent all dots status. - /// @param show_back_dot true if background dots are shown; otherwise false. + /// @param show_back_dot true if background dots are shown; otherwise `false`. /// @param location A xtd::drawing::point that represent location of the xtd::forms::dot_matrix_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::dot_matrix_display. /// @param name The name of the xtd::forms::dot_matrix_display. diff --git a/src/xtd.forms/include/xtd/forms/enable_debug.hpp b/src/xtd.forms/include/xtd/forms/enable_debug.hpp index c0259e085170..634ff6b16ce5 100644 --- a/src/xtd.forms/include/xtd/forms/enable_debug.hpp +++ b/src/xtd.forms/include/xtd/forms/enable_debug.hpp @@ -80,10 +80,10 @@ namespace xtd { /// @{ /// @brief Gets enable_debug flags status. - /// @return true if enable_debug flags is on; otherwise false. + /// @return `true` if enable_debug flags is on; otherwise `false`. static bool get(const enable_debug& flags); /// @brief Sets enable_debug flags status. - /// @param on true if enable_debug flags is on; otherwise false. + /// @param on true if enable_debug flags is on; otherwise `false`. static void set(const enable_debug& flags, bool on); /// @} diff --git a/src/xtd.forms/include/xtd/forms/file_dialog.hpp b/src/xtd.forms/include/xtd/forms/file_dialog.hpp index 48cfd7ccfb6b..3bfd1cd45dd6 100644 --- a/src/xtd.forms/include/xtd/forms/file_dialog.hpp +++ b/src/xtd.forms/include/xtd/forms/file_dialog.hpp @@ -57,7 +57,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the dialog box automatically adds an extension to a file name if the user omits the extension. - /// @return true if the dialog box adds an extension to a file name if the user omits the extension; otherwise, false. The default value is true. + /// @return `true` if the dialog box adds an extension to a file name if the user omits the extension; otherwise, false. The default value is true. virtual bool add_extension() const noexcept; /// @brief Sets a value indicating whether the dialog box automatically adds an extension to a file name if the user omits the extension. /// @param value true if the dialog box adds an extension to a file name if the user omits the extension; otherwise, false. The default value is true. @@ -65,7 +65,7 @@ namespace xtd { virtual file_dialog& add_extension(bool value); /// @brief Gets a value indicating whether this file_dialog instance should automatically upgrade appearance and behavior when running on Windows Vista. - /// @return true if this file_dialog instance should automatically upgrade appearance and behavior when running on Windows Vista; otherwise, false. The default is true. + /// @return `true` if this file_dialog instance should automatically upgrade appearance and behavior when running on Windows Vista; otherwise, false. The default is true. /// @remarks If this property is false, the file_dialog class will have a Windows XP-style appearance and behavior on Windows Vista. /// @remarks On Windows XP, this property does not have any effect. virtual bool auto_upgrade_enabled() const noexcept; @@ -77,7 +77,7 @@ namespace xtd { virtual file_dialog& auto_upgrade_enabled(bool value); /// @brief Gets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist. - /// @return true if the dialog box displays a warning if the user specifies a file name that does not exist; otherwise, false. The default value is false. + /// @return `true` if the dialog box displays a warning if the user specifies a file name that does not exist; otherwise, false. The default value is false. /// @remarks The default value is true for an inheriting open_file_dialog and false for an inheriting save_file_dialog. virtual bool check_file_exists() const noexcept; /// @brief Sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist. @@ -87,7 +87,7 @@ namespace xtd { virtual file_dialog& check_file_exists(bool value); /// @brief Gets a value indicating whether the dialog box displays a warning if the user specifies a path that does not exist. - /// @return true if the dialog box displays a warning when the user specifies a path that does not exist; otherwise, false. The default value is true. + /// @return `true` if the dialog box displays a warning when the user specifies a path that does not exist; otherwise, false. The default value is true. virtual bool check_path_exists() const noexcept; /// @brief Sets a value indicating whether the dialog box displays a warning if the user specifies a path that does not exist. /// @param value true if the dialog box displays a warning when the user specifies a path that does not exist; otherwise, false. The default value is true. @@ -105,7 +105,7 @@ namespace xtd { virtual file_dialog& default_ext(const xtd::string& value); /// @brief Gets a value indicating whether the dialog box returns the location of the file referenced by the shortcut or whether it returns the location of the shortcut (.lnk). - /// @return true if the dialog box returns the location of the file referenced by the shortcut; otherwise, false. The default value is true. + /// @return `true` if the dialog box returns the location of the file referenced by the shortcut; otherwise, false. The default value is true. virtual bool dereference_link() const noexcept; /// @brief Sets a value indicating whether the dialog box returns the location of the file referenced by the shortcut or whether it returns the location of the shortcut (.lnk). /// @param value true if the dialog box returns the location of the file referenced by the shortcut; otherwise, false. The default value is true. @@ -187,7 +187,7 @@ namespace xtd { size_t options() const noexcept; /// @brief Gets a value indicating whether the dialog box restores the directory to the previously selected directory before closing. - /// @return true if the dialog box restores the current directory to the previously selected directory if the user changed the directory while searching for files; otherwise, false. The default value is false. + /// @return `true` if the dialog box restores the current directory to the previously selected directory if the user changed the directory while searching for files; otherwise, false. The default value is false. virtual bool restore_directory() const noexcept; /// @brief Sets a value indicating whether the dialog box restores the directory to the previously selected directory before closing. /// @param value true if the dialog box restores the current directory to the previously selected directory if the user changed the directory while searching for files; otherwise, false. The default value is false. @@ -195,7 +195,7 @@ namespace xtd { virtual file_dialog& restore_directory(bool value); /// @brief Gets a value indicating whether the Help button is displayed in the file dialog box. - /// @return true if the dialog box includes a help button; otherwise, false. The default value is false. + /// @return `true` if the dialog box includes a help button; otherwise, false. The default value is false. /// @remarks A xtd::forms::control::help_requested event is raised when the user clicks the Help button. virtual bool show_help() const noexcept; /// @brief Sets a value indicating whether the Help button is displayed in the file dialog box. @@ -205,7 +205,7 @@ namespace xtd { virtual file_dialog& show_help(bool value); /// @brief Gets a value indicating whether hidden files are displayed in the file dialog box. - /// @return true if the dialog box includes hidden files; otherwise, false. The default value is false. + /// @return `true` if the dialog box includes hidden files; otherwise, false. The default value is false. virtual bool show_hidden_files() const noexcept; /// @brief Sets a value indicating whether hidden files are displayed in the file dialog box. /// @param value true if the dialog box includes hidden files; otherwise, false. The default value is false. @@ -213,7 +213,7 @@ namespace xtd { virtual file_dialog& show_hidden_files(bool value); /// @brief Gets a value indicating whether preview file is displayed in the file dialog box. - /// @return true if the dialog box includes preview file; otherwise, false. The default value is false. + /// @return `true` if the dialog box includes preview file; otherwise, false. The default value is false. virtual bool show_preview() const noexcept; /// @brief Sets a value indicating whether preview file is displayed in the file dialog box. /// @param value true if the dialog box includes preview file; otherwise, false. The default value is false. @@ -221,7 +221,7 @@ namespace xtd { virtual file_dialog& show_preview(bool value); /// @brief Gets whether the dialog box supports displaying and saving files that have multiple file name extensions.Gets or sets whether the dialog box supports displaying and saving files that have multiple file name extensions. - /// @return true if the dialog box supports multiple file name extensions; otherwise, false. The default is false. + /// @return `true` if the dialog box supports multiple file name extensions; otherwise, false. The default is false. /// @remarks Sometimes users must open and save files that use multiple file name extensions. For example, the application manifest files used by the click_once deployment technology end in the complex file name extension ".exe.manifest". Setting this property to true enables you to set the FFilter property to a multi-dotted extension. /// @remarks If support_multi_dotted_extensions is false, and you assign a multi-dotted extension to Filter, derived controls such as save_file_dialog will only use the last extension in the string. For example, ".manifest" will be used instead of ".exe.manifest". virtual bool support_multi_dotted_extensions() const noexcept; @@ -243,7 +243,7 @@ namespace xtd { virtual file_dialog& title(const xtd::string& value); /// @brief Gets a value indicating whether the dialog box accepts only valid file names. - /// @return true if the dialog box accepts only valid file names; otherwise, false. The default value is true. + /// @return `true` if the dialog box accepts only valid file names; otherwise, false. The default value is true. /// @remarks If the edit control contains anything but spaces when the user clicks OK, the dialog box returns the file name, whether it is valid or not. No default extension is added to the text. virtual bool validate_names() const noexcept; /// @brief Gets a value indicating whether the dialog box accepts only valid file names. @@ -271,7 +271,7 @@ namespace xtd { /// @{ /// @brief Runs file dialog box. /// @param hwnd_owner A value that represents the window handle of the owner window for the common dialog box. - /// @return true if the file could be opened; otherwise, false. + /// @return `true` if the file could be opened; otherwise, false. /// @remarks This method provides an implementation of run_dialog, and is invoked when the user of a file dialog invokes show_dialog. bool run_dialog(intptr hwnd_owner) override; /// @brief Runs file dialog box in sheet mode. diff --git a/src/xtd.forms/include/xtd/forms/find_box.hpp b/src/xtd.forms/include/xtd/forms/find_box.hpp index 1d138f0e6026..a3386a30aad1 100644 --- a/src/xtd.forms/include/xtd/forms/find_box.hpp +++ b/src/xtd.forms/include/xtd/forms/find_box.hpp @@ -55,7 +55,7 @@ namespace xtd { /// @param owner An xtd::forms::iwin32_window that represents the owner window of the find dialog box. /// @param find_string The string to find. /// @param title The find dialog title. - /// @param match_case true if match case option selected; otherwise false. + /// @param match_case true if match case option selected; otherwise `false`. /// @param find_next The callback called when the user click the find button. template static void show(const iwin32_window& owner, const xtd::string& find_string, const xtd::string& title, bool match_case, find_next_callback_t find_next) {show_find_box(owner, xtd::forms::find_event_handler(find_next), find_string, title, match_case);} @@ -63,7 +63,7 @@ namespace xtd { /// @param owner An xtd::forms::iwin32_window that represents the owner window of the find dialog box. /// @param find_string The string to find. /// @param title The find dialog title. - /// @param match_case true if match case option selected; otherwise false. + /// @param match_case true if match case option selected; otherwise `false`. /// @param search_direction One of xtd::forms::search_direction values. /// @param find_next The callback called when the user click the find button. template @@ -72,9 +72,9 @@ namespace xtd { /// @param owner An xtd::forms::iwin32_window that represents the owner window of the find dialog box. /// @param find_string The string to find. /// @param title The find dialog title. - /// @param match_case true if match case option selected; otherwise false. + /// @param match_case true if match case option selected; otherwise `false`. /// @param search_direction One of xtd::forms::search_direction values. - /// @param whole_word true if whole word option selected; otherwise false. + /// @param whole_word true if whole word option selected; otherwise `false`. /// @param find_next The callback called when the user click the find button. template static void show(const iwin32_window& owner, const xtd::string& find_string, const xtd::string& title, bool match_case, xtd::forms::search_direction search_direction, bool whole_word, find_next_callback_t find_next) {show_find_box(owner, xtd::forms::find_event_handler(find_next), find_string, title, match_case, search_direction, whole_word);} diff --git a/src/xtd.forms/include/xtd/forms/find_dialog.hpp b/src/xtd.forms/include/xtd/forms/find_dialog.hpp index d5b991c1c761..3e08c3dd7e94 100644 --- a/src/xtd.forms/include/xtd/forms/find_dialog.hpp +++ b/src/xtd.forms/include/xtd/forms/find_dialog.hpp @@ -70,10 +70,10 @@ namespace xtd { find_dialog& location(const xtd::drawing::point& value); /// @brief Gets the match case value. - /// @return true if match case option selected; otherwise false. The default is false. + /// @return `true` if match case option selected; otherwise `false`. The default is false. bool match_case() const noexcept; /// @brief Sets the match case value. - /// @param value true if match case option selected; otherwise false. The default is false. + /// @param value true if match case option selected; otherwise `false`. The default is false. /// @return Current find_dialog instance. find_dialog& match_case(bool value); @@ -86,26 +86,26 @@ namespace xtd { find_dialog& search_direction(xtd::forms::search_direction value); /// @brief Gets a value that indicates whether match case option is shown. - /// @return true if match case option is shown; otherwise false. The default is true. + /// @return `true` if match case option is shown; otherwise `false`. The default is true. bool show_match_case() const noexcept; /// @brief Sets a value that indicates whether match case option is shown. - /// @param value true if match case option is shown; otherwise false. The default is true. + /// @param value true if match case option is shown; otherwise `false`. The default is true. /// @return Current find_dialog instance. find_dialog& show_match_case(bool value); /// @brief Gets a value that indicates whether up down option is shown. - /// @return true if up down option is shown; otherwise false. The default is true. + /// @return `true` if up down option is shown; otherwise `false`. The default is true. bool show_up_down() const noexcept; /// @brief Sets a value that indicates whether up down option is shown. - /// @param value true if up down option is shown; otherwise false. The default is true. + /// @param value true if up down option is shown; otherwise `false`. The default is true. /// @return Current find_dialog instance. find_dialog& show_up_down(bool value); /// @brief Gets a value that indicates whether whole word option is shown. - /// @return true if whole word option is shown; otherwise false. The default is true. + /// @return `true` if whole word option is shown; otherwise `false`. The default is true. bool show_whole_word() const noexcept; /// @brief Sets a value that indicates whether whole word option is shown. - /// @param value true if whole word option is shown; otherwise false. The default is true. + /// @param value true if whole word option is shown; otherwise `false`. The default is true. /// @return Current find_dialog instance. find_dialog& show_whole_word(bool value); @@ -118,10 +118,10 @@ namespace xtd { find_dialog& title(const xtd::string& value); /// @brief Gets the whole word value. - /// @return true if whole word option selected; otherwise false. The default is false. + /// @return `true` if whole word option selected; otherwise `false`. The default is false. bool whole_word() const noexcept; /// @brief Sets the whole word value. - /// @param value true if whole word option selected; otherwise false. The default is false. + /// @param value true if whole word option selected; otherwise `false`. The default is false. /// @return Current find_dialog instance. find_dialog& whole_word(bool value); /// @} diff --git a/src/xtd.forms/include/xtd/forms/find_event_args.hpp b/src/xtd.forms/include/xtd/forms/find_event_args.hpp index 2d16b937b406..63d87703b6b5 100644 --- a/src/xtd.forms/include/xtd/forms/find_event_args.hpp +++ b/src/xtd.forms/include/xtd/forms/find_event_args.hpp @@ -33,8 +33,8 @@ namespace xtd { find_event_args(); /// @brief Initializes a new instance of the xtd::forms::find_event_args class. /// @param find_string The string to find. - /// @param match_case true if match case option selected; otherwise false. - /// @param search_direction true if match case option selected; otherwise false. + /// @param match_case true if match case option selected; otherwise `false`. + /// @param search_direction true if match case option selected; otherwise `false`. /// @param whole_word One of xtd::forms::search_direction values. find_event_args(const xtd::string& find_string, bool match_case, xtd::forms::search_direction search_direction, bool whole_word); /// @} @@ -52,7 +52,7 @@ namespace xtd { const xtd::string& find_string() const noexcept; /// @brief Gets the match case value. - /// @return true if match case option selected; otherwise false. The default is false. + /// @return `true` if match case option selected; otherwise `false`. The default is false. bool match_case() const noexcept; /// @brief Gets the search direction value. @@ -60,7 +60,7 @@ namespace xtd { xtd::forms::search_direction search_direction() const noexcept; /// @brief Gets the whole word value. - /// @return true if whole word option selected; otherwise false. The default is false. + /// @return `true` if whole word option selected; otherwise `false`. The default is false. bool whole_word() const noexcept; /// @} diff --git a/src/xtd.forms/include/xtd/forms/folder_browser_dialog.hpp b/src/xtd.forms/include/xtd/forms/folder_browser_dialog.hpp index 0405594cfaf6..4120e7380c51 100644 --- a/src/xtd.forms/include/xtd/forms/folder_browser_dialog.hpp +++ b/src/xtd.forms/include/xtd/forms/folder_browser_dialog.hpp @@ -47,7 +47,7 @@ namespace xtd { /// @{ /// @brief Gets a value that indicates whether the dialog will be automatically upgraded to enable new features. - /// @return true if the the dialog will be automatically upgraded to enable new features; otherwise, false. The default value is true. + /// @return `true` if the the dialog will be automatically upgraded to enable new features; otherwise, false. The default value is true. bool auto_upgrade_enable() const noexcept; /// @brief Sets a value that indicates whether the dialog will be automatically upgraded to enable new features. /// @param value true if the the dialog will be automatically upgraded to enable new features; otherwise, false. The default value is true. @@ -86,7 +86,7 @@ namespace xtd { folder_browser_dialog& selected_path(const xtd::string& value); /// @brief Gets a value indicating whether the New Folder button appears in the folder browser dialog box. - /// @return true if the New Folder button is shown in the dialog box; otherwise, false. The default is true. + /// @return `true` if the New Folder button is shown in the dialog box; otherwise, false. The default is true. /// @remarks When show_new_folder_button is true, the New Folder button is visible, giving the user a chance to create a folder. When the user clicks the New Folder button, a new folder is created and the user is prompted to specify the folder name. The selected node in the tree becomes the parent of the new folder. The actual caption of the New Folder button can vary depending upon the operating system bool show_new_folder_button() const noexcept; /// @brief Sets a value indicating whether the New Folder button appears in the folder browser dialog box. @@ -108,7 +108,7 @@ namespace xtd { /// @{ /// @brief When overridden in a derived class, specifies a common dialog box. /// @param owner A value that represents the window handle of the owner window for the common dialog box. - /// @return true if the dialog box was successfully run; otherwise, false. + /// @return `true` if the dialog box was successfully run; otherwise, false. bool run_dialog(intptr owner) override; /// @brief When overridden in a derived class, specifies a common dialog box. diff --git a/src/xtd.forms/include/xtd/forms/font_dialog.hpp b/src/xtd.forms/include/xtd/forms/font_dialog.hpp index 90476e9d383b..fac9047384d2 100644 --- a/src/xtd.forms/include/xtd/forms/font_dialog.hpp +++ b/src/xtd.forms/include/xtd/forms/font_dialog.hpp @@ -65,7 +65,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the user can change the character set specified in the Script combo box to display a character set other than the one currently displayed. - /// @return true if the user can change the character set specified in the Script combo box; otherwise, false. The default value is true. + /// @return `true` if the user can change the character set specified in the Script combo box; otherwise, false. The default value is true. /// @remarks The Script combo box found on the Font dialog box contains character sets associated with the selected font. bool allow_script_change() const noexcept; /// @brief Sets a value indicating whether the user can change the character set specified in the Script combo box to display a character set other than the one currently displayed. @@ -75,7 +75,7 @@ namespace xtd { font_dialog& allow_script_change(bool allow_script_change); /// @brief Gets a value indicating whether the dialog box allows graphics device interface (GDI) font simulations. - /// @return true if font simulations are allowed; otherwise, false. The default value is true. + /// @return `true` if font simulations are allowed; otherwise, false. The default value is true. bool allow_simulation() const noexcept; /// @brief Sets a value indicating whether the dialog box allows graphics device interface (GDI) font simulations. /// @param allow_simulation true if font simulations are allowed; otherwise, false. The default value is true. @@ -83,7 +83,7 @@ namespace xtd { font_dialog& allow_simulation(bool allow_simulation); /// @brief Gets a value indicating whether the dialog box allows vector font selections. - /// @return true if vector fonts are allowed; otherwise, false. The default value is true. + /// @return `true` if vector fonts are allowed; otherwise, false. The default value is true. bool allow_vector_fonts() const noexcept; /// @brief Sets a value indicating whether the dialog box allows vector font selections. /// @param allow_vector_fonts true if vector fonts are allowed; otherwise, false. The default value is true. @@ -91,7 +91,7 @@ namespace xtd { font_dialog& allow_vector_fonts(bool allow_vector_fonts); /// @brief Gets a value indicating whether the dialog box displays both vertical and horizontal fonts or only horizontal fonts. - /// @return true if both vertical and horizontal fonts are allowed; otherwise, false. The default value is true. + /// @return `true` if both vertical and horizontal fonts are allowed; otherwise, false. The default value is true. bool allow_vertical_fonts() const noexcept; /// @brief Sets a value indicating whether the dialog box displays both vertical and horizontal fonts or only horizontal fonts. /// @param allow_vertical_fonts true if both vertical and horizontal fonts are allowed; otherwise, false. The default value is true. @@ -107,7 +107,7 @@ namespace xtd { font_dialog& color(const drawing::color& color); /// @brief Gets a value indicating whether the dialog box allows only the selection of fixed-pitch fonts. - /// @return true if only fixed-pitch fonts can be selected; otherwise, false. The default value is false. + /// @return `true` if only fixed-pitch fonts can be selected; otherwise, false. The default value is false. bool fixed_pitch_only() const noexcept; /// @brief Sets a value indicating whether the dialog box allows only the selection of fixed-pitch fonts. /// @param fixed_pitch_only true if only fixed-pitch fonts can be selected; otherwise, false. The default value is false. @@ -123,7 +123,7 @@ namespace xtd { font_dialog& font(const drawing::font& font); /// @brief Gets a value indicating whether the dialog box specifies an error condition if the user attempts to select a font or style that does not exist. - /// @return true if the dialog box specifies an error condition when the user tries to select a font or style that does not exist; otherwise, false. The default is false. + /// @return `true` if the dialog box specifies an error condition when the user tries to select a font or style that does not exist; otherwise, false. The default is false. bool font_must_exist() const noexcept; /// @brief Sets a value indicating whether the dialog box specifies an error condition if the user attempts to select a font or style that does not exist. /// @param font_must_exist true if the dialog box specifies an error condition when the user tries to select a font or style that does not exist; otherwise, false. The default is false. @@ -152,7 +152,7 @@ namespace xtd { size_t options() const noexcept; /// @brief Gets a value indicating whether the dialog box allows selection of fonts for all non-OEM and Symbol character sets, as well as the ANSI character set. - /// @return true if selection of fonts for all non-OEM and Symbol character sets, as well as the ANSI character set, is allowed; otherwise, false. The default value is false. + /// @return `true` if selection of fonts for all non-OEM and Symbol character sets, as well as the ANSI character set, is allowed; otherwise, false. The default value is false. bool script_only() const noexcept; /// @brief Sets a value indicating whether the dialog box allows selection of fonts for all non-OEM and Symbol character sets, as well as the ANSI character set. /// @param script_script = true if selection of fonts for all non-OEM and Symbol character sets, as well as the ANSI character set, is allowed; otherwise, false. The default value is false. @@ -160,7 +160,7 @@ namespace xtd { font_dialog& script_only(bool script_only); /// @brief Gets a value indicating whether the dialog box contains an Apply button. - /// @return true if the dialog box contains an Apply button; otherwise, false. The default value is false. + /// @return `true` if the dialog box contains an Apply button; otherwise, false. The default value is false. bool show_apply() const noexcept; /// @brief Sets a value indicating whether the dialog box contains an Apply button. /// @param show_apply true if the dialog box contains an Apply button; otherwise, false. The default value is false. @@ -168,7 +168,7 @@ namespace xtd { font_dialog& show_apply(bool show_apply); /// @brief Gets a value indicating whether the dialog box displays the color choice. - /// @return true if the dialog box displays the color choice; otherwise, false. The default value is false. + /// @return `true` if the dialog box displays the color choice; otherwise, false. The default value is false. bool show_color() const noexcept; /// @brief Sets a value indicating whether the dialog box displays the color choice. /// @param show_color true if the dialog box displays the color choice; otherwise, false. The default value is false. @@ -176,7 +176,7 @@ namespace xtd { font_dialog& show_color(bool show_color); /// @brief Gets a value indicating whether the dialog box contains controls that allow the user to specify strikethrough, underline, and text color options. - /// @return true if the dialog box contains controls to set strikethrough, underline, and text color options; otherwise, false. The default value is true. + /// @return `true` if the dialog box contains controls to set strikethrough, underline, and text color options; otherwise, false. The default value is true. bool show_effect() const noexcept; /// @brief Sets a value indicating whether the dialog box contains controls that allow the user to specify strikethrough, underline, and text color options. /// @param show_effect true if the dialog box contains controls to set strikethrough, underline, and text color options; otherwise, false. The default value is true. @@ -184,7 +184,7 @@ namespace xtd { font_dialog& show_effect(bool show_effect); /// @brief Gets a value indicating whether the dialog box displays a Help button. - /// @return true if the dialog box displays a Help button; otherwise, false. The default value is false. + /// @return `true` if the dialog box displays a Help button; otherwise, false. The default value is false. bool show_help() const noexcept; /// @brief Sets a value indicating whether the dialog box displays a Help button. /// @param show_help true if the dialog box displays a Help button; otherwise, false. The default value is false. @@ -222,7 +222,7 @@ namespace xtd { /// @return Specifies a file dialog box. /// @param owner The window handle of the owner window for the common dialog box. - /// @return true if the dialog box was successfully run; otherwise, false. + /// @return `true` if the dialog box was successfully run; otherwise, false. /// @remarks The run_dialog method is invoked when the user of a font dialog box calls the show_dialog method. bool run_dialog(intptr owner) override; diff --git a/src/xtd.forms/include/xtd/forms/form.hpp b/src/xtd.forms/include/xtd/forms/form.hpp index 0c03971d6533..d76baa2e1cd3 100644 --- a/src/xtd.forms/include/xtd/forms/form.hpp +++ b/src/xtd.forms/include/xtd/forms/form.hpp @@ -115,7 +115,7 @@ namespace xtd { form& cancel_button(std::nullptr_t); /// @brief Gets a value indicating whether a close box is displayed in the caption bar of the form. - /// @return true if the form displays a close box in the upper-left corner of the form; otherwise, false. The default is true. + /// @return `true` if the form displays a close box in the upper-left corner of the form; otherwise, false. The default is true. virtual bool close_box() const noexcept; /// @brief Sets a value indicating whether a close box is displayed in the caption bar of the form. /// @param value true if the form displays a close box in the upper-left corner of the form; otherwise, false. The default is true. @@ -123,7 +123,7 @@ namespace xtd { virtual form& close_box(bool value); /// @brief Gets a value indicating whether a control box is displayed in the caption bar of the form. - /// @return true if the form displays a control box in the upper-right corner of the form; otherwise, false. The default is true. + /// @return `true` if the form displays a control box in the upper-right corner of the form; otherwise, false. The default is true. virtual bool control_box() const noexcept; /// @brief Sets a value indicating whether a control box is displayed in the caption bar of the form. /// @param value true if the form displays a control box in the upper-right corner of the form; otherwise, false. The default is true. @@ -152,7 +152,7 @@ namespace xtd { virtual form& form_border_style(forms::form_border_style value); /// @brief Gets a value indicating whether a Help button should be displayed in the caption box of the form. - /// @return true to display a Help button in the form's caption bar; otherwise, false. The default is false. + /// @return `true` to display a Help button in the form's caption bar; otherwise, false. The default is false. virtual bool help_button() const; /// @brief Sets a value indicating whether a Help button should be displayed in the caption box of the form. /// @param value true to display a Help button in the form's caption bar; otherwise, false. The default is false. @@ -168,7 +168,7 @@ namespace xtd { virtual form& icon(const xtd::drawing::icon& value); /// @brief Gets a value indicating whether the Maximize button is displayed in the caption bar of the form. - /// @return true to display a Maximize button for the form; otherwise, false. The default is true. + /// @return `true` to display a Maximize button for the form; otherwise, false. The default is true. virtual bool maximize_box() const noexcept; /// @brief Sets a value indicating whether the Maximize button is displayed in the caption bar of the form. /// @param value true to display a Maximize button for the form; otherwise, false. The default is true. @@ -188,7 +188,7 @@ namespace xtd { virtual form& menu(std::nullptr_t); /// @brief Gets a value indicating whether the Minimize button is displayed in the caption bar of the form. - /// @return true to display a Minimize button for the form; otherwise, false. The default is true. + /// @return `true` to display a Minimize button for the form; otherwise, false. The default is true. virtual bool minimize_box() const noexcept; /// @brief Sets a value indicating whether the Minimize button is displayed in the caption bar of the form. /// @param value true to display a Minimize button for the form; otherwise, false. The default is true. @@ -196,7 +196,7 @@ namespace xtd { virtual form& minimize_box(bool value); /// @brief Gets a value indicating whether this form is displayed modally. - /// @return true if the form is displayed modally; otherwise, false. + /// @return `true` if the form is displayed modally; otherwise, false. bool modal() const noexcept; /// @brief Gets form opacity. @@ -224,7 +224,7 @@ namespace xtd { control& parent(const control& value) override; /// @brief Gets a value indicating whether an icon is displayed in the caption bar of the form. - /// @return true if the form displays an icon in the caption bar; otherwise, false. The default is true. + /// @return `true` if the form displays an icon in the caption bar; otherwise, false. The default is true. virtual bool show_icon() const noexcept; /// @brief Sets a value indicating whether an icon is displayed in the caption bar of the form. /// @param value true if the form displays an icon in the caption bar; otherwise, false. The default is true. @@ -232,7 +232,7 @@ namespace xtd { virtual form& show_icon(bool value); /// @brief Gets a value indicating whether the form is displayed in the Windows taskbar. - /// @return true to display the form in the Windows taskbar at run time; otherwise, false. The default is true. + /// @return `true` to display the form in the Windows taskbar at run time; otherwise, false. The default is true. /// @remarks If a form is parented within another form, the parented form is not displayed in the Windows taskbar. /// @remarks You can use this property to prevent users from selecting your form through the Windows taskbar. For example, if you display a Find and Replace tool window in your application, you might want to prevent that window from being selected through the Windows taskbar because you would need both the application's main window and the Find and Replace tool window displayed in order to process searches appropriately. /// @remarks You will often wish to use this property when creating a form with the xtd::forms::form_border_style::fixed_tool_window style. Setting the xtd::forms::form_border_style::fixed_tool_window style does not alone guarantee that a window will not appear in the taskbar. @@ -278,18 +278,18 @@ namespace xtd { virtual form& tool_bar(std::nullptr_t); /// @brief Gets a value indicating whether to display the form as a top-level window. - /// @return true to display the form as a top-level window; otherwise, false. The default is true. + /// @return `true` to display the form as a top-level window; otherwise, false. The default is true. /// @remarks A Multiple-document interface (MDI) parent form must be a top-level window. So set to false has no effect. /// @remarks A top-level form is a window that has no parent form, or whose parent form is the desktop window. Top-level windows are typically used as the main form in an application. virtual bool top_level() const noexcept; /// @brief Sets a value indicating whether to display the form as a top-level window. - /// @return true to display the form as a top-level window; otherwise, false. The default is true. + /// @return `true` to display the form as a top-level window; otherwise, false. The default is true. /// @remarks A Multiple-document interface (MDI) parent form must be a top-level window. So set to false has no effect. /// @remarks A top-level form is a window that has no parent form, or whose parent form is the desktop window. Top-level windows are typically used as the main form in an application. virtual form& top_level(bool top_level); /// @brief Gets a value indicating whether the form should be displayed as a topmost form. - /// @return true to display the form as a topmost form; otherwise, false. The default is false. + /// @return `true` to display the form as a topmost form; otherwise, false. The default is false. virtual bool top_most() const noexcept; /// @brief Sets a value indicating whether the form should be displayed as a topmost form. /// @param value true to display the form as a topmost form; otherwise, false. The default is false. diff --git a/src/xtd.forms/include/xtd/forms/form_button_images.hpp b/src/xtd.forms/include/xtd/forms/form_button_images.hpp index 56e89a7c92da..3e1d84de42d8 100644 --- a/src/xtd.forms/include/xtd/forms/form_button_images.hpp +++ b/src/xtd.forms/include/xtd/forms/form_button_images.hpp @@ -30,7 +30,7 @@ namespace xtd { /// @return A xtd::drawing::image that represent "window-close". static xtd::drawing::image close(); /// @brief Close image object with specified maximized form. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-close". static xtd::drawing::image close(bool maximized_form); /// @brief Close image object with specified theme. @@ -39,7 +39,7 @@ namespace xtd { static xtd::drawing::image close(const xtd::string& theme); /// @brief Close image object with specified theme and maximized form. /// @param theme a string that represent theme of image. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-close". static xtd::drawing::image close(const xtd::string& theme, bool maximized_form); /// @brief Close image object with specified size. @@ -56,7 +56,7 @@ namespace xtd { /// @return A xtd::drawing::image that represent "window-close-hovered". static xtd::drawing::image close_hovered(); /// @brief Close hovered image object with specified maximized form. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-close". static xtd::drawing::image close_hovered(bool maximized_form); /// @brief Close hovered image object with specified theme. @@ -65,7 +65,7 @@ namespace xtd { static xtd::drawing::image close_hovered(const xtd::string& theme); /// @brief Close hovered image object with specified theme and maximized form. /// @param theme a string that represent theme of image. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-close-hovered". static xtd::drawing::image close_hovered(const xtd::string& theme, bool maximized_form); /// @brief Close hovered image object with specified size. @@ -82,7 +82,7 @@ namespace xtd { /// @return A xtd::drawing::image that represent "window-fullscreen". static xtd::drawing::image fullscreen(); /// @brief Fullscreen image object with specified maximized form. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-fullscreen". static xtd::drawing::image fullscreen(bool maximized_form); /// @brief Fullscreen image object with specified theme. @@ -91,7 +91,7 @@ namespace xtd { static xtd::drawing::image fullscreen(const xtd::string& theme); /// @brief Fullscreen image object with specified theme and maximized form. /// @param theme a string that represent theme of image. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-fullscreen". static xtd::drawing::image fullscreen(const xtd::string& theme, bool maximized_form); /// @brief Fullscreen image object with specified size. @@ -108,7 +108,7 @@ namespace xtd { /// @return A xtd::drawing::image that represent "window-fullscreen-hovered". static xtd::drawing::image fullscreen_hovered(); /// @brief Fullscreen hovered image object with specified maximized form. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-fullscreen-hovered". static xtd::drawing::image fullscreen_hovered(bool maximized_form); /// @brief Fullscreen hovered image object with specified theme. @@ -117,7 +117,7 @@ namespace xtd { static xtd::drawing::image fullscreen_hovered(const xtd::string& theme); /// @brief Fullscreen hovered image object with specified theme and maximized form. /// @param theme a string that represent theme of image. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-fullscreen-hovered". static xtd::drawing::image fullscreen_hovered(const xtd::string& theme, bool maximized_form); /// @brief Fullscreen hovered image object with specified size. @@ -134,7 +134,7 @@ namespace xtd { /// @return A xtd::drawing::image that represent "window-maximize". static xtd::drawing::image maximize(); /// @brief Maximize image object with specified maximized form. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-maximize". static xtd::drawing::image maximize(bool maximized_form); /// @brief Maximize image object with specified theme. @@ -143,7 +143,7 @@ namespace xtd { static xtd::drawing::image maximize(const xtd::string& theme); /// @brief Maximize image object with specified theme and maximized form. /// @param theme a string that represent theme of image. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-maximize". static xtd::drawing::image maximize(const xtd::string& theme, bool maximized_form); /// @brief Maximize image object with specified size. @@ -160,7 +160,7 @@ namespace xtd { /// @return A xtd::drawing::image that represent "window-maximize-hovered". static xtd::drawing::image maximize_hovered(); /// @brief Maximize hovered image object with specified maximized form. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-maximize-hovered". static xtd::drawing::image maximize_hovered(bool maximized_form); /// @brief Maximize hovered image object with specified theme. @@ -169,7 +169,7 @@ namespace xtd { static xtd::drawing::image maximize_hovered(const xtd::string& theme); /// @brief Maximize hovered image object with specified theme and maximized form. /// @param theme a string that represent theme of image. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-maximize-hovered". static xtd::drawing::image maximize_hovered(const xtd::string& theme, bool maximized_form); /// @brief Maximize hovered image object with specified size. @@ -186,7 +186,7 @@ namespace xtd { /// @return A xtd::drawing::image that represent "window-minimize". static xtd::drawing::image minimize(); /// @brief Minimize image object with specified maximized form. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-minimize". static xtd::drawing::image minimize(bool maximized_form); /// @brief Minimize image object with specified theme. @@ -195,7 +195,7 @@ namespace xtd { static xtd::drawing::image minimize(const xtd::string& theme); /// @brief Minimize image object with specified theme and maximized form. /// @param theme a string that represent theme of image. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-minimize". static xtd::drawing::image minimize(const xtd::string& theme, bool maximized_form); /// @brief Minimize image object with specified size. @@ -212,7 +212,7 @@ namespace xtd { /// @return A xtd::drawing::image that represent "window-close". static xtd::drawing::image minimize_hovered(); /// @brief Minimize hovered image object with specified maximized form. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-minimize-hovered". static xtd::drawing::image minimize_hovered(bool maximized_form); /// @brief Minimize hovered image object with specified theme. @@ -221,7 +221,7 @@ namespace xtd { static xtd::drawing::image minimize_hovered(const xtd::string& theme); /// @brief Minimize hovered image object with specified theme and maximized form. /// @param theme a string that represent theme of image. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-minimize-hovered". static xtd::drawing::image minimize_hovered(const xtd::string& theme, bool maximized_form); /// @brief Minimize hovered image object with specified size. @@ -238,7 +238,7 @@ namespace xtd { /// @return A xtd::drawing::image that represent "window-restore". static xtd::drawing::image restore(); /// @brief Restore image object with specified maximized form. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-restore". static xtd::drawing::image restore(bool maximized_form); /// @brief Restore image object with specified theme. @@ -247,7 +247,7 @@ namespace xtd { static xtd::drawing::image restore(const xtd::string& theme); /// @brief Restore image object with specified theme and maximized form. /// @param theme a string that represent theme of image. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-restore". static xtd::drawing::image restore(const xtd::string& theme, bool maximized_form); /// @brief Restore image object with specified size. @@ -264,7 +264,7 @@ namespace xtd { /// @return A xtd::drawing::image that represent "window-restore-hovered". static xtd::drawing::image restore_hovered(); /// @brief Restore hovered image object with specified maximized form. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-restore-hovered". static xtd::drawing::image restore_hovered(bool maximized_form); /// @brief Restore hovered image object with specified theme. @@ -273,7 +273,7 @@ namespace xtd { static xtd::drawing::image restore_hovered(const xtd::string& theme); /// @brief Restore hovered image object with specified theme and maximized form. /// @param theme a string that represent theme of image. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-restore-hovered". static xtd::drawing::image restore_hovered(const xtd::string& theme, bool maximized_form); /// @brief Restore hovered image object with specified size. @@ -290,7 +290,7 @@ namespace xtd { /// @return A xtd::drawing::image that represent "window-system-menu". static xtd::drawing::image system_menu(); /// @brief System menu image object with specified maximized form. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-system-menu". static xtd::drawing::image system_menu(bool maximized_form); /// @brief System menu image object with specified theme. @@ -299,7 +299,7 @@ namespace xtd { static xtd::drawing::image system_menu(const xtd::string& theme); /// @brief System menu image object with specified theme and maximized form. /// @param theme a string that represent theme of image. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-system-menu". static xtd::drawing::image system_menu(const xtd::string& theme, bool maximized_form); /// @brief System menu image object with specified size. @@ -316,7 +316,7 @@ namespace xtd { /// @return A xtd::drawing::image that represent "window-system-menu-hovered". static xtd::drawing::image system_menu_hovered(); /// @brief System menu hovered image object with specified maximized form. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-system-menu-hovered". static xtd::drawing::image system_menu_hovered(bool maximized_form); /// @brief System menu hovered image object with specified theme. @@ -325,7 +325,7 @@ namespace xtd { static xtd::drawing::image system_menu_hovered(const xtd::string& theme); /// @brief System menu hovered image object with specified theme and maximized form. /// @param theme a string that represent theme of image. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent "window-system-menu-hovered". static xtd::drawing::image system_menu_hovered(const xtd::string& theme, bool maximized_form); /// @brief System menu hovered image object with specified size. @@ -346,7 +346,7 @@ namespace xtd { /// | {90, 58} | {24, 24} | {64, 64} | static xtd::drawing::size size(); /// @brief Gets the height and width of the button images with specified maximized form. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return The size that represents the height and width of the button images in pixels. /// @remarks The following table show size by operating system : /// | maximized form | Windows | macOS | linux | @@ -384,7 +384,7 @@ namespace xtd { static xtd::drawing::image from_name(const xtd::string& theme, const xtd::string& name, const xtd::drawing::size& size); /// @brief Gets image object with specified name and maximized form. /// @param name the image name to get. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent the specified name. /// @remarks Use xtd::drawing::system_images::themes to get valid themes. /// @remarks Use xtd::drawing::system_images::context_names to get valid names by context. @@ -392,7 +392,7 @@ namespace xtd { /// @brief Gets image object with specified theme, name and maximized form. /// @param theme the theme name that contains the image to get. /// @param name the image name to get. - /// @param maximized_form true if form is maximized; otherwise false. + /// @param maximized_form true if form is maximized; otherwise `false`. /// @return A xtd::drawing::image that represent the specified name. /// @remarks Use xtd::drawing::system_images::themes to get valid themes. /// @remarks Use xtd::drawing::system_images::context_names to get valid names by context. diff --git a/src/xtd.forms/include/xtd/forms/fourteen_segment_display.hpp b/src/xtd.forms/include/xtd/forms/fourteen_segment_display.hpp index dd1fcb08356c..d45a8a97ef01 100644 --- a/src/xtd.forms/include/xtd/forms/fourteen_segment_display.hpp +++ b/src/xtd.forms/include/xtd/forms/fourteen_segment_display.hpp @@ -93,25 +93,25 @@ namespace xtd { static fourteen_segment_display create(xtd::forms::segments segments, const drawing::point& location, const drawing::size& size, const xtd::string& name); /// @brief A factory to create an xtd::forms::fourteen_segment_display with specified segments, and back_segment visibility. /// @param segments A dots_collection that represent all dots status. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @return New xtd::forms::fourteen_segment_display created. static fourteen_segment_display create(xtd::forms::segments segments, bool show_back_segment); /// @brief A factory to create an xtd::forms::fourteen_segment_display with specified segments, back_segment visibility, and location. /// @param segments A dots_collection that represent all dots status. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::fourteen_segment_display. /// @return New xtd::forms::fourteen_segment_display created. static fourteen_segment_display create(xtd::forms::segments segments, bool show_back_segment, const drawing::point& location); /// @brief A factory to create an xtd::forms::fourteen_segment_display with specified segments, back_segment visibility, location, and size. /// @param segments A dots_collection that represent all dots status. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::fourteen_segment_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::fourteen_segment_display. /// @return New xtd::forms::fourteen_segment_display created. static fourteen_segment_display create(xtd::forms::segments segments, bool show_back_segment, const drawing::point& location, const drawing::size& size); /// @brief A factory to create an xtd::forms::fourteen_segment_display with specified segments, back_segment visibility, location, size, and name. /// @param segments A dots_collection that represent all dots status. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::fourteen_segment_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::fourteen_segment_display. /// @param name The name of the xtd::forms::fourteen_segment_display. @@ -168,20 +168,20 @@ namespace xtd { /// @brief A factory to create an xtd::forms::fourteen_segment_display with specified parent, segments, and back_segment visibility. /// @param parent The parent that contains the new created xtd::forms::fourteen_segment_display. /// @param segments A xtd::forms::segments combination that represent fourteen_segment_display. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @return New xtd::forms::fourteen_segment_display created. static fourteen_segment_display create(const control& parent, xtd::forms::segments segments, bool show_back_segment); /// @brief A factory to create an xtd::forms::fourteen_segment_display with specified parent, segments, back_segment visibility, and location. /// @param parent The parent that contains the new created xtd::forms::fourteen_segment_display. /// @param segments A xtd::forms::segments combination that represent fourteen_segment_display. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::fourteen_segment_display. /// @return New xtd::forms::fourteen_segment_display created. static fourteen_segment_display create(const control& parent, xtd::forms::segments segments, bool show_back_segment, const drawing::point& location); /// @brief A factory to create an xtd::forms::fourteen_segment_display with specified parent, segments, back_segment visibility, location, and size. /// @param parent The parent that contains the new created xtd::forms::fourteen_segment_display. /// @param segments A xtd::forms::segments combination that represent fourteen_segment_display. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::fourteen_segment_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::fourteen_segment_display. /// @return New xtd::forms::fourteen_segment_display created. @@ -189,7 +189,7 @@ namespace xtd { /// @brief A factory to create an xtd::forms::fourteen_segment_display with specified parent, segments, back_segment visibility, location, size, and name. /// @param parent The parent that contains the new created xtd::forms::fourteen_segment_display. /// @param segments A xtd::forms::segments combination that represent fourteen_segment_display. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::fourteen_segment_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::fourteen_segment_display. /// @param name The name of the xtd::forms::fourteen_segment_display. diff --git a/src/xtd.forms/include/xtd/forms/help_event_args.hpp b/src/xtd.forms/include/xtd/forms/help_event_args.hpp index 39a5cb78777c..cd8d208fd96e 100644 --- a/src/xtd.forms/include/xtd/forms/help_event_args.hpp +++ b/src/xtd.forms/include/xtd/forms/help_event_args.hpp @@ -42,7 +42,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the help event was handled. - /// @return true if the event is handled; otherwise, false. The default is false. + /// @return `true` if the event is handled; otherwise, false. The default is false. /// @remarks If you do not set this property to true the event will be passed to Windows for additional processing. bool handled() const noexcept {return handled_;} /// @brief Sets a value indicating whether the help event was handled. diff --git a/src/xtd.forms/include/xtd/forms/horizontal_control_layout_style.hpp b/src/xtd.forms/include/xtd/forms/horizontal_control_layout_style.hpp index 99597fc41a1d..55a2d9881ba6 100644 --- a/src/xtd.forms/include/xtd/forms/horizontal_control_layout_style.hpp +++ b/src/xtd.forms/include/xtd/forms/horizontal_control_layout_style.hpp @@ -45,15 +45,15 @@ namespace xtd { /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size. horizontal_control_layout_style(int32 width, xtd::forms::size_type size_type); /// @brief Initialises a new instance of horizontal control layout style class with specified expanded. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. explicit horizontal_control_layout_style(bool expanded); /// @brief Initialises a new instance of horizontal control layout style class with specified width and expanded. /// @param width The preferred width, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. horizontal_control_layout_style(float width, bool expanded); /// @brief Initialises a new instance of horizontal control layout style class with specified width and expanded. /// @param width The preferred width, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. horizontal_control_layout_style(int32 width, bool expanded); /// @brief Initialises a new instance of horizontal control layout style class with specified content alignment. /// @param align One of the content_alignment values. The default is middle_center. @@ -68,17 +68,17 @@ namespace xtd { horizontal_control_layout_style(int32 width, xtd::forms::content_alignment align); /// @brief Initialises a new instance of horizontal control layout style class with specified size type and expanded. /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. horizontal_control_layout_style(xtd::forms::size_type size_type, bool expanded); /// @brief Initialises a new instance of horizontal control layout style class with specified width, size type and expanded. /// @param width The preferred width, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property. /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. horizontal_control_layout_style(float width, xtd::forms::size_type size_type, bool expanded); /// @brief Initialises a new instance of horizontal control layout style class with specified width, size type and expanded. /// @param width The preferred width, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property. /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. horizontal_control_layout_style(int32 width, xtd::forms::size_type size_type, bool expanded); /// @brief Initialises a new instance of horizontal control layout style class with specified size type and content alignment. /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size. @@ -96,33 +96,33 @@ namespace xtd { horizontal_control_layout_style(int32 width, xtd::forms::size_type size_type, xtd::forms::content_alignment align); /// @brief Initialises a new instance of horizontal control layout style class with specified size type, expanded and content alignment. /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. /// @param align One of the content_alignment values. The default is middle_center. horizontal_control_layout_style(xtd::forms::size_type size_type, bool expanded, xtd::forms::content_alignment align); /// @brief Initialises a new instance of horizontal control layout style class with specified width, size type, expanded and content alignment. /// @param width The preferred width, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property. /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. /// @param align One of the content_alignment values. The default is middle_center. horizontal_control_layout_style(float width, xtd::forms::size_type size_type, bool expanded, xtd::forms::content_alignment align); /// @brief Initialises a new instance of horizontal control layout style class with specified width, size type, expanded and content alignment. /// @param width The preferred width, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property. /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. /// @param align One of the content_alignment values. The default is middle_center. horizontal_control_layout_style(int32 width, xtd::forms::size_type size_type, bool expanded, xtd::forms::content_alignment align); /// @brief Initialises a new instance of horizontal control layout style class with specified expanded and content alignment. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. /// @param align One of the content_alignment values. The default is middle_center. horizontal_control_layout_style(bool expanded, xtd::forms::content_alignment align); /// @brief Initialises a new instance of horizontal control layout style class with specified expanded and content alignment. /// @param width The preferred width, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. /// @param align One of the content_alignment values. The default is middle_center. horizontal_control_layout_style(float width, bool expanded, xtd::forms::content_alignment align); /// @brief Initialises a new instance of horizontal control layout style class with specified expanded and content alignment. /// @param width The preferred width, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. /// @param align One of the content_alignment values. The default is middle_center. horizontal_control_layout_style(int32 width, bool expanded, xtd::forms::content_alignment align); /// @} diff --git a/src/xtd.forms/include/xtd/forms/ibutton_control.hpp b/src/xtd.forms/include/xtd/forms/ibutton_control.hpp index fd3b860bf583..27c461229020 100644 --- a/src/xtd.forms/include/xtd/forms/ibutton_control.hpp +++ b/src/xtd.forms/include/xtd/forms/ibutton_control.hpp @@ -42,7 +42,7 @@ namespace xtd { /// @{ /// @brief Notifies a control that it is the default button so that its appearance and behavior is adjusted accordingly. - /// @param value true if the control should behave as a default button; otherwise false. + /// @param value true if the control should behave as a default button; otherwise `false`. /// @remarks This method is called by a parent form to make a control the default button. Default buttons are set to have an extra thick border. virtual void notify_default(bool value) = 0; diff --git a/src/xtd.forms/include/xtd/forms/image_list.hpp b/src/xtd.forms/include/xtd/forms/image_list.hpp index 7cc05da1a6aa..8b73bf92f3c4 100644 --- a/src/xtd.forms/include/xtd/forms/image_list.hpp +++ b/src/xtd.forms/include/xtd/forms/image_list.hpp @@ -68,7 +68,7 @@ namespace xtd { intptr handle() const noexcept; /// @brief Gets a value indicating whether the underlying Win32 handle has been created. - /// @return true if the Handle has been created; otherwise, false. The default is false. + /// @return `true` if the Handle has been created; otherwise, false. The default is false. bool handle_created() const noexcept; /// @brief Gets the xtd::forms::image_list::image_collection for this image list. diff --git a/src/xtd.forms/include/xtd/forms/imessage_filter.hpp b/src/xtd.forms/include/xtd/forms/imessage_filter.hpp index 808b4102470e..0a519bdd11c7 100644 --- a/src/xtd.forms/include/xtd/forms/imessage_filter.hpp +++ b/src/xtd.forms/include/xtd/forms/imessage_filter.hpp @@ -28,7 +28,7 @@ namespace xtd { /// @{ /// @brief Filters out a message before it is dispatched. /// @param m The message to be dispatched. You cannot modify this message. - /// @return true to filter the message and stop it from being dispatched; false to allow the message to continue to the next filter or control. + /// @return `true` to filter the message and stop it from being dispatched; false to allow the message to continue to the next filter or control. /// @remarks Use pre_filter_message to filter out a message before it is dispatched to a control or form. For example, to stop the click event of a button control from being dispatched to the control, you implement the pre_filter_message method and return a true value when the click message occurs. You can also use this method to perform code work that you might need to do before the message is dispatched. virtual bool pre_filter_message(const message& m) = 0; /// @} diff --git a/src/xtd.forms/include/xtd/forms/input_box.hpp b/src/xtd.forms/include/xtd/forms/input_box.hpp index 9501271ff97b..e585a9e9b35c 100644 --- a/src/xtd.forms/include/xtd/forms/input_box.hpp +++ b/src/xtd.forms/include/xtd/forms/input_box.hpp @@ -85,7 +85,7 @@ namespace xtd { /// @param style On of xtd::forms::input_box_style values. The default is xtd::forms::input_box_style::normal /// @param casing On of xtd::forms::character_casing values. The default is xtd::forms::character_casing::normal /// @return ok if the user clicks OK in the dialog box; otherwise, cancel. - /// @param word_wrap true if word_wrap; otherwise false. The default is true. + /// @param word_wrap true if word_wrap; otherwise `false`. The default is true. /// @remarks If dialog_result is ok, the value parameter contains the new chosen value. static xtd::forms::dialog_result show(xtd::string& value, const xtd::forms::iwin32_window& owner, const xtd::string& text, const xtd::string& caption, xtd::forms::input_box_style style, xtd::forms::character_casing casing, bool word_wrap); @@ -136,7 +136,7 @@ namespace xtd { /// @param caption A xtd::string that specifies the caption title of dialog. /// @param style On of xtd::forms::input_box_style values. The default is xtd::forms::input_box_style::normal /// @param casing On of xtd::forms::character_casing values. The default is xtd::forms::character_casing::normal - /// @param word_wrap true if word_wrap; otherwise false. The default is true. + /// @param word_wrap true if word_wrap; otherwise `false`. The default is true. /// @return ok if the user clicks OK in the dialog box; otherwise, cancel. /// @remarks If dialog_result is ok, the value parameter contains the new chosen value. static xtd::forms::dialog_result show(xtd::string& value, const xtd::string& text, const xtd::string& caption, xtd::forms::input_box_style style, xtd::forms::character_casing casing, bool word_wrap); diff --git a/src/xtd.forms/include/xtd/forms/input_dialog.hpp b/src/xtd.forms/include/xtd/forms/input_dialog.hpp index c3330bbf3de6..ffb21fb5dd17 100644 --- a/src/xtd.forms/include/xtd/forms/input_dialog.hpp +++ b/src/xtd.forms/include/xtd/forms/input_dialog.hpp @@ -65,11 +65,11 @@ namespace xtd { input_dialog& dialog_appearance(xtd::forms::dialog_appearance dialog_appearance); /// @brief Gets multiline status. - /// @return true if dialog text box is multiline; otherwise false. + /// @return `true` if dialog text box is multiline; otherwise `false`. /// @remarks The default value is false. bool multiline() const noexcept; /// @brief Sets multiline status. - /// @param multiline true if dialog text box is multiline; otherwise false. + /// @param multiline true if dialog text box is multiline; otherwise `false`. /// @return Current input_dialog instance. /// @remarks The default value is false. input_dialog& multiline(bool multiline); @@ -91,11 +91,11 @@ namespace xtd { input_dialog& text(const xtd::string& text); /// @brief Gets use system password char status. - /// @return true if dialog text box use system password char status; otherwise false. + /// @return `true` if dialog text box use system password char status; otherwise `false`. /// @remarks The default value is false. bool use_system_password_char() const noexcept; /// @brief Sets use system password char status. - /// @param use_system_password_char true if dialog text box use system password char status; otherwise false. + /// @param use_system_password_char true if dialog text box use system password char status; otherwise `false`. /// @return Current input_dialog instance. /// @remarks The default value is false. input_dialog& use_system_password_char(bool use_system_password_char); @@ -109,11 +109,11 @@ namespace xtd { input_dialog& value(const xtd::string& value); /// @brief Gets word wrap status. - /// @return true if dialog text box is word wrap; otherwise false. + /// @return `true` if dialog text box is word wrap; otherwise `false`. /// @remarks The default value is true. bool word_wrap() const noexcept; /// @brief Sets word wrap status. - /// @param word_wrap true if dialog text box is word wrap; otherwise false. + /// @param word_wrap true if dialog text box is word wrap; otherwise `false`. /// @return Current input_dialog instance. /// @remarks The default value is true. input_dialog& word_wrap(bool word_wrap); diff --git a/src/xtd.forms/include/xtd/forms/key_event_args.hpp b/src/xtd.forms/include/xtd/forms/key_event_args.hpp index 7566c3711975..f0a19bc953a0 100644 --- a/src/xtd.forms/include/xtd/forms/key_event_args.hpp +++ b/src/xtd.forms/include/xtd/forms/key_event_args.hpp @@ -43,19 +43,19 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the ALT key was pressed. - /// @return true if the ALT key was pressed; otherwise, false. + /// @return `true` if the ALT key was pressed; otherwise, false. bool alt() const noexcept {return (key_data_ & xtd::forms::keys::alt) == keys::alt;} /// @brief Gets a value indicating whether the CMD key was pressed. - /// @return true if the CMD key was pressed; otherwise, false. + /// @return `true` if the CMD key was pressed; otherwise, false. bool command() const noexcept {return (key_data_ & xtd::forms::keys::command) == keys::command;} /// @brief Gets a value indicating whether the CTRL key was pressed. - /// @return true if the CTRL key was pressed; otherwise, false. + /// @return `true` if the CTRL key was pressed; otherwise, false. bool control() const noexcept {return (key_data_ & xtd::forms::keys::control) == keys::control;} /// @brief Gets a value indicating whether the event was handled. - /// @return true to bypass the control's default handling; otherwise, false to also pass the event along to the default control handler. + /// @return `true` to bypass the control's default handling; otherwise, false to also pass the event along to the default control handler. /// @remarks handled is implemented differently by different controls within xtd.forms. For controls like text_box which subclass native Win32 controls, it is interpreted to mean that the key message should not be passed to the underlying native control. If you set handled to true on a text_box, that control will not pass the key press events to the underlying Win32 text box control, but it will still display the characters that the user typed. bool handled() const noexcept {return handled_;} /// @brief Sets a value indicating whether the event was handled. @@ -81,11 +81,11 @@ namespace xtd { keys modifiers() const noexcept {return key_data_ & xtd::forms::keys::modifiers;} /// @brief Gets a value indicating whether the SHIFT key was pressed. - /// @return true if the SHIFT key was pressed; otherwise, false. + /// @return `true` if the SHIFT key was pressed; otherwise, false. bool shift() const noexcept {return (key_data_ & xtd::forms::keys::shift) == keys::shift;} /// @brief Gets a value indicating whether the key event should be passed on to the underlying control. - /// @return true if the key event should not be sent to the control; otherwise, false. + /// @return `true` if the key event should not be sent to the control; otherwise, false. /// @remarks You can assign true to this property in an event handler such as xtd::forms::control::key_down in order to prevent user input. /// @remarks Setting suppress_key_press to true also sets handled to true. bool suppress_key_press() const noexcept {return suppress_key_press_;} diff --git a/src/xtd.forms/include/xtd/forms/key_press_event_args.hpp b/src/xtd.forms/include/xtd/forms/key_press_event_args.hpp index 857d74a2a8dd..93a4097a48c8 100644 --- a/src/xtd.forms/include/xtd/forms/key_press_event_args.hpp +++ b/src/xtd.forms/include/xtd/forms/key_press_event_args.hpp @@ -46,7 +46,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the xtd::forms::control::key_press event was handled. - /// @return true if the event is handled; otherwise, false. + /// @return `true` if the event is handled; otherwise, false. /// @remarks If the event is not handled, it will be sent to the operating system for default processing. Set handled to true to cancel the xtd::forms::control::key_press event. bool handled() const noexcept {return handled_;} /// @brief Sets a value indicating whether the xtd::forms::control::key_press event was handled. diff --git a/src/xtd.forms/include/xtd/forms/label.hpp b/src/xtd.forms/include/xtd/forms/label.hpp index b8be0177f55b..306741c72209 100644 --- a/src/xtd.forms/include/xtd/forms/label.hpp +++ b/src/xtd.forms/include/xtd/forms/label.hpp @@ -50,7 +50,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the ellipsis character (...) appears at the right edge of the xtd::forms::label, denoting that the xtd::forms::label text extends beyond the specified length of the xtd::forms::label. - /// @return true if the additional label text is to be indicated by an ellipsis; otherwise, false. The default is false. + /// @return `true` if the additional label text is to be indicated by an ellipsis; otherwise, false. The default is false. /// @remarks Set xtd::forms::label::auto_ellipsis to true to display text that extends beyond the width of the xtd::forms::label in a tooltip when the user passes over the control with the mouse. If xtd::forms::label::auto_size is true, the label will grow to fit the text and an ellipsis will not appear. /// @note If the font is taller than the height of the xtd::forms::label and xtd::forms::label::auto_ellipsis is true, you must set xtd::forms::label::auto_size to false for text to be drawn. virtual bool auto_ellipsis() const noexcept; @@ -143,10 +143,10 @@ namespace xtd { virtual xtd::forms::label& image_list(const forms::image_list& value); /// @brief Gets a value that allows to draw a drop shadow under the text. - /// @return true allows to draw a drop shadow under the text; otherwise false. The default is false. + /// @return `true` allows to draw a drop shadow under the text; otherwise `false`. The default is false. virtual bool shadow() const noexcept; /// @brief Sets a value that allows to draw a drop shadow under the text. - /// @param value true allows to draw a drop shadow under the text; otherwise false. The default is false. + /// @param value true allows to draw a drop shadow under the text; otherwise `false`. The default is false. /// @return Current label instance. virtual xtd::forms::label& shadow(bool value); diff --git a/src/xtd.forms/include/xtd/forms/layout/arranged_element_collection.hpp b/src/xtd.forms/include/xtd/forms/layout/arranged_element_collection.hpp index d558e525e7db..42340ed94e67 100644 --- a/src/xtd.forms/include/xtd/forms/layout/arranged_element_collection.hpp +++ b/src/xtd.forms/include/xtd/forms/layout/arranged_element_collection.hpp @@ -212,7 +212,7 @@ namespace xtd { const_reverse_iterator crend() const noexcept {return collection_.crend();} /// @brief Checks whether the container is empty. - /// @return true if container is empty; otherwise false. + /// @return `true` if container is empty; otherwise `false`. bool empty() const noexcept {return collection_.empty();} /// @brief Returns the number of elements. @@ -234,10 +234,10 @@ namespace xtd { void shrink_to_fit() {collection_.shrink_to_fit();} /// @brief Checks whether the container is sorted. - /// @return true if container is sorted; otherwise false. + /// @return `true` if container is sorted; otherwise `false`. virtual bool sorted() const noexcept {return sorted_;} /// @brief Sets the container is sorted. - /// @param value true if container is sorted; otherwise false. + /// @param value true if container is sorted; otherwise `false`. virtual void sorted(bool value) { if (sorted_ != value) { sorted_ = value; diff --git a/src/xtd.forms/include/xtd/forms/lcd_label.hpp b/src/xtd.forms/include/xtd/forms/lcd_label.hpp index 3a97a139d414..90bb1c4baacd 100644 --- a/src/xtd.forms/include/xtd/forms/lcd_label.hpp +++ b/src/xtd.forms/include/xtd/forms/lcd_label.hpp @@ -77,10 +77,10 @@ namespace xtd { lcd_label& back_digit_opacity(double value); /// @brief Gets a value indicate if background digits are shown. - /// @return true if background digits are shown; otherwise false + /// @return `true` if background digits are shown; otherwise `false` bool show_back_digit() const noexcept; /// @brief Sets a value indicate if background digits are shown. - /// @param value true if background digits are shown; otherwise false + /// @param value true if background digits are shown; otherwise `false` /// @return Current lcd_label. lcd_label& show_back_digit(bool value); diff --git a/src/xtd.forms/include/xtd/forms/light_button.hpp b/src/xtd.forms/include/xtd/forms/light_button.hpp index e27af05fdddd..91d1f07e3fca 100644 --- a/src/xtd.forms/include/xtd/forms/light_button.hpp +++ b/src/xtd.forms/include/xtd/forms/light_button.hpp @@ -58,7 +58,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the checked or check_state values and the light_button's appearance are automatically changed when the light_button is clicked. - /// @return true if the checked value or check_state value and the appearance of the control are automatically changed on the click event; otherwise, false. The default value is true. + /// @return `true` if the checked value or check_state value and the appearance of the control are automatically changed on the click event; otherwise, false. The default value is true. /// @remarks If auto_check is set to false, you will need to add code to update the checked or check_state values in the click event handler. /// @par Examples /// The following code example demonstrates the use of light_button auto_check. @@ -70,7 +70,7 @@ namespace xtd { virtual light_button& auto_check(bool auto_check); /// @brief Gets a value indicating whether the light_button is in the checked state. - /// @return true if the light_button is in the checked state; otherwise, false. The default value is false. If the three_state property is set to true, the checked property will return true for either a checked or indeterminate check_state. + /// @return `true` if the light_button is in the checked state; otherwise, false. The default value is false. If the three_state property is set to true, the checked property will return true for either a checked or indeterminate check_state. /// @remarks When the value is true, the light_button portion of the control displays a check mark. If the appearance property is set to button, the control will appear sunken when checked is true and raised like a standard button when false. /// @par Examples /// The following code example demonstrates the use of light_button checked. @@ -143,7 +143,7 @@ namespace xtd { /// @endcond /// @brief Gets a value indicating whether the light_button will allow three check states rather than two. - /// @return true if the light_button is able to display three check states; otherwise, false. The default value is false. + /// @return `true` if the light_button is able to display three check states; otherwise, false. The default value is false. /// @remarks If the three_state property is set to false, the check_state property value can only be set to the indeterminate value of xtd.forms.check_state in code and not by user interaction. /// @par Examples /// The following code example demonstrates the use of light_button three_state. diff --git a/src/xtd.forms/include/xtd/forms/link.hpp b/src/xtd.forms/include/xtd/forms/link.hpp index 68b1b60d3b35..b0ec0538a2f5 100644 --- a/src/xtd.forms/include/xtd/forms/link.hpp +++ b/src/xtd.forms/include/xtd/forms/link.hpp @@ -68,7 +68,7 @@ namespace xtd { link& description(const xtd::string& value); /// @brief Gets a value indicating whether the link is enabled. - /// @return true if the link is enabled; otherwise, false. + /// @return `true` if the link is enabled; otherwise, false. /// @remarks You can use this property to display a link in a disabled state within the xtd::forms::link_label control. When a link is disabled, clicking on the link does not cause the xtd::forms::link_label control to raise the xtd::forms::link_label::link_clicked event. bool enabled() const noexcept; /// @brief Sets a value indicating whether the link is enabled. @@ -124,7 +124,7 @@ namespace xtd { link& tag(std::any value); /// @brief Gets a value indicating whether the user has visited the link. - /// @return true if the link has been visited; otherwise, false. + /// @return `true` if the link has been visited; otherwise, false. /// @remarks A xtd::forms::link_label control does not automatically denote that a link is a visited link. To display the link as a visited link, you can set the value of this property to true in an event handler for the xtd::forms::link_label::link_clicked event of a xtd::forms::link_label. A visited link is displayed using the color specified in the xtd::forms::link_label::visited_link_color property of the xtd::forms::link_label control. Once the form containing the xtd::forms::link_label control is closed, the all display state associated with the link is deleted. In order to retain the display state of the link, you need to store the display state of the link in a registry setting associated with your application. /// @note If you have only one link specified in a xtd::forms::link_label control, you can use the xtd::forms::link_label::link_visited property of the xtd::forms::link_label to specify the link as visited. You can also use the xtd::forms::link_label::link_visited property if you have multiple links defined, but the setting only applies to the first link defined in the control. bool visited() const noexcept; diff --git a/src/xtd.forms/include/xtd/forms/link_area.hpp b/src/xtd.forms/include/xtd/forms/link_area.hpp index 8bb2062af178..877b995d0cf9 100644 --- a/src/xtd.forms/include/xtd/forms/link_area.hpp +++ b/src/xtd.forms/include/xtd/forms/link_area.hpp @@ -45,7 +45,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the LinkArea is empty. - /// @return true if the specified start and length return an empty link area; otherwise, false. + /// @return `true` if the specified start and length return an empty link area; otherwise, false. bool is_empty() const noexcept; /// @brief Gets the number of characters in the link area. diff --git a/src/xtd.forms/include/xtd/forms/link_label_clicked_event_args.hpp b/src/xtd.forms/include/xtd/forms/link_label_clicked_event_args.hpp index c14c1f505eca..3c71ea8eb2af 100644 --- a/src/xtd.forms/include/xtd/forms/link_label_clicked_event_args.hpp +++ b/src/xtd.forms/include/xtd/forms/link_label_clicked_event_args.hpp @@ -49,10 +49,10 @@ namespace xtd { xtd::forms::mouse_buttons button() const noexcept; /// @brief Gets the visited link value. - /// @return true if visited link; otherwise false. + /// @return `true` if visited link; otherwise `false`. bool visited() const noexcept; /// @brief Sets the visited link value. - /// @param value true if visited link; otherwise false. + /// @param value true if visited link; otherwise `false`. void visited(bool value); /// @} diff --git a/src/xtd.forms/include/xtd/forms/list_box.hpp b/src/xtd.forms/include/xtd/forms/list_box.hpp index c34e9bb51ce4..2e1db40d0425 100644 --- a/src/xtd.forms/include/xtd/forms/list_box.hpp +++ b/src/xtd.forms/include/xtd/forms/list_box.hpp @@ -134,7 +134,7 @@ namespace xtd { virtual list_box& selection_mode(forms::selection_mode selection_mode); /// @brief Gets a value indicating whether the items in the list_box are sorted alphabetically. - /// @return true if items in the control are sorted; otherwise, false. The default is false. + /// @return `true` if items in the control are sorted; otherwise, false. The default is false. /// @remarks Use the sorted property to automatically sort strings alphabetically in a list_box. As items are added to a sorted list_box, the items are moved to the appropriate location in the sorted list. When adding items to a list_box, it is more efficient to sort the items first and then add new items. virtual bool sorted() const noexcept; /// @brief Sets a value indicating whether the items in the list_box are sorted alphabetically. diff --git a/src/xtd.forms/include/xtd/forms/list_control.hpp b/src/xtd.forms/include/xtd/forms/list_control.hpp index 0f1cef2da7ee..5b92b6ee9ecc 100644 --- a/src/xtd.forms/include/xtd/forms/list_control.hpp +++ b/src/xtd.forms/include/xtd/forms/list_control.hpp @@ -165,7 +165,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the list enables selection of list items. - /// @return true if the list enables list item selection; otherwise, false. The default is true. + /// @return `true` if the list enables list item selection; otherwise, false. The default is true. virtual bool allow_selection() const noexcept; /// @brief Raises the list_control::selected_index_changed event. diff --git a/src/xtd.forms/include/xtd/forms/loading_indicator.hpp b/src/xtd.forms/include/xtd/forms/loading_indicator.hpp index 0e5c5481f0b4..101f3e66dd05 100644 --- a/src/xtd.forms/include/xtd/forms/loading_indicator.hpp +++ b/src/xtd.forms/include/xtd/forms/loading_indicator.hpp @@ -62,11 +62,11 @@ namespace xtd { virtual xtd::forms::loading_indicator& loading_indicator_style(xtd::forms::loading_indicator_style loading_indicator_style); /// @brief Gets a valiue that indicates if the loading indicator is running. - /// @return true if the loading indicator is running; otherwise false. + /// @return `true` if the loading indicator is running; otherwise `false`. virtual bool running() const noexcept; /// @brief Gets a valiue that indicates if the loading indicator is running. - /// @param value true if the loading indicator is running; otherwise false. + /// @param value true if the loading indicator is running; otherwise `false`. virtual loading_indicator& running(bool value); /// @} diff --git a/src/xtd.forms/include/xtd/forms/loading_indicators.hpp b/src/xtd.forms/include/xtd/forms/loading_indicators.hpp index 9af7235066fc..bbdfc08a248f 100644 --- a/src/xtd.forms/include/xtd/forms/loading_indicators.hpp +++ b/src/xtd.forms/include/xtd/forms/loading_indicators.hpp @@ -48,22 +48,22 @@ namespace xtd { /// @return The created loading indicator. static loading_indicator bar(const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent bar loading indicator with specified and running state. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator bar(bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent bar loading indicator with specified running state, and location. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator bar(bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent bar loading indicator with specified running state, location, and size. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator bar(bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent bar loading indicator with specified running state, location, size, and name. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -93,25 +93,25 @@ namespace xtd { static loading_indicator bar(const control& parent, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent bar loading indicator with specified parent, and running state. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator bar(const control& parent, bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent bar loading indicator with specified parent, running state, and location. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator bar(const control& parent, bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent bar loading indicator with specified parent, running state, location, and size. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator bar(const control& parent, bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent bar loading indicator with specified parent, running state, location, size, and name. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -137,22 +137,22 @@ namespace xtd { /// @return The created loading indicator. static loading_indicator circle_bars(const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent circle_bars loading indicator with specified and running state. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator circle_bars(bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent circle_bars loading indicator with specified running state, and location. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator circle_bars(bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent circle_bars loading indicator with specified running state, location, and size. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator circle_bars(bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent circle_bars loading indicator with specified running state, location, size, and name. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -182,25 +182,25 @@ namespace xtd { static loading_indicator circle_bars(const control& parent, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent circle_bars loading indicator with specified parent, and running state. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator circle_bars(const control& parent, bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent circle_bars loading indicator with specified parent, running state, and location. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator circle_bars(const control& parent, bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent circle_bars loading indicator with specified parent, running state, location, and size. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator circle_bars(const control& parent, bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent circle_bars loading indicator with specified parent, running state, location, size, and name. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -226,22 +226,22 @@ namespace xtd { /// @return The created loading indicator. static loading_indicator circle_blinks(const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent circle_blinks loading indicator with specified and running state. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator circle_blinks(bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent circle_blinks loading indicator with specified running state, and location. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator circle_blinks(bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent circle_blinks loading indicator with specified running state, location, and size. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator circle_blinks(bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent circle_blinks loading indicator with specified running state, location, size, and name. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -271,25 +271,25 @@ namespace xtd { static loading_indicator circle_blinks(const control& parent, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent circle_blinks loading indicator with specified parent, and running state. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator circle_blinks(const control& parent, bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent circle_blinks loading indicator with specified parent, running state, and location. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator circle_blinks(const control& parent, bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent circle_blinks loading indicator with specified parent, running state, location, and size. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator circle_blinks(const control& parent, bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent circle_blinks loading indicator with specified parent, running state, location, size, and name. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -315,22 +315,22 @@ namespace xtd { /// @return The created loading indicator. static loading_indicator five_lines_center(const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_center loading indicator with specified and running state. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator five_lines_center(bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_center loading indicator with specified running state, and location. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator five_lines_center(bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_center loading indicator with specified running state, location, and size. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator five_lines_center(bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_center loading indicator with specified running state, location, size, and name. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -360,25 +360,25 @@ namespace xtd { static loading_indicator five_lines_center(const control& parent, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_center loading indicator with specified parent, and running state. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator five_lines_center(const control& parent, bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_center loading indicator with specified parent, running state, and location. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator five_lines_center(const control& parent, bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_center loading indicator with specified parent, running state, location, and size. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator five_lines_center(const control& parent, bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_center loading indicator with specified parent, running state, location, size, and name. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -404,22 +404,22 @@ namespace xtd { /// @return The created loading indicator. static loading_indicator five_lines_chronological(const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_chronological loading indicator with specified and running state. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator five_lines_chronological(bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_chronological loading indicator with specified running state, and location. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator five_lines_chronological(bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_chronological loading indicator with specified running state, location, and size. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator five_lines_chronological(bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_chronological loading indicator with specified running state, location, size, and name. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -449,25 +449,25 @@ namespace xtd { static loading_indicator five_lines_chronological(const control& parent, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_chronological loading indicator with specified parent, and running state. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator five_lines_chronological(const control& parent, bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_chronological loading indicator with specified parent, running state, and location. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator five_lines_chronological(const control& parent, bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_chronological loading indicator with specified parent, running state, location, and size. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator five_lines_chronological(const control& parent, bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_chronological loading indicator with specified parent, running state, location, size, and name. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -493,22 +493,22 @@ namespace xtd { /// @return The created loading indicator. static loading_indicator five_lines_pulse(const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_pulse loading indicator with specified and running state. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator five_lines_pulse(bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_pulse loading indicator with specified running state, and location. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator five_lines_pulse(bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_pulse loading indicator with specified running state, location, and size. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator five_lines_pulse(bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_pulse loading indicator with specified running state, location, size, and name. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -538,25 +538,25 @@ namespace xtd { static loading_indicator five_lines_pulse(const control& parent, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_pulse loading indicator with specified parent, and running state. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator five_lines_pulse(const control& parent, bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_pulse loading indicator with specified parent, running state, and location. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator five_lines_pulse(const control& parent, bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_pulse loading indicator with specified parent, running state, location, and size. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator five_lines_pulse(const control& parent, bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_pulse loading indicator with specified parent, running state, location, size, and name. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -582,22 +582,22 @@ namespace xtd { /// @return The created loading indicator. static loading_indicator five_lines_wave(const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_wave loading indicator with specified and running state. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator five_lines_wave(bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_wave loading indicator with specified running state, and location. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator five_lines_wave(bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_wave loading indicator with specified running state, location, and size. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator five_lines_wave(bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_wave loading indicator with specified running state, location, size, and name. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -627,25 +627,25 @@ namespace xtd { static loading_indicator five_lines_wave(const control& parent, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_wave loading indicator with specified parent, and running state. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator five_lines_wave(const control& parent, bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_wave loading indicator with specified parent, running state, and location. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator five_lines_wave(const control& parent, bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_wave loading indicator with specified parent, running state, location, and size. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator five_lines_wave(const control& parent, bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines_wave loading indicator with specified parent, running state, location, size, and name. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -671,22 +671,22 @@ namespace xtd { /// @return The created loading indicator. static loading_indicator five_lines(const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines loading indicator with specified and running state. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator five_lines(bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines loading indicator with specified running state, and location. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator five_lines(bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines loading indicator with specified running state, location, and size. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator five_lines(bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines loading indicator with specified running state, location, size, and name. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -716,25 +716,25 @@ namespace xtd { static loading_indicator five_lines(const control& parent, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines loading indicator with specified parent, and running state. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator five_lines(const control& parent, bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines loading indicator with specified parent, running state, and location. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator five_lines(const control& parent, bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines loading indicator with specified parent, running state, location, and size. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator five_lines(const control& parent, bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent five_lines loading indicator with specified parent, running state, location, size, and name. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -760,22 +760,22 @@ namespace xtd { /// @return The created loading indicator. static loading_indicator pulse(const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent pulse loading indicator with specified and running state. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator pulse(bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent pulse loading indicator with specified running state, and location. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator pulse(bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent pulse loading indicator with specified running state, location, and size. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator pulse(bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent pulse loading indicator with specified running state, location, size, and name. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -805,25 +805,25 @@ namespace xtd { static loading_indicator pulse(const control& parent, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent pulse loading indicator with specified parent, and running state. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator pulse(const control& parent, bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent pulse loading indicator with specified parent, running state, and location. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator pulse(const control& parent, bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent pulse loading indicator with specified parent, running state, location, and size. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator pulse(const control& parent, bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent pulse loading indicator with specified parent, running state, location, size, and name. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -849,22 +849,22 @@ namespace xtd { /// @return The created loading indicator. static loading_indicator pulse_outline(const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent pulse_outline loading indicator with specified and running state. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator pulse_outline(bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent pulse_outline loading indicator with specified running state, and location. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator pulse_outline(bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent pulse_outline loading indicator with specified running state, location, and size. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator pulse_outline(bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent pulse_outline loading indicator with specified running state, location, size, and name. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -894,25 +894,25 @@ namespace xtd { static loading_indicator pulse_outline(const control& parent, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent pulse_outline loading indicator with specified parent, and running state. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator pulse_outline(const control& parent, bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent pulse_outline loading indicator with specified parent, running state, and location. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator pulse_outline(const control& parent, bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent pulse_outline loading indicator with specified parent, running state, location, and size. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator pulse_outline(const control& parent, bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent pulse_outline loading indicator with specified parent, running state, location, size, and name. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -938,22 +938,22 @@ namespace xtd { /// @return The created loading indicator. static loading_indicator standard(const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent standard loading indicator with specified and running state. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator standard(bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent standard loading indicator with specified running state, and location. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator standard(bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent standard loading indicator with specified running state, location, and size. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator standard(bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent standard loading indicator with specified running state, location, size, and name. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -983,25 +983,25 @@ namespace xtd { static loading_indicator standard(const control& parent, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent standard loading indicator with specified parent, and running state. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator standard(const control& parent, bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent standard loading indicator with specified parent, running state, and location. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator standard(const control& parent, bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent standard loading indicator with specified parent, running state, location, and size. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator standard(const control& parent, bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent standard loading indicator with specified parent, running state, location, size, and name. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -1027,22 +1027,22 @@ namespace xtd { /// @return The created loading indicator. static loading_indicator system(const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent system loading indicator with specified and running state. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator system(bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent system loading indicator with specified running state, and location. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator system(bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent system loading indicator with specified running state, location, and size. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator system(bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent system loading indicator with specified running state, location, size, and name. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -1072,25 +1072,25 @@ namespace xtd { static loading_indicator system(const control& parent, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent system loading indicator with specified parent, and running state. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator system(const control& parent, bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent system loading indicator with specified parent, running state, and location. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator system(const control& parent, bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent system loading indicator with specified parent, running state, location, and size. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator system(const control& parent, bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent system loading indicator with specified parent, running state, location, size, and name. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -1116,22 +1116,22 @@ namespace xtd { /// @return The created loading indicator. static loading_indicator three_balls(const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls loading indicator with specified and running state. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator three_balls(bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls loading indicator with specified running state, and location. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator three_balls(bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls loading indicator with specified running state, location, and size. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator three_balls(bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls loading indicator with specified running state, location, size, and name. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -1161,25 +1161,25 @@ namespace xtd { static loading_indicator three_balls(const control& parent, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls loading indicator with specified parent, and running state. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator three_balls(const control& parent, bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls loading indicator with specified parent, running state, and location. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator three_balls(const control& parent, bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls loading indicator with specified parent, running state, location, and size. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator three_balls(const control& parent, bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls loading indicator with specified parent, running state, location, size, and name. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -1205,22 +1205,22 @@ namespace xtd { /// @return The created loading indicator. static loading_indicator three_balls_bouncing(const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls_bouncing loading indicator with specified and running state. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator three_balls_bouncing(bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls_bouncing loading indicator with specified running state, and location. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator three_balls_bouncing(bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls_bouncing loading indicator with specified running state, location, and size. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator three_balls_bouncing(bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls_bouncing loading indicator with specified running state, location, size, and name. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -1250,25 +1250,25 @@ namespace xtd { static loading_indicator three_balls_bouncing(const control& parent, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls_bouncing loading indicator with specified parent, and running state. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator three_balls_bouncing(const control& parent, bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls_bouncing loading indicator with specified parent, running state, and location. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator three_balls_bouncing(const control& parent, bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls_bouncing loading indicator with specified parent, running state, location, and size. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator three_balls_bouncing(const control& parent, bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls_bouncing loading indicator with specified parent, running state, location, size, and name. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -1294,22 +1294,22 @@ namespace xtd { /// @return The created loading indicator. static loading_indicator three_balls_rotation(const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls_rotation loading indicator with specified and running state. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator three_balls_rotation(bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls_rotation loading indicator with specified running state, and location. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator three_balls_rotation(bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls_rotation loading indicator with specified running state, location, and size. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator three_balls_rotation(bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls_rotation loading indicator with specified running state, location, size, and name. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. @@ -1339,25 +1339,25 @@ namespace xtd { static loading_indicator three_balls_rotation(const control& parent, const xtd::drawing::point& location, const xtd::drawing::size& size, const xtd::string& name) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls_rotation loading indicator with specified parent, and running state. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @return The created loading indicator. static loading_indicator three_balls_rotation(const control& parent, bool running) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls_rotation loading indicator with specified parent, running state, and location. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @return The created loading indicator. static loading_indicator three_balls_rotation(const control& parent, bool running, const xtd::drawing::point& location) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls_rotation loading indicator with specified parent, running state, location, and size. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @return The created loading indicator. static loading_indicator three_balls_rotation(const control& parent, bool running, const xtd::drawing::point& location, const xtd::drawing::size& size) noexcept; /// @brief Create a system-defined xtd::forms::loading_indicator that represent three_balls_rotation loading indicator with specified parent, running state, location, size, and name. /// @param parent The control that contains the loading indicator. - /// @param running true if the loading indicator is running; otherwise false. + /// @param running true if the loading indicator is running; otherwise `false`. /// @param location The loading indicator location in pixels. /// @param size The loading indicator size in pixels. /// @param name The name of the loading indicator. diff --git a/src/xtd.forms/include/xtd/forms/menu.hpp b/src/xtd.forms/include/xtd/forms/menu.hpp index af69436c24a8..f44e6e5af738 100644 --- a/src/xtd.forms/include/xtd/forms/menu.hpp +++ b/src/xtd.forms/include/xtd/forms/menu.hpp @@ -66,7 +66,7 @@ namespace xtd { intptr handle() const noexcept; /// @brief Gets a value indicating whether this menu contains any menu items. - /// @return true if this menu contains menu_item objects; otherwise, false. The default is false. + /// @return `true` if this menu contains menu_item objects; otherwise, false. The default is false. virtual bool is_parent() const noexcept; /// @brief Gets a value indicating the menu_item that is used to display a list of multiple document interface (MDI) child forms. diff --git a/src/xtd.forms/include/xtd/forms/menu_item.hpp b/src/xtd.forms/include/xtd/forms/menu_item.hpp index d139c723a042..a1be27b184e0 100644 --- a/src/xtd.forms/include/xtd/forms/menu_item.hpp +++ b/src/xtd.forms/include/xtd/forms/menu_item.hpp @@ -263,7 +263,7 @@ namespace xtd { intptr menu_id() const noexcept; /// @brief Gets a value indicating whether a check mark appears next to the text of the menu item. - /// @return true if there is a check mark next to the menu item; otherwise, false. The default is false. + /// @return `true` if there is a check mark next to the menu item; otherwise, false. The default is false. bool checked() const noexcept; /// @brief Sets a value indicating whether a check mark appears next to the text of the menu item. /// @param value true if there is a check mark next to the menu item; otherwise, false. The default is false. @@ -271,7 +271,7 @@ namespace xtd { menu_item& checked(bool value); /// @brief Gets a value indicating whether the menu item is enabled. - /// @return true if the menu item is enabled; otherwise, false. The default is true. + /// @return `true` if the menu item is enabled; otherwise, false. The default is true. bool enabled() const noexcept; /// @brief Gets a value indicating whether the menu item is enabled. /// @param value true if the menu item is enabled; otherwise, false. The default is true. diff --git a/src/xtd.forms/include/xtd/forms/message_dialog.hpp b/src/xtd.forms/include/xtd/forms/message_dialog.hpp index 8d7cf0f05ba2..b667c92f79d0 100644 --- a/src/xtd.forms/include/xtd/forms/message_dialog.hpp +++ b/src/xtd.forms/include/xtd/forms/message_dialog.hpp @@ -70,7 +70,7 @@ namespace xtd { message_dialog& default_button(xtd::forms::message_dialog_default_button default_button); /// @brief Gets a value indicate if help button is shown. - /// @return true to show the Help button; otherwise, false. The default is false. + /// @return `true` to show the Help button; otherwise, false. The default is false. bool display_help_button() const noexcept; /// @brief Sets a value indicate if help button is shown. /// @param display_help_button true to show the Help button; otherwise, false. The default is false. diff --git a/src/xtd.forms/include/xtd/forms/message_loop_callback.hpp b/src/xtd.forms/include/xtd/forms/message_loop_callback.hpp index d2ea1a01930e..d9b44d125138 100644 --- a/src/xtd.forms/include/xtd/forms/message_loop_callback.hpp +++ b/src/xtd.forms/include/xtd/forms/message_loop_callback.hpp @@ -18,7 +18,7 @@ namespace xtd { /// @par Library /// xtd.forms /// @ingroup xtd_forms events - /// @return true if the hosting environment is still sending messages; otherwise, false. + /// @return `true` if the hosting environment is still sending messages; otherwise, false. /// @remarks This delegate is used with the application::register_message_loop method. using message_loop_callback = delegate; } diff --git a/src/xtd.forms/include/xtd/forms/month_calendar.hpp b/src/xtd.forms/include/xtd/forms/month_calendar.hpp index 06db5920272e..c03f49533eb3 100644 --- a/src/xtd.forms/include/xtd/forms/month_calendar.hpp +++ b/src/xtd.forms/include/xtd/forms/month_calendar.hpp @@ -241,7 +241,7 @@ namespace xtd { month_calendar& selection_start(xtd::date_time value); /// @brief Gets a value indicating whether the date represented by the xtd::today_date property is displayed at the bottom of the control. - /// @return true if today's date is displayed; otherwise, false. The default is true. + /// @return `true` if today's date is displayed; otherwise, false. The default is true. /// @remarks The date is displayed in the format specified by the system settings for the short date format. bool show_today() const noexcept; /// @brief Sets a value indicating whether the date represented by the xtd::today_date property is displayed at the bottom of the control. @@ -251,7 +251,7 @@ namespace xtd { month_calendar& show_today(bool value); /// @brief Gets a value indicating whether today's date is identified with a circle or a square. - /// @return true if today's date is identified with a circle or a square; otherwise, false. The default is true. + /// @return `true` if today's date is identified with a circle or a square; otherwise, false. The default is true. /// @remarks If xtd::forms::month_calendar::show_today_circle is true, and visual styles are enabled and supported on the computer running the application, today's date will be enclosed in a square, otherwise today's date will be circled. bool show_today_circle() const noexcept; /// @brief Sets a value indicating whether today's date is identified with a circle or a square. @@ -261,7 +261,7 @@ namespace xtd { month_calendar& show_today_circle(bool value); /// @brief Gets a value indicating whether the month calendar control displays week numbers (1-52) to the left of each row of days. - /// @return true if the week numbers are displayed; otherwise, false. The default is false. + /// @return `true` if the week numbers are displayed; otherwise, false. The default is false. bool show_week_numbers() const noexcept; /// @brief Sets a value indicating whether the month calendar control displays week numbers (1-52) to the left of each row of days. /// @param value true if the week numbers are displayed; otherwise, false. The default is false. @@ -302,7 +302,7 @@ namespace xtd { month_calendar& today_date(const xtd::date_time& value); /// @brief Gets a value indicating whether the xtd::forms::month_calendar::today_date property has been explicitly set. - /// @return true if the value for the xtd::forms::month_calendar::today_date property has been explicitly set; otherwise, false. The default is false. + /// @return `true` if the value for the xtd::forms::month_calendar::today_date property has been explicitly set; otherwise, false. The default is false. bool today_date_set() const noexcept; /// @brief Gets a value indicating the color of days in months that are not fully displayed in the control. diff --git a/src/xtd.forms/include/xtd/forms/nine_segment_display.hpp b/src/xtd.forms/include/xtd/forms/nine_segment_display.hpp index ab692c274702..dc737f4828ef 100644 --- a/src/xtd.forms/include/xtd/forms/nine_segment_display.hpp +++ b/src/xtd.forms/include/xtd/forms/nine_segment_display.hpp @@ -93,25 +93,25 @@ namespace xtd { static nine_segment_display create(xtd::forms::segments segments, const drawing::point& location, const drawing::size& size, const xtd::string& name); /// @brief A factory to create an xtd::forms::nine_segment_display with specified segments, and back_segment visibility. /// @param segments A dots_collection that represent all dots status. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @return New xtd::forms::nine_segment_display created. static nine_segment_display create(xtd::forms::segments segments, bool show_back_segment); /// @brief A factory to create an xtd::forms::nine_segment_display with specified segments, back_segment visibility, and location. /// @param segments A dots_collection that represent all dots status. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::nine_segment_display. /// @return New xtd::forms::nine_segment_display created. static nine_segment_display create(xtd::forms::segments segments, bool show_back_segment, const drawing::point& location); /// @brief A factory to create an xtd::forms::nine_segment_display with specified segments, back_segment visibility, location, and size. /// @param segments A dots_collection that represent all dots status. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::nine_segment_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::nine_segment_display. /// @return New xtd::forms::nine_segment_display created. static nine_segment_display create(xtd::forms::segments segments, bool show_back_segment, const drawing::point& location, const drawing::size& size); /// @brief A factory to create an xtd::forms::nine_segment_display with specified segments, back_segment visibility, location, size, and name. /// @param segments A dots_collection that represent all dots status. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::nine_segment_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::nine_segment_display. /// @param name The name of the xtd::forms::nine_segment_display. @@ -168,20 +168,20 @@ namespace xtd { /// @brief A factory to create an xtd::forms::nine_segment_display with specified parent, segments, and back_segment visibility. /// @param parent The parent that contains the new created xtd::forms::nine_segment_display. /// @param segments A xtd::forms::segments combination that represent nine_segment_display. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @return New xtd::forms::nine_segment_display created. static nine_segment_display create(const control& parent, xtd::forms::segments segments, bool show_back_segment); /// @brief A factory to create an xtd::forms::nine_segment_display with specified parent, segments, back_segment visibility, and location. /// @param parent The parent that contains the new created xtd::forms::nine_segment_display. /// @param segments A xtd::forms::segments combination that represent nine_segment_display. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::nine_segment_display. /// @return New xtd::forms::nine_segment_display created. static nine_segment_display create(const control& parent, xtd::forms::segments segments, bool show_back_segment, const drawing::point& location); /// @brief A factory to create an xtd::forms::nine_segment_display with specified parent, segments, back_segment visibility, location, and size. /// @param parent The parent that contains the new created xtd::forms::nine_segment_display. /// @param segments A xtd::forms::segments combination that represent nine_segment_display. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::nine_segment_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::nine_segment_display. /// @return New xtd::forms::nine_segment_display created. @@ -189,7 +189,7 @@ namespace xtd { /// @brief A factory to create an xtd::forms::nine_segment_display with specified parent, segments, back_segment visibility, location, size, and name. /// @param parent The parent that contains the new created xtd::forms::nine_segment_display. /// @param segments A xtd::forms::segments combination that represent nine_segment_display. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::nine_segment_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::nine_segment_display. /// @param name The name of the xtd::forms::nine_segment_display. diff --git a/src/xtd.forms/include/xtd/forms/numeric_up_down.hpp b/src/xtd.forms/include/xtd/forms/numeric_up_down.hpp index b15c3fb36069..778034c39277 100644 --- a/src/xtd.forms/include/xtd/forms/numeric_up_down.hpp +++ b/src/xtd.forms/include/xtd/forms/numeric_up_down.hpp @@ -96,10 +96,10 @@ namespace xtd { virtual numeric_up_down& value(double value); /// @brief Gets a value indicate if value can be wrapped. - /// @return true if value can be wrapped; otherwise false. The default is false. + /// @return `true` if value can be wrapped; otherwise `false`. The default is false. virtual bool wrapped() const noexcept; /// @brief Sets a value indicate if value can be wrapped. - /// @param value true if value can be wrapped; otherwise false. The default is false. + /// @param value true if value can be wrapped; otherwise `false`. The default is false. /// @return Current numeric_up_down. virtual numeric_up_down& wrapped(bool value); /// @} diff --git a/src/xtd.forms/include/xtd/forms/open_file_dialog.hpp b/src/xtd.forms/include/xtd/forms/open_file_dialog.hpp index 17d3947ddc3c..67c5c1b8bffb 100644 --- a/src/xtd.forms/include/xtd/forms/open_file_dialog.hpp +++ b/src/xtd.forms/include/xtd/forms/open_file_dialog.hpp @@ -44,7 +44,7 @@ namespace xtd { std::ifstream open_file() const noexcept; /// @brief Gets a value indicating whether the dialog box allows multiple files to be selected. - /// @return true if the dialog box allows multiple files to be selected together or concurrently; otherwise, false. The default value is false. + /// @return `true` if the dialog box allows multiple files to be selected together or concurrently; otherwise, false. The default value is false. /// @remarks Use the file_names property to access the full list of selected file names. virtual bool multiselect() const noexcept; /// @brief Sets a value indicating whether the dialog box allows multiple files to be selected. diff --git a/src/xtd.forms/include/xtd/forms/progress_box.hpp b/src/xtd.forms/include/xtd/forms/progress_box.hpp index 2470f4db0e38..6b6f79c7ff19 100644 --- a/src/xtd.forms/include/xtd/forms/progress_box.hpp +++ b/src/xtd.forms/include/xtd/forms/progress_box.hpp @@ -34,10 +34,10 @@ namespace xtd { /// @{ /// @brief Check if the progress dialog is canceled - /// @return true if the progress dialog is canceled + /// @return `true` if the progress dialog is canceled static bool cancelled(); /// @brief Check if the progress dialog is skipped - /// @return true if the progress dialog is skipped + /// @return `true` if the progress dialog is skipped static bool skipped(); /// @brief Gets the minimum value of the range of the progress dialog. /// @return The minimum value of the range. The default is 0. diff --git a/src/xtd.forms/include/xtd/forms/progress_dialog.hpp b/src/xtd.forms/include/xtd/forms/progress_dialog.hpp index 28377cb42810..315006f92cae 100644 --- a/src/xtd.forms/include/xtd/forms/progress_dialog.hpp +++ b/src/xtd.forms/include/xtd/forms/progress_dialog.hpp @@ -47,7 +47,7 @@ namespace xtd { /// @{ /// @brief Gets whether user has clicked on cancel button. - /// @return true if user has clicked on cancel button; otherwise false. + /// @return `true` if user has clicked on cancel button; otherwise `false`. bool cancelled() const; /// @brief Gets the dialog appearance. @@ -67,10 +67,10 @@ namespace xtd { progress_dialog& informations(const std::vector& informations); /// @brief Gets a value that Indicates progress by continuously scrolling a block across a progress_bar in a marquee fashion. - /// @return tree is marquee; otherwise false. The default is false. + /// @return tree is marquee; otherwise `false`. The default is false. bool marquee() const noexcept; /// @brief Gets a value that Indicates progress by continuously scrolling a block across a progress_bar in a marquee fashion. - /// @param marquee tree is marquee; otherwise false. The default is false. + /// @param marquee tree is marquee; otherwise `false`. The default is false. /// @return Current progress_dialog instance. progress_dialog& marquee(bool marquee); @@ -115,47 +115,47 @@ namespace xtd { progress_dialog& minimum(int32 minimum); /// @brief Gets a value that indicates whether cancel button is shown. - /// @return true if cancel button shown; otherwise false. By default false. + /// @return `true` if cancel button shown; otherwise `false`. By default false. bool show_cancel_button() const noexcept; /// @brief Sets a value that indicates whether cancel button is shown. - /// @param show_cancel_button true if cancel button is shown; otherwise false. By default false. + /// @param show_cancel_button true if cancel button is shown; otherwise `false`. By default false. /// @return Current progress_dialog instance. progress_dialog& show_cancel_button(bool show_cancel_button); /// @brief Gets a value that indicates whether elapsed time is shown. - /// @return true if elapsed time is shown; otherwise false. By default false. + /// @return `true` if elapsed time is shown; otherwise `false`. By default false. bool show_elapsed_time() const noexcept; /// @brief Sets a value that indicates whether elapsed time is shown. - /// @param show_elapsed_time true if elapsed time is shown; otherwise false. By default false. + /// @param show_elapsed_time true if elapsed time is shown; otherwise `false`. By default false. /// @return Current progress_dialog instance. progress_dialog& show_elapsed_time(bool show_elapsed_time); /// @brief Gets a value that indicates whether estimated time is shown. - /// @return true if estimated time is shown; otherwise false. By default false. + /// @return `true` if estimated time is shown; otherwise `false`. By default false. bool show_estimated_time() const noexcept; /// @brief Sets a value that indicates whether estimated time is shown. - /// @param show_estimated_time true if estimated time is shown; otherwise false. By default false. + /// @param show_estimated_time true if estimated time is shown; otherwise `false`. By default false. /// @return Current progress_dialog instance. progress_dialog& show_estimated_time(bool show_estimated_time); /// @brief Gets a value that indicates whether remaining time is shown. - /// @return true if remaining time is shown; otherwise false. By default false. + /// @return `true` if remaining time is shown; otherwise `false`. By default false. bool show_remaining_time() const noexcept; /// @brief Sets a value that indicates whether remaining time is shown. - /// @param show_remaining_time true if remaining time is shown; otherwise false. By default false. + /// @param show_remaining_time true if remaining time is shown; otherwise `false`. By default false. /// @return Current progress_dialog instance. progress_dialog& show_remaining_time(bool show_remaining_time); /// @brief Gets a value that indicates whether skip button is shown. - /// @return true if skip button shown; otherwise false. By default false. + /// @return `true` if skip button shown; otherwise `false`. By default false. bool show_skip_button() const noexcept; /// @brief Sets a value that indicates whether skip button is shown. - /// @param show_skip_button true if skip button is shown; otherwise false. By default false. + /// @param show_skip_button true if skip button is shown; otherwise `false`. By default false. /// @return Current progress_dialog instance. progress_dialog& show_skip_button(bool show_skip_button); /// @brief Gets whether user has clicked on skip button. - /// @return true if user has clicked on skip button; otherwise false. + /// @return `true` if user has clicked on skip button; otherwise `false`. bool skipped() const; /// @brief Gets the amount by which a call to the PerformStep() method increases the current position of the progress bar. diff --git a/src/xtd.forms/include/xtd/forms/radio_button.hpp b/src/xtd.forms/include/xtd/forms/radio_button.hpp index 1f55e9af4e67..7247ddd24c5d 100644 --- a/src/xtd.forms/include/xtd/forms/radio_button.hpp +++ b/src/xtd.forms/include/xtd/forms/radio_button.hpp @@ -63,7 +63,7 @@ namespace xtd { virtual radio_button& appearance(forms::appearance appearance); /// @brief Gets a value indicating whether the checked value and the appearance of the control automatically change when the control is clicked. - /// @return true if the checked value and the appearance of the control automatically change on the click event; otherwise, false. The default value is true. + /// @return `true` if the checked value and the appearance of the control automatically change on the click event; otherwise, false. The default value is true. /// @remarks If the checked value is set to false, the radio_button portion of the control must be checked in code in the click event handler. In addition, if the radio_button is part of a radio_button control group, this property ensures that only one of the controls is checked at a given time. /// @remarks If the auto_check property is set to false, a group of radio_button controls will not act as a mutually exclusive group and the checked property must be updated in code. virtual bool auto_check() const noexcept; @@ -75,7 +75,7 @@ namespace xtd { virtual radio_button& auto_check(bool auto_check); /// @brief Gets a value indicating whether the control is checked. - /// @return true if the check box is checked; otherwise, false. + /// @return `true` if the check box is checked; otherwise, false. virtual bool checked() const noexcept; /// @brief Sets a value indicating whether the control is checked. /// @param checked true if the check box is checked; otherwise, false. diff --git a/src/xtd.forms/include/xtd/forms/replace_box.hpp b/src/xtd.forms/include/xtd/forms/replace_box.hpp index 694c914050e7..7c16cbb4b2bd 100644 --- a/src/xtd.forms/include/xtd/forms/replace_box.hpp +++ b/src/xtd.forms/include/xtd/forms/replace_box.hpp @@ -76,7 +76,7 @@ namespace xtd { /// @param find_string The string to find. /// @param replace_string The replaced string. /// @param title The find dialog title. - /// @param match_case true if match case option selected; otherwise false. + /// @param match_case true if match case option selected; otherwise `false`. /// @param find_next The callback called when the user click the find button. /// @param replace The callback called when the user click the replace button. /// @param replace_all The callback called when the user click the replace all button. @@ -88,8 +88,8 @@ namespace xtd { /// @param find_string The string to find. /// @param replace_string The replaced string. /// @param title The find dialog title. - /// @param match_case true if match case option selected; otherwise false. - /// @param whole_word true if whole word option selected; otherwise false. + /// @param match_case true if match case option selected; otherwise `false`. + /// @param whole_word true if whole word option selected; otherwise `false`. /// @param find_next The callback called when the user click the find button. /// @param replace The callback called when the user click the replace button. /// @param replace_all The callback called when the user click the replace all button. diff --git a/src/xtd.forms/include/xtd/forms/replace_dialog.hpp b/src/xtd.forms/include/xtd/forms/replace_dialog.hpp index 6db1ad4d59ac..d6010a70f303 100644 --- a/src/xtd.forms/include/xtd/forms/replace_dialog.hpp +++ b/src/xtd.forms/include/xtd/forms/replace_dialog.hpp @@ -78,26 +78,26 @@ namespace xtd { replace_dialog& location(const xtd::drawing::point& value); /// @brief Gets the match case value. - /// @return true if match case option selected; otherwise false. The default is false. + /// @return `true` if match case option selected; otherwise `false`. The default is false. bool match_case() const noexcept; /// @brief Sets the match case value. - /// @param value true if match case option selected; otherwise false. The default is false. + /// @param value true if match case option selected; otherwise `false`. The default is false. /// @return Current replace_dialog instance. replace_dialog& match_case(bool value); /// @brief Gets a value that indicates whether match case option is shown. - /// @return true if match case option is shown; otherwise false. The default is true. + /// @return `true` if match case option is shown; otherwise `false`. The default is true. bool show_match_case() const noexcept; /// @brief Sets a value that indicates whether match case option is shown. - /// @param value true if match case option is shown; otherwise false. The default is true. + /// @param value true if match case option is shown; otherwise `false`. The default is true. /// @return Current replace_dialog instance. replace_dialog& show_match_case(bool value); /// @brief Gets a value that indicates whether whole word option is shown. - /// @return true if whole word option is shown; otherwise false. The default is true. + /// @return `true` if whole word option is shown; otherwise `false`. The default is true. bool show_whole_word() const noexcept; /// @brief Sets a value that indicates whether whole word option is shown. - /// @param value true if whole word option is shown; otherwise false. The default is true. + /// @param value true if whole word option is shown; otherwise `false`. The default is true. /// @return Current replace_dialog instance. replace_dialog& show_whole_word(bool value); @@ -110,10 +110,10 @@ namespace xtd { replace_dialog& title(const xtd::string& value); /// @brief Gets the whole word value. - /// @return true if whole word option selected; otherwise false. The default is false. + /// @return `true` if whole word option selected; otherwise `false`. The default is false. bool whole_word() const noexcept; /// @brief Sets the whole word value. - /// @param value true if whole word option selected; otherwise false. The default is false. + /// @param value true if whole word option selected; otherwise `false`. The default is false. /// @return Current replace_dialog instance. replace_dialog& whole_word(bool value); /// @} diff --git a/src/xtd.forms/include/xtd/forms/replace_event_args.hpp b/src/xtd.forms/include/xtd/forms/replace_event_args.hpp index e31507ef3c61..dca3ae6bfa60 100644 --- a/src/xtd.forms/include/xtd/forms/replace_event_args.hpp +++ b/src/xtd.forms/include/xtd/forms/replace_event_args.hpp @@ -30,7 +30,7 @@ namespace xtd { /// @brief Initializes a new instance of the xtd::forms::replace_event_args class. /// @param find_string The string to find. /// @param replace_string A string that specifies the replaced text. - /// @param match_case true if match case option selected; otherwise false. + /// @param match_case true if match case option selected; otherwise `false`. /// @param whole_word One of xtd::forms::search_direction values. replace_event_args(const xtd::string& find_string, const xtd::string& replace_string, bool match_case, bool whole_word) : find_string_(find_string), replace_string_(replace_string), match_case_(match_case), whole_word_(whole_word) {} /// @} @@ -52,11 +52,11 @@ namespace xtd { const xtd::string& replace_string() const noexcept {return replace_string_;} /// @brief Gets the match case value. - /// @return true if match case option selected; otherwise false. The default is false. + /// @return `true` if match case option selected; otherwise `false`. The default is false. bool match_case() const noexcept {return match_case_;} /// @brief Gets the whole word value. - /// @return true if whole word option selected; otherwise false. The default is false. + /// @return `true` if whole word option selected; otherwise `false`. The default is false. bool whole_word() const noexcept {return whole_word_;} /// @} diff --git a/src/xtd.forms/include/xtd/forms/screen.hpp b/src/xtd.forms/include/xtd/forms/screen.hpp index 9aa30af57a84..bb6ba22329e1 100644 --- a/src/xtd.forms/include/xtd/forms/screen.hpp +++ b/src/xtd.forms/include/xtd/forms/screen.hpp @@ -54,7 +54,7 @@ namespace xtd { const xtd::string& device_name() const; /// @brief Gets a value indicating whether a particular display is high resolution. - /// @return true if this display is high resolution; otherwise, false. + /// @return `true` if this display is high resolution; otherwise, false. bool high_resolution() const noexcept; /// @brief Gets the number of pixels per inch of the display. @@ -63,7 +63,7 @@ namespace xtd { int32 pixels_per_inch() const noexcept; /// @brief Gets a value indicating whether a particular display is the primary device. - /// @return true if this display is primary; otherwise, false. + /// @return `true` if this display is primary; otherwise, false. bool primary() const noexcept; /// @brief Gets the scale factor of the display. diff --git a/src/xtd.forms/include/xtd/forms/scroll_bar.hpp b/src/xtd.forms/include/xtd/forms/scroll_bar.hpp index 9e1426539823..578a5f174a0d 100644 --- a/src/xtd.forms/include/xtd/forms/scroll_bar.hpp +++ b/src/xtd.forms/include/xtd/forms/scroll_bar.hpp @@ -98,7 +98,7 @@ namespace xtd { /// @{ /// @brief Initializes a new instance of scroll_bar class. - /// @param vertical true if scroll_bar vertical; otherwise false. + /// @param vertical true if scroll_bar vertical; otherwise `false`. explicit scroll_bar(bool vertical); /// @} diff --git a/src/xtd.forms/include/xtd/forms/scrollable_control.hpp b/src/xtd.forms/include/xtd/forms/scrollable_control.hpp index 4a7aea72aaf6..e4ab158ac3b1 100644 --- a/src/xtd.forms/include/xtd/forms/scrollable_control.hpp +++ b/src/xtd.forms/include/xtd/forms/scrollable_control.hpp @@ -27,7 +27,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the container enables the user to scroll to any controls placed outside of its visible boundaries. - /// @return true if the container enables auto-scrolling; otherwise, false. The default value is false. + /// @return `true` if the container enables auto-scrolling; otherwise, false. The default value is false. virtual bool auto_scroll() const noexcept; /// @brief Sets a value indicating whether the container enables the user to scroll to any controls placed outside of its visible boundaries. /// @param auto_scroll true if the container enables auto-scrolling; otherwise, false. The default value is false. @@ -47,7 +47,7 @@ namespace xtd { drawing::rectangle display_rectangle() const noexcept override; /// @brief Gets a value indicating whether the horizontal scroll bar is visible. - /// @return true if the horizontal scroll bar is visible; otherwise, false. + /// @return `true` if the horizontal scroll bar is visible; otherwise, false. virtual bool h_scroll() const noexcept; /// @brief Sets a value indicating whether the horizontal scroll bar is visible. /// @param hscrooll true if the horizontal scroll bar is visible; otherwise, false. @@ -55,7 +55,7 @@ namespace xtd { virtual scrollable_control& h_scroll(bool h_scroll); /// @brief Gets a value indicating whether the vertical scroll bar is visible. - /// @return true if the vertical scroll bar is visible; otherwise, false. + /// @return `true` if the vertical scroll bar is visible; otherwise, false. virtual bool v_scroll() const noexcept; /// @brief Sets a value indicating whether the vertical scroll bar is visible. /// @param vscroll true if the vertical scroll bar is visible; otherwise, false. diff --git a/src/xtd.forms/include/xtd/forms/seven_segment_display.hpp b/src/xtd.forms/include/xtd/forms/seven_segment_display.hpp index cf749c4ec7f5..e48e0ec9eabc 100644 --- a/src/xtd.forms/include/xtd/forms/seven_segment_display.hpp +++ b/src/xtd.forms/include/xtd/forms/seven_segment_display.hpp @@ -63,10 +63,10 @@ namespace xtd { virtual seven_segment_display& back_segment_opacity(double value); /// @brief Gets a value indicate if background segments are shown. - /// @return true if background segments are shown; otherwise false + /// @return `true` if background segments are shown; otherwise `false` virtual bool show_back_segment() const noexcept; /// @brief Sets a value indicate if background segments are shown. - /// @param value true if background segments are shown; otherwise false + /// @param value true if background segments are shown; otherwise `false` /// @return Current seven_segment_display. virtual seven_segment_display& show_back_segment(bool value); @@ -99,11 +99,11 @@ namespace xtd { /// @{ /// @brief Gets if specified xtd::forms::segments combination is on. - /// @return true if xtd::forms::segments combination is on; otherwise false. + /// @return `true` if xtd::forms::segments combination is on; otherwise `false`. virtual bool get_segments(forms::segments segment) const noexcept; /// @brief Sets specified xtd::forms::segments combination to on. /// @param segment A xtd::forms::segments combination to set. - /// @param on true to set to on; otherwise false. + /// @param on true to set to on; otherwise `false`. virtual void set_segments(forms::segments segment, bool value); /// @} @@ -152,25 +152,25 @@ namespace xtd { static seven_segment_display create(xtd::forms::segments segments, const drawing::point& location, const drawing::size& size, const xtd::string& name); /// @brief A factory to create an xtd::forms::seven_segment_display with specified segments, and back_segment visibility. /// @param segments A dots_collection that represent all dots status. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @return New xtd::forms::seven_segment_display created. static seven_segment_display create(xtd::forms::segments segments, bool show_back_segment); /// @brief A factory to create an xtd::forms::seven_segment_display with specified segments, back_segment visibility, and location. /// @param segments A dots_collection that represent all dots status. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::seven_segment_display. /// @return New xtd::forms::seven_segment_display created. static seven_segment_display create(xtd::forms::segments segments, bool show_back_segment, const drawing::point& location); /// @brief A factory to create an xtd::forms::seven_segment_display with specified segments, back_segment visibility, location, and size. /// @param segments A dots_collection that represent all dots status. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::seven_segment_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::seven_segment_display. /// @return New xtd::forms::seven_segment_display created. static seven_segment_display create(xtd::forms::segments segments, bool show_back_segment, const drawing::point& location, const drawing::size& size); /// @brief A factory to create an xtd::forms::seven_segment_display with specified segments, back_segment visibility, location, size, and name. /// @param segments A dots_collection that represent all dots status. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::seven_segment_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::seven_segment_display. /// @param name The name of the xtd::forms::seven_segment_display. @@ -227,20 +227,20 @@ namespace xtd { /// @brief A factory to create an xtd::forms::seven_segment_display with specified parent, segments, and back_segment visibility. /// @param parent The parent that contains the new created xtd::forms::seven_segment_display. /// @param segments A xtd::forms::segments combination that represent seven_segment_display. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @return New xtd::forms::seven_segment_display created. static seven_segment_display create(const control& parent, xtd::forms::segments segments, bool show_back_segment); /// @brief A factory to create an xtd::forms::seven_segment_display with specified parent, segments, back_segment visibility, and location. /// @param parent The parent that contains the new created xtd::forms::seven_segment_display. /// @param segments A xtd::forms::segments combination that represent seven_segment_display. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::seven_segment_display. /// @return New xtd::forms::seven_segment_display created. static seven_segment_display create(const control& parent, xtd::forms::segments segments, bool show_back_segment, const drawing::point& location); /// @brief A factory to create an xtd::forms::seven_segment_display with specified parent, segments, back_segment visibility, location, and size. /// @param parent The parent that contains the new created xtd::forms::seven_segment_display. /// @param segments A xtd::forms::segments combination that represent seven_segment_display. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::seven_segment_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::seven_segment_display. /// @return New xtd::forms::seven_segment_display created. @@ -248,7 +248,7 @@ namespace xtd { /// @brief A factory to create an xtd::forms::seven_segment_display with specified parent, segments, back_segment visibility, location, size, and name. /// @param parent The parent that contains the new created xtd::forms::seven_segment_display. /// @param segments A xtd::forms::segments combination that represent seven_segment_display. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::seven_segment_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::seven_segment_display. /// @param name The name of the xtd::forms::seven_segment_display. diff --git a/src/xtd.forms/include/xtd/forms/sixteen_segment_display.hpp b/src/xtd.forms/include/xtd/forms/sixteen_segment_display.hpp index eafcaf8a61da..1871186cbc12 100644 --- a/src/xtd.forms/include/xtd/forms/sixteen_segment_display.hpp +++ b/src/xtd.forms/include/xtd/forms/sixteen_segment_display.hpp @@ -92,25 +92,25 @@ namespace xtd { static sixteen_segment_display create(xtd::forms::segments segments, const drawing::point& location, const drawing::size& size, const xtd::string& name); /// @brief A factory to create an xtd::forms::sixteen_segment_display with specified segments, and back_segment visibility. /// @param segments A dots_collection that represent all dots status. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @return New xtd::forms::sixteen_segment_display created. static sixteen_segment_display create(xtd::forms::segments segments, bool show_back_segment); /// @brief A factory to create an xtd::forms::sixteen_segment_display with specified segments, back_segment visibility, and location. /// @param segments A dots_collection that represent all dots status. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::sixteen_segment_display. /// @return New xtd::forms::sixteen_segment_display created. static sixteen_segment_display create(xtd::forms::segments segments, bool show_back_segment, const drawing::point& location); /// @brief A factory to create an xtd::forms::sixteen_segment_display with specified segments, back_segment visibility, location, and size. /// @param segments A dots_collection that represent all dots status. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::sixteen_segment_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::sixteen_segment_display. /// @return New xtd::forms::sixteen_segment_display created. static sixteen_segment_display create(xtd::forms::segments segments, bool show_back_segment, const drawing::point& location, const drawing::size& size); /// @brief A factory to create an xtd::forms::sixteen_segment_display with specified segments, back_segment visibility, location, size, and name. /// @param segments A dots_collection that represent all dots status. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::sixteen_segment_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::sixteen_segment_display. /// @param name The name of the xtd::forms::sixteen_segment_display. @@ -167,20 +167,20 @@ namespace xtd { /// @brief A factory to create an xtd::forms::sixteen_segment_display with specified parent, segments, and back_segment visibility. /// @param parent The parent that contains the new created xtd::forms::sixteen_segment_display. /// @param segments A xtd::forms::segments combination that represent sixteen_segment_display. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @return New xtd::forms::sixteen_segment_display created. static sixteen_segment_display create(const control& parent, xtd::forms::segments segments, bool show_back_segment); /// @brief A factory to create an xtd::forms::sixteen_segment_display with specified parent, segments, back_segment visibility, and location. /// @param parent The parent that contains the new created xtd::forms::sixteen_segment_display. /// @param segments A xtd::forms::segments combination that represent sixteen_segment_display. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::sixteen_segment_display. /// @return New xtd::forms::sixteen_segment_display created. static sixteen_segment_display create(const control& parent, xtd::forms::segments segments, bool show_back_segment, const drawing::point& location); /// @brief A factory to create an xtd::forms::sixteen_segment_display with specified parent, segments, back_segment visibility, location, and size. /// @param parent The parent that contains the new created xtd::forms::sixteen_segment_display. /// @param segments A xtd::forms::segments combination that represent sixteen_segment_display. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::sixteen_segment_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::sixteen_segment_display. /// @return New xtd::forms::sixteen_segment_display created. @@ -188,7 +188,7 @@ namespace xtd { /// @brief A factory to create an xtd::forms::sixteen_segment_display with specified parent, segments, back_segment visibility, location, size, and name. /// @param parent The parent that contains the new created xtd::forms::sixteen_segment_display. /// @param segments A xtd::forms::segments combination that represent sixteen_segment_display. - /// @param show_back_segment true if background segments are shown; otherwise false + /// @param show_back_segment true if background segments are shown; otherwise `false` /// @param location A xtd::drawing::point that represent location of the xtd::forms::sixteen_segment_display. /// @param size A xtd::drawing::size that represent size of the xtd::forms::sixteen_segment_display. /// @param name The name of the xtd::forms::sixteen_segment_display. diff --git a/src/xtd.forms/include/xtd/forms/status_bar.hpp b/src/xtd.forms/include/xtd/forms/status_bar.hpp index c00cc0cf40d8..5e2326160b79 100644 --- a/src/xtd.forms/include/xtd/forms/status_bar.hpp +++ b/src/xtd.forms/include/xtd/forms/status_bar.hpp @@ -94,7 +94,7 @@ namespace xtd { status_bar_panel_collection& panels(); /// @brief Gets a value indicating whether any panels that have been added to the control are displayed. - /// @return true if panels are displayed; otherwise, false. The default is false. + /// @return `true` if panels are displayed; otherwise, false. The default is false. /// @remarks By default, the xtd::forms::status_bar control displays the value of its xtd::forms::status_bar::text property without any panels. When xtd::forms::status_bar::show_panels is set to true, any xtd::forms::status_bar objects specified in the StatusBar control are displayed. No panels are initially created when you create an instance of the xtd::forms::status_bar class. You can add panels to a xtd::forms::status_bar control by using the xtd::forms::status_bar::status_bar_panel_collection::push_back method of the xtd::forms::status_bar::status_bar_panel_collection class. This collection class can be accessed through the xtd::forms::status_bar::panels property of xtd::forms::status_bar. virtual bool show_panels() const noexcept; /// @brief Sets a value indicating whether any panels that have been added to the control are displayed. @@ -104,7 +104,7 @@ namespace xtd { virtual status_bar& show_panels(bool value); /// @brief Gets a value indicating whether the status bar displays a xtd::forms::tool_tip for each button. - /// @return true if the status bar display a xtd::forms::tool_tip for each button; otherwise, false. The default is false. + /// @return `true` if the status bar display a xtd::forms::tool_tip for each button; otherwise, false. The default is false. /// @remarks To set the text displayed by the xtd::forms::tool_tip, set the xtd::forms::tool_bar_button::tool_tip_text property of each xtd::forms::tool_bar_button on the xtd::forms::tool_bar. To cause the xtd::forms::tool_tip to display as the user moves the mouse pointer over the status bar button, set the xtd::forms::tool_bar::show_tool_tips property to true. virtual bool show_tool_tips() const noexcept; /// @brief Sets a value indicating whether the status bar displays a xtd::forms::tool_tip for each button. @@ -114,7 +114,7 @@ namespace xtd { virtual status_bar& show_tool_tips(bool value); /// @brief Gets a value indicating whether a sizing grip is displayed in the lower-right corner of the control. - /// @return true if a sizing grip is displayed; otherwise, false. The default is true. + /// @return `true` if a sizing grip is displayed; otherwise, false. The default is true. /// @remarks You can use this property to display a sizing grip to provide an indication to the user when a form is resizable. If the xtd::forms::form_border_style property of your xtd::forms::form is set to a border style that is not resizable, such as xtd::forms::form_border_style::fixed_3d or xtd::forms::form_border_style::fixed_dialog, you should set the xtd::forms::status_bar::sizing_grip property to false to prevent the user from thinking that the form can be resized. virtual bool sizing_grip() const noexcept; /// @brief Sets a value indicating whether a sizing grip is displayed in the lower-right corner of the control. diff --git a/src/xtd.forms/include/xtd/forms/style_sheets/itext_model.hpp b/src/xtd.forms/include/xtd/forms/style_sheets/itext_model.hpp index 02d5a9bcef71..93518b468308 100644 --- a/src/xtd.forms/include/xtd/forms/style_sheets/itext_model.hpp +++ b/src/xtd.forms/include/xtd/forms/style_sheets/itext_model.hpp @@ -43,7 +43,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the ellipsis character (...) appears at the right edge of the control, denoting that the control text extends beyond the specified length of the control. - /// @return true if the additional control text is to be indicated by an ellipsis; otherwise, false. + /// @return `true` if the additional control text is to be indicated by an ellipsis; otherwise, false. virtual bool auto_ellipsis() const noexcept = 0; /// @brief Gets the alignment of the text. diff --git a/src/xtd.forms/include/xtd/forms/style_sheets/style_sheet.hpp b/src/xtd.forms/include/xtd/forms/style_sheets/style_sheet.hpp index 7265d9e8d6d6..dbcabf58f414 100644 --- a/src/xtd.forms/include/xtd/forms/style_sheets/style_sheet.hpp +++ b/src/xtd.forms/include/xtd/forms/style_sheets/style_sheet.hpp @@ -179,7 +179,7 @@ namespace xtd { const forms_t& forms() const noexcept; /// @brief Gets a value indicate if this instance is system style sheet. - /// @return true if the current instance is system style sheet; otherwise false. + /// @return `true` if the current instance is system style sheet; otherwise `false`. /// @remarks This method return true only if the current instance is equal to xtd::forms::style_sheets::style_sheet::system_style_sheet. bool is_system_style_sheet() const noexcept; diff --git a/src/xtd.forms/include/xtd/forms/style_sheets/theme.hpp b/src/xtd.forms/include/xtd/forms/style_sheets/theme.hpp index 88866e7c5b8a..93af0bf202a6 100644 --- a/src/xtd.forms/include/xtd/forms/style_sheets/theme.hpp +++ b/src/xtd.forms/include/xtd/forms/style_sheets/theme.hpp @@ -116,7 +116,7 @@ namespace xtd { /// @brief Creates a xtd::forms::style_sheets::theme object from the specified css text. /// @param css_text A css xtd::string that represents a xtd::forms::style_sheets::theme object. /// @param result The xtd::forms::style_sheets::theme class that this method creates. - /// @return true if succeed; otherwise false. + /// @return `true` if succeed; otherwise `false`. static bool from_css(const xtd::string& css_text, theme& result); /// @brief Creates a xtd::forms::style_sheets::theme object from the specified text. @@ -128,7 +128,7 @@ namespace xtd { /// @brief Creates a xtd::forms::style_sheets::theme object from the specified text. /// @param text A xtd::string that represents a xtd::forms::style_sheets::theme object. /// @param result The xtd::forms::style_sheets::theme class that this method creates. - /// @return true if succeed; otherwise false. + /// @return `true` if succeed; otherwise `false`. static bool try_parse(const xtd::string& text, theme& result) noexcept; /// @} diff --git a/src/xtd.forms/include/xtd/forms/switch_button.hpp b/src/xtd.forms/include/xtd/forms/switch_button.hpp index 297247ebf02f..da70b87aff72 100644 --- a/src/xtd.forms/include/xtd/forms/switch_button.hpp +++ b/src/xtd.forms/include/xtd/forms/switch_button.hpp @@ -44,7 +44,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the checked and the switch_button's appearance are automatically changed when the switch_button is clicked. - /// @return true if the checked value and the appearance of the control are automatically changed on the click event; otherwise, false. The default value is true. + /// @return `true` if the checked value and the appearance of the control are automatically changed on the click event; otherwise, false. The default value is true. /// @remarks If auto_check is set to false, you will need to add code to update the checked in the click event handler. virtual bool auto_check() const noexcept; /// @brief Sets a value indicating whether the checked and the switch_button's appearance are automatically changed when the switch_button is clicked. @@ -74,7 +74,7 @@ namespace xtd { /// @endcond /// @brief Gets a value indicating whether the switch_button is rounded appearance. - /// @return true if the switch_button is in the rounded appearance; otherwise, false. The default value is true. + /// @return `true` if the switch_button is in the rounded appearance; otherwise, false. The default value is true. virtual bool rounded() const noexcept; /// @brief Sets a value indicating whether the switch_button is rounded appearance. /// @param value true if the switch_button is in the rounded appearance; otherwise, false. The default value is true. @@ -82,7 +82,7 @@ namespace xtd { virtual switch_button& rounded(bool value); /// @brief Gets a value indicating whether the switch_button is in the checked state. - /// @return true if the switch_button is in the checked state; otherwise, false. The default value is false. + /// @return `true` if the switch_button is in the checked state; otherwise, false. The default value is false. virtual bool checked() const noexcept; /// @brief Sets a value indicating whether the switch_button is in the checked state. /// @param checked true if the switch_button is in the checked state; otherwise, false. The default value is false. @@ -90,7 +90,7 @@ namespace xtd { virtual switch_button& checked(bool checked); /// @brief Gets a value indicating whether the switch_button text is shown. - /// @return true if the switch_button text is shown; otherwise, false. The default value is false. + /// @return `true` if the switch_button text is shown; otherwise, false. The default value is false. virtual bool show_text() const noexcept; /// @brief Sets a value indicating whether the switch_button text is shown. /// @param value true if the switch_button text is shown; otherwise, false. The default value is false. diff --git a/src/xtd.forms/include/xtd/forms/system_information.hpp b/src/xtd.forms/include/xtd/forms/system_information.hpp index 031ac3a50faf..fe19202d770e 100644 --- a/src/xtd.forms/include/xtd/forms/system_information.hpp +++ b/src/xtd.forms/include/xtd/forms/system_information.hpp @@ -103,12 +103,12 @@ namespace xtd { static xtd::drawing::size cursor_size(); /// @brief Gets a value indicating whether the operating system is capable of handling double-byte character set (DBCS) characters. - /// @return true if the operating system supports DBCS; otherwise, false. + /// @return `true` if the operating system supports DBCS; otherwise, false. /// @remarks The dbcs_enabled property indicates whether the current operating system supports DBCS. static bool dbcs_enabled(); /// @brief Gets a value indicating whether the debug version of USER.EXE is installed. - /// @return true if the debugging version of USER.EXE is installed; otherwise, false. + /// @return `true` if the debugging version of USER.EXE is installed; otherwise, false. static bool debug_os(); /// @brief Gets the dimensions, in pixels, of the area within which the user must click twice for the operating system to consider the two clicks a double-click. @@ -123,7 +123,7 @@ namespace xtd { static int32 double_click_time(); /// @brief Gets a value indicating whether the user has enabled full window drag. - /// @return true if the user has enabled full window drag; otherwise, false. + /// @return `true` if the user has enabled full window drag; otherwise, false. /// @remarks When this property is true, the content of a window is refreshed during a window move or resize drag, using the current position and size as they are updated. static bool drag_full_windows(); @@ -154,7 +154,7 @@ namespace xtd { static xtd::drawing::size frame_border_size(); /// @brief Gets a value indicating whether the user has enabled the high-contrast mode accessibility feature. - /// @return true if the user has enabled high-contrast mode; otherwise, false. + /// @return `true` if the user has enabled high-contrast mode; otherwise, false. /// @remarks The high-contrast accessibility feature can make the screen easier for some users to view by enabling a color scheme that can heighten screen contrast with alternative color combinations. Some of the schemes also change font sizes for easier reading. /// @remarks The high-contrast mode feature can be enabled or disabled through the Accessibility Options control panel. static bool high_contrast(); @@ -201,22 +201,22 @@ namespace xtd { static int32 icon_vertical_spacing(); /// @brief Gets a value indicating whether active window tracking is enabled. - /// @return true if active window tracking is enabled; otherwise, false. + /// @return `true` if active window tracking is enabled; otherwise, false. /// @remarks The is_active_window_tracking_enabled property indicates whether active window tracking is enabled. Active window tracking causes any window the mouse is directly over to become the active window. static bool is_active_window_tracking_enabled(); /// @brief Gets a value indicating whether the slide-open effect for combo boxes is enabled. - /// @return true if the slide-open effect for combo boxes is enabled; otherwise, false. + /// @return `true` if the slide-open effect for combo boxes is enabled; otherwise, false. /// @remarks The is_combo_box_animation_enabled property indicates whether the slide-open effect for system control combo boxes is enabled. /// @remarks When the slide-open effect for system control combo boxes is enabled, the drop down menu of a combo box slides into view when it is displayed, instead of being immediately fully drawn in view. static bool is_combo_box_animation_enabled(); /// @brief Gets a value indicating whether the drop shadow effect is enabled. - /// @return true if the drop shadow effect is enabled; otherwise, false. + /// @return `true` if the drop shadow effect is enabled; otherwise, false. static bool is_drop_shadow_enabled(); /// @brief Gets a value indicating whether native user menus have a flat menu appearance. - /// @return true if native user menus have a flat menu appearance; otherwise, false. + /// @return `true` if native user menus have a flat menu appearance; otherwise, false. static bool is_flat_menu_enabled(); /// @brief Gets a value indicating whether font smoothing is enabled. @@ -239,50 +239,50 @@ namespace xtd { static bool is_keyboard_preferred(); /// @brief Gets a value indicating whether the smooth-scrolling effect for list boxes is enabled. - /// @return true if smooth-scrolling is enabled; otherwise, false. + /// @return `true` if smooth-scrolling is enabled; otherwise, false. /// @remarks The is_list_box_smooth_scrolling_enabled property indicates whether the smooth-scrolling effect for system control list boxes is enabled. static bool is_list_box_smooth_scrolling_enabled(); /// @brief Gets a value indicating whether menu fade or slide animation features are enabled. - /// @return true if menu fade or slide animation is enabled; otherwise, false. + /// @return `true` if menu fade or slide animation is enabled; otherwise, false. /// @remarks The is_menu_animation_enabled property indicates whether either of the fade or slide animation features of system control menus is enabled. /// @remarks If the value of this property is true, the xtd::forms::system_information::is_menu_fade_enabled property indicates whether menus use fade or slide animation. static bool is_menu_animation_enabled(); /// @brief Gets a value indicating whether menu fade animation is enabled. - /// @return true if fade animation is enabled; false if it is disabled. + /// @return `true` if fade animation is enabled; false if it is disabled. /// @remarks The is_menu_fade_enabled property indicates whether a menu uses fade animation, if menu animation is enabled. The IsMenuAnimationEnabled property indicates whether menu animation is enabled. /// @remarks If menu animation is enabled and the value of this property is true, menus use fade animation. If menu animation is enabled and the value of this property is false, menus use slide animation. If menu animation is disabled, the value of this property is meaningless. static bool is_menu_fade_enabled(); /// @brief Gets a value indicating whether window minimize and restore animation is enabled. - /// @return true if window minimize and restore animation is enabled; otherwise, false. + /// @return `true` if window minimize and restore animation is enabled; otherwise, false. /// @remarks The is_minimize_restore_animation_enabled property indicates whether the window minimize and restore sequence is animated. static bool is_minimize_restore_animation_enabled(); /// @brief Gets the operating system is natively double buffered. - /// @return true is operating system is natively double buffered; otherwise false. + /// @return `true` is operating system is natively double buffered; otherwise `false`. /// @remarks The xtd::drawing::graphics is double_buffered. static bool is_operating_system_double_buffered(); /// @brief Gets a value indicating whether the selection fade effect is enabled. - /// @return true if the selection fade effect is enabled; otherwise, false. + /// @return `true` if the selection fade effect is enabled; otherwise, false. /// @remarks The is_selection_fade_enabled property indicates whether the selection fade effect is enabled. The selection fade effect causes a menu item selected by the user to remain on the screen briefly while fading out after the menu is dismissed. static bool is_selection_fade_enabled(); /// @brief Gets a value indicating whether the snap-to-default-button feature is enabled. - /// @return true if the snap-to-default-button feature is enabled; otherwise, false. + /// @return `true` if the snap-to-default-button feature is enabled; otherwise, false. /// @remarks The is_snap_to_default_enabled property indicates whether the snap-to-default-button feature is enabled. If the feature is enabled, the mouse cursor automatically moves to the default button, such as OK or Apply, of a dialog box. static bool is_snap_to_default_enabled(); /// @brief Gets a value indicating whether the gradient effect for window title bars is enabled. - /// @return true if the gradient effect for window title bars is enabled; otherwise, false. + /// @return `true` if the gradient effect for window title bars is enabled; otherwise, false. /// @remarks The is_title_bar_gradient_enabled property indicates whether the background of window title bars are drawn using a gradient fill effect. /// @note This property is supported only on Windows 98, Windows Millennium Edition, Windows 2000, Windows XP, and the Windows Server 2003 family. static bool is_title_bar_gradient_enabled(); /// @brief Gets a value indicating whether tool_tip animation is enabled. - /// @return true if tool_tip animation is enabled; otherwise, false. + /// @return `true` if tool_tip animation is enabled; otherwise, false. /// @remarks The is_tool_tip_animation_enabled property indicates whether tool_tips can fade or slide into view. /// @note This property is supported only on Windows 2000, Windows XP, and the Windows Server 2003 family. On other platforms, this property returns false. static bool is_tool_tip_animation_enabled(); @@ -310,7 +310,7 @@ namespace xtd { static xtd::drawing::size max_window_track_size(); /// @brief Gets a value indicating whether menu access keys are always underlined. - /// @return true if menu access keys are always underlined; false if they are underlined only when the menu is activated or receives focus. + /// @return `true` if menu access keys are always underlined; false if they are underlined only when the menu is activated or receives focus. /// @remarks The menu_access_keys_underlined property indicates whether the menu shortcut keys are underlined in menu text even when the menu has not been activated or received focus. static bool menu_access_keys_underlined(); @@ -345,7 +345,7 @@ namespace xtd { static int32 menu_show_delay(); /// @brief Gets a value indicating whether the operating system is enabled for the Hebrew and Arabic languages. - /// @return true if the operating system is enabled for Hebrew or Arabic; otherwise, false. + /// @return `true` if the operating system is enabled for Hebrew or Arabic; otherwise, false. /// @remarks The mid_east_enabled property indicates whether the operating system is enabled for the Hebrew and Arabic languages. static bool mid_east_enabled(); @@ -379,7 +379,7 @@ namespace xtd { static int32 monitor_count(); /// @brief Gets a value indicating whether all the display monitors are using the same pixel color format. - /// @return true if all monitors are using the same pixel color format; otherwise, false. + /// @return `true` if all monitors are using the same pixel color format; otherwise, false. /// @remarks The monitors_same_display_format indicates whether all monitors currently recognized by the operating system are using the same pixel color format. /// @remarks Pixel formats define the data structure used to encode pixel color and luminosity information. The pixel_format enumeration indicates a set of standard pixel color formats. Pixel values can be encoded in a variety of formats, with differing color value ranges and bit precisions, and differing positions of bits in a pixel data format structure. /// @note Two displays can have the same bit depth but different color formats. @@ -393,7 +393,7 @@ namespace xtd { static int32 mouse_buttons(); /// @brief Gets a value indicating whether the functions of the left and right mouse buttons have been swapped. - /// @return true if the functions of the left and right mouse buttons are swapped; otherwise, false. + /// @return `true` if the functions of the left and right mouse buttons are swapped; otherwise, false. static bool mouse_buttons_swapped(); /// @brief Gets the dimensions, in pixels, of the rectangle within which the mouse pointer has to stay for the mouse hover time before a mouse hover message is generated. @@ -409,7 +409,7 @@ namespace xtd { static int32 mouse_hover_time(); /// @brief Gets a value indicating whether the functions of the left and right mouse buttons have been swapped. - /// @return true if a mouse is installed; otherwise, false. + /// @return `true` if a mouse is installed; otherwise, false. /// @remarks The mouse_present property indicates whether a pointing device is present or installed on the system. This is usually the case, so mouse_present almost always returns true. static bool mouse_present(); @@ -419,7 +419,7 @@ namespace xtd { static int32 mouse_speed(); /// @brief Gets a value indicating whether a mouse with a mouse wheel is installed. - /// @return true if a mouse with a mouse wheel is installed; otherwise, false. + /// @return `true` if a mouse with a mouse wheel is installed; otherwise, false. /// @remarks The Mouse_wheel_present property indicates whether the system recognizes a mouse wheel on an installed mouse. /// @note This property is equivalent to native_mouse_wheel_support. static bool Mouse_wheel_present(); @@ -436,19 +436,19 @@ namespace xtd { static int32 mouse_wheel_scroll_lines(); /// @brief Gets a value indicating whether a mouse with a mouse wheel is installed. - /// @return true if a mouse with a mouse wheel is installed; otherwise, false. + /// @return `true` if a mouse with a mouse wheel is installed; otherwise, false. /// @remarks The native_mouse_wheel_support property indicates whether the system recognizes a mouse wheel on an installed mouse. /// @note This property is equivalent to mouse_wheel_present. static bool native_mouse_wheel_support(); /// @brief Gets a value indicating whether a network connection is present. - /// @return true if a network connection is present; otherwise, false. + /// @return `true` if a network connection is present; otherwise, false. /// @remarks The network property indicates whether the system has a currently established network connection. /// @note This property always returns true on all platforms. static bool network(); /// @brief Gets a value indicating whether the Microsoft Windows for Pen Computing extensions are installed. - /// @return true if the Windows for Pen Computing extensions are installed; false if Windows for Pen Computing extensions are not installed. + /// @return `true` if the Windows for Pen Computing extensions are installed; false if Windows for Pen Computing extensions are not installed. /// @remarks The xtd::forms::system_information::pen_windows property indicates whether the Microsoft Windows for Pen Computing extensions are installed. static bool pen_windows(); @@ -470,7 +470,7 @@ namespace xtd { static xtd::drawing::size primary_monitor_size(); /// @brief Gets a value indicating whether drop-down menus are right-aligned with the corresponding menu-bar item. - /// @return true if drop-down menus are right-aligned with the corresponding menu-bar item; false if the menus are left-aligned. + /// @return `true` if drop-down menus are right-aligned with the corresponding menu-bar item; false if the menus are left-aligned. static bool right_aligned_menus(); /// @brief Gets the orientation of the screen. @@ -478,12 +478,12 @@ namespace xtd { static xtd::forms::screen_orientation screen_orientation(); /// @brief Gets a value indicating whether a Security Manager is present on this operating system. - /// @return true if a Security Manager is present; otherwise, false. + /// @return `true` if a Security Manager is present; otherwise, false. /// @remarks The xtd::forms::system_information::secure property indicates whether a Security Manager is available from the operating system. A Security Manager determines access to the registry and file system. static bool secure(); /// @brief Gets a value indicating whether the user prefers that an application present information in visual form in situations when it would present the information in audible form. - /// @return true if the application should visually show information about audible output; false if the application does not need to provide extra visual cues for audio events. + /// @return `true` if the application should visually show information about audible output; false if the application does not need to provide extra visual cues for audio events. /// @remarks The xtd::forms::system_information::show_sounds property indicates whether a user preference has been set that indicates the user prefers visual information displays for audio events. /// @remarks You can use this property to provide accessibility mode features to an application. static bool show_sounds(); @@ -503,7 +503,7 @@ namespace xtd { static xtd::drawing::size small_icon_size(); /// @brief Gets a value indicating whether the calling process is associated with a Terminal Services client session. - /// @return true if the calling process is associated with a Terminal Services client session; otherwise, false. + /// @return `true` if the calling process is associated with a Terminal Services client session; otherwise, false. /// @remarks The xtd::forms::system_information::terminal_server_session property indicates whether the calling process is associated with a Terminal Services client session. static bool terminal_server_session(); @@ -517,7 +517,7 @@ namespace xtd { static int32 tool_window_caption_height(); /// @brief Gets a value indicating whether user interface (UI) effects are enabled or disabled. - /// @return true if UI effects are enabled; otherwise, false. + /// @return `true` if UI effects are enabled; otherwise, false. /// @remarks UI effects include animation, fading, hot tracking, and smooth scrolling of system controls, and drawing a shadow under the mouse cursor. When UI effects are disabled, these features are disabled. When UI effects are enabled, only the effects configured as active for the current user are enabled. /// @remarks The following table lists properties that indicate whether particular UI effects are enabled, if the value of this property is true: /// | Name | Description | @@ -538,7 +538,7 @@ namespace xtd { static xtd::string user_domain_name(); /// @brief Gets a value indicating whether the current process is running in user-interactive mode. - /// @return true if the current process is running in user-interactive mode; otherwise, false. + /// @return `true` if the current process is running in user-interactive mode; otherwise, false. /// @remarks When the xtd::forms::system_information::user_interactive property is false, do not display any modal dialogs or message boxes, as there is no graphical user interface for the user to interact with. /// @remarks This property is false only when called from a service process or from a Web application. static bool user_interactive(); diff --git a/src/xtd.forms/include/xtd/forms/tab_page_ref_less.hpp b/src/xtd.forms/include/xtd/forms/tab_page_ref_less.hpp index 69c180e5a357..e864a56d1882 100644 --- a/src/xtd.forms/include/xtd/forms/tab_page_ref_less.hpp +++ b/src/xtd.forms/include/xtd/forms/tab_page_ref_less.hpp @@ -26,7 +26,7 @@ namespace xtd { /// @brief Compare two specified tab_page_ref. /// @param value1 The first value to compare. /// @param value2 The second value to compare. - /// @return true if value1 < value2; otherwise false. + /// @return `true` if value1 < value2; otherwise `false`. bool operator()(const tab_page_ref& value1, const tab_page_ref& value2) const { return &value1.get() < &value2.get(); } diff --git a/src/xtd.forms/include/xtd/forms/text_box.hpp b/src/xtd.forms/include/xtd/forms/text_box.hpp index 194401b8f0ea..7eaf1db2b538 100644 --- a/src/xtd.forms/include/xtd/forms/text_box.hpp +++ b/src/xtd.forms/include/xtd/forms/text_box.hpp @@ -43,7 +43,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether pressing ENTER in a multiline text_box control creates a new line of text in the control or activates the default button for the form. - /// @return true if the ENTER key creates a new line of text in a multiline version of the control; false if the ENTER key activates the default button for the form. The default is false. + /// @return `true` if the ENTER key creates a new line of text in a multiline version of the control; false if the ENTER key activates the default button for the form. The default is false. /// @remarks If the value of this property is false, the user must press CTRL+ENTER to create a new line in a multiline text_box control. If there is no default button for the form, the ENTER key will always create a new line of text in the control, regardless of the value of this property. virtual bool accepts_return() const noexcept; /// @brief Sets a value indicating whether pressing ENTER in a multiline text_box control creates a new line of text in the control or activates the default button for the form. @@ -98,7 +98,7 @@ namespace xtd { control& text(const xtd::string& text) override; /// @brief Gets a value indicating whether the text in the TextBox control should appear as the default password character. - /// @return true if the text in the TextBox control should appear as the default password character; otherwise, false. + /// @return `true` if the text in the TextBox control should appear as the default password character; otherwise, false. /// @remarks The use_system_password_char property has precedence over the password_char property. Whenever the use_system_password_char is set to true, the default system password character is used and any character set by password_char is ignored. virtual bool use_system_password_char() const noexcept; /// @brief Sets a value indicating whether the text in the TextBox control should appear as the default password character. diff --git a/src/xtd.forms/include/xtd/forms/text_box_base.hpp b/src/xtd.forms/include/xtd/forms/text_box_base.hpp index e274fb4c4296..39326add78a3 100644 --- a/src/xtd.forms/include/xtd/forms/text_box_base.hpp +++ b/src/xtd.forms/include/xtd/forms/text_box_base.hpp @@ -31,7 +31,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether pressing the TAB key in a multiline text box control types a TAB character in the control instead of moving the focus to the next control in the tab order. - /// @return true if users can enter tabs in a multiline text box using the TAB key; false if pressing the TAB key moves the focus. The default is false. + /// @return `true` if users can enter tabs in a multiline text box using the TAB key; false if pressing the TAB key moves the focus. The default is false. virtual bool accepts_tab() const noexcept; /// @brief Sets a value indicating whether pressing the TAB key in a multiline text box control types a TAB character in the control instead of moving the focus to the next control in the tab order. /// @param value true if users can enter tabs in a multiline text box using the TAB key; false if pressing the TAB key moves the focus. The default is false. @@ -69,7 +69,7 @@ namespace xtd { text_box_base& lines(const std::vector& lines); /// @brief Gets a value indicating whether this is a multiline text box control. - /// @return true if the control is a multiline text box control; otherwise, false. The default is false. + /// @return `true` if the control is a multiline text box control; otherwise, false. The default is false. /// @remarks A multiline text box allows you to display more than one line of text in the control. If the word_wrap property is set to true, text entered into the multiline text box is wrapped to the next line in the control. If the word_wrap property is set to false, text entered into the multiline text box control will be displayed on the same line until a newline character is entered. virtual bool multiline() const noexcept; /// @brief Sets a value indicating whether this is a multiline text box control. @@ -79,7 +79,7 @@ namespace xtd { virtual text_box_base& multiline(bool value); /// @brief Gets a value indicating whether text in the text box is read-only. - /// @return true if the text box is read-only; otherwise, false. The default is false. + /// @return `true` if the text box is read-only; otherwise, false. The default is false. /// @remarks When this property is set to true, the contents of the control cannot be changed by the user at runtime. With this property set to true, you can still set the value of the Text property in code. You can use this feature instead of disabling the control with the Enabled property to allow the contents to be copied and ToolTips to be shown. virtual bool read_only() const noexcept; /// @brief Sets a value indicating whether text in the text box is read-only. @@ -109,7 +109,7 @@ namespace xtd { virtual text_box_base& selection_start(size_t value); /// @brief Indicates whether a multiline text box control automatically wraps words to the beginning of the next line when necessary. - /// @return true if the multiline text box control wraps words; false if the text box control automatically scrolls horizontally when the user types past the right edge of the control. The default is true. + /// @return `true` if the multiline text box control wraps words; false if the text box control automatically scrolls horizontally when the user types past the right edge of the control. The default is true. virtual bool word_wrap() const noexcept; /// @brief Indicates whether a multiline text box control automatically wraps words to the beginning of the next line when necessary. /// @param value true if the multiline text box control wraps words; false if the text box control automatically scrolls horizontally when the user types past the right edge of the control. The default is true. diff --git a/src/xtd.forms/include/xtd/forms/timer.hpp b/src/xtd.forms/include/xtd/forms/timer.hpp index c432956b4a4f..c0f946437c69 100644 --- a/src/xtd.forms/include/xtd/forms/timer.hpp +++ b/src/xtd.forms/include/xtd/forms/timer.hpp @@ -58,7 +58,7 @@ namespace xtd { /// @{ /// @brief Gets whether the timer is running. - /// @return true if the timer is currently enabled; otherwise, false. The default is false. + /// @return `true` if the timer is currently enabled; otherwise, false. The default is false. /// @remarks Calling the start method is the same as setting enabled to true. Likewise, calling the stop method is the same as setting enabled to false. virtual bool enabled() const noexcept; /// @brief Sets whether the timer is running. diff --git a/src/xtd.forms/include/xtd/forms/toggle_button.hpp b/src/xtd.forms/include/xtd/forms/toggle_button.hpp index 305175b91b0d..c8a74c966bf9 100644 --- a/src/xtd.forms/include/xtd/forms/toggle_button.hpp +++ b/src/xtd.forms/include/xtd/forms/toggle_button.hpp @@ -57,7 +57,7 @@ namespace xtd { /// @{ /// @brief Gets a value indicating whether the checked or check_state values and the toggle_button's appearance are automatically changed when the toggle_button is clicked. - /// @return true if the checked value or check_state value and the appearance of the control are automatically changed on the click event; otherwise, false. The default value is true. + /// @return `true` if the checked value or check_state value and the appearance of the control are automatically changed on the click event; otherwise, false. The default value is true. /// @remarks If auto_check is set to false, you will need to add code to update the checked or check_state values in the click event handler. virtual bool auto_check() const noexcept; /// @brief Sets a value indicating whether the checked or check_state values and the toggle_button's appearance are automatically changed when the toggle_button is clicked. @@ -73,7 +73,7 @@ namespace xtd { virtual toggle_button& check_align(content_alignment check_align); /// @brief Gets a value indicating whether the toggle_button is in the checked state. - /// @return true if the toggle_button is in the checked state; otherwise, false. The default value is false. If the three_state property is set to true, the checked property will return true for either a checked or indeterminate check_state. + /// @return `true` if the toggle_button is in the checked state; otherwise, false. The default value is false. If the three_state property is set to true, the checked property will return true for either a checked or indeterminate check_state. /// @remarks When the value is true, the toggle_button portion of the control displays a check mark. If the appearance property is set to button, the control will appear sunken when checked is true and raised like a standard button when false. virtual bool checked() const noexcept; /// @brief Sets a value indicating whether the toggle_button is in the checked state. @@ -102,7 +102,7 @@ namespace xtd { virtual toggle_button& check_state(forms::check_state check_state); /// @brief Gets a value indicating whether the toggle_button will allow three check states rather than two. - /// @return true if the toggle_button is able to display three check states; otherwise, false. The default value is false. + /// @return `true` if the toggle_button is able to display three check states; otherwise, false. The default value is false. /// @remarks If the three_state property is set to false, the check_state property value can only be set to the indeterminate value of xtd.forms.check_state in code and not by user interaction. virtual bool three_state() const noexcept; /// @brief Gets a value indicating whether the toggle_button will allow three check states rather than two. diff --git a/src/xtd.forms/include/xtd/forms/tool_bar.hpp b/src/xtd.forms/include/xtd/forms/tool_bar.hpp index fa721bd6d244..b8d616cbc889 100644 --- a/src/xtd.forms/include/xtd/forms/tool_bar.hpp +++ b/src/xtd.forms/include/xtd/forms/tool_bar.hpp @@ -136,7 +136,7 @@ namespace xtd { virtual tool_bar& button_size(std::nullptr_t value); /// @brief Gets a value indicating whether the toolbar displays a divider. - /// @return true if the toolbar displays a divider; otherwise, false. The default is true. + /// @return `true` if the toolbar displays a divider; otherwise, false. The default is true. /// @remarks Dividers are displayed to help distinguish the toolbar from adjacent controls, such as menus. A divider is displayed as a raised edge along the top of the xtd::forms::tool_bar control. /// @note Only on Windows and if xtd::forms::tool_bar::appearance is set to xtd::forms::tool_bar_appearance::system. virtual bool divider() const noexcept; @@ -151,7 +151,7 @@ namespace xtd { control& dock(dock_style dock) override; /// @brief Gets a value indicating whether drop-down buttons on a toolbar display down arrows. - /// @return true if drop-down toolbar buttons display down arrows; otherwise, false. The default is true. + /// @return `true` if drop-down toolbar buttons display down arrows; otherwise, false. The default is true. /// @remarks When xtd::forms::tool_bar::drop_down_arrows is set to false, no down arrows display on drop-down style toolbar buttons. When the user clicks the drop-down button on the toolbar, the menu drops down for selection. When the drop-down arrow is displayed, the user must press the down arrow to display the menu. virtual bool drop_down_arrows() const noexcept; /// @brief Sets a value indicating whether drop-down buttons on a toolbar display down arrows. @@ -179,7 +179,7 @@ namespace xtd { virtual xtd::drawing::size image_size() const noexcept; /// @brief Gets a value indicating whether the toolbar displays the image for each button. - /// @return true if the toolbar display the image for each button; otherwise, false. The default is true. + /// @return `true` if the toolbar display the image for each button; otherwise, false. The default is true. virtual bool show_icon() const noexcept; /// @brief Sets a value indicating whether the toolbar displays the image for each button. /// @param value true if the toolbar display the image for each button; otherwise, false. The default is true. @@ -187,7 +187,7 @@ namespace xtd { virtual tool_bar& show_icon(bool value); /// @brief Gets a value indicating whether the toolbar displays the text for each button. - /// @return true if the toolbar display the text for each button; otherwise, false. The default is false. + /// @return `true` if the toolbar display the text for each button; otherwise, false. The default is false. virtual bool show_text() const noexcept; /// @brief Sets a value indicating whether the toolbar displays the text for each button. /// @param value true if the toolbar display the text for each button; otherwise, false. The default is false. @@ -195,7 +195,7 @@ namespace xtd { virtual tool_bar& show_text(bool value); /// @brief Gets a value indicating whether the toolbar displays a xtd::forms::tool_tip for each button. - /// @return true if the toolbar display a xtd::forms::tool_tip for each button; otherwise, false. The default is false. + /// @return `true` if the toolbar display a xtd::forms::tool_tip for each button; otherwise, false. The default is false. /// @remarks To set the text displayed by the xtd::forms::tool_tip, set the xtd::forms::tool_bar_button::tool_tip_text property of each xtd::forms::tool_bar_button on the xtd::forms::tool_bar. To cause the xtd::forms::tool_tip to display as the user moves the mouse pointer over the toolbar button, set the xtd::forms::tool_bar::show_tool_tips property to true. virtual bool show_tool_tips() const noexcept; /// @brief Sets a value indicating whether the toolbar displays a xtd::forms::tool_tip for each button. @@ -215,7 +215,7 @@ namespace xtd { virtual tool_bar& text_align(xtd::forms::tool_bar_text_align value); /// @brief Gets a value indicating whether the toolbar buttons wrap to the next line if the toolbar becomes too small to display all the buttons on the same line. - /// @return true if the toolbar buttons wrap to another line if the toolbar becomes too small to display all the buttons on the same line; otherwise, false. The default value is true. + /// @return `true` if the toolbar buttons wrap to another line if the toolbar becomes too small to display all the buttons on the same line; otherwise, false. The default value is true. /// @note Not yet implemented. virtual bool wrappable() const noexcept; /// @brief Gets a value indicating whether the toolbar buttons wrap to the next line if the toolbar becomes too small to display all the buttons on the same line. diff --git a/src/xtd.forms/include/xtd/forms/tool_bar_button.hpp b/src/xtd.forms/include/xtd/forms/tool_bar_button.hpp index f2f0add83df2..cf036bfdc6cd 100644 --- a/src/xtd.forms/include/xtd/forms/tool_bar_button.hpp +++ b/src/xtd.forms/include/xtd/forms/tool_bar_button.hpp @@ -96,7 +96,7 @@ namespace xtd { tool_bar_button& drop_down_menu(std::nullptr_t value); /// @brief Gets a value indicating whether the button is enabled. - /// @return true if the button is enabled; otherwise, false. The default is true. + /// @return `true` if the button is enabled; otherwise, false. The default is true. /// @remarks When the xtd::forms::tool_bar_button::enabled property is set to false, the toolbar button cannot be clicked, and the button's appearance changes. The xtd::drawing::image and xtd::forms::tool_bar_button::text assigned to the button appear grayed out. If the image or text has multiple colors, they display in a monochromatic gray. bool enabled() const noexcept; /// @brief Sets a value indicating whether the button is enabled. @@ -185,7 +185,7 @@ namespace xtd { tool_bar_button& tool_tip_text(const xtd::string& value); /// @brief Gets a value indicating whether the toolbar button is visible. - /// @return true if the toolbar button is visible; otherwise, false. The default is true. + /// @return `true` if the toolbar button is visible; otherwise, false. The default is true. /// @remarks If the toolbar button is not visible, it will not be displayed on the toolbar, and therefore cannot receive user input. bool visible() const noexcept; /// @brief Sets a value indicating whether the toolbar button is visible. diff --git a/src/xtd.forms/include/xtd/forms/trace_form_base.hpp b/src/xtd.forms/include/xtd/forms/trace_form_base.hpp index e623996a405b..d5ef77db21f0 100644 --- a/src/xtd.forms/include/xtd/forms/trace_form_base.hpp +++ b/src/xtd.forms/include/xtd/forms/trace_form_base.hpp @@ -47,18 +47,18 @@ namespace xtd { const xtd::string& name() const noexcept override; /// @brief Gets a value indicate if date is showing before trace text. - /// @return true is date showing; otherwise false. By default is true. + /// @return `true` is date showing; otherwise `false`. By default is true. virtual bool show_date() const noexcept; /// @brief Sets a value indicate if date is showing before trace text. - /// @param value true is date showing; otherwise false. By default is true. + /// @param value true is date showing; otherwise `false`. By default is true. /// @return Current trace_form_base. virtual trace_form_base& show_date(bool value); /// @brief Gets a value indicate if time is showing before trace text. - /// @return true is time showing; otherwise false. By default is true. + /// @return `true` is time showing; otherwise `false`. By default is true. virtual bool show_time() const noexcept; /// @brief Sets a value indicate if time is showing before trace text. - /// @param value true is time showing; otherwise false. By default is true. + /// @param value true is time showing; otherwise `false`. By default is true. /// @return Current trace_form_base. virtual trace_form_base& show_time(bool value); /// @} @@ -91,11 +91,11 @@ namespace xtd { virtual void write_header(); /// @brief Gets a value indicate if header need written. - /// @return true if header needed; otherwise false. + /// @return `true` if header needed; otherwise `false`. /// @remarks After each line terminator, header was needed. virtual bool need_header() const; /// @brief Sets a value indicate if header need written. - /// @param value true if header needed; otherwise false. + /// @param value true if header needed; otherwise `false`. /// @remarks After each line terminator, header was needed. /// @return Current trace_form_base. virtual trace_form_base& need_header(bool value); diff --git a/src/xtd.forms/include/xtd/forms/up_down_button.hpp b/src/xtd.forms/include/xtd/forms/up_down_button.hpp index 7c22952e2957..fc0c95002409 100644 --- a/src/xtd.forms/include/xtd/forms/up_down_button.hpp +++ b/src/xtd.forms/include/xtd/forms/up_down_button.hpp @@ -85,10 +85,10 @@ namespace xtd { virtual up_down_button& value(int32 value); /// @brief Gets a value indicate if value can be wrapped. - /// @return true if value can be wrapped; otherwise false. The default is false. + /// @return `true` if value can be wrapped; otherwise `false`. The default is false. virtual bool wrapped() const noexcept; /// @brief Sets a value indicate if value can be wrapped. - /// @param value true if value can be wrapped; otherwise false. The default is false. + /// @param value true if value can be wrapped; otherwise `false`. The default is false. /// @return Current numeric_up_down. virtual up_down_button& wrapped(bool value); /// @} diff --git a/src/xtd.forms/include/xtd/forms/vertical_control_layout_style.hpp b/src/xtd.forms/include/xtd/forms/vertical_control_layout_style.hpp index 21932372fb5e..aea59b87e0a2 100644 --- a/src/xtd.forms/include/xtd/forms/vertical_control_layout_style.hpp +++ b/src/xtd.forms/include/xtd/forms/vertical_control_layout_style.hpp @@ -45,15 +45,15 @@ namespace xtd { /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size. vertical_control_layout_style(int32 height, xtd::forms::size_type size_type); /// @brief Initialises a new instance of vertical control layout style class with specified expanded. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. explicit vertical_control_layout_style(bool expanded); /// @brief Initialises a new instance of vertical control layout style class with specified height and expanded. /// @param height The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. vertical_control_layout_style(float height, bool expanded); /// @brief Initialises a new instance of vertical control layout style class with specified height and expanded. /// @param height The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. vertical_control_layout_style(int32 height, bool expanded); /// @brief Initialises a new instance of vertical control layout style class with specified content alignment. /// @param align One of the content_alignment values. The default is middle_center. @@ -68,17 +68,17 @@ namespace xtd { vertical_control_layout_style(int32 height, xtd::forms::content_alignment align); /// @brief Initialises a new instance of vertical control layout style class with specified size type and expanded. /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. vertical_control_layout_style(xtd::forms::size_type size_type, bool expanded); /// @brief Initialises a new instance of vertical control layout style class with specified height, size type and expanded. /// @param height The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property. /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. vertical_control_layout_style(float height, xtd::forms::size_type size_type, bool expanded); /// @brief Initialises a new instance of vertical control layout style class with specified height, size type and expanded. /// @param height The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property. /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. vertical_control_layout_style(int32 height, xtd::forms::size_type size_type, bool expanded); /// @brief Initialises a new instance of vertical control layout style class with specified size type and content alignment. /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size. @@ -96,33 +96,33 @@ namespace xtd { vertical_control_layout_style(int32 height, xtd::forms::size_type size_type, xtd::forms::content_alignment align); /// @brief Initialises a new instance of vertical control layout style class with specified size type, expanded and content alignment. /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. /// @param align One of the content_alignment values. The default is middle_center. vertical_control_layout_style(xtd::forms::size_type size_type, bool expanded, xtd::forms::content_alignment align); /// @brief Initialises a new instance of vertical control layout style class with specified height, size type, expanded and content alignment. /// @param height The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property. /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. /// @param align One of the content_alignment values. The default is middle_center. vertical_control_layout_style(float height, xtd::forms::size_type size_type, bool expanded, xtd::forms::content_alignment align); /// @brief Initialises a new instance of vertical control layout style class with specified height, size type, expanded and content alignment. /// @param height The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property. /// @param size_type One of the xtd::forms::size_type values that specifies how layout container of user interface (UI) elements should be sized relative to their container. The default is xtd::forms::size_type::auto_size. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. /// @param align One of the content_alignment values. The default is middle_center. vertical_control_layout_style(int32 height, xtd::forms::size_type size_type, bool expanded, xtd::forms::content_alignment align); /// @brief Initialises a new instance of vertical control layout style class with specified expanded and content alignment. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. /// @param align One of the content_alignment values. The default is middle_center. vertical_control_layout_style(bool expanded, xtd::forms::content_alignment align); /// @brief Initialises a new instance of vertical control layout style class with specified height, expanded and content alignment. /// @param height The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. /// @param align One of the content_alignment values. The default is middle_center. vertical_control_layout_style(float height, bool expanded, xtd::forms::content_alignment align); /// @brief Initialises a new instance of vertical control layout style class with specified height, expanded and content alignment. /// @param height The preferred height, in pixels or percentage, depending on the xtd::forms::control_layout_style::size_type property. - /// @param expanded true if control expanded; otherwise false. + /// @param expanded true if control expanded; otherwise `false`. /// @param align One of the content_alignment values. The default is middle_center. vertical_control_layout_style(int32 height, bool expanded, xtd::forms::content_alignment align); /// @} diff --git a/src/xtd.tunit/include/xtd/tunit/settings.hpp b/src/xtd.tunit/include/xtd/tunit/settings.hpp index 2f835ef071b3..68778153b304 100644 --- a/src/xtd.tunit/include/xtd/tunit/settings.hpp +++ b/src/xtd.tunit/include/xtd/tunit/settings.hpp @@ -216,11 +216,11 @@ namespace xtd { void show_duration(bool show_duration) noexcept; /// @brief Gets shuffle tests. - /// @return `true` if shuffle test; otherwise false. The default value is `false`. + /// @return `true` if shuffle test; otherwise `false`. The default value is `false`. bool shuffle_test() const noexcept; /// @brief Sets shuffle tests. - /// @param shuffle_test `true` if shuffle test; otherwise false. The default value is `false`. + /// @param shuffle_test `true` if shuffle test; otherwise `false`. The default value is `false`. void shuffle_test(bool shuffle_test) noexcept; /// @brief Gets unit test start time. diff --git a/src/xtd.tunit/include/xtd/tunit/test.hpp b/src/xtd.tunit/include/xtd/tunit/test.hpp index eba1d3308173..3a2d8f5bbaeb 100644 --- a/src/xtd.tunit/include/xtd/tunit/test.hpp +++ b/src/xtd.tunit/include/xtd/tunit/test.hpp @@ -65,7 +65,7 @@ namespace xtd { /// @{ /// @brief Gets a value that represent an aborted test. - /// @return true is the test is aborted; otherwise false. + /// @return `true` is the test is aborted; otherwise `false`. bool aborted() const noexcept; /// @brief Gets the actual value string. @@ -81,19 +81,19 @@ namespace xtd { const xtd::string& expect() const noexcept; /// @brief Gest a value that represent an failed test. - /// @return tru is the test is failed; otherwise false. + /// @return tru is the test is failed; otherwise `false`. bool failed() const noexcept; /// @brief Get a value that represent an ignored test. - /// @return true is the test is ignored; otherwise false. + /// @return `true` is the test is ignored; otherwise `false`. bool ignored() const noexcept; /// @brief Get a value that represent a not started test. - /// @return true is the test is not started; otherwise false. + /// @return `true` is the test is not started; otherwise `false`. bool not_started() const noexcept; /// @brief Gets a value that represent an succeed test. - /// @return true is the test is succeed; otherwise false. + /// @return `true` is the test is succeed; otherwise `false`. bool succeed() const noexcept; /// @brief Gets the stack frame of the test method. diff --git a/src/xtd.tunit/include/xtd/tunit/unit_test.hpp b/src/xtd.tunit/include/xtd/tunit/unit_test.hpp index bb2bb8d3007f..73ad3ae71749 100644 --- a/src/xtd.tunit/include/xtd/tunit/unit_test.hpp +++ b/src/xtd.tunit/include/xtd/tunit/unit_test.hpp @@ -59,7 +59,7 @@ namespace xtd { int32 repeat_iteration_count() const noexcept; /// @brief Gets a boolean indictaes if there is repeat tests. - /// @return true is repart test; otherwhise false. + /// @return `true` is repart test; otherwise `false`. /// @remarks Returns true if xtd::tunit::unit_test::repeat_test_count greater than 0. bool repeat_tests() const noexcept; @@ -138,7 +138,7 @@ namespace xtd { /// @brief Parses the specified arguments. /// @param The arguments to parse. - /// @return true the execution process stops immediately after the analysis of the arguments; otherwise false the execution process continues its execution. + /// @return `true` the execution process stops immediately after the analysis of the arguments; otherwise `false` the execution process continues its execution. /// @remarks This method can be overloaded by the heirs. It is typically in this method that the heirs can react to their own arguments. Like for example display a helper when the @p -help argument is passed. virtual bool parse_arguments(const std::vector& args); /// @}