Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gammasoft71 committed Jan 28, 2025
1 parent d78e376 commit 7a1db78
Show file tree
Hide file tree
Showing 230 changed files with 1,039 additions and 1,039 deletions.
6 changes: 3 additions & 3 deletions src/xtd.core.native/include/xtd/native/condition_variable.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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);
/// @}
Expand Down
46 changes: 23 additions & 23 deletions src/xtd.core.native/include/xtd/native/console.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand All @@ -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.
Expand All @@ -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();

Expand All @@ -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);

Expand All @@ -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);

Expand All @@ -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);

Expand All @@ -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);

Expand Down Expand Up @@ -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);
Expand All @@ -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);

Expand All @@ -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);

Expand All @@ -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);

Expand All @@ -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);

Expand All @@ -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);

Expand All @@ -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);
/// @}
Expand Down
4 changes: 2 additions & 2 deletions src/xtd.core.native/include/xtd/native/critical_section.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/xtd.core.native/include/xtd/native/date_time.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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);
/// @}
Expand Down
6 changes: 3 additions & 3 deletions src/xtd.core.native/include/xtd/native/debugger.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/xtd.core.native/include/xtd/native/directory.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions src/xtd.core.native/include/xtd/native/drive.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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);
/// @}
Expand Down
4 changes: 2 additions & 2 deletions src/xtd.core.native/include/xtd/native/environment.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/xtd.core.native/include/xtd/native/file.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/xtd.core.native/include/xtd/native/file_system.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down
2 changes: 1 addition & 1 deletion src/xtd.core.native/include/xtd/native/named_mutex.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down
2 changes: 1 addition & 1 deletion src/xtd.core.native/include/xtd/native/named_semaphore.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down
Loading

0 comments on commit 7a1db78

Please sign in to comment.