From 1e16c6fdc5266624e6716fa07c367f71ee1d1c60 Mon Sep 17 00:00:00 2001 From: Ellpeck Date: Sat, 15 Apr 2023 15:11:50 +0200 Subject: [PATCH] some docs website improvements with new docfx version --- Docs/articles/toc.yml | 19 ++++++++++++++----- MLEM.Data/RuntimeTexturePacker.cs | 2 +- .../Tiled/IndividualTiledMapRenderer.cs | 2 +- MLEM.Ui/Elements/Button.cs | 2 +- MLEM.Ui/Elements/Panel.cs | 4 ++-- MLEM.Ui/Elements/ProgressBar.cs | 2 +- MLEM.Ui/Elements/Tooltip.cs | 2 +- MLEM/Cameras/Camera.cs | 2 +- MLEM/Input/GenericInput.cs | 2 +- build.cake | 2 +- 10 files changed, 24 insertions(+), 15 deletions(-) diff --git a/Docs/articles/toc.yml b/Docs/articles/toc.yml index 235f58b..8a8b16f 100644 --- a/Docs/articles/toc.yml +++ b/Docs/articles/toc.yml @@ -1,16 +1,25 @@ -- name: MLEM.Ui - href: ui.md +- name: MLEM - name: Font Extensions href: font_extensions.md - name: Text Formatting href: text_formatting.md - name: Input Handler href: input.md -- name: Raw Content Manager - href: raw_content.md - name: Sprite Animations href: sprite_animations.md + +- name: MLEM.Ui +- name: MLEM.Ui + href: ui.md + +- name: MLEM.Extended - name: Tiled Extensions href: tiled_extensions.md + +- name: MLEM.Data +- name: Raw Content Manager + href: raw_content.md + - name: MLEM.Startup - href: startup.md \ No newline at end of file +- name: MLEM.Startup + href: startup.md diff --git a/MLEM.Data/RuntimeTexturePacker.cs b/MLEM.Data/RuntimeTexturePacker.cs index 97d6dec..8939190 100644 --- a/MLEM.Data/RuntimeTexturePacker.cs +++ b/MLEM.Data/RuntimeTexturePacker.cs @@ -49,7 +49,7 @@ namespace MLEM.Data { /// Creates a new runtime texture packer with the given settings. /// /// The maximum width that the packed texture can have. Defaults to 2048. - /// Whether the maximum width should be increased if there is a texture to be packed that is wider than . Defaults to false. + /// Whether the maximum width should be increased if there is a texture to be packed that is wider than the maximum width specified in the constructor. Defaults to false. /// Whether the resulting should have a width and height that is a power of two. /// Whether the resulting should be square regardless of required size. /// Whether the original textures submitted to this texture packer should be disposed after packing. diff --git a/MLEM.Extended/Tiled/IndividualTiledMapRenderer.cs b/MLEM.Extended/Tiled/IndividualTiledMapRenderer.cs index 297576f..7d175e6 100644 --- a/MLEM.Extended/Tiled/IndividualTiledMapRenderer.cs +++ b/MLEM.Extended/Tiled/IndividualTiledMapRenderer.cs @@ -190,7 +190,7 @@ namespace MLEM.Extended.Tiled { } /// - /// A delegate method used for . + /// A delegate method used for an 's depth function. /// The idea is to return a depth (between 0 and 1) for the given tile that determines where in the sprite batch it should be rendererd. /// Note that, for this depth function to take effect, the sprite batch needs to begin with or . /// diff --git a/MLEM.Ui/Elements/Button.cs b/MLEM.Ui/Elements/Button.cs index 0c42523..a5c3425 100644 --- a/MLEM.Ui/Elements/Button.cs +++ b/MLEM.Ui/Elements/Button.cs @@ -76,7 +76,7 @@ namespace MLEM.Ui.Elements { public bool CanSelectDisabled; /// /// An optional function that can be used to modify the result of automatically based on a user-defined condition. This removes the need to disable a button based on a condition in or manually. - /// Note that, if 's underlying value is set to using , this function's result will be ignored. + /// Note that, if 's underlying value is set to using , this function's result will be ignored. /// public Func AutoDisableCondition; diff --git a/MLEM.Ui/Elements/Panel.cs b/MLEM.Ui/Elements/Panel.cs index 48cf938..d5f4cf9 100644 --- a/MLEM.Ui/Elements/Panel.cs +++ b/MLEM.Ui/Elements/Panel.cs @@ -13,13 +13,13 @@ namespace MLEM.Ui.Elements { /// /// A panel element to be used inside of a . /// The panel is a complex element that displays a box as a background to all of its child elements. - /// Additionally, a panel can be set to on construction, which causes all elements that don't fit into the panel to be hidden until scrolled to using a . + /// Additionally, a panel can be set to scroll overflowing elements on construction, which causes all elements that don't fit into the panel to be hidden until scrolled to using a . /// public class Panel : Element { /// /// The scroll bar that this panel contains. - /// This is only nonnull if is true. + /// This is only nonnull if scrolling overflow was enabled in the constructor. /// Note that some scroll bar styling is controlled by this panel, namely and . /// public readonly ScrollBar ScrollBar; diff --git a/MLEM.Ui/Elements/ProgressBar.cs b/MLEM.Ui/Elements/ProgressBar.cs index 7a38637..000e71d 100644 --- a/MLEM.Ui/Elements/ProgressBar.cs +++ b/MLEM.Ui/Elements/ProgressBar.cs @@ -10,7 +10,7 @@ using MLEM.Ui.Style; namespace MLEM.Ui.Elements { /// /// A progress bar element to use inside of a . - /// A progress bar is an element that fills up a bar based on a given percentage. + /// A progress bar is an element that fills up a bar based on a given percentage. /// public class ProgressBar : Element { diff --git a/MLEM.Ui/Elements/Tooltip.cs b/MLEM.Ui/Elements/Tooltip.cs index 35ec98d..48ad306 100644 --- a/MLEM.Ui/Elements/Tooltip.cs +++ b/MLEM.Ui/Elements/Tooltip.cs @@ -196,7 +196,7 @@ namespace MLEM.Ui.Elements { } /// - /// Causes this tooltip's position to be snapped to the mouse position, or the if is true, or the if set. + /// Causes this tooltip's position to be snapped to the mouse position, or the element to snap to if is true, or the if set. /// public void SnapPositionToMouse() { Vector2 snapPosition; diff --git a/MLEM/Cameras/Camera.cs b/MLEM/Cameras/Camera.cs index ee7288a..171c3e1 100644 --- a/MLEM/Cameras/Camera.cs +++ b/MLEM/Cameras/Camera.cs @@ -13,7 +13,7 @@ namespace MLEM.Cameras { /// /// This field holds an epsilon value used in some camera calculations to mitigate floating point rounding inaccuracies. - /// If camera or size are extremely small or extremely big, this value can be reduced or increased. + /// If camera or size are extremely small or extremely big, this value can be reduced or increased. /// public static float Epsilon = 0.01F; diff --git a/MLEM/Input/GenericInput.cs b/MLEM/Input/GenericInput.cs index 2451946..1a45a23 100644 --- a/MLEM/Input/GenericInput.cs +++ b/MLEM/Input/GenericInput.cs @@ -32,7 +32,7 @@ namespace MLEM.Input { public static readonly GenericInput[] AllInputs = GenericInput.AllKeys.Concat(GenericInput.AllMouseButtons).Concat(GenericInput.AllButtons).ToArray(); /// - /// The of this generic input's current . + /// The of this generic input's current value. /// [DataMember] public readonly InputType Type; diff --git a/build.cake b/build.cake index b91e5fc..d0a47aa 100644 --- a/build.cake +++ b/build.cake @@ -1,5 +1,5 @@ #addin nuget:?package=Cake.DocFx&version=1.0.0 -#tool dotnet:?package=docfx&version=2.63.0 +#tool dotnet:?package=docfx&version=2.65.3 // this is the upcoming version, for prereleases var version = Argument("version", "6.2.0");