update docs, readme, changelog

CodeSmile-0000011110110111 · Jan 24, 2024 · 730100c · 730100c
1 parent d912787
commit 730100c
Show file tree

Hide file tree

Showing 68 changed files with 3,855 additions and 3,752 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,7 +8,7 @@
 #### v1.8.2 - Dec 26, 2023
 
 - updated README and API docs
-- removed extra call to ImportIfNotImported in method chain
+- removed extra call to "ImportIfNotImported" in load asset method chain
 
 #### v1.8.1 - Dec 21, 2023
 
@@ -20,7 +20,7 @@
 - renamed ForceReserializeAssets to UpgradeAssetSerializationVersion and
 - renamed ForceReserializeAllAssets to UpgradeAllAssetSerializationVersions (*)
 
-(*) To provide more rationale: I saw a user's script where the user helplessly threw in the usual candidates due to some issue, but this also included "ForceReserializeAssets" That's when I realized the name of the method only describes what it does internally but not its intent respectively what it should be used for: upgrading the version of serialized assets.
+(*) To provide more rationale: I saw a user's script where the user helplessly threw in the usual candidates due to some issue, but this also included "ForceReserializeAssets". That's when I realized the name of the method only describes what it does internally but not its intent respectively what it should be used for: upgrading the version (format) of serialized assets when you change editor versions and you want version control not polluting these upgrades in individual future commits.
 
 #### v1.7.1 - Dec 05, 2023
 

diff --git a/Docs~/Doxyfile b/Docs~/Doxyfile
@@ -2142,7 +2142,7 @@ USE_PDFLATEX           = YES
 # The default value is: NO.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
-LATEX_BATCHMODE        = NON_STOP
+LATEX_BATCHMODE        = YES
 
 # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
 # index chapters (such as File Index, Compound Index, etc.) in the output.

diff --git a/Docs~/Doxygen.bat b/Docs~/Doxygen.bat
@@ -8,3 +8,5 @@ if "%~1"=="clean" (
 
 REM run doxygen with the doxyfile in the same folder
 "C:\Program Files\doxygen\bin\doxygen.exe"
+
+call create-pdf-manual.bat
diff --git a/Docs~/create-pdf-manual.bat b/Docs~/create-pdf-manual.bat
@@ -0,0 +1,8 @@
+@echo off
+cd latex
+call make.bat
+
+cd..
+cd..
+echo.
+xcopy "Docs~/latex/refman.pdf" MANUAL.pdf /Y /F
diff --git a/Docs~/html/doxygen_crawl.html b/Docs~/html/doxygen_crawl.html
@@ -8,25 +8,25 @@
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 </head>
 <body>
-<a href="_asset_8_database_8cs_source.html"/>
 <a href="_asset_8cs_source.html"/>
-<a href="_asset_8_path_8_static_8cs_source.html"/>
-<a href="_asset_8_label_8cs_source.html"/>
 <a href="_asset_8_bundle_8cs_source.html"/>
-<a href="_asset_8_importer_8cs_source.html"/>
-<a href="_asset_8_file_8cs_source.html"/>
-<a href="_asset_8_static_8cs_source.html"/>
+<a href="_asset_8_database_8cs_source.html"/>
 <a href="_asset_8_database_8_cache_server_8cs_source.html"/>
+<a href="_asset_8_file_8cs_source.html"/>
 <a href="_asset_8_dependency_8cs_source.html"/>
-<a href="_asset_8_package_8cs_source.html"/>
-<a href="_asset_8_properties_8cs_source.html"/>
+<a href="_asset_8_label_8cs_source.html"/>
+<a href="_asset_8_importer_8cs_source.html"/>
 <a href="_asset_8_path_8cs_source.html"/>
-<a href="_asset_8_status_8cs_source.html"/>
-<a href="_string_extensions_8cs_source.html"/>
-<a href="_asset_load_exception_8cs_source.html"/>
-<a href="_asset_8_version_control_8cs_source.html"/>
+<a href="_asset_8_properties_8cs_source.html"/>
+<a href="_asset_8_package_8cs_source.html"/>
+<a href="_asset_8_path_8_static_8cs_source.html"/>
 <a href="_asset_8_sub_asset_8cs_source.html"/>
 <a href="_asset_8_throw_if_8cs_source.html"/>
+<a href="_string_extensions_8cs_source.html"/>
+<a href="_asset_8_version_control_8cs_source.html"/>
+<a href="_asset_8_static_8cs_source.html"/>
+<a href="_asset_load_exception_8cs_source.html"/>
+<a href="_asset_8_status_8cs_source.html"/>
 <a href="md__p_1_2de_8codesmile_8assetdatabase_2_c_h_a_n_g_e_l_o_g.html"/>
 <a href="md__p_1_2de_8codesmile_8assetdatabase_2_g_e_t_t_i_n_g_01_s_t_a_r_t_e_d.html"/>
 <a href="namespace_code_smile_editor.html"/>

diff --git a/Docs~/html/index.html b/Docs~/html/index.html
diff --git a/Docs~/html/index.js b/Docs~/html/index.js
@@ -0,0 +1,16 @@
+var index =
+[
+    [ "Why did I create this?", "index.html#why-did-i-create-this", null ],
+    [ "Main Features", "index.html#main-features", null ],
+    [ "Example Code Snippets", "index.html#example-code-snippets", null ],
+    [ "Documentation & Support", "index.html#documentation--support", null ],
+    [ "Installation", "index.html#installation", null ],
+    [ "Requirements", "index.html#requirements", null ],
+    [ "Licenses", "index.html#licenses", [
+      [ "Bam, now it is! :)", "index.html#bam-now-it-is-", null ],
+      [ "FREE => GPL License", "index.html#free--gpl-license", null ],
+      [ "PAID => Unity Asset Store EULA", "index.html#paid--unity-asset-store-eula", null ]
+    ] ],
+    [ "What to expect from me?", "index.html#what-to-expect-from-me", null ],
+    [ "Support, Feeback, Inquiries", "index.html#support-feeback-inquiries", null ]
+];
diff --git a/Docs~/html/md__p_1_2de_8codesmile_8assetdatabase_2_c_h_a_n_g_e_l_o_g.html b/Docs~/html/md__p_1_2de_8codesmile_8assetdatabase_2_c_h_a_n_g_e_l_o_g.html
@@ -109,7 +109,7 @@ <h3><a class="anchor" id="v182---dec-26-2023"></a>
 v1.8.2 - Dec 26, 2023</h3>
 <ul>
 <li>updated README and API docs</li>
-<li>removed extra call to ImportIfNotImported in method chain</li>
+<li>removed extra call to "ImportIfNotImported" in load asset method chain</li>
 </ul>
 <h3><a class="anchor" id="v181---dec-21-2023"></a>
 v1.8.1 - Dec 21, 2023</h3>
@@ -123,7 +123,7 @@ <h3><a class="anchor" id="v180---dec-09-2023"></a>
 <li>renamed ForceReserializeAssets to UpgradeAssetSerializationVersion and</li>
 <li>renamed ForceReserializeAllAssets to UpgradeAllAssetSerializationVersions (*)</li>
 </ul>
-<p>(*) To provide more rationale: I saw a user's script where the user helplessly threw in the usual candidates due to some issue, but this also included "ForceReserializeAssets" That's when I realized the name of the method only describes what it does internally but not its intent respectively what it should be used for: upgrading the version of serialized assets.</p>
+<p>(*) To provide more rationale: I saw a user's script where the user helplessly threw in the usual candidates due to some issue, but this also included "ForceReserializeAssets". That's when I realized the name of the method only describes what it does internally but not its intent respectively what it should be used for: upgrading the version (format) of serialized assets when you change editor versions and you want version control not polluting these upgrades in individual future commits.</p>
 <h3><a class="anchor" id="v171---dec-05-2023"></a>
 v1.7.1 - Dec 05, 2023</h3>
 <ul>

diff --git a/Docs~/html/md__p_1_2de_8codesmile_8assetdatabase_2_g_e_t_t_i_n_g_01_s_t_a_r_t_e_d.html b/Docs~/html/md__p_1_2de_8codesmile_8assetdatabase_2_g_e_t_t_i_n_g_01_s_t_a_r_t_e_d.html
@@ -105,9 +105,15 @@
 <p>Run the Tests to confirm that everything is alright:</p><ul>
 <li>Window =&gt; General =&gt; Test Runner -&gt; (EditMode) -&gt; select CodeSmile* -&gt; (Run Selected)</li>
 </ul>
-<p>Locate the Packages (README, scripts, etc):</p><ul>
+<p>Locate the Packages (README, Scripts, etc):</p><ul>
 <li>Project view: <code>Packages/CodeSmile *</code></li>
-<li>File system: <code>&lt;path-to-project&gt;/Packages/de.codesmile.*</code> </li>
+<li>File system: <code>&lt;path-to-project&gt;/Packages/de.codesmile.*</code></li>
+</ul>
+<p>Some packages include a MANUAL.pdf file which is the offline version of the API reference.</p>
+<p>You can find the latest versions and online documentation in the corresponding package repositories on <a href="https://github.com/CodeSmile-0000011110110111/" target="_blank">my GitHub profile</a> and on my Website <a href="https://codesmile.de/" target="_blank">CodeSmile.de</a>.</p>
+<ul>
+<li>Steffen aka CodeSmile</li>
+<li><a href="mailto:steffen@codesmile.de">Email</a> / <a href="https://discord.gg/JN3Jz8qkeV" target="_blank">Discord</a> </li>
 </ul>
 </div></div><!-- contents -->
 </div><!-- PageDoc -->

diff --git a/Docs~/html/navtreedata.js b/Docs~/html/navtreedata.js
@@ -25,17 +25,19 @@
 var NAVTREE =
 [
   [ "CodeSmile AssetDatabase", "index.html", [
-    [ "Who needs this?", "index.html#who-needs-this", null ],
-    [ "But .. why?", "index.html#but--why", null ],
+    [ "Why did I create this?", "index.html#why-did-i-create-this", null ],
+    [ "Main Features", "index.html#main-features", null ],
     [ "Example Code Snippets", "index.html#example-code-snippets", null ],
-    [ "I don't trust this ..", "index.html#i-dont-trust-this-", null ],
-    [ "What about support?", "index.html#what-about-support", null ],
-    [ "Where's Refresh?", "index.html#wheres-refresh", null ],
-    [ "Documentation", "index.html#documentation", null ],
+    [ "Documentation & Support", "index.html#documentation--support", null ],
     [ "Installation", "index.html#installation", null ],
     [ "Requirements", "index.html#requirements", null ],
-    [ "GPL License", "index.html#gpl-license", null ],
-    [ "Support & Feeback", "index.html#support--feeback", null ],
+    [ "Licenses", "index.html#licenses", [
+      [ "Bam, now it is! :)", "index.html#bam-now-it-is-", null ],
+      [ "FREE => GPL License", "index.html#free--gpl-license", null ],
+      [ "PAID => Unity Asset Store EULA", "index.html#paid--unity-asset-store-eula", null ]
+    ] ],
+    [ "What to expect from me?", "index.html#what-to-expect-from-me", null ],
+    [ "Support, Feeback, Inquiries", "index.html#support-feeback-inquiries", null ],
     [ "Change Log", "md__p_1_2de_8codesmile_8assetdatabase_2_c_h_a_n_g_e_l_o_g.html", null ],
     [ "CodeSmile Packages - Getting Started", "md__p_1_2de_8codesmile_8assetdatabase_2_g_e_t_t_i_n_g_01_s_t_a_r_t_e_d.html", null ],
     [ "Classes", "annotated.html", [
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,3 +8,5 @@ if "%~1"=="clean" (

		REM run doxygen with the doxyfile in the same folder
		"C:\Program Files\doxygen\bin\doxygen.exe"

		call create-pdf-manual.bat