create the basics of a documentation (#7)(#31)

* chore: add dartdoc library to pubspec.yaml * chore: add comments for dartdoc * chore: add dartdoc library to THIRD_PARTY.md * chore: update changelog for dartdoc lib addition * chore: add generated dartdoc documentation
Orange-OpenSource · Dec 16, 2024 · 46dc751 · 46dc751
1 parent 31d2f7d
commit 46dc751
Show file tree

Hide file tree

Showing 28 changed files with 8,236 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- [Library] Create the basics of a documentation ([#7](https://github.com/Orange-OpenSource/ouds-flutter/issues/7))
+- [Library] Create the basic architecture of the library ([#4](https://github.com/Orange-OpenSource/ouds-flutter/issues/4))
 - [DemoApp] Create the basic architecture of the demo application ([#5](https://github.com/Orange-OpenSource/ouds-flutter/issues/5))
 
 ### Changed

diff --git a/THIRD_PARTY.md b/THIRD_PARTY.md
@@ -6,6 +6,12 @@ Copyright 2014 The Flutter Authors
 [https://github.com/flutter/flutter](https://github.com/flutter/flutter)
 BSD-3-Clause License
 
+### Dart documentation generator
+
+Copyright 2006 Ivan Sagalaev Authors
+[https://pub.dev/packages/dartdoc#dart-documentation-generator](https://pub.dev/packages/dartdoc#dart-documentation-generator)
+BSD-3-Clause License
+
 ## In the OUDS Playground app
 
 ### Flutter Localizations Framework

diff --git a/library/.gitignore b/library/.gitignore
@@ -24,6 +24,8 @@ migrate_working_dir/
 # Flutter/Dart/Pub related
 # Libraries should not include pubspec.lock, per https://dart.dev/guides/libraries/private-files#pubspeclock.
 /pubspec.lock
-**/doc/api/
 .dart_tool/
 build/
+
+# Allow doc-api to be tracked (generated documentation)
+!doc/api/
diff --git a/library/doc/api/__404error.html b/library/doc/api/__404error.html
@@ -0,0 +1,93 @@
+<!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="ouds_flutter API docs, for the Dart programming language.">
+  <title>ouds_flutter - 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">ouds_flutter package</li>
+  </ol>
+  <div class="self-name">ouds_flutter</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">ouds_flutter package</li>
+</ol>
+
+    <h5><span class="package-name">ouds_flutter</span> <span class="package-kind">package</span></h5>
+    <ol>
+      <li class="section-title">Libraries</li>
+      <li><a href="core_ouds_theme/core_ouds_theme-library.html">core/ouds_theme</a></li>
+</ol>
+
+  </div>
+  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
+  </div>
+</main>
+<footer>
+  <span class="no-break">
+    ouds_flutter
+      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/library/doc/api/categories.json b/library/doc/api/categories.json
@@ -0,0 +1 @@
+[]
diff --git a/library/doc/api/core_ouds_theme/OudsTheme-class-sidebar.html b/library/doc/api/core_ouds_theme/OudsTheme-class-sidebar.html
@@ -0,0 +1,29 @@
+<ol>
+
+
+
+
+        <li class="section-title inherited">
+          <a href="core_ouds_theme/OudsTheme-class.html#instance-properties">Properties</a>
+        </li>
+          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></li>
+          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></li>
+
+        <li class="section-title inherited"><a href="core_ouds_theme/OudsTheme-class.html#instance-methods">Methods</a></li>
+          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
+          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></li>
+
+        <li class="section-title inherited"><a href="core_ouds_theme/OudsTheme-class.html#operators">Operators</a></li>
+          <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></li>
+
+
+
+
+      <li class="section-title"><a href="core_ouds_theme/OudsTheme-class.html#static-properties">Static properties</a></li>
+        <li><a href="core_ouds_theme/OudsTheme/inverseThemeDark.html">inverseThemeDark</a></li>
+        <li><a href="core_ouds_theme/OudsTheme/inverseThemeLight.html">inverseThemeLight</a></li>
+        <li><a href="core_ouds_theme/OudsTheme/orangeThemeDark.html">orangeThemeDark</a></li>
+        <li><a href="core_ouds_theme/OudsTheme/orangeThemeLight.html">orangeThemeLight</a></li>
+
+
+</ol>