Docs: Refactor documentation (#328)

* Refactor Flutter documentation * Fix typo * Bump Boosted dep * .
Orange-OpenSource · Mar 5, 2024 · d1dab1f · d1dab1f
1 parent b7b558b
commit d1dab1f
Show file tree

Hide file tree

Showing 214 changed files with 661 additions and 509 deletions.
diff --git a/app/lib/constants.dart b/app/lib/constants.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/domain/recipes/my_app_state.dart b/app/lib/domain/recipes/my_app_state.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/domain/recipes/recipes_entities.dart b/app/lib/domain/recipes/recipes_entities.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/main.dart b/app/lib/main.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/about/about_screen.dart b/app/lib/ui/about/about_screen.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/about/detail/about_file_screen.dart b/app/lib/ui/about/detail/about_file_screen.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/app_bars/top/top_app_bar_large.dart b/app/lib/ui/components/app_bars/top/top_app_bar_large.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/app_bars/top/top_app_bars.dart b/app/lib/ui/components/app_bars/top/top_app_bars.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/app_bars/top/top_app_bars_customization.dart b/app/lib/ui/components/app_bars/top/top_app_bars_customization.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/buttons/button_contained.dart b/app/lib/ui/components/buttons/button_contained.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/buttons/button_customization.dart b/app/lib/ui/components/buttons/button_customization.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/buttons/button_enum.dart b/app/lib/ui/components/buttons/button_enum.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/buttons/button_outlined.dart b/app/lib/ui/components/buttons/button_outlined.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/buttons/button_text.dart b/app/lib/ui/components/buttons/button_text.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/buttons/buttons_icon/button_icon.dart b/app/lib/ui/components/buttons/buttons_icon/button_icon.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/buttons/buttons_icon/button_icon_customization.dart b/app/lib/ui/components/buttons/buttons_icon/button_icon_customization.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/buttons/buttons_icon/button_icon_enum.dart b/app/lib/ui/components/buttons/buttons_icon/button_icon_enum.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/buttons/segmented/segmented_button.dart b/app/lib/ui/components/buttons/segmented/segmented_button.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/buttons/segmented/segmented_button_customization.dart b/app/lib/ui/components/buttons/segmented/segmented_button_customization.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/buttons/segmented/segmented_button_enum.dart b/app/lib/ui/components/buttons/segmented/segmented_button_enum.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/cards/card_customization.dart b/app/lib/ui/components/cards/card_customization.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/cards/card_enum.dart b/app/lib/ui/components/cards/card_enum.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/cards/card_horizontal.dart b/app/lib/ui/components/cards/card_horizontal.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/cards/card_small.dart b/app/lib/ui/components/cards/card_small.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/cards/card_vertical_header_first.dart b/app/lib/ui/components/cards/card_vertical_header_first.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/cards/card_vertical_image_first.dart b/app/lib/ui/components/cards/card_vertical_image_first.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/checkboxes/checkboxes.dart b/app/lib/ui/components/checkboxes/checkboxes.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/checkboxes/checkboxes_customization.dart b/app/lib/ui/components/checkboxes/checkboxes_customization.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/chips/chips_action.dart b/app/lib/ui/components/chips/chips_action.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/chips/chips_choice.dart b/app/lib/ui/components/chips/chips_choice.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/chips/chips_customization.dart b/app/lib/ui/components/chips/chips_customization.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/chips/chips_enum.dart b/app/lib/ui/components/chips/chips_enum.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/chips/chips_filter.dart b/app/lib/ui/components/chips/chips_filter.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/chips/chips_input.dart b/app/lib/ui/components/chips/chips_input.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/component_entities.dart b/app/lib/ui/components/component_entities.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/components.dart b/app/lib/ui/components/components.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/components_screen.dart b/app/lib/ui/components/components_screen.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/detail_screen.dart b/app/lib/ui/components/detail_screen.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/dialogs/dialogs.dart b/app/lib/ui/components/dialogs/dialogs.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/dialogs/dialogs_customization.dart b/app/lib/ui/components/dialogs/dialogs_customization.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/floating_action_button/floating_action_button.dart b/app/lib/ui/components/floating_action_button/floating_action_button.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/floating_action_button/floating_action_button_enum.dart b/app/lib/ui/components/floating_action_button/floating_action_button_enum.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/floating_action_button/floating_action_customization.dart b/app/lib/ui/components/floating_action_button/floating_action_customization.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *

diff --git a/app/lib/ui/components/list_item/list_checkbox.dart b/app/lib/ui/components/list_item/list_checkbox.dart
@@ -3,7 +3,7 @@
  * SPDX-FileCopyrightText: Copyright (c) Orange SA
  * SPDX-License-Identifier: MIT
  *
- * This software is distributed under the MIT licence,
+ * This software is distributed under the MIT license,
  * the text of which is available at https://opensource.org/license/MIT/
  * or see the "LICENSE" file for more details.
  *