Skip to content
Snippets Groups Projects
Unverified Commit 0b57be9c authored by Arthur Sonzogni's avatar Arthur Sonzogni Committed by GitHub
Browse files

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

Fixed wrong parameter documentation name.

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



Co-authored-by: default avatarLostInCompilation <12819635+LostInCompilation@users.noreply.github.com>
parent a366c5a4
No related branches found
No related tags found
No related merge requests found
...@@ -12,9 +12,9 @@ namespace ftxui { ...@@ -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
......
...@@ -37,7 +37,7 @@ Component Maybe(Component child, std::function<bool()> show) { ...@@ -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) { ...@@ -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) { ...@@ -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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment