Skip to content

Commit

Permalink
[csharp] Minor: Fixed xml documentation tags (missing closing tags an…
Browse files Browse the repository at this point in the history
…d multi-line code tags).
  • Loading branch information
HaraldCsaszar committed Sep 13, 2024
1 parent c3feed0 commit 22cc555
Show file tree
Hide file tree
Showing 7 changed files with 105 additions and 97 deletions.
96 changes: 48 additions & 48 deletions spine-csharp/src/Animation.cs

Large diffs are not rendered by default.

91 changes: 47 additions & 44 deletions spine-csharp/src/AnimationState.cs

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion spine-csharp/src/Attachments/RegionAttachment.cs
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ public class RegionAttachment : Attachment, IHasTextureRegion {
public string Path { get; set; }
public TextureRegion Region { get { return region; } set { region = value; } }

/// <summary>For each of the 4 vertices, a pair of <code>x,y</code> values that is the local position of the vertex.</summary>
/// <summary>For each of the 4 vertices, a pair of <c>x,y</c> values that is the local position of the vertex.</summary>
/// <seealso cref="UpdateRegion"/>
public float[] Offset { get { return offset; } }
public float[] UVs { get { return uvs; } }
Expand Down
4 changes: 2 additions & 2 deletions spine-csharp/src/Skeleton.cs
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ public class Skeleton {
/// <summary>The skeleton's transform constraints.</summary>
public ExposedList<TransformConstraint> TransformConstraints { get { return transformConstraints; } }

/// <summary>The skeleton's current skin.</summary>
/// <summary>The skeleton's current skin. May be null. See <see cref="SetSkin(Spine.Skin)"/></summary>
public Skin Skin {
/// <summary>The skeleton's current skin. May be null.</summary>
get { return skin; }
Expand Down Expand Up @@ -561,7 +561,7 @@ public Slot FindSlot (string slotName) {
return null;
}

/// <summary>Sets a skin by name (see <see cref="SetSkin(Skin)"/>).</summary>
/// <summary>Sets a skin by name (see <see cref="SetSkin(Spine.Skin)"/>).</summary>
public void SetSkin (string skinName) {
Skin foundSkin = data.FindSkin(skinName);
if (foundSkin == null) throw new ArgumentException("Skin not found: " + skinName, "skinName");
Expand Down
2 changes: 1 addition & 1 deletion spine-csharp/src/Skin.cs
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ public void RemoveAttachment (int slotIndex, string name) {
}

/// <summary>Returns all attachments in this skin for the specified slot index.</summary>
/// <param name="slotIndex">The target slotIndex. To find the slot index, use <see cref="Spine.SkeletonData.FindSlot"/> and <see cref="Spine.SlotData.Index"/>.
/// <param name="slotIndex">The target slotIndex. To find the slot index, use <see cref="Spine.SkeletonData.FindSlot"/> and <see cref="Spine.SlotData.Index"/></param>.
public void GetAttachments (int slotIndex, List<SkinEntry> attachments) {
if (slotIndex < 0) throw new ArgumentException("slotIndex must be >= 0.");
if (attachments == null) throw new ArgumentNullException("attachments", "attachments cannot be null.");
Expand Down
5 changes: 5 additions & 0 deletions spine-csharp/src/Slot.cs
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,11 @@ public void ClampSecondColor () {
b2 = MathUtils.Clamp(b2, 0, 1);
}

/// <summary>
/// The current attachment for the slot, or null if the slot has no attachment.
/// If the attachment is changed, resets <see cref="SequenceIndex"/> and clears the <see cref="Deform"/>.
/// The deform is not cleared if the old attachment has the same <see cref="VertexAttachment.TimelineAttachment"/> as the
/// specified attachment.</summary>
public Attachment Attachment {
/// <summary>The current attachment for the slot, or null if the slot has no attachment.</summary>
get { return attachment; }
Expand Down
2 changes: 1 addition & 1 deletion spine-csharp/src/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "com.esotericsoftware.spine.spine-csharp",
"displayName": "spine-csharp Runtime",
"description": "This plugin provides the spine-csharp core runtime.",
"version": "4.2.30",
"version": "4.2.31",
"unity": "2018.3",
"author": {
"name": "Esoteric Software",
Expand Down

0 comments on commit 22cc555

Please sign in to comment.