Merge pull request #10 from dcronqvist/add-docs

Add docs

.editorconfig

@@ -5,4 +5,11 @@ charset = utf-8
 end_of_line = lf
 indent_size = 2
 indent_style = space
-insert_final_newline = true
+insert_final_newline = true
+
+[.github/**/*.yml]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true

.github/workflows/deploy-docs.yml

@@ -0,0 +1,41 @@
+on:
+  push:
+    branches:
+      - master
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  actions: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy-docs:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 8.0.x
+      - name: Setup DocFX
+        run: dotnet tool update -g docfx
+      - name: Build docs
+        run: make docs-build
+      - name: Upload docs
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_site
+      - name: Deploy docs
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/tests.yml

@@ -5,7 +5,7 @@ on:
       - dev
       
 jobs:
-  build:
+  tests:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
@@ -14,9 +14,9 @@ jobs:
       with:
         dotnet-version: 8.0.x
     - name: Restore dependencies
-      run: dotnet restore
+      run: dotnet restore src/DotTiled.sln
     - name: Build
-      run: dotnet build --no-restore
+      run: dotnet build --no-restore src/DotTiled.sln
     - name: Test
-      run: dotnet test --no-build --verbosity normal
+      run: dotnet test --no-build --verbosity normal src/DotTiled.sln
       

.gitignore

@@ -3,6 +3,11 @@
 ##
 ## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
 
+# Generated docs
+docs/_site/
+docs/api/
+docs/index.md
+
 # User-specific files
 *.rsuser
 *.suo

DotTiled/Model/Layers/Objects/PointObject.cs

@@ -1,3 +0,0 @@
-namespace DotTiled;
-
-public class PointObject : Object { }

DotTiled/Serialization/Tmj/Tmj.Wangset.cs

@@ -1,13 +0,0 @@
-using System;
-using System.Collections.Generic;
-using System.Globalization;
-using System.IO;
-using System.IO.Compression;
-using System.Linq;
-using System.Text.Json;
-
-namespace DotTiled;
-
-internal partial class Tmj
-{
-}

FUNDING.yml

@@ -1,15 +0,0 @@
-# These are supported funding model platforms
-
-github: [dcronqvist]
-patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
-polar: # Replace with a single Polar username
-buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
-thanks_dev: # Replace with a single thanks.dev username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

Makefile

@@ -1,5 +1,12 @@
 test:
-	dotnet test
+	dotnet test src/DotTiled.sln
+
+docs-serve: docs-build
+	docfx docs/docfx.json --serve
+
+docs-build:
+	cp README.md docs/index.md
+	docfx docs/docfx.json
 
 BENCHMARK_SOURCES = DotTiled.Benchmark/Program.cs DotTiled.Benchmark/DotTiled.Benchmark.csproj
 BENCHMARK_OUTPUTDIR = DotTiled.Benchmark/BenchmarkDotNet.Artifacts

README.md

@@ -8,8 +8,7 @@ DotTiled is designed to be a lightweight and efficient library that provides a s
 
 - [Alternative libraries and comparison + benchmarks](#alternative-libraries-and-comparison)
 - [Feature coverage comparison](#feature-coverage-comparison)
-- [Quickstart](#quickstart)
-  - [Installing DotTiled](#installing-dottiled)
+- [Installing DotTiled](#installing-dottiled)
 
 # Alternative libraries and comparison
 
@@ -74,9 +73,7 @@ Below is a comparison of the feature coverage of DotTiled and other similar libr
 > [!NOTE]
 > ✅ Full support. ⚠️ Partial support, see respective library for details about supported features. ❌ No support.
 
-# Quickstart
-
-### Installing DotTiled
+# Installing DotTiled
 
 DotTiled is available as a NuGet package. You can install it by using the NuGet Package Manager UI in Visual Studio, or equivalent, or using the following command for the .NET CLI:
 

docs/docfx.json

@@ -0,0 +1,46 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "src": "../src",
+          "files": [
+            "DotTiled/DotTiled.csproj"
+          ]
+        }
+      ],
+      "dest": "api"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "**/*.{md,yml}"
+        ],
+        "exclude": [
+          "_site/**"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ]
+      }
+    ],
+    "output": "_site",
+    "template": [
+      "default",
+      "modern",
+      "template"
+    ],
+    "globalMetadata": {
+      "_appName": "DotTiled",
+      "_appTitle": "DotTiled",
+      "_enableSearch": true,
+      "pdf": true
+    }
+  }
+}

docs/docs/loading-a-map.md

@@ -0,0 +1 @@
+# Loading a map

docs/docs/quickstart.md

@@ -0,0 +1 @@
+# Quick Start

docs/docs/toc.yml

@@ -0,0 +1,6 @@
+- name: Introduction
+- href: ../index.md
+- href: quickstart.md
+
+- name: Essentials
+- href: loading-a-map.md

docs/template/public/main.css

@@ -0,0 +1,4 @@
+body {
+    --bs-link-color-rgb: 66, 184, 131 !important;
+    --bs-link-hover-color-rgb: 64, 180, 128 !important;
+}

docs/toc.yml

@@ -0,0 +1,4 @@
+- name: Docs
+  href: docs/
+- name: API
+  href: api/

src/DotTiled.Benchmark/Program.cs

@@ -39,19 +39,19 @@ namespace MyBenchmarks
 
     [BenchmarkCategory("MapFromInMemoryTmxString")]
     [Benchmark(Baseline = true, Description = "DotTiled")]
-    public DotTiled.Map LoadWithDotTiledFromInMemoryTmxString()
+    public DotTiled.Model.Map LoadWithDotTiledFromInMemoryTmxString()
     {
       using var stringReader = new StringReader(_tmxContents);
       using var xmlReader = XmlReader.Create(stringReader);
-      using var mapReader = new DotTiled.TmxMapReader(xmlReader, _ => throw new Exception(), _ => throw new Exception(), []);
+      using var mapReader = new DotTiled.Serialization.Tmx.TmxMapReader(xmlReader, _ => throw new Exception(), _ => throw new Exception(), []);
       return mapReader.ReadMap();
     }
 
     [BenchmarkCategory("MapFromInMemoryTmjString")]
     [Benchmark(Baseline = true, Description = "DotTiled")]
-    public DotTiled.Map LoadWithDotTiledFromInMemoryTmjString()
+    public DotTiled.Model.Map LoadWithDotTiledFromInMemoryTmjString()
     {
-      using var mapReader = new DotTiled.TmjMapReader(_tmjContents, _ => throw new Exception(), _ => throw new Exception(), []);
+      using var mapReader = new DotTiled.Serialization.Tmj.TmjMapReader(_tmjContents, _ => throw new Exception(), _ => throw new Exception(), []);
       return mapReader.ReadMap();
     }
 

src/DotTiled.Tests/Assert/AssertData.cs

@@ -1,3 +1,5 @@
+using DotTiled.Model.Layers;
+
 namespace DotTiled.Tests;
 
 public static partial class DotTiledAssert

src/DotTiled.Tests/Assert/AssertImage.cs

@@ -1,3 +1,5 @@
+using DotTiled.Model.Tilesets;
+
 namespace DotTiled.Tests;
 
 public static partial class DotTiledAssert

src/DotTiled.Tests/Assert/AssertLayer.cs

@@ -1,3 +1,5 @@
+using DotTiled.Model.Layers;
+
 namespace DotTiled.Tests;
 
 public static partial class DotTiledAssert

src/DotTiled.Tests/Assert/AssertMap.cs

@@ -1,5 +1,6 @@
 using System.Collections;
 using System.Numerics;
+using DotTiled.Model;
 
 namespace DotTiled.Tests;
 

src/DotTiled.Tests/Assert/AssertObject.cs

@@ -1,20 +1,22 @@
+using DotTiled.Model.Layers.Objects;
+
 namespace DotTiled.Tests;
 
 public static partial class DotTiledAssert
 {
-  internal static void AssertObject(Object expected, Object actual)
+  internal static void AssertObject(Model.Layers.Objects.Object expected, Model.Layers.Objects.Object actual)
   {
     // Attributes
-    AssertEqual(expected.ID, actual.ID, nameof(Object.ID));
-    AssertEqual(expected.Name, actual.Name, nameof(Object.Name));
-    AssertEqual(expected.Type, actual.Type, nameof(Object.Type));
-    AssertEqual(expected.X, actual.X, nameof(Object.X));
-    AssertEqual(expected.Y, actual.Y, nameof(Object.Y));
-    AssertEqual(expected.Width, actual.Width, nameof(Object.Width));
-    AssertEqual(expected.Height, actual.Height, nameof(Object.Height));
-    AssertEqual(expected.Rotation, actual.Rotation, nameof(Object.Rotation));
-    AssertEqual(expected.Visible, actual.Visible, nameof(Object.Visible));
-    AssertEqual(expected.Template, actual.Template, nameof(Object.Template));
+    AssertEqual(expected.ID, actual.ID, nameof(Model.Layers.Objects.Object.ID));
+    AssertEqual(expected.Name, actual.Name, nameof(Model.Layers.Objects.Object.Name));
+    AssertEqual(expected.Type, actual.Type, nameof(Model.Layers.Objects.Object.Type));
+    AssertEqual(expected.X, actual.X, nameof(Model.Layers.Objects.Object.X));
+    AssertEqual(expected.Y, actual.Y, nameof(Model.Layers.Objects.Object.Y));
+    AssertEqual(expected.Width, actual.Width, nameof(Model.Layers.Objects.Object.Width));
+    AssertEqual(expected.Height, actual.Height, nameof(Model.Layers.Objects.Object.Height));
+    AssertEqual(expected.Rotation, actual.Rotation, nameof(Model.Layers.Objects.Object.Rotation));
+    AssertEqual(expected.Visible, actual.Visible, nameof(Model.Layers.Objects.Object.Visible));
+    AssertEqual(expected.Template, actual.Template, nameof(Model.Layers.Objects.Object.Template));
 
     AssertProperties(expected.Properties, actual.Properties);
 

src/DotTiled.Tests/Assert/AssertProperties.cs

@@ -1,3 +1,5 @@
+using DotTiled.Model.Properties;
+
 namespace DotTiled.Tests;
 
 public static partial class DotTiledAssert

src/DotTiled.Tests/Assert/AssertTileset.cs

@@ -1,3 +1,6 @@
+using DotTiled.Model.Layers;
+using DotTiled.Model.Tilesets;
+
 namespace DotTiled.Tests;
 
 public static partial class DotTiledAssert

src/DotTiled.Tests/Serialization/TestData.cs

@@ -1,4 +1,6 @@
 using System.Xml;
+using DotTiled.Model.Properties;
+using DotTiled.Model.Properties.CustomTypes;
 
 namespace DotTiled.Tests;
 

src/DotTiled.Tests/Serialization/TestData/Map/default-map/default-map.cs

@@ -1,3 +1,6 @@
+using DotTiled.Model;
+using DotTiled.Model.Layers;
+
 namespace DotTiled.Tests;
 
 public partial class TestData

src/DotTiled.Tests/Serialization/TestData/Map/map-external-tileset-multi/map-external-tileset-multi.cs

@@ -1,4 +1,8 @@
 using System.Globalization;
+using DotTiled.Model;
+using DotTiled.Model.Layers;
+using DotTiled.Model.Properties;
+using DotTiled.Model.Tilesets;
 
 namespace DotTiled.Tests;
 

src/DotTiled.Tests/Serialization/TestData/Map/map-external-tileset-wangset/map-external-tileset-wangset.cs

@@ -1,4 +1,7 @@
 using System.Globalization;
+using DotTiled.Model;
+using DotTiled.Model.Layers;
+using DotTiled.Model.Tilesets;
 
 namespace DotTiled.Tests;
 

src/DotTiled.Tests/Serialization/TestData/Map/map-with-common-props/map-with-common-props.cs

@@ -1,4 +1,7 @@
 using System.Globalization;
+using DotTiled.Model;
+using DotTiled.Model.Layers;
+using DotTiled.Model.Properties;
 
 namespace DotTiled.Tests;
 

src/DotTiled.Tests/Serialization/TestData/Map/map-with-custom-type-props/map-with-custom-type-props.cs

@@ -1,4 +1,8 @@
 using System.Globalization;
+using DotTiled.Model;
+using DotTiled.Model.Layers;
+using DotTiled.Model.Properties;
+using DotTiled.Model.Properties.CustomTypes;
 
 namespace DotTiled.Tests;
 

src/DotTiled.Tests/Serialization/TestData/Map/map-with-embedded-tileset/map-with-embedded-tileset.cs

@@ -1,4 +1,7 @@
 using System.Globalization;
+using DotTiled.Model;
+using DotTiled.Model.Layers;
+using DotTiled.Model.Tilesets;
 
 namespace DotTiled.Tests;
 

src/DotTiled.Tests/Serialization/TestData/Map/map-with-external-tileset/map-with-external-tileset.cs

@@ -1,4 +1,7 @@
 using System.Globalization;
+using DotTiled.Model;
+using DotTiled.Model.Layers;
+using DotTiled.Model.Tilesets;
 
 namespace DotTiled.Tests;
 

src/DotTiled.Tests/Serialization/TestData/Map/map-with-flippingflags/map-with-flippingflags.cs

@@ -1,4 +1,7 @@
 using System.Globalization;
+using DotTiled.Model;
+using DotTiled.Model.Layers;
+using DotTiled.Model.Tilesets;
 
 namespace DotTiled.Tests;
 

src/DotTiled.Tests/Serialization/TestData/Map/map-with-many-layers/map-with-many-layers.cs

@@ -1,4 +1,9 @@
 using System.Numerics;
+using DotTiled.Model;
+using DotTiled.Model.Layers;
+using DotTiled.Model.Layers.Objects;
+using DotTiled.Model.Properties;
+using DotTiled.Model.Tilesets;
 
 namespace DotTiled.Tests;
 

src/DotTiled.Tests/Serialization/Tmj/TmjMapReaderTests.cs

@@ -1,3 +1,8 @@
+using DotTiled.Model;
+using DotTiled.Model.Properties.CustomTypes;
+using DotTiled.Model.Tilesets;
+using DotTiled.Serialization.Tmj;
+
 namespace DotTiled.Tests;
 
 public partial class TmjMapReaderTests

src/DotTiled.Tests/Serialization/Tmx/TmxMapReaderTests.cs

@@ -1,4 +1,8 @@
 using System.Xml;
+using DotTiled.Model;
+using DotTiled.Model.Properties.CustomTypes;
+using DotTiled.Model.Tilesets;
+using DotTiled.Serialization.Tmx;
 
 namespace DotTiled.Tests;
 

src/DotTiled/Model/Color.cs

@@ -2,7 +2,7 @@ using System;
 using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 
-namespace DotTiled;
+namespace DotTiled.Model;
 
 public class Color : IParsable<Color>, IEquatable<Color>
 {

src/DotTiled/Model/Layers/BaseLayer.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
+using DotTiled.Model.Properties;
 
-namespace DotTiled;
+namespace DotTiled.Model.Layers;
 
 public abstract class BaseLayer
 {

src/DotTiled/Model/Layers/Data.cs

@@ -1,6 +1,6 @@
 using System;
 
-namespace DotTiled;
+namespace DotTiled.Model.Layers;
 
 public enum DataEncoding
 {

src/DotTiled/Model/Layers/Group.cs

@@ -1,6 +1,6 @@
 using System.Collections.Generic;
 
-namespace DotTiled;
+namespace DotTiled.Model.Layers;
 
 public class Group : BaseLayer
 {

src/DotTiled/Model/Layers/ImageLayer.cs

@@ -1,4 +1,6 @@
-namespace DotTiled;
+using DotTiled.Model.Tilesets;
+
+namespace DotTiled.Model.Layers;
 
 public class ImageLayer : BaseLayer
 {

src/DotTiled/Model/Layers/ObjectLayer.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
+using DotTiled.Model.Layers.Objects;
 
-namespace DotTiled;
+namespace DotTiled.Model.Layers;
 
 public enum DrawOrder
 {

src/DotTiled/Model/Layers/Objects/EllipseObject.cs

@@ -1,3 +1,3 @@
-namespace DotTiled;
+namespace DotTiled.Model.Layers.Objects;
 
 public class EllipseObject : Object { }

src/DotTiled/Model/Layers/Objects/Object.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
+using DotTiled.Model.Properties;
 
-namespace DotTiled;
+namespace DotTiled.Model.Layers.Objects;
 
 public abstract class Object
 {

src/DotTiled/Model/Layers/Objects/PointObject.cs

@@ -0,0 +1,3 @@
+namespace DotTiled.Model.Layers.Objects;
+
+public class PointObject : Object { }

src/DotTiled/Model/Layers/Objects/PolygonObject.cs

@@ -1,7 +1,7 @@
 using System.Collections.Generic;
 using System.Numerics;
 
-namespace DotTiled;
+namespace DotTiled.Model.Layers.Objects;
 
 public class PolygonObject : Object
 {

src/DotTiled/Model/Layers/Objects/PolylineObject.cs

@@ -1,7 +1,7 @@
 using System.Collections.Generic;
 using System.Numerics;
 
-namespace DotTiled;
+namespace DotTiled.Model.Layers.Objects;
 
 public class PolylineObject : Object
 {

src/DotTiled/Model/Layers/Objects/RectangleObject.cs

@@ -1,3 +1,3 @@
-namespace DotTiled;
+namespace DotTiled.Model.Layers.Objects;
 
 public class RectangleObject : Object { }

src/DotTiled/Model/Layers/Objects/TextObject.cs

@@ -1,6 +1,6 @@
 using System.Globalization;
 
-namespace DotTiled;
+namespace DotTiled.Model.Layers.Objects;
 
 
 public enum TextHorizontalAlignment

src/DotTiled/Model/Layers/Objects/TileObject.cs

@@ -1,4 +1,4 @@
-namespace DotTiled;
+namespace DotTiled.Model.Layers.Objects;
 
 public class TileObject : Object
 {

src/DotTiled/Model/Layers/TileLayer.cs

@@ -1,4 +1,4 @@
-namespace DotTiled;
+namespace DotTiled.Model.Layers;
 
 public class TileLayer : BaseLayer
 {

src/DotTiled/Model/Map.cs

@@ -1,7 +1,10 @@
 using System.Collections.Generic;
 using System.Globalization;
+using DotTiled.Model.Layers;
+using DotTiled.Model.Properties;
+using DotTiled.Model.Tilesets;
 
-namespace DotTiled;
+namespace DotTiled.Model;
 
 public enum MapOrientation
 {

src/DotTiled/Model/Properties/BoolProperty.cs

@@ -1,4 +1,4 @@
-namespace DotTiled;
+namespace DotTiled.Model.Properties;
 
 public class BoolProperty : IProperty
 {

src/DotTiled/Model/Properties/ClassProperty.cs

@@ -1,12 +1,12 @@
 using System.Collections.Generic;
 using System.Linq;
 
-namespace DotTiled;
+namespace DotTiled.Model.Properties;
 
 public class ClassProperty : IProperty
 {
   public required string Name { get; set; }
-  public PropertyType Type => DotTiled.PropertyType.Class;
+  public PropertyType Type => Model.Properties.PropertyType.Class;
   public required string PropertyType { get; set; }
   public required Dictionary<string, IProperty> Properties { get; set; }
 

src/DotTiled/Model/Properties/ColorProperty.cs

@@ -1,4 +1,4 @@
-namespace DotTiled;
+namespace DotTiled.Model.Properties;
 
 public class ColorProperty : IProperty
 {

src/DotTiled/Model/Properties/CustomTypes/CustomClassDefinition.cs

@@ -1,7 +1,7 @@
 using System;
 using System.Collections.Generic;
 
-namespace DotTiled;
+namespace DotTiled.Model.Properties.CustomTypes;
 
 [Flags]
 public enum CustomClassUseAs

src/DotTiled/Model/Properties/CustomTypes/CustomEnumDefinition.cs

@@ -1,6 +1,6 @@
 using System.Collections.Generic;
 
-namespace DotTiled;
+namespace DotTiled.Model.Properties.CustomTypes;
 
 public enum CustomEnumStorageType
 {

src/DotTiled/Model/Properties/CustomTypes/CustomTypeDefinition.cs

@@ -1,4 +1,4 @@
-namespace DotTiled;
+namespace DotTiled.Model.Properties.CustomTypes;
 
 public abstract class CustomTypeDefinition
 {

src/DotTiled/Model/Properties/FileProperty.cs

@@ -1,4 +1,4 @@
-namespace DotTiled;
+namespace DotTiled.Model.Properties;
 
 public class FileProperty : IProperty
 {

src/DotTiled/Model/Properties/FloatProperty.cs

@@ -1,4 +1,4 @@
-namespace DotTiled;
+namespace DotTiled.Model.Properties;
 
 public class FloatProperty : IProperty
 {