Skip to content

Commit 2ec8315

Browse files
committed
Add summary tags
1 parent c1f2bfe commit 2ec8315

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

Assets/MixedRealityToolkit/Definitions/Utilities/MixedRealityPose.cs

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,21 @@ public MixedRealityPose(Quaternion rotation)
5050
public static MixedRealityPose ZeroIdentity { get; } = new MixedRealityPose(Vector3.zero, Quaternion.identity);
5151

5252
[SerializeField]
53+
[Tooltip("The position of the pose")]
5354
private Vector3 position;
5455

56+
/// <summary>
57+
/// The position of the pose.
58+
/// </summary>
5559
public Vector3 Position { get { return position; } set { position = value; } }
5660

5761
[SerializeField]
62+
[Tooltip("The rotation of the pose.")]
5863
private Quaternion rotation;
5964

65+
/// <summary>
66+
/// The rotation of the pose.
67+
/// </summary>
6068
public Quaternion Rotation { get { return rotation; } set { rotation = value; } }
6169

6270
public static MixedRealityPose operator +(MixedRealityPose left, MixedRealityPose right)
@@ -79,13 +87,19 @@ public override string ToString()
7987
return $"{position} | {rotation}";
8088
}
8189

82-
/// The Z axis of the pose in world space
90+
/// <summary>
91+
/// The Z axis of the pose in world space.
92+
/// </summary>
8393
public Vector3 Forward => rotation * Vector3.forward;
8494

85-
/// The Y axis of the pose in world space
95+
/// <summary>
96+
/// The Y axis of the pose in world space.
97+
/// </summary>
8698
public Vector3 Up => rotation * Vector3.up;
8799

88-
/// The X axis of the pose in world space
100+
/// <summary>
101+
/// The X axis of the pose in world space.
102+
/// </summary>
89103
public Vector3 Right => rotation * Vector3.right;
90104

91105
#region IEqualityComparer Implementation

0 commit comments

Comments
 (0)