mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-09-21 19:48:16 +08:00
docs: fix typos and grammar (#1055)
Some checks are pending
Build / Bazel, ${{ matrix.cxx }}, ${{ matrix.os }} (cl, cl, windows-latest) (push) Waiting to run
Build / Bazel, ${{ matrix.cxx }}, ${{ matrix.os }} (clang, clang++, macos-latest) (push) Waiting to run
Build / Bazel, ${{ matrix.cxx }}, ${{ matrix.os }} (clang, clang++, ubuntu-latest) (push) Waiting to run
Build / Bazel, ${{ matrix.cxx }}, ${{ matrix.os }} (gcc, g++, macos-latest) (push) Waiting to run
Build / Bazel, ${{ matrix.cxx }}, ${{ matrix.os }} (gcc, g++, ubuntu-latest) (push) Waiting to run
Build / CMake, ${{ matrix.compiler }}, ${{ matrix.os }} (cl, Windows MSVC, windows-latest) (push) Waiting to run
Build / CMake, ${{ matrix.compiler }}, ${{ matrix.os }} (gcc, Linux GCC, ubuntu-latest) (push) Waiting to run
Build / CMake, ${{ matrix.compiler }}, ${{ matrix.os }} (llvm, llvm-cov gcov, Linux Clang, ubuntu-latest) (push) Waiting to run
Build / CMake, ${{ matrix.compiler }}, ${{ matrix.os }} (llvm, llvm-cov gcov, MacOS clang, macos-latest) (push) Waiting to run
Build / Test modules (llvm, ubuntu-latest) (push) Waiting to run
Documentation / documentation (push) Waiting to run
Some checks are pending
Build / Bazel, ${{ matrix.cxx }}, ${{ matrix.os }} (cl, cl, windows-latest) (push) Waiting to run
Build / Bazel, ${{ matrix.cxx }}, ${{ matrix.os }} (clang, clang++, macos-latest) (push) Waiting to run
Build / Bazel, ${{ matrix.cxx }}, ${{ matrix.os }} (clang, clang++, ubuntu-latest) (push) Waiting to run
Build / Bazel, ${{ matrix.cxx }}, ${{ matrix.os }} (gcc, g++, macos-latest) (push) Waiting to run
Build / Bazel, ${{ matrix.cxx }}, ${{ matrix.os }} (gcc, g++, ubuntu-latest) (push) Waiting to run
Build / CMake, ${{ matrix.compiler }}, ${{ matrix.os }} (cl, Windows MSVC, windows-latest) (push) Waiting to run
Build / CMake, ${{ matrix.compiler }}, ${{ matrix.os }} (gcc, Linux GCC, ubuntu-latest) (push) Waiting to run
Build / CMake, ${{ matrix.compiler }}, ${{ matrix.os }} (llvm, llvm-cov gcov, Linux Clang, ubuntu-latest) (push) Waiting to run
Build / CMake, ${{ matrix.compiler }}, ${{ matrix.os }} (llvm, llvm-cov gcov, MacOS clang, macos-latest) (push) Waiting to run
Build / Test modules (llvm, ubuntu-latest) (push) Waiting to run
Documentation / documentation (push) Waiting to run
This commit is contained in:
@@ -12,11 +12,11 @@
|
||||
|
||||
namespace ftxui {
|
||||
|
||||
/// @brief A collapsible component. It display a checkbox with an arrow. Once
|
||||
/// activated, the children is displayed.
|
||||
/// @brief A collapsible component. It displays a checkbox with an arrow. Once
|
||||
/// activated, the child is displayed.
|
||||
/// @param label The label of the checkbox.
|
||||
/// @param child The children to display.
|
||||
/// @param show Hold the state about whether the children is displayed or not.
|
||||
/// @param child The child to display.
|
||||
/// @param show Hold the state about whether the child is displayed or not.
|
||||
///
|
||||
/// ### Example
|
||||
/// ```cpp
|
||||
|
@@ -68,7 +68,7 @@ void UnderlineOption::SetAnimationFunction(
|
||||
follower_function = std::move(f_follower);
|
||||
}
|
||||
|
||||
/// @brief Standard options for an horizontal menu.
|
||||
/// @brief Standard options for a horizontal menu.
|
||||
/// This can be useful to implement a tab bar.
|
||||
/// @ingroup component
|
||||
// static
|
||||
@@ -148,7 +148,7 @@ MenuOption MenuOption::VerticalAnimated() {
|
||||
return option;
|
||||
}
|
||||
|
||||
/// @brief Standard options for a horitontal menu with some separator.
|
||||
/// @brief Standard options for a horizontal menu with some separator.
|
||||
/// This can be useful to implement a tab bar.
|
||||
/// @ingroup component
|
||||
// static
|
||||
|
@@ -32,7 +32,7 @@ class ClearUnder : public NodeDecorator {
|
||||
} // namespace
|
||||
|
||||
/// @brief Before drawing |child|, clear the pixels below. This is useful in
|
||||
// combinaison with dbox.
|
||||
/// combination with dbox.
|
||||
/// @see ftxui::dbox
|
||||
/// @ingroup dom
|
||||
Element clear_under(Element element) {
|
||||
|
@@ -34,8 +34,8 @@ class Hyperlink : public NodeDecorator {
|
||||
} // namespace
|
||||
|
||||
/// @brief Make the rendered area clickable using a web browser.
|
||||
/// The link will be opened when the user click on it.
|
||||
/// This is supported only on a limited set of terminal emulator.
|
||||
/// The link will be opened when the user clicks on it.
|
||||
/// This is supported only on a limited set of terminal emulators.
|
||||
/// List: https://github.com/Alhadis/OSC8-Adoption/
|
||||
/// @param link The link
|
||||
/// @param child The input element.
|
||||
@@ -52,9 +52,9 @@ Element hyperlink(std::string link, Element child) {
|
||||
return std::make_shared<Hyperlink>(std::move(child), std::move(link));
|
||||
}
|
||||
|
||||
/// @brief Decorate using an hyperlink.
|
||||
/// The link will be opened when the user click on it.
|
||||
/// This is supported only on a limited set of terminal emulator.
|
||||
/// @brief Decorate using a hyperlink.
|
||||
/// The link will be opened when the user clicks on it.
|
||||
/// This is supported only on a limited set of terminal emulators.
|
||||
/// List: https://github.com/Alhadis/OSC8-Adoption/
|
||||
/// @param link The link to redirect the users to.
|
||||
/// @return The Decorator applying the hyperlink.
|
||||
|
@@ -16,7 +16,7 @@ Node::Node() = default;
|
||||
Node::Node(Elements children) : children_(std::move(children)) {}
|
||||
Node::~Node() = default;
|
||||
|
||||
/// @brief Compute how much space an elements needs.
|
||||
/// @brief Compute how much space an element needs.
|
||||
/// @ingroup dom
|
||||
void Node::ComputeRequirement() {
|
||||
if (children_.empty()) {
|
||||
|
@@ -15,8 +15,8 @@
|
||||
|
||||
namespace ftxui {
|
||||
|
||||
/// @brief Display a vertical scrollbar to the right.
|
||||
/// colors.
|
||||
/// @brief Display a vertical scrollbar on the right.
|
||||
/// Colors follow the content.
|
||||
/// @ingroup dom
|
||||
Element vscroll_indicator(Element child) {
|
||||
class Impl : public NodeDecorator {
|
||||
@@ -70,8 +70,8 @@ Element vscroll_indicator(Element child) {
|
||||
return std::make_shared<Impl>(std::move(child));
|
||||
}
|
||||
|
||||
/// @brief Display an horizontal scrollbar to the bottom.
|
||||
/// colors.
|
||||
/// @brief Display a horizontal scrollbar at the bottom.
|
||||
/// Colors follow the content.
|
||||
/// @ingroup dom
|
||||
Element hscroll_indicator(Element child) {
|
||||
class Impl : public NodeDecorator {
|
||||
|
@@ -427,7 +427,7 @@ Element separator(Pixel pixel) {
|
||||
return std::make_shared<SeparatorWithPixel>(std::move(pixel));
|
||||
}
|
||||
|
||||
/// @brief Draw an horizontal bar, with the area in between left/right colored
|
||||
/// @brief Draw a horizontal bar, with the area in between left/right colored
|
||||
/// differently.
|
||||
/// @param left the left limit of the active area.
|
||||
/// @param right the right limit of the active area.
|
||||
|
@@ -273,8 +273,8 @@ const std::vector<std::vector<std::vector<std::string>>> elements = {
|
||||
|
||||
} // namespace
|
||||
|
||||
/// @brief Useful to represent the effect of time and/or events. This display an
|
||||
/// ASCII art "video".
|
||||
/// @brief Useful to represent the effect of time and/or events. This displays
|
||||
/// an ASCII art "video".
|
||||
/// @param charset_index The type of "video".
|
||||
/// @param image_index The "frame" of the video. You need to increase this for
|
||||
/// every "step".
|
||||
|
@@ -28,7 +28,7 @@ class Underlined : public NodeDecorator {
|
||||
};
|
||||
} // namespace
|
||||
|
||||
/// @brief Make the underlined element to be underlined.
|
||||
/// @brief Underline the given element.
|
||||
/// @ingroup dom
|
||||
Element underlined(Element child) {
|
||||
return std::make_shared<Underlined>(std::move(child));
|
||||
|
Reference in New Issue
Block a user