Ellpeck/MLEM
1
0
Fork 0
mirror of https://github.com/Ellpeck/MLEM.git synced 2024-12-24 17:29:23 +01:00
Code Issues Projects Releases Wiki Activity

resolved some documentation warnings

Browse source
This commit is contained in:
Ell 2021-11-30 11:46:06 +01:00
parent 0371e6ce75
commit 636522bc3e
16 changed files with 36 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.config/dotnet-tools.json
View file

@ -3,7 +3,7 @@
"isRoot": true,
"tools": {
"cake.tool": {
"version": "1.1.0",
"version": "1.3.0",
"commands": [
"dotnet-cake"
]

7
Docs/docfx.json
View file

@ -4,13 +4,10 @@
"src": [
{
"src": "../",
"files": [
"**.csproj"
]
"files": ["**/MLEM**.csproj"]
}
],
"dest": "api",
"filter": "filter.yml"
"dest": "api"
}
],
"build": {

7
Docs/filter.yml
View file

@ -1,7 +0,0 @@
apiRules:
- exclude:
uidRegex: ^Demos
- exclude:
uidRegex: ^Sandbox
- exclude:
uidRegex: ^Template

1
MLEM.Data/MLEM.Data.csproj
View file

@ -2,6 +2,7 @@
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<ProduceReferenceAssembly>true</ProduceReferenceAssembly>
</PropertyGroup>
<PropertyGroup>

1
MLEM.Extended/MLEM.Extended.csproj
View file

@ -2,6 +2,7 @@
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<ProduceReferenceAssembly>true</ProduceReferenceAssembly>
</PropertyGroup>
<PropertyGroup>

3
MLEM.Extended/Tiled/LayerPosition.cs
View file

@ -67,7 +67,8 @@ namespace MLEM.Extended.Tiled {
return hashCode;
}
/// <inheritdoc />
/// <summary>Returns the fully qualified type name of this instance.</summary>
/// <returns>The fully qualified type name.</returns>
public override string ToString() {
return $"{nameof(this.Layer)}: {this.Layer}, {nameof(this.X)}: {this.X}, {nameof(this.Y)}: {this.Y}";
}

1
MLEM.Startup/MLEM.Startup.csproj
View file

@ -3,6 +3,7 @@
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<ProduceReferenceAssembly>true</ProduceReferenceAssembly>
</PropertyGroup>
<PropertyGroup>

18
MLEM.Startup/MlemGame.cs
View file

@ -67,7 +67,9 @@ namespace MLEM.Startup {
this.Content.RootDirectory = "Content";
}
/// <inheritdoc />
/// <summary>
/// Override this to load graphical resources required by the game.
/// </summary>
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);
}
/// <inheritdoc />
/// <summary>
/// Called when the game should update.
/// Updates the <see cref="T:Microsoft.Xna.Framework.GameComponent" /> instances attached to this game.
/// Override this to update your game.
/// </summary>
/// <param name="gameTime">The elapsed time since the last call to <see cref="M:Microsoft.Xna.Framework.Game.Update(Microsoft.Xna.Framework.GameTime)" />.</param>
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);
}
/// <inheritdoc />
/// <summary>
/// Called when the game should draw a frame.
/// Draws the <see cref="T:Microsoft.Xna.Framework.DrawableGameComponent" /> instances attached to this game.
/// Override this to render your game.
/// </summary>
/// <param name="gameTime">A <see cref="T:Microsoft.Xna.Framework.GameTime" /> instance containing the elapsed time since the last call to <see cref="M:Microsoft.Xna.Framework.Game.Draw(Microsoft.Xna.Framework.GameTime)" /> and the total time elapsed since the game started.</param>
protected sealed override void Draw(GameTime gameTime) {
this.UiSystem.DrawEarly(gameTime, this.SpriteBatch);
this.DoDraw(gameTime);

2
MLEM.Ui/Elements/Element.cs
View file

@ -972,7 +972,7 @@ namespace MLEM.Ui.Elements {
return this.CanBeMoused && this.DisplayArea.Contains(position) ? this : null;
}
/// <inheritdoc />
/// <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
public virtual void Dispose() {
this.OnDisposed?.Invoke(this);
GC.SuppressFinalize(this);

1
MLEM.Ui/MLEM.Ui.csproj
View file

@ -2,6 +2,7 @@
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<ProduceReferenceAssembly>true</ProduceReferenceAssembly>
</PropertyGroup>
<PropertyGroup>

3
MLEM.Ui/Style/StyleProp.cs
View file

@ -65,7 +65,8 @@ namespace MLEM.Ui.Style {
return !EqualityComparer<T>.Default.Equals(this.Value, default);
}
/// <inheritdoc />
/// <summary>Returns the fully qualified type name of this instance.</summary>
/// <returns>The fully qualified type name.</returns>
public override string ToString() {
return this.Value?.ToString();
}

3
MLEM/Input/Keybind.cs
View file

@ -233,7 +233,8 @@ namespace MLEM.Input {
return string.Join(joiner, this.Modifiers.Append(this.Key).Select(i => inputName?.Invoke(i) ?? i.ToString()));
}
/// <inheritdoc />
/// <summary>Returns a string that represents the current object.</summary>
/// <returns>A string that represents the current object.</returns>
public override string ToString() {
return this.ToString(" + ");
}

1
MLEM/MLEM.csproj
View file

@ -2,6 +2,7 @@
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<ProduceReferenceAssembly>true</ProduceReferenceAssembly>
</PropertyGroup>
<PropertyGroup>

1
MLEM/Misc/MlemPlatform.cs
View file

@ -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.
/// </summary>
/// <exception cref="InvalidOperationException"></exception>
public static MlemPlatform Current;
/// <summary>

7
MLEM/Misc/RectangleF.cs
View file

@ -170,7 +170,9 @@ namespace MLEM.Misc {
return obj is RectangleF f && this == f;
}
/// <inheritdoc cref="Equals(object)"/>
/// <summary>Indicates whether the current object is equal to another object of the same type.</summary>
/// <param name="other">An object to compare with this object.</param>
/// <returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
public bool Equals(RectangleF other) {
return this == other;
}
@ -219,7 +221,8 @@ namespace MLEM.Misc {
this.Y += amount.Y;
}
/// <inheritdoc/>
/// <summary>Returns a string that represents the current object.</summary>
/// <returns>A string that represents the current object.</returns>
public override string ToString() {
return "{X:" + this.X + " Y:" + this.Y + " Width:" + this.Width + " Height:" + this.Height + "}";
}

2
build.cake
View file

@ -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");