Merge pull request #27 from IKE-B/26-pipeline-fix-dartdoc-action

26 pipeline fix dartdoc action
IKE-B · Oct 19, 2024 · 33bbb13 · 33bbb13
2 parents c93a779 + c7c93ee
commit 33bbb13
Show file tree

Hide file tree

Showing 163 changed files with 28,286 additions and 3 deletions.
diff --git a/.github/workflows/dartdoc.yml b/.github/workflows/dartdoc.yml
@@ -3,7 +3,7 @@ run-name: "docs(doc): generate dart documentation from code comments"
 on:
   push:
     branches:
-      - 11-documentation-documentation-generation-and-publishing
+      - dev
       - main
     paths:
       - revoiceme/lib/**
@@ -23,9 +23,10 @@ jobs:
           flutter
       # change to 
       - name: run documentation generator
+        working-directory: ./revoiceme
         run: |
-          cd revoiceme
-          dart doc --output ../docs
+          flutter pub get
+          dart doc . --output ../docs
       # stages changes, commits them and pushs them as contributor "github_actor"
       - name: commit and push
         uses: EndBug/add-and-commit@v9 # You can change this to use a specific version.

diff --git a/docs/__404error.html b/docs/__404error.html
@@ -0,0 +1,130 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
+  <meta name="description" content="revoiceme API docs, for the Dart programming language.">
+  <title>revoiceme - Dart API docs</title>
+
+
+
+  <link rel="preconnect" href="https://fonts.gstatic.com">
+  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
+  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet">
+
+  <link rel="stylesheet" href="static-assets/github.css?v1">
+  <link rel="stylesheet" href="static-assets/styles.css?v1">
+  <link rel="icon" href="static-assets/favicon.png?v1">
+
+
+</head>
+
+
+<body data-base-href="" data-using-base-href="false" class="light-theme">
+
+<div id="overlay-under-drawer"></div>
+
+<header id="title">
+  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
+  <ol class="breadcrumbs gt-separated dark hidden-xs">
+    <li class="self-crumb">revoiceme package</li>
+  </ol>
+  <div class="self-name">revoiceme</div>
+  <form class="search navbar-right" role="search">
+    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+  </form>
+  <div class="toggle" id="theme-button" title="Toggle brightness">
+    <label for="theme">
+      <input type="checkbox" id="theme" value="light-theme">
+      <span id="dark-theme-button" class="material-symbols-outlined">
+        dark_mode
+      </span>
+      <span id="light-theme-button" class="material-symbols-outlined">
+        light_mode
+      </span>
+    </label>
+  </div>
+</header>
+<main>
+
+  <div id="dartdoc-main-content" class="main-content">
+    <h1>404: Something's gone wrong :-(</h1>
+
+    <section class="desc">
+      <p>You've tried to visit a page that doesn't exist.  Luckily this site
+         has other <a href="index.html">pages</a>.</p>
+      <p>If you were looking for something specific, try searching:
+      <form class="search-body" role="search">
+        <input type="text" id="search-body" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+      </form>
+      </p>
+
+    </section>
+  </div> <!-- /.main-content -->
+
+  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
+    <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
+<header id="header-search-sidebar" class="hidden-l">
+  <form class="search-sidebar" role="search">
+    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
+  </form>
+</header>
+
+<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
+    <li class="self-crumb">revoiceme package</li>
+</ol>
+
+
+    <h5><span class="package-name">revoiceme</span> <span class="package-kind">package</span></h5>
+    <ol>
+      <li class="section-title">Topics</li>
+        <li><a href="topics/Screen-topic.html">Screen</a></li>
+        <li><a href="topics/Widget-topic.html">Widget</a></li>
+        <li><a href="topics/Global-topic.html">Global</a></li>
+        <li><a href="topics/Other-topic.html">Other</a></li>
+      <li class="section-title">Libraries</li>
+      <li><a href="core_routers_router/core_routers_router-library.html">core/routers/router</a></li>
+      <li><a href="core_utils_styles_default_theme/core_utils_styles_default_theme-library.html">core/utils/styles/default_theme</a></li>
+      <li><a href="core_utils_widgets_device_volume_slider_presentation_widget_device_volume_slider/core_utils_widgets_device_volume_slider_presentation_widget_device_volume_slider-library.html">core/utils/widgets/device_volume_slider/presentation/widget/device_volume_slider</a></li>
+      <li><a href="core_utils_widgets_nav_item_presentation_widget_nav_item/core_utils_widgets_nav_item_presentation_widget_nav_item-library.html">core/utils/widgets/nav_item/presentation/widget/nav_item</a></li>
+      <li><a href="core_utils_widgets_play_button_presentation_widget_play_button/core_utils_widgets_play_button_presentation_widget_play_button-library.html">core/utils/widgets/play_button/presentation/widget/play_button</a></li>
+      <li><a href="core_utils_widgets_revoiceme_appbar_presentation_widget_revoiceme_appbar/core_utils_widgets_revoiceme_appbar_presentation_widget_revoiceme_appbar-library.html">core/utils/widgets/revoiceme_appbar/presentation/widget/revoiceme_appbar</a></li>
+      <li><a href="core_utils_widgets_revoiceme_drawer_presentation_widget_revoiceme_drawer/core_utils_widgets_revoiceme_drawer_presentation_widget_revoiceme_drawer-library.html">core/utils/widgets/revoiceme_drawer/presentation/widget/revoiceme_drawer</a></li>
+      <li><a href="core_utils_widgets_small_padder_presentation_widget_small_padder/core_utils_widgets_small_padder_presentation_widget_small_padder-library.html">core/utils/widgets/small_padder/presentation/widget/small_padder</a></li>
+      <li><a href="core_utils_widgets_voice_change_demo_presentation_widget_voice_change_demo_bloc/core_utils_widgets_voice_change_demo_presentation_widget_voice_change_demo_bloc-library.html">core/utils/widgets/voice_change_demo/presentation/widget/voice_change_demo_bloc</a></li>
+      <li><a href="core_utils_widgets_voice_change_demo_presentation_widget_voice_change_demo_event/core_utils_widgets_voice_change_demo_presentation_widget_voice_change_demo_event-library.html">core/utils/widgets/voice_change_demo/presentation/widget/voice_change_demo_event</a></li>
+      <li><a href="core_utils_widgets_voice_change_demo_presentation_widget_voice_change_demo_state/core_utils_widgets_voice_change_demo_presentation_widget_voice_change_demo_state-library.html">core/utils/widgets/voice_change_demo/presentation/widget/voice_change_demo_state</a></li>
+      <li><a href="core_utils_widgets_voice_changer_slider_presentation_widget_voice_changer_slider/core_utils_widgets_voice_changer_slider_presentation_widget_voice_changer_slider-library.html">core/utils/widgets/voice_changer_slider/presentation/widget/voice_changer_slider</a></li>
+      <li><a href="main/main-library.html">main</a></li>
+      <li><a href="screens_main_presentation_screen_configurator_screen/screens_main_presentation_screen_configurator_screen-library.html">screens/main/presentation/screen/configurator_screen</a></li>
+      <li><a href="screens_main_presentation_screen_home_screen/screens_main_presentation_screen_home_screen-library.html">screens/main/presentation/screen/home_screen</a></li>
+</ol>
+
+  </div>
+
+  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
+  </div>
+
+</main>
+
+<footer>
+  <span class="no-break">
+    revoiceme
+      1.0.0+1
+  </span>
+
+
+</footer>
+
+
+
+<script src="static-assets/highlight.pack.js?v1"></script>
+<script src="static-assets/docs.dart.js"></script>
+
+
+
+</body>
+
+</html>
+
diff --git a/docs/categories.json b/docs/categories.json
@@ -0,0 +1 @@
+[{"name":"ConfiguratorScreen","qualifiedName":"configurator_screen.ConfiguratorScreen","href":"screens_main_presentation_screen_configurator_screen/ConfiguratorScreen-class.html","type":"class","categories":["Screen"]},{"name":"CustomThemeData","qualifiedName":"default_theme.CustomThemeData","href":"core_utils_styles_default_theme/CustomThemeData-class.html","type":"class","categories":["Other"]},{"name":"buildThemeData","qualifiedName":"default_theme.buildThemeData","href":"core_utils_styles_default_theme/buildThemeData.html","type":"function","categories":["Other"]},{"name":"DeviceVolumeSlider","qualifiedName":"device_volume_slider.DeviceVolumeSlider","href":"core_utils_widgets_device_volume_slider_presentation_widget_device_volume_slider/DeviceVolumeSlider-class.html","type":"class","categories":["Global","Widget"]},{"name":"HomeScreen","qualifiedName":"home_screen.HomeScreen","href":"screens_main_presentation_screen_home_screen/HomeScreen-class.html","type":"class","categories":["Screen"]},{"name":"ReVoiceMe","qualifiedName":"main.ReVoiceMe","href":"main/ReVoiceMe-class.html","type":"class","categories":["Other"]},{"name":"NavItem","qualifiedName":"nav_item.NavItem","href":"core_utils_widgets_nav_item_presentation_widget_nav_item/NavItem-class.html","type":"class","categories":["Widget"]},{"name":"PlayButton","qualifiedName":"play_button.PlayButton","href":"core_utils_widgets_play_button_presentation_widget_play_button/PlayButton-class.html","type":"class","categories":["Global","Widget"]},{"name":"ReVoiceMeAppBar","qualifiedName":"revoiceme_appbar.ReVoiceMeAppBar","href":"core_utils_widgets_revoiceme_appbar_presentation_widget_revoiceme_appbar/ReVoiceMeAppBar-class.html","type":"class","categories":["Global","Widget"]},{"name":"ReVoiceMeDrawer","qualifiedName":"revoiceme_drawer.ReVoiceMeDrawer","href":"core_utils_widgets_revoiceme_drawer_presentation_widget_revoiceme_drawer/ReVoiceMeDrawer-class.html","type":"class","categories":["Widget"]},{"name":"router","qualifiedName":"router.router","href":"core_routers_router/router.html","type":"top-level property","categories":["Other"]},{"name":"routes","qualifiedName":"router.routes","href":"core_routers_router/routes-constant.html","type":"top-level constant","categories":["Other"]},{"name":"SmallPadder","qualifiedName":"small_padder.SmallPadder","href":"core_utils_widgets_small_padder_presentation_widget_small_padder/SmallPadder-class.html","type":"class","categories":["Widget"]},{"name":"VoiceChangeDemo","qualifiedName":"voice_change_demo_bloc.VoiceChangeDemo","href":"core_utils_widgets_voice_change_demo_presentation_widget_voice_change_demo_bloc/VoiceChangeDemo-class.html","type":"class","categories":["Global","Other"]},{"name":"VoiceChangeDemoEvent","qualifiedName":"voice_change_demo_event.VoiceChangeDemoEvent","href":"core_utils_widgets_voice_change_demo_presentation_widget_voice_change_demo_event/VoiceChangeDemoEvent-class.html","type":"class","categories":["Other"]},{"name":"VoiceChangeDemoState","qualifiedName":"voice_change_demo_state.VoiceChangeDemoState","href":"core_utils_widgets_voice_change_demo_presentation_widget_voice_change_demo_state/VoiceChangeDemoState-class.html","type":"class","categories":["Other"]},{"name":"VoiceChangerSlider","qualifiedName":"voice_changer_slider.VoiceChangerSlider","href":"core_utils_widgets_voice_changer_slider_presentation_widget_voice_changer_slider/VoiceChangerSlider-class.html","type":"class","categories":["Widget"]}]
diff --git a/docs/categories/globals.md b/docs/categories/globals.md
@@ -0,0 +1,4 @@
+# Globals
+
+**Globals** are non-screen (screen as in the category Screens) pieces of code that rely on a custom, specific global state of the ReVoiceMe app.
+They will not function properly otherwise.
diff --git a/docs/categories/others.md b/docs/categories/others.md
@@ -0,0 +1,3 @@
+# Others
+
+**Others** contains special code parts of the project that do not fit into any other category.
diff --git a/docs/categories/screens.md b/docs/categories/screens.md
@@ -0,0 +1,6 @@
+# Screens
+
+**Screens** are the biggest building blocks of the app.
+They are composed of multiple components.
+They define the overall layout, navigation, structure and flow of the app.
+Appearance and features between screens is very distinct.
diff --git a/docs/categories/widgets.md b/docs/categories/widgets.md
@@ -0,0 +1,5 @@
+# Widgets
+
+**Widgets** are typically small and reusable components.
+They are the basic building blocks of the app.
+Multiple widgets can be combined into bigger components or screens.
diff --git a/docs/core_routers_router/core_routers_router-library-sidebar.html b/docs/core_routers_router/core_routers_router-library-sidebar.html
@@ -0,0 +1,15 @@
+<ol>
+
+
+
+
+      <li class="section-title"><a href="core_routers_router/core_routers_router-library.html#constants">Constants</a></li>
+        <li><a href="core_routers_router/routes-constant.html">routes</a></li>
+
+      <li class="section-title"><a href="core_routers_router/core_routers_router-library.html#properties">Properties</a></li>
+        <li><a href="core_routers_router/router.html">router</a></li>
+
+
+
+
+</ol>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		[{"name":"ConfiguratorScreen","qualifiedName":"configurator_screen.ConfiguratorScreen","href":"screens_main_presentation_screen_configurator_screen/ConfiguratorScreen-class.html","type":"class","categories":["Screen"]},{"name":"CustomThemeData","qualifiedName":"default_theme.CustomThemeData","href":"core_utils_styles_default_theme/CustomThemeData-class.html","type":"class","categories":["Other"]},{"name":"buildThemeData","qualifiedName":"default_theme.buildThemeData","href":"core_utils_styles_default_theme/buildThemeData.html","type":"function","categories":["Other"]},{"name":"DeviceVolumeSlider","qualifiedName":"device_volume_slider.DeviceVolumeSlider","href":"core_utils_widgets_device_volume_slider_presentation_widget_device_volume_slider/DeviceVolumeSlider-class.html","type":"class","categories":["Global","Widget"]},{"name":"HomeScreen","qualifiedName":"home_screen.HomeScreen","href":"screens_main_presentation_screen_home_screen/HomeScreen-class.html","type":"class","categories":["Screen"]},{"name":"ReVoiceMe","qualifiedName":"main.ReVoiceMe","href":"main/ReVoiceMe-class.html","type":"class","categories":["Other"]},{"name":"NavItem","qualifiedName":"nav_item.NavItem","href":"core_utils_widgets_nav_item_presentation_widget_nav_item/NavItem-class.html","type":"class","categories":["Widget"]},{"name":"PlayButton","qualifiedName":"play_button.PlayButton","href":"core_utils_widgets_play_button_presentation_widget_play_button/PlayButton-class.html","type":"class","categories":["Global","Widget"]},{"name":"ReVoiceMeAppBar","qualifiedName":"revoiceme_appbar.ReVoiceMeAppBar","href":"core_utils_widgets_revoiceme_appbar_presentation_widget_revoiceme_appbar/ReVoiceMeAppBar-class.html","type":"class","categories":["Global","Widget"]},{"name":"ReVoiceMeDrawer","qualifiedName":"revoiceme_drawer.ReVoiceMeDrawer","href":"core_utils_widgets_revoiceme_drawer_presentation_widget_revoiceme_drawer/ReVoiceMeDrawer-class.html","type":"class","categories":["Widget"]},{"name":"router","qualifiedName":"router.router","href":"core_routers_router/router.html","type":"top-level property","categories":["Other"]},{"name":"routes","qualifiedName":"router.routes","href":"core_routers_router/routes-constant.html","type":"top-level constant","categories":["Other"]},{"name":"SmallPadder","qualifiedName":"small_padder.SmallPadder","href":"core_utils_widgets_small_padder_presentation_widget_small_padder/SmallPadder-class.html","type":"class","categories":["Widget"]},{"name":"VoiceChangeDemo","qualifiedName":"voice_change_demo_bloc.VoiceChangeDemo","href":"core_utils_widgets_voice_change_demo_presentation_widget_voice_change_demo_bloc/VoiceChangeDemo-class.html","type":"class","categories":["Global","Other"]},{"name":"VoiceChangeDemoEvent","qualifiedName":"voice_change_demo_event.VoiceChangeDemoEvent","href":"core_utils_widgets_voice_change_demo_presentation_widget_voice_change_demo_event/VoiceChangeDemoEvent-class.html","type":"class","categories":["Other"]},{"name":"VoiceChangeDemoState","qualifiedName":"voice_change_demo_state.VoiceChangeDemoState","href":"core_utils_widgets_voice_change_demo_presentation_widget_voice_change_demo_state/VoiceChangeDemoState-class.html","type":"class","categories":["Other"]},{"name":"VoiceChangerSlider","qualifiedName":"voice_changer_slider.VoiceChangerSlider","href":"core_utils_widgets_voice_changer_slider_presentation_widget_voice_changer_slider/VoiceChangerSlider-class.html","type":"class","categories":["Widget"]}]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Others

		Others contains special code parts of the project that do not fit into any other category.