added documentation github page

krnlexception · Apr 20, 2024 · 3e1a11c · 3e1a11c
1 parent ef328f5
commit 3e1a11c
Show file tree

Hide file tree

Showing 253 changed files with 3,575 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -14,6 +14,10 @@ You can download the package from NuGet here: https://www.nuget.org/packages/Til
 ### DLL library
 Add `TiledCSPlus.dll` as a dependency in your project.
 
+## Documentation
+Full API reference is available at https://nolemretawxd.github.io/TiledCSPlus.
+For examples, see [TiledCSPlus.Examples](TiledCSPlus.Examples) project.
+
 ## Does it break compability?
 **YES**, practically every field was renamed to be in PascalCase, and few fields were combined into one property eg. `offsetX` and `offsetY` into `Vector2` `offset`. Except those few changes, API didn't change much as of now.
 

diff --git a/TiledCSPlus/NuGet.md b/TiledCSPlus/NuGet.md
@@ -2,14 +2,5 @@
 
 TiledCSPlus is an extended, and up to date fork of [TiledCS](https://github.com/TheBoneJarmer/TiledCS), a .NET library for loading Tiled maps and tilesets. Currently supports only uncompressed Base64 encoded .TMX maps and .TSX tilesets.
 
-## Planned features
-* ~~Support for Tiled 1.9 and 1.10 features.~~ Fully supported!
-* ~~Embedded tilesets~~ Done!
-* ~~Better layer arrangement (layers will be arranged in order from top to bottom, instead of current tile layers, then object layers, and image layers at the end)~~ Also done!
-* Support for more formats
-
-## Does it break compability?
-**YES**, practically every field was renamed to be in PascalCase, and few fields were combined into one property eg. `offsetX` and `offsetY` into `Vector2` `offset`. Except those few changes, API didn't change much as of now.
-
 ## License
 TiledCSPlus is [licensed under MIT license](LICENSE). TiledCS, the original project, was created by [Ruben Labruyere](https://github.com/TheBoneJarmer), and it was [licensed under MIT license](LICENSE_orig).
diff --git a/docs/classes/CSharp/TiledCSPlus/Color-Summary.js b/docs/classes/CSharp/TiledCSPlus/Color-Summary.js
diff --git a/docs/classes/CSharp/TiledCSPlus/Color-SummaryToolTips.js b/docs/classes/CSharp/TiledCSPlus/Color-SummaryToolTips.js
diff --git a/docs/classes/CSharp/TiledCSPlus/Color-ToolTips.js b/docs/classes/CSharp/TiledCSPlus/Color-ToolTips.js
diff --git a/docs/classes/CSharp/TiledCSPlus/Color.html b/docs/classes/CSharp/TiledCSPlus/Color.html
@@ -0,0 +1,61 @@
+<!DOCTYPE html>
+
+<html class="NDPage NDContentPage"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>Color</title><link rel="stylesheet" type="text/css" href="../../../styles/main.css" /><script type="text/javascript" src="../../../styles/main.js"></script><script type="text/javascript">NDLoader.LoadJS("Content", "../../../styles/");</script></head>
+
+<!-- Generated by Natural Docs, version 2.3 -->
+
+<!-- saved from url=(0016)http://localhost -->
+
+<body onload="NDLoader.OnLoad('Content');">
+
+<script type="text/javascript">var q = window.location.search;if (q.startsWith("?Theme=")){var t = q.slice(7);var e = t.indexOf(";");if (e != -1){  t = t.slice(0, e);  }document.documentElement.classList.add(t + "Theme")}</script>
+
+<a name="Topic70"></a><div class="CTopic TClass LCSharp first">
+ <div class="CTitle"><span class="Qualifier">TiledCSPlus.</span>&#8203;Color</div>
+ <div class="NDClassPrototype HasParents" id="NDClassPrototype70"><div class="CPEntry Parent TClass"><div class="CPName">IEquatable&#8203;<span class="TemplateSignature">&lt;Color&gt;</span></div></div><div class="CPEntry TClass Current"><div class="CPModifiers"><span class="SHKeyword">public</span></div><div class="CPName"><span class="Qualifier">TiledCSPlus.</span>&#8203;Color</div></div></div>
+ <div class="CBody"><p>Represents a color in RGBA format</p></div>
+</div>
+
+<a name="Properties"></a><a name="Topic71"></a><div class="CTopic TGroup LCSharp">
+ <div class="CTitle">Properties</div>
+</div>
+
+<a name="R"></a><a name="Topic72"></a><div class="CTopic TProperty LCSharp">
+ <div class="CTitle">R</div>
+ <div id="NDPrototype72" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><div class="PParameterCells" data-WideColumnCount="3" data-NarrowColumnCount="2"><div class="PBeforeParameters RightSpaceOnWide" data-WideGridArea="1/1/3/2" data-NarrowGridArea="1/1/2/3" style="grid-area:1/1/3/2"><span class="SHKeyword">public</span> <span class="SHKeyword">byte</span> R {</div><div class="PName InFirstParameterColumn InLastParameterColumn" data-WideGridArea="1/2/2/3" data-NarrowGridArea="2/1/3/2" style="grid-area:1/2/2/3"><span class="SHKeyword">get</span>;</div><div class="PName InFirstParameterColumn InLastParameterColumn" data-WideGridArea="2/2/3/3" data-NarrowGridArea="3/1/4/2" style="grid-area:2/2/3/3"><span class="SHKeyword">set</span></div><div class="PAfterParameters" data-WideGridArea="2/3/3/4" data-NarrowGridArea="4/1/5/3" style="grid-area:2/3/3/4">}</div></div></div></div>
+ <div class="CBody"><p>Red channel of the color</p></div>
+</div>
+
+<a name="G"></a><a name="Topic73"></a><div class="CTopic TProperty LCSharp">
+ <div class="CTitle">G</div>
+ <div id="NDPrototype73" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><div class="PParameterCells" data-WideColumnCount="3" data-NarrowColumnCount="2"><div class="PBeforeParameters RightSpaceOnWide" data-WideGridArea="1/1/3/2" data-NarrowGridArea="1/1/2/3" style="grid-area:1/1/3/2"><span class="SHKeyword">public</span> <span class="SHKeyword">byte</span> G {</div><div class="PName InFirstParameterColumn InLastParameterColumn" data-WideGridArea="1/2/2/3" data-NarrowGridArea="2/1/3/2" style="grid-area:1/2/2/3"><span class="SHKeyword">get</span>;</div><div class="PName InFirstParameterColumn InLastParameterColumn" data-WideGridArea="2/2/3/3" data-NarrowGridArea="3/1/4/2" style="grid-area:2/2/3/3"><span class="SHKeyword">set</span></div><div class="PAfterParameters" data-WideGridArea="2/3/3/4" data-NarrowGridArea="4/1/5/3" style="grid-area:2/3/3/4">}</div></div></div></div>
+ <div class="CBody"><p>Green channel of the color</p></div>
+</div>
+
+<a name="B"></a><a name="Topic74"></a><div class="CTopic TProperty LCSharp">
+ <div class="CTitle">B</div>
+ <div id="NDPrototype74" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><div class="PParameterCells" data-WideColumnCount="3" data-NarrowColumnCount="2"><div class="PBeforeParameters RightSpaceOnWide" data-WideGridArea="1/1/3/2" data-NarrowGridArea="1/1/2/3" style="grid-area:1/1/3/2"><span class="SHKeyword">public</span> <span class="SHKeyword">byte</span> B {</div><div class="PName InFirstParameterColumn InLastParameterColumn" data-WideGridArea="1/2/2/3" data-NarrowGridArea="2/1/3/2" style="grid-area:1/2/2/3"><span class="SHKeyword">get</span>;</div><div class="PName InFirstParameterColumn InLastParameterColumn" data-WideGridArea="2/2/3/3" data-NarrowGridArea="3/1/4/2" style="grid-area:2/2/3/3"><span class="SHKeyword">set</span></div><div class="PAfterParameters" data-WideGridArea="2/3/3/4" data-NarrowGridArea="4/1/5/3" style="grid-area:2/3/3/4">}</div></div></div></div>
+ <div class="CBody"><p>Blue channel of the color</p></div>
+</div>
+
+<a name="A"></a><a name="Topic75"></a><div class="CTopic TProperty LCSharp">
+ <div class="CTitle">A</div>
+ <div id="NDPrototype75" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><div class="PParameterCells" data-WideColumnCount="3" data-NarrowColumnCount="2"><div class="PBeforeParameters RightSpaceOnWide" data-WideGridArea="1/1/3/2" data-NarrowGridArea="1/1/2/3" style="grid-area:1/1/3/2"><span class="SHKeyword">public</span> <span class="SHKeyword">byte</span> A {</div><div class="PName InFirstParameterColumn InLastParameterColumn" data-WideGridArea="1/2/2/3" data-NarrowGridArea="2/1/3/2" style="grid-area:1/2/2/3"><span class="SHKeyword">get</span>;</div><div class="PName InFirstParameterColumn InLastParameterColumn" data-WideGridArea="2/2/3/3" data-NarrowGridArea="3/1/4/2" style="grid-area:2/2/3/3"><span class="SHKeyword">set</span></div><div class="PAfterParameters" data-WideGridArea="2/3/3/4" data-NarrowGridArea="4/1/5/3" style="grid-area:2/3/3/4">}</div></div></div></div>
+ <div class="CBody"><p>Alpha channel of the color</p></div>
+</div>
+
+<a name="Functions"></a><a name="Topic76"></a><div class="CTopic TGroup LCSharp">
+ <div class="CTitle">Functions</div>
+</div>
+
+<a name="Color"></a><a name="Topic77"></a><div class="CTopic TFunction LCSharp">
+ <div class="CTitle">Color</div>
+ <div id="NDPrototype77" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><div class="PParameterCells" data-WideColumnCount="6" data-NarrowColumnCount="5"><div class="PBeforeParameters" data-WideGridArea="1/1/5/2" data-NarrowGridArea="1/1/2/6" style="grid-area:1/1/5/2"><span class="SHKeyword">public</span> Color(</div><div class="PType InFirstParameterColumn" data-WideGridArea="1/2/2/3" data-NarrowGridArea="2/1/3/2" style="grid-area:1/2/2/3"><span class="SHKeyword">byte</span>&nbsp;</div><div class="PName" data-WideGridArea="1/3/2/4" data-NarrowGridArea="2/2/3/3" style="grid-area:1/3/2/4">r,</div><div class="PType InFirstParameterColumn" data-WideGridArea="2/2/3/3" data-NarrowGridArea="3/1/4/2" style="grid-area:2/2/3/3"><span class="SHKeyword">byte</span>&nbsp;</div><div class="PName" data-WideGridArea="2/3/3/4" data-NarrowGridArea="3/2/4/3" style="grid-area:2/3/3/4">g,</div><div class="PType InFirstParameterColumn" data-WideGridArea="3/2/4/3" data-NarrowGridArea="4/1/5/2" style="grid-area:3/2/4/3"><span class="SHKeyword">byte</span>&nbsp;</div><div class="PName" data-WideGridArea="3/3/4/4" data-NarrowGridArea="4/2/5/3" style="grid-area:3/3/4/4">b,</div><div class="PType InFirstParameterColumn" data-WideGridArea="4/2/5/3" data-NarrowGridArea="5/1/6/2" style="grid-area:4/2/5/3"><span class="SHKeyword">byte</span>&nbsp;</div><div class="PName" data-WideGridArea="4/3/5/4" data-NarrowGridArea="5/2/6/3" style="grid-area:4/3/5/4">a</div><div class="PDefaultValueSeparator" data-WideGridArea="4/4/5/5" data-NarrowGridArea="5/3/6/4" style="grid-area:4/4/5/5">=&nbsp;</div><div class="PDefaultValue InLastParameterColumn" data-WideGridArea="4/5/5/6" data-NarrowGridArea="5/4/6/5" style="grid-area:4/5/5/6"> <span class="SHNumber">255</span></div><div class="PAfterParameters" data-WideGridArea="4/6/5/7" data-NarrowGridArea="6/1/7/6" style="grid-area:4/6/5/7">)</div></div></div></div>
+</div>
+
+<a name="Equals"></a><a name="Topic78"></a><div class="CTopic TFunction LCSharp last">
+ <div class="CTitle">Equals</div>
+ <div id="NDPrototype78" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><div class="PParameterCells" data-WideColumnCount="4" data-NarrowColumnCount="3"><div class="PBeforeParameters" data-WideGridArea="1/1/2/2" data-NarrowGridArea="1/1/2/4" style="grid-area:1/1/2/2"><span class="SHKeyword">public</span> <span class="SHKeyword">bool</span> Equals(</div><div class="PType InFirstParameterColumn" data-WideGridArea="1/2/2/3" data-NarrowGridArea="2/1/3/2" style="grid-area:1/2/2/3"><a href="../../../index.html#CSharpClass:TiledCSPlus.Color" target="_top" onmouseover="NDContentPage.OnLinkMouseOver(event,70);" onmouseout="NDContentPage.OnLinkMouseOut(event);" >Color</a>&nbsp;</div><div class="PName InLastParameterColumn" data-WideGridArea="1/3/2/4" data-NarrowGridArea="2/2/3/3" style="grid-area:1/3/2/4">other</div><div class="PAfterParameters" data-WideGridArea="1/4/2/5" data-NarrowGridArea="3/1/4/4" style="grid-area:1/4/2/5">)</div></div></div></div>
+</div>
+
+</body></html>
diff --git a/docs/classes/CSharp/TiledCSPlus/Extensions-Summary.js b/docs/classes/CSharp/TiledCSPlus/Extensions-Summary.js