zhangyiss/FTXUI
1
0
Fork 0
mirror of https://github.com/ArthurSonzogni/FTXUI.git synced 2025-10-31 10:38:09 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve documentation workflow (#163)

Browse Source 
* Compact project relative paths from doc directory

* Remove committed example_list.md

- generate example_list from cmake for documentation

* Fix doxygen same-line comments

* Add workflow for generating documentation
This commit is contained in:
Tushar Maheshwari
2021-07-23 12:10:47 +05:30
committed by GitHub
parent 7f95d59954
commit a40a54ec10
7 changed files with 72 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
include/ftxui/component/component_options.hpp
View File

@@ -9,11 +9,11 @@ namespace ftxui {
/// @brief Option for the Menu component.
/// @ingroup component
struct MenuOption {
Decorator style_normal = nothing; /// style.
Decorator style_focused = inverted; /// Style when focused.
Decorator style_selected = bold; /// Style when selected.
Decorator style_normal = nothing; ///< style.
Decorator style_focused = inverted; ///< Style when focused.
Decorator style_selected = bold; ///< Style when selected.
Decorator style_selected_focused =
Decorator(inverted) | bold; /// Style when selected and focused.
Decorator(inverted) | bold; ///< Style when selected and focused.
/// Called when the selected entry changes.
std::function<void()> on_change = [] {};
@@ -33,10 +33,10 @@ struct ButtonOption {
/// @brief Option for the Checkbox component.
/// @ingroup component
struct CheckboxOption {
std::wstring style_checked = L"▣ "; /// Prefix for a "checked" state.
std::wstring style_unchecked = L"☐ "; /// Prefix for a "unchecked" state.
Decorator style_focused = inverted; /// Decorator used when focused.
Decorator style_unfocused = nothing; /// Decorator used when unfocused.
std::wstring style_checked = L"▣ "; ///< Prefix for a "checked" state.
std::wstring style_unchecked = L"☐ "; ///< Prefix for a "unchecked" state.
Decorator style_focused = inverted; ///< Decorator used when focused.
Decorator style_unfocused = nothing; ///< Decorator used when unfocused.
/// Called when the user change the state.
std::function<void()> on_change = []() {};
@@ -59,10 +59,10 @@ struct InputOption {
/// @brief Option for the Radiobox component.
/// @ingroup component
struct RadioboxOption {
std::wstring style_checked = L"◉ "; /// Prefix for a "checked" state.
std::wstring style_unchecked = L"○ "; /// Prefix for a "unchecked" state.
Decorator style_focused = inverted; /// Decorator used when focused.
Decorator style_unfocused = nothing; /// Decorator used when unfocused.
std::wstring style_checked = L"◉ "; ///< Prefix for a "checked" state.
std::wstring style_unchecked = L"○ "; ///< Prefix for a "unchecked" state.
Decorator style_focused = inverted; ///< Decorator used when focused.
Decorator style_unfocused = nothing; ///< Decorator used when unfocused.
/// Called when the selected entry changes.
std::function<void()> on_change = []() {};
@@ -73,11 +73,11 @@ struct RadioboxOption {
/// @brief Option for the Toggle component.
/// @ingroup component
struct ToggleOption {
Decorator style_normal = nothing; /// style.
Decorator style_focused = inverted; /// Style when focused.
Decorator style_selected = bold; /// Style when selected.
Decorator style_normal = nothing; ///< style.
Decorator style_focused = inverted; ///< Style when focused.
Decorator style_selected = bold; ///< Style when selected.
Decorator style_selected_focused =
Decorator(inverted) | bold; /// Style when selected and focused.
Decorator(inverted) | bold; ///< Style when selected and focused.
/// Called when the selected entry changes.
std::function<void()> on_change = [] {};