amass/FTXUI
1
0
Fork 0
mirror of https://github.com/ArthurSonzogni/FTXUI.git synced 2024-11-26 12:37:06 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Doc: Fix @params vs @param (#605)

Browse Source 
Fixed wrong parameter documentation name.

Taken out of:
https://github.com/ArthurSonzogni/FTXUI/pull/600

Co-authored-by: LostInCompilation <12819635+LostInCompilation@users.noreply.github.com>
This commit is contained in:
Arthur Sonzogni 2023-03-26 15:56:28 +02:00 committed by GitHub
parent a366c5a423
commit 0b57be9c49
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/ftxui/component/collapsible.cpp
View File

@ -12,9 +12,9 @@ namespace ftxui {
/// @brief A collapsible component. It display a checkbox with an arrow. Once /// @brief A collapsible component. It display a checkbox with an arrow. Once
/// activated, the children is displayed. /// activated, the children is displayed.
/// @params label The label of the checkbox. /// @param label The label of the checkbox.
/// @params child The children to display. /// @param child The children to display.
/// @params show Hold the state about whether the children is displayed or not. /// @param show Hold the state about whether the children is displayed or not.
/// ///
/// ### Example /// ### Example
/// ```cpp /// ```cpp

8
src/ftxui/component/maybe.cpp
View File

@ -37,7 +37,7 @@ Component Maybe(Component child, std::function<bool()> show) {
/// @brief Decorate a component. It is shown only when the |show| function /// @brief Decorate a component. It is shown only when the |show| function
/// returns true. /// returns true.
/// @params show a function returning whether the decoratorated component should /// @param show a function returning whether the decoratorated component should
/// be shown. /// be shown.
/// @ingroup component /// @ingroup component
/// ///
@ -54,8 +54,8 @@ ComponentDecorator Maybe(std::function<bool()> show) {
} }
/// @brief Decorate a component |child|. It is shown only when |show| is true. /// @brief Decorate a component |child|. It is shown only when |show| is true.
/// @params child the compoennt to decorate. /// @param child the compoennt to decorate.
/// @params show a boolean. |child| is shown when |show| is true. /// @param show a boolean. |child| is shown when |show| is true.
/// @ingroup component /// @ingroup component
/// ///
/// ### Example /// ### Example
@ -69,7 +69,7 @@ Component Maybe(Component child, const bool* show) {
} }
/// @brief Decorate a component. It is shown only when |show| is true. /// @brief Decorate a component. It is shown only when |show| is true.
/// @params show a boolean. |child| is shown when |show| is true. /// @param show a boolean. |child| is shown when |show| is true.
/// @ingroup component /// @ingroup component
/// ///
/// ### Example /// ### Example