Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@CodeSmile-0000011110110111
CodeSmile-0000011110110111 committed Jan 24, 2024
1 parent 0d0e65f commit 672395e
Show file tree
Hide file tree
Showing 54 changed files with 2,497 additions and 767 deletions.
3 changes: 2 additions & 1 deletion Docs~/Doxyfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1049,7 +1049,8 @@ RECURSIVE = YES
# Note that relative paths are relative to the directory from which doxygen is
# run.

EXCLUDE = ../Tests
EXCLUDE = ../Tests \
../Samples~

# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
Expand Down
158 changes: 158 additions & 0 deletions Docs~/html/_code_smile_asset_database_examples_8cs_source.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CodeSmile AssetDatabase: P:/de.codesmile.assetdatabase/Samples~/CreateAndDelete/CodeSmileAssetDatabaseExamples.cs Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript" src="darkmode_toggle.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="steffen portrait codesmile logo larger top-left-64x62.png"/></td>
<td id="projectalign">
<div id="projectname">CodeSmile AssetDatabase<span id="projectnumber">&#160;1.8</span>
</div>
<div id="projectbrief">Clean and accessible version of Unity&#39;s ~20 year old AssetDatabase.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('_code_smile_asset_database_examples_8cs_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
<div class="headertitle"><div class="title">CodeSmileAssetDatabaseExamples.cs</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright (C) 2021-2024 Steffen Itterheim</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Refer to included LICENSE file for terms and conditions.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_code_smile_editor.html">CodeSmileEditor</a>;</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">using </span>System;</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">using </span>System.IO;</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">using </span>UnityEditor;</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">using </span>UnityEngine;</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="foldopen" id="foldopen00010" data-start="{" data-end="};">
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="class_code_smile_asset_database_examples.html"> 10</a></span><span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">class </span><a class="code hl_class" href="class_code_smile_asset_database_examples.html">CodeSmileAssetDatabaseExamples</a></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span>{</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">private</span> <span class="keyword">const</span> String TestFolder = <span class="stringliteral">&quot;Assets/_sub_folder_&quot;</span>;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> [MenuItem(<span class="stringliteral">&quot;Window/CodeSmile/AssetDatabase Examples/Create and Delete Asset&quot;</span>)]</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">private</span> <span class="keyword">static</span> <span class="keywordtype">void</span> CreateAndDeleteAsset()</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> {</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> var path = $<span class="stringliteral">&quot;{TestFolder}/TestAsset.asset&quot;</span>;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> var asset = <span class="keyword">new</span> <a class="code hl_class" href="class_code_smile_editor_1_1_asset.html">Asset</a>(ScriptableObject.CreateInstance&lt;<a class="code hl_class" href="class_test_asset.html">TestAsset</a>&gt;(), path);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> var instance = asset.MainObject;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> var assetPath = asset.AssetPath;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> Debug.Log($<span class="stringliteral">&quot;Asset &#39;{instance}&#39; created at &#39;{assetPath}&#39;&quot;</span>);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> var message = asset.GetMain&lt;<a class="code hl_class" href="class_test_asset.html">TestAsset</a>&gt;().Message;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> Debug.Log($<span class="stringliteral">&quot;Asset says: &#39;{message}&#39;&quot;</span>);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> asset.Delete();</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> Debug.Log($<span class="stringliteral">&quot;Asset deleted: {asset.IsDeleted}&quot;</span>);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// a folder is an asset, too!</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> var folder = <span class="keyword">new</span> <a class="code hl_class" href="class_code_smile_editor_1_1_asset.html">Asset</a>(TestFolder);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> folder.Delete();</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> Debug.Log($<span class="stringliteral">&quot;Testfolder removed: {!Directory.Exists(TestFolder)}&quot;</span>);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> }</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span>}</div>
</div>
<div class="ttc" id="aclass_code_smile_asset_database_examples_html"><div class="ttname"><a href="class_code_smile_asset_database_examples.html">CodeSmileAssetDatabaseExamples</a></div><div class="ttdef"><b>Definition</b> <a href="#l00010">CodeSmileAssetDatabaseExamples.cs:11</a></div></div>
<div class="ttc" id="aclass_code_smile_editor_1_1_asset_html"><div class="ttname"><a href="class_code_smile_editor_1_1_asset.html">CodeSmileEditor.Asset</a></div><div class="ttdoc">Replacement implementation for Unity's massive AssetDatabase class with a cleaner interface and more ...</div><div class="ttdef"><b>Definition</b> <a href="_asset_8_bundle_8cs_source.html#l00010">Asset.Bundle.cs:11</a></div></div>
<div class="ttc" id="aclass_test_asset_html"><div class="ttname"><a href="class_test_asset.html">TestAsset</a></div><div class="ttdef"><b>Definition</b> <a href="_test_asset_8cs_source.html#l00007">TestAsset.cs:8</a></div></div>
<div class="ttc" id="anamespace_code_smile_editor_html"><div class="ttname"><a href="namespace_code_smile_editor.html">CodeSmileEditor</a></div><div class="ttdef"><b>Definition</b> <a href="_asset_8_bundle_8cs_source.html#l00008">Asset.Bundle.cs:9</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_4489e9d55fb4f483f405cd4aeb8c8248.html">Samples~</a></li><li class="navelem"><a class="el" href="dir_3116713f16952cca50e94121c3c2735b.html">CreateAndDelete</a></li><li class="navelem"><b>CodeSmileAssetDatabaseExamples.cs</b></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
</ul>
</div>
</body>
</html>
131 changes: 131 additions & 0 deletions Docs~/html/_test_asset_8cs_source.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CodeSmile AssetDatabase: P:/de.codesmile.assetdatabase/Samples~/CreateAndDelete/TestAsset.cs Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript" src="darkmode_toggle.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="steffen portrait codesmile logo larger top-left-64x62.png"/></td>
<td id="projectalign">
<div id="projectname">CodeSmile AssetDatabase<span id="projectnumber">&#160;1.8</span>
</div>
<div id="projectbrief">Clean and accessible version of Unity&#39;s ~20 year old AssetDatabase.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('_test_asset_8cs_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
<div class="headertitle"><div class="title">TestAsset.cs</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright (C) 2021-2024 Steffen Itterheim</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Refer to included LICENSE file for terms and conditions.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">using </span>System;</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">using </span>UnityEngine;</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="foldopen" id="foldopen00007" data-start="{" data-end="};">
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"><a class="line" href="class_test_asset.html"> 7</a></span><span class="keyword">public</span> <span class="keyword">class </span><a class="code hl_class" href="class_test_asset.html">TestAsset</a> : ScriptableObject</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span>{</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> <span class="keyword">public</span> String Message = <span class="stringliteral">&quot;To be, or not to be: that is not a question.&quot;</span>;</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">private</span> <span class="keywordtype">void</span> OnEnable() =&gt; name = <span class="stringliteral">&quot;Test ScriptableObject&quot;</span>;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span>}</div>
</div>
<div class="ttc" id="aclass_test_asset_html"><div class="ttname"><a href="class_test_asset.html">TestAsset</a></div><div class="ttdef"><b>Definition</b> <a href="#l00007">TestAsset.cs:8</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_4489e9d55fb4f483f405cd4aeb8c8248.html">Samples~</a></li><li class="navelem"><a class="el" href="dir_3116713f16952cca50e94121c3c2735b.html">CreateAndDelete</a></li><li class="navelem"><b>TestAsset.cs</b></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
</ul>
</div>
</body>
</html>
Loading

0 comments on commit 672395e

Please sign in to comment.