1
0
Fork 0
mirror of https://github.com/Ellpeck/MLEM.git synced 2024-12-25 01:39:23 +01:00

fixed some documentation issues

This commit is contained in:
Ell 2020-10-06 20:14:57 +02:00
parent 58eae7d240
commit aaeda825e0
4 changed files with 5 additions and 5 deletions

View file

@ -40,7 +40,7 @@ namespace MLEM.Data {
}
/// <summary>
/// Copies the given object <paramref name="obj"/> into the given object <see cref="otherObj"/> in a shallow manner.
/// Copies the given object <paramref name="obj"/> into the given object <paramref name="otherObj"/> in a shallow manner.
/// </summary>
/// <param name="obj">The object to create a shallow copy of</param>
/// <param name="otherObj">The object to copy into</param>
@ -55,7 +55,7 @@ namespace MLEM.Data {
}
/// <summary>
/// Copies the given object <paramref name="obj"/> into the given object <see cref="otherObj"/> in a deep manner.
/// Copies the given object <paramref name="obj"/> into the given object <paramref name="otherObj"/> in a deep manner.
/// Note that, for this to work correctly, each type that should be constructed below the topmost level needs to contanin a parameterless constructor.
/// </summary>
/// <param name="obj">The object to create a deep copy of</param>

View file

@ -92,7 +92,7 @@ namespace MLEM.Ui.Style {
/// </summary>
public Color RadioHoveredColor;
/// <summary>
/// The texture that the <see cref="RadioButton"/> renders on top of its regular texture when it is <see cref="RadioButton.Checked"/>
/// The texture that the <see cref="RadioButton"/> renders on top of its regular texture when it is <see cref="Checkbox.Checked"/>
/// </summary>
public TextureRegion RadioCheckmark;
/// <summary>

View file

@ -99,7 +99,7 @@ namespace MLEM.Ui {
public TextFormatter TextFormatter;
/// <summary>
/// The action that should be executed when a <see cref="LinkCode"/> in a paragraph's <see cref="Paragraph.TokenizedText"/> is pressed.
/// The actual link stored in the link code is stored in its <see cref="LinkCode.Match"/>'s 1st group.
/// The actual link stored in the link code is stored in its <see cref="Code.Match"/>'s 1st group.
/// By default, the browser is opened with the given link's address.
/// </summary>
public Action<LinkCode> LinkBehavior = l => Process.Start(l.Match.Groups[1].Value);

View file

@ -124,7 +124,7 @@ namespace MLEM.Font {
/// <summary>
/// Truncates a string to a given width. If the string's displayed area is larger than the maximum width, the string is cut off.
/// Optionally, the string can be cut off a bit sooner, adding the <see cref="ellipsis"/> at the end instead.
/// Optionally, the string can be cut off a bit sooner, adding the <paramref name="ellipsis"/> at the end instead.
/// </summary>
/// <param name="text">The text to truncate</param>
/// <param name="width">The maximum width, in display pixels based on the font and scale</param>