diff --git a/src/DotTiled/Serialization/IMapReader.cs b/src/DotTiled/Serialization/IMapReader.cs
index a1e8b05..d96def5 100644
--- a/src/DotTiled/Serialization/IMapReader.cs
+++ b/src/DotTiled/Serialization/IMapReader.cs
@@ -3,7 +3,14 @@ using DotTiled.Model;
namespace DotTiled.Serialization;
+///
+/// Interface for reading a map from some source. Used by the different file format parsers to read a map.
+///
public interface IMapReader : IDisposable
{
+ ///
+ /// Reads a map from the source.
+ ///
+ /// The parsed map.
Map ReadMap();
}
diff --git a/src/DotTiled/Serialization/ITemplateReader.cs b/src/DotTiled/Serialization/ITemplateReader.cs
index 45832fa..9497e26 100644
--- a/src/DotTiled/Serialization/ITemplateReader.cs
+++ b/src/DotTiled/Serialization/ITemplateReader.cs
@@ -3,7 +3,14 @@ using DotTiled.Model;
namespace DotTiled.Serialization;
+///
+/// Interface for reading a template from some source. Used by the different file format parsers to read a template.
+///
public interface ITemplateReader : IDisposable
{
+ ///
+ /// Reads a template from the source.
+ ///
+ /// The parsed template.
Template ReadTemplate();
}
diff --git a/src/DotTiled/Serialization/ITilesetReader.cs b/src/DotTiled/Serialization/ITilesetReader.cs
index 803ea8e..e798bcf 100644
--- a/src/DotTiled/Serialization/ITilesetReader.cs
+++ b/src/DotTiled/Serialization/ITilesetReader.cs
@@ -3,7 +3,14 @@ using DotTiled.Model;
namespace DotTiled.Serialization;
+///
+/// Interface for reading a tileset from some source. Used by the different file format parsers to read a tileset.
+///
public interface ITilesetReader : IDisposable
{
+ ///
+ /// Reads a tileset from the source.
+ ///
+ /// The parsed tileset.
Tileset ReadTileset();
}
diff --git a/src/DotTiled/Serialization/Tmj/TjTemplateReader.cs b/src/DotTiled/Serialization/Tmj/TjTemplateReader.cs
index a10a1f3..3a66f1b 100644
--- a/src/DotTiled/Serialization/Tmj/TjTemplateReader.cs
+++ b/src/DotTiled/Serialization/Tmj/TjTemplateReader.cs
@@ -4,6 +4,9 @@ using DotTiled.Model;
namespace DotTiled.Serialization.Tmj;
+///
+/// A template reader for reading Tiled JSON templates.
+///
public class TjTemplateReader : ITemplateReader
{
// External resolvers
@@ -15,6 +18,14 @@ public class TjTemplateReader : ITemplateReader
private readonly IReadOnlyCollection _customTypeDefinitions;
+ ///
+ /// Constructs a new .
+ ///
+ /// A string containing a Tiled template in the Tiled JSON format.
+ /// A function that resolves external tilesets given their source.
+ /// A function that resolves external templates given their source.
+ /// A collection of custom type definitions that can be used to resolve custom types when encountering .
+ /// Thrown when any of the arguments are null.
public TjTemplateReader(
string jsonString,
Func externalTilesetResolver,
@@ -27,6 +38,7 @@ public class TjTemplateReader : ITemplateReader
_customTypeDefinitions = customTypeDefinitions ?? throw new ArgumentNullException(nameof(customTypeDefinitions));
}
+ ///
public Template ReadTemplate()
{
var jsonDoc = System.Text.Json.JsonDocument.Parse(_jsonString);
@@ -34,6 +46,7 @@ public class TjTemplateReader : ITemplateReader
return Tmj.ReadTemplate(rootElement, _externalTilesetResolver, _externalTemplateResolver, _customTypeDefinitions);
}
+ ///
protected virtual void Dispose(bool disposing)
{
if (!disposedValue)
@@ -56,6 +69,7 @@ public class TjTemplateReader : ITemplateReader
// Dispose(disposing: false);
// }
+ ///
public void Dispose()
{
// Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
diff --git a/src/DotTiled/Serialization/Tmj/TmjMapReader.cs b/src/DotTiled/Serialization/Tmj/TmjMapReader.cs
index 23d9754..8e5ddd4 100644
--- a/src/DotTiled/Serialization/Tmj/TmjMapReader.cs
+++ b/src/DotTiled/Serialization/Tmj/TmjMapReader.cs
@@ -7,6 +7,9 @@ using DotTiled.Model;
namespace DotTiled.Serialization.Tmj;
+///
+/// A map reader for reading Tiled JSON maps.
+///
public class TmjMapReader : IMapReader
{
// External resolvers
@@ -18,6 +21,14 @@ public class TmjMapReader : IMapReader
private readonly IReadOnlyCollection _customTypeDefinitions;
+ ///
+ /// Constructs a new .
+ ///
+ /// A string containing a Tiled map in the Tiled JSON format.
+ /// A function that resolves external tilesets given their source.
+ /// A function that resolves external templates given their source.
+ /// A collection of custom type definitions that can be used to resolve custom types when encountering .
+ /// Thrown when any of the arguments are null.
public TmjMapReader(
string jsonString,
Func externalTilesetResolver,
@@ -30,6 +41,7 @@ public class TmjMapReader : IMapReader
_customTypeDefinitions = customTypeDefinitions ?? throw new ArgumentNullException(nameof(customTypeDefinitions));
}
+ ///
public Map ReadMap()
{
var jsonDoc = JsonDocument.Parse(_jsonString);
@@ -37,6 +49,7 @@ public class TmjMapReader : IMapReader
return Tmj.ReadMap(rootElement, _externalTilesetResolver, _externalTemplateResolver, _customTypeDefinitions);
}
+ ///
protected virtual void Dispose(bool disposing)
{
if (!disposedValue)
@@ -59,6 +72,7 @@ public class TmjMapReader : IMapReader
// Dispose(disposing: false);
// }
+ ///
public void Dispose()
{
// Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
diff --git a/src/DotTiled/Serialization/Tmj/TsjTilesetReader.cs b/src/DotTiled/Serialization/Tmj/TsjTilesetReader.cs
index 7ddae3e..84ec60e 100644
--- a/src/DotTiled/Serialization/Tmj/TsjTilesetReader.cs
+++ b/src/DotTiled/Serialization/Tmj/TsjTilesetReader.cs
@@ -4,6 +4,9 @@ using DotTiled.Model;
namespace DotTiled.Serialization.Tmj;
+///
+/// A tileset reader for the Tiled JSON format.
+///
public class TsjTilesetReader : ITilesetReader
{
// External resolvers
@@ -14,6 +17,13 @@ public class TsjTilesetReader : ITilesetReader
private readonly IReadOnlyCollection _customTypeDefinitions;
+ ///
+ /// Constructs a new .
+ ///
+ /// A string containing a Tiled tileset in the Tiled JSON format.
+ /// A function that resolves external templates given their source.
+ /// A collection of custom type definitions that can be used to resolve custom types when encountering .
+ /// Thrown when any of the arguments are null.
public TsjTilesetReader(
string jsonString,
Func externalTemplateResolver,
@@ -24,6 +34,7 @@ public class TsjTilesetReader : ITilesetReader
_customTypeDefinitions = customTypeDefinitions ?? throw new ArgumentNullException(nameof(customTypeDefinitions));
}
+ ///
public Tileset ReadTileset()
{
var jsonDoc = System.Text.Json.JsonDocument.Parse(_jsonString);
@@ -35,6 +46,7 @@ public class TsjTilesetReader : ITilesetReader
_customTypeDefinitions);
}
+ ///
protected virtual void Dispose(bool disposing)
{
if (!disposedValue)
@@ -57,6 +69,7 @@ public class TsjTilesetReader : ITilesetReader
// Dispose(disposing: false);
// }
+ ///
public void Dispose()
{
// Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
diff --git a/src/DotTiled/Serialization/Tmx/TmxMapReader.cs b/src/DotTiled/Serialization/Tmx/TmxMapReader.cs
index 091f161..be21580 100644
--- a/src/DotTiled/Serialization/Tmx/TmxMapReader.cs
+++ b/src/DotTiled/Serialization/Tmx/TmxMapReader.cs
@@ -5,6 +5,9 @@ using DotTiled.Model;
namespace DotTiled.Serialization.Tmx;
+///
+/// A map reader for the Tiled XML format.
+///
public class TmxMapReader : IMapReader
{
// External resolvers
@@ -16,6 +19,14 @@ public class TmxMapReader : IMapReader
private readonly IReadOnlyCollection _customTypeDefinitions;
+ ///
+ /// Constructs a new .
+ ///
+ /// An XML reader for reading a Tiled map in the Tiled XML format.
+ /// A function that resolves external tilesets given their source.
+ /// A function that resolves external templates given their source.
+ /// A collection of custom type definitions that can be used to resolve custom types when encountering .
+ /// Thrown when any of the arguments are null.
public TmxMapReader(
XmlReader reader,
Func externalTilesetResolver,
@@ -31,11 +42,13 @@ public class TmxMapReader : IMapReader
_reader.MoveToContent();
}
+ ///
public Map ReadMap()
{
return Tmx.ReadMap(_reader, _externalTilesetResolver, _externalTemplateResolver, _customTypeDefinitions);
}
+ ///
protected virtual void Dispose(bool disposing)
{
if (!disposedValue)
@@ -59,6 +72,7 @@ public class TmxMapReader : IMapReader
// Dispose(disposing: false);
// }
+ ///
public void Dispose()
{
// Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
diff --git a/src/DotTiled/Serialization/Tmx/TsxTilesetReader.cs b/src/DotTiled/Serialization/Tmx/TsxTilesetReader.cs
index 0cc4e2f..374a0d1 100644
--- a/src/DotTiled/Serialization/Tmx/TsxTilesetReader.cs
+++ b/src/DotTiled/Serialization/Tmx/TsxTilesetReader.cs
@@ -5,6 +5,9 @@ using DotTiled.Model;
namespace DotTiled.Serialization.Tmx;
+///
+/// A tileset reader for the Tiled XML format.
+///
public class TsxTilesetReader : ITilesetReader
{
// External resolvers
@@ -15,6 +18,13 @@ public class TsxTilesetReader : ITilesetReader
private readonly IReadOnlyCollection _customTypeDefinitions;
+ ///
+ /// Constructs a new .
+ ///
+ /// An XML reader for reading a Tiled tileset in the Tiled XML format.
+ /// A function that resolves external templates given their source.
+ /// A collection of custom type definitions that can be used to resolve custom types when encountering .
+ /// Thrown when any of the arguments are null.
public TsxTilesetReader(
XmlReader reader,
Func externalTemplateResolver,
@@ -28,8 +38,10 @@ public class TsxTilesetReader : ITilesetReader
_reader.MoveToContent();
}
+ ///
public Tileset ReadTileset() => Tmx.ReadTileset(_reader, null, _externalTemplateResolver, _customTypeDefinitions);
+ ///
protected virtual void Dispose(bool disposing)
{
if (!disposedValue)
@@ -52,6 +64,7 @@ public class TsxTilesetReader : ITilesetReader
// Dispose(disposing: false);
// }
+ ///
public void Dispose()
{
// Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
diff --git a/src/DotTiled/Serialization/Tmx/TxTemplateReader.cs b/src/DotTiled/Serialization/Tmx/TxTemplateReader.cs
index e640dd8..fe93244 100644
--- a/src/DotTiled/Serialization/Tmx/TxTemplateReader.cs
+++ b/src/DotTiled/Serialization/Tmx/TxTemplateReader.cs
@@ -5,6 +5,9 @@ using DotTiled.Model;
namespace DotTiled.Serialization.Tmx;
+///
+/// A template reader for the Tiled XML format.
+///
public class TxTemplateReader : ITemplateReader
{
// Resolvers
@@ -16,6 +19,14 @@ public class TxTemplateReader : ITemplateReader
private readonly IReadOnlyCollection _customTypeDefinitions;
+ ///
+ /// Constructs a new .
+ ///
+ /// An XML reader for reading a Tiled template in the Tiled XML format.
+ /// A function that resolves external tilesets given their source.
+ /// A function that resolves external templates given their source.
+ /// A collection of custom type definitions that can be used to resolve custom types when encountering .
+ /// Thrown when any of the arguments are null.
public TxTemplateReader(
XmlReader reader,
Func externalTilesetResolver,
@@ -31,8 +42,10 @@ public class TxTemplateReader : ITemplateReader
_reader.MoveToContent();
}
+ ///
public Template ReadTemplate() => Tmx.ReadTemplate(_reader, _externalTilesetResolver, _externalTemplateResolver, _customTypeDefinitions);
+ ///
protected virtual void Dispose(bool disposing)
{
if (!disposedValue)
@@ -55,6 +68,7 @@ public class TxTemplateReader : ITemplateReader
// Dispose(disposing: false);
// }
+ ///
public void Dispose()
{
// Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method