diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
index 6cf141e..4903ba5 100644
--- a/.config/dotnet-tools.json
+++ b/.config/dotnet-tools.json
@@ -3,7 +3,7 @@
"isRoot": true,
"tools": {
"cake.tool": {
- "version": "1.1.0",
+ "version": "1.3.0",
"commands": [
"dotnet-cake"
]
diff --git a/Docs/docfx.json b/Docs/docfx.json
index bd0d77f..e359148 100644
--- a/Docs/docfx.json
+++ b/Docs/docfx.json
@@ -4,13 +4,10 @@
"src": [
{
"src": "../",
- "files": [
- "**.csproj"
- ]
+ "files": ["**/MLEM**.csproj"]
}
],
- "dest": "api",
- "filter": "filter.yml"
+ "dest": "api"
}
],
"build": {
diff --git a/Docs/filter.yml b/Docs/filter.yml
deleted file mode 100644
index aab4438..0000000
--- a/Docs/filter.yml
+++ /dev/null
@@ -1,7 +0,0 @@
-apiRules:
- - exclude:
- uidRegex: ^Demos
- - exclude:
- uidRegex: ^Sandbox
- - exclude:
- uidRegex: ^Template
\ No newline at end of file
diff --git a/MLEM.Data/MLEM.Data.csproj b/MLEM.Data/MLEM.Data.csproj
index 98e8f70..87438d6 100644
--- a/MLEM.Data/MLEM.Data.csproj
+++ b/MLEM.Data/MLEM.Data.csproj
@@ -2,6 +2,7 @@
netstandard2.0
true
+ true
diff --git a/MLEM.Extended/MLEM.Extended.csproj b/MLEM.Extended/MLEM.Extended.csproj
index 8de99b0..0286960 100644
--- a/MLEM.Extended/MLEM.Extended.csproj
+++ b/MLEM.Extended/MLEM.Extended.csproj
@@ -2,6 +2,7 @@
netstandard2.0
true
+ true
diff --git a/MLEM.Extended/Tiled/LayerPosition.cs b/MLEM.Extended/Tiled/LayerPosition.cs
index 1133d0b..c7138ff 100644
--- a/MLEM.Extended/Tiled/LayerPosition.cs
+++ b/MLEM.Extended/Tiled/LayerPosition.cs
@@ -67,7 +67,8 @@ namespace MLEM.Extended.Tiled {
return hashCode;
}
- ///
+ /// Returns the fully qualified type name of this instance.
+ /// The fully qualified type name.
public override string ToString() {
return $"{nameof(this.Layer)}: {this.Layer}, {nameof(this.X)}: {this.X}, {nameof(this.Y)}: {this.Y}";
}
diff --git a/MLEM.Startup/MLEM.Startup.csproj b/MLEM.Startup/MLEM.Startup.csproj
index 8b33cc4..40a384c 100644
--- a/MLEM.Startup/MLEM.Startup.csproj
+++ b/MLEM.Startup/MLEM.Startup.csproj
@@ -3,6 +3,7 @@
netstandard2.0
true
+ true
diff --git a/MLEM.Startup/MlemGame.cs b/MLEM.Startup/MlemGame.cs
index 3a42e26..71848cf 100644
--- a/MLEM.Startup/MlemGame.cs
+++ b/MLEM.Startup/MlemGame.cs
@@ -67,7 +67,9 @@ namespace MLEM.Startup {
this.Content.RootDirectory = "Content";
}
- ///
+ ///
+ /// Override this to load graphical resources required by the game.
+ ///
protected override void LoadContent() {
this.SpriteBatch = new SpriteBatch(this.GraphicsDevice);
this.InputHandler = new InputHandler(this);
@@ -77,7 +79,12 @@ namespace MLEM.Startup {
this.OnLoadContent?.Invoke(this);
}
- ///
+ ///
+ /// Called when the game should update.
+ /// Updates the instances attached to this game.
+ /// Override this to update your game.
+ ///
+ /// The elapsed time since the last call to .
protected sealed override void Update(GameTime gameTime) {
this.DoUpdate(gameTime);
this.OnUpdate?.Invoke(this, gameTime);
@@ -85,7 +92,12 @@ namespace MLEM.Startup {
CoroutineHandler.RaiseEvent(CoroutineEvents.Update);
}
- ///
+ ///
+ /// Called when the game should draw a frame.
+ /// Draws the instances attached to this game.
+ /// Override this to render your game.
+ ///
+ /// A instance containing the elapsed time since the last call to and the total time elapsed since the game started.
protected sealed override void Draw(GameTime gameTime) {
this.UiSystem.DrawEarly(gameTime, this.SpriteBatch);
this.DoDraw(gameTime);
diff --git a/MLEM.Ui/Elements/Element.cs b/MLEM.Ui/Elements/Element.cs
index 2fb2c78..1398e05 100644
--- a/MLEM.Ui/Elements/Element.cs
+++ b/MLEM.Ui/Elements/Element.cs
@@ -972,7 +972,7 @@ namespace MLEM.Ui.Elements {
return this.CanBeMoused && this.DisplayArea.Contains(position) ? this : null;
}
- ///
+ /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public virtual void Dispose() {
this.OnDisposed?.Invoke(this);
GC.SuppressFinalize(this);
diff --git a/MLEM.Ui/MLEM.Ui.csproj b/MLEM.Ui/MLEM.Ui.csproj
index 98cdc6c..48290cc 100644
--- a/MLEM.Ui/MLEM.Ui.csproj
+++ b/MLEM.Ui/MLEM.Ui.csproj
@@ -2,6 +2,7 @@
netstandard2.0
true
+ true
diff --git a/MLEM.Ui/Style/StyleProp.cs b/MLEM.Ui/Style/StyleProp.cs
index 02f6c4a..d41e0ea 100644
--- a/MLEM.Ui/Style/StyleProp.cs
+++ b/MLEM.Ui/Style/StyleProp.cs
@@ -65,7 +65,8 @@ namespace MLEM.Ui.Style {
return !EqualityComparer.Default.Equals(this.Value, default);
}
- ///
+ /// Returns the fully qualified type name of this instance.
+ /// The fully qualified type name.
public override string ToString() {
return this.Value?.ToString();
}
diff --git a/MLEM/Input/Keybind.cs b/MLEM/Input/Keybind.cs
index a18f50c..69cd824 100644
--- a/MLEM/Input/Keybind.cs
+++ b/MLEM/Input/Keybind.cs
@@ -233,7 +233,8 @@ namespace MLEM.Input {
return string.Join(joiner, this.Modifiers.Append(this.Key).Select(i => inputName?.Invoke(i) ?? i.ToString()));
}
- ///
+ /// Returns a string that represents the current object.
+ /// A string that represents the current object.
public override string ToString() {
return this.ToString(" + ");
}
diff --git a/MLEM/MLEM.csproj b/MLEM/MLEM.csproj
index 5653ec7..f255cc5 100644
--- a/MLEM/MLEM.csproj
+++ b/MLEM/MLEM.csproj
@@ -2,6 +2,7 @@
netstandard2.0
true
+ true
diff --git a/MLEM/Misc/MlemPlatform.cs b/MLEM/Misc/MlemPlatform.cs
index 66e52a5..10914b1 100644
--- a/MLEM/Misc/MlemPlatform.cs
+++ b/MLEM/Misc/MlemPlatform.cs
@@ -18,7 +18,6 @@ namespace MLEM.Misc {
/// The current MLEM platform
/// Set this value before starting your game if you want to use platform-dependent MLEM features.
///
- ///
public static MlemPlatform Current;
///
diff --git a/MLEM/Misc/RectangleF.cs b/MLEM/Misc/RectangleF.cs
index 6459b9d..af5122e 100644
--- a/MLEM/Misc/RectangleF.cs
+++ b/MLEM/Misc/RectangleF.cs
@@ -170,7 +170,9 @@ namespace MLEM.Misc {
return obj is RectangleF f && this == f;
}
- ///
+ /// Indicates whether the current object is equal to another object of the same type.
+ /// An object to compare with this object.
+ /// if the current object is equal to the parameter; otherwise, .
public bool Equals(RectangleF other) {
return this == other;
}
@@ -219,7 +221,8 @@ namespace MLEM.Misc {
this.Y += amount.Y;
}
- ///
+ /// Returns a string that represents the current object.
+ /// A string that represents the current object.
public override string ToString() {
return "{X:" + this.X + " Y:" + this.Y + " Width:" + this.Width + " Height:" + this.Height + "}";
}
diff --git a/build.cake b/build.cake
index ed15844..607110d 100644
--- a/build.cake
+++ b/build.cake
@@ -1,5 +1,5 @@
#addin Cake.DocFx&version=1.0.0
-#tool docfx.console&version=2.51.0
+#tool docfx.console&version=2.58.9
// this is the upcoming version, for prereleases
var version = Argument("version", "5.2.0");