Ellpeck/MLEM
1
0
Fork 0
mirror of https://github.com/Ellpeck/MLEM.git synced 2024-11-01 05:10:50 +01:00
Code Issues Projects Releases Wiki Activity

small Panel documentation improvements

Browse source
This commit is contained in:
Ell 2024-10-30 19:47:02 +01:00
parent c46b11f4fc
commit b733d1df0e
2 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
MLEM.Ui/Elements/Group.cs
View file

@ -6,6 +6,7 @@ namespace MLEM.Ui.Elements {
/// <summary> /// <summary>
/// A group element to be used inside of a <see cref="UiSystem"/>. /// A group element to be used inside of a <see cref="UiSystem"/>.
/// A group is an element that has no rendering or interaction on its own, but that can aid with automatic placement of child elements. /// A group is an element that has no rendering or interaction on its own, but that can aid with automatic placement of child elements.
/// If a grouping whose children scroll, and which has a <see cref="ScrollBar"/>, is desired, a panel with its <see cref="Panel.Texture"/> set to <see langword="null"/> can be used.
/// </summary> /// </summary>
public class Group : Element { public class Group : Element {

4
MLEM.Ui/Elements/Panel.cs
View file

@ -13,6 +13,7 @@ namespace MLEM.Ui.Elements {
/// A panel element to be used inside of a <see cref="UiSystem"/>. /// A panel element to be used inside of a <see cref="UiSystem"/>.
/// The panel is a complex element that displays a box as a background to all of its child elements. /// 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 scroll overflowing elements on construction, which causes all elements that don't fit into the panel to be hidden until scrolled to using a <see cref="ScrollBar"/>. /// 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 <see cref="ScrollBar"/>.
/// If an element similar to a <see cref="Group"/>, but with scrolling content, is desired, a panel with its <see cref="Texture"/> set to <see langword="null"/> can be used.
/// </summary> /// </summary>
public class Panel : Element { public class Panel : Element {
@ -24,7 +25,8 @@ namespace MLEM.Ui.Elements {
public readonly ScrollBar ScrollBar; public readonly ScrollBar ScrollBar;
/// <summary> /// <summary>
/// The texture that this panel should have, or null if it should be invisible. /// The texture that this panel should have.
/// If this is set to <see langword="null"/>, this panel will not have a texture, but all of its content will still be visible.
/// </summary> /// </summary>
public StyleProp<NinePatch> Texture; public StyleProp<NinePatch> Texture;
/// <summary> /// <summary>