diff --git a/VpSharp.Commands/CommandsExtension.cs b/VpSharp.Commands/CommandsExtension.cs
index b71bdfe..0b1ebbf 100644
--- a/VpSharp.Commands/CommandsExtension.cs
+++ b/VpSharp.Commands/CommandsExtension.cs
@@ -62,7 +62,7 @@ public sealed class CommandsExtension : VirtualParadiseClientExtension
}
///
- /// Registers the command
+ /// Registers the commands defined in the specified type.
///
///
/// refers to a type that does not inherit .
@@ -84,9 +84,9 @@ public sealed class CommandsExtension : VirtualParadiseClientExtension
}
///
- /// Registers the command
+ /// Registers the commands defined in the specified type.
///
- ///
+ /// The type whose command methods to register.
/// is .
///
/// refers to an abstract type.
diff --git a/VpSharp/src/Entities/VirtualParadiseModelObject.cs b/VpSharp/src/Entities/VirtualParadiseModelObject.cs
index 4c1b152..26e0fb4 100644
--- a/VpSharp/src/Entities/VirtualParadiseModelObject.cs
+++ b/VpSharp/src/Entities/VirtualParadiseModelObject.cs
@@ -1,4 +1,4 @@
-using VpSharp.Internal;
+using VpSharp.Internal;
using VpSharp.Internal.NativeAttributes;
using static VpSharp.Internal.Native;
@@ -10,7 +10,12 @@ namespace VpSharp.Entities;
///
public class VirtualParadiseModelObject : VirtualParadiseObject
{
- ///
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// The owning client.
+ /// The object ID.
+ /// is .
internal VirtualParadiseModelObject(VirtualParadiseClient client, int id)
: base(client, id)
{
diff --git a/VpSharp/src/Entities/VirtualParadiseParticleEmitterObject.cs b/VpSharp/src/Entities/VirtualParadiseParticleEmitterObject.cs
index 7193697..3947711 100644
--- a/VpSharp/src/Entities/VirtualParadiseParticleEmitterObject.cs
+++ b/VpSharp/src/Entities/VirtualParadiseParticleEmitterObject.cs
@@ -10,9 +10,17 @@ using VpSharp.Internal.ValueConverters;
namespace VpSharp.Entities;
+///
+/// Represents a particle emitter object.
+///
public sealed class VirtualParadiseParticleEmitterObject : VirtualParadiseObject
{
- ///
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// The owning client.
+ /// The object ID.
+ /// is .
internal VirtualParadiseParticleEmitterObject(VirtualParadiseClient client, int id)
: base(client, id)
{
@@ -228,6 +236,7 @@ public sealed class VirtualParadiseParticleEmitterObject : VirtualParadiseObject
}
}
+ ///
protected override void ExtractFromData(ReadOnlySpan data)
{
#pragma warning disable 612
diff --git a/VpSharp/src/Entities/VirtualParadisePathObject.cs b/VpSharp/src/Entities/VirtualParadisePathObject.cs
index 5a829d6..360fa95 100644
--- a/VpSharp/src/Entities/VirtualParadisePathObject.cs
+++ b/VpSharp/src/Entities/VirtualParadisePathObject.cs
@@ -11,7 +11,12 @@ namespace VpSharp.Entities;
///
public sealed class VirtualParadisePathObject : VirtualParadiseObject
{
- ///
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// The owning client.
+ /// The object ID.
+ /// is .
internal VirtualParadisePathObject(VirtualParadiseClient client, int id)
: base(client, id)
{
@@ -34,6 +39,7 @@ public sealed class VirtualParadisePathObject : VirtualParadiseObject
Path = (VirtualParadisePath)path.Path.Clone();
}
+ ///
protected override void ExtractFromData(ReadOnlySpan data)
{
Span chars = stackalloc char[data.Length];
diff --git a/VpSharp/src/Extensions/QuaternionExtensions.cs b/VpSharp/src/Extensions/QuaternionExtensions.cs
index f0427c7..4245956 100644
--- a/VpSharp/src/Extensions/QuaternionExtensions.cs
+++ b/VpSharp/src/Extensions/QuaternionExtensions.cs
@@ -1,10 +1,22 @@
-using System.Numerics;
+using System.Numerics;
namespace VpSharp.Extensions;
+///
+/// Extension methods for .
+///
public static class QuaternionExtensions
{
- // https://www.euclideanspace.com/maths/geometry/rotations/conversions/quaternionToEuler/
+ ///
+ /// Converts this quaternion to a containing an Euler representation of the rotation.
+ ///
+ /// The quaternion to convert.
+ ///
+ /// if the resulting vector should be in radians; or if the resulting
+ /// vector should be in degrees.
+ ///
+ /// The Euler representation of .
+ ///
public static Vector3d ToEulerAngles(this Quaternion value, bool radians = true)
{
double a = 2.0 * value.Y * value.W - 2.0 * value.X * value.Z;
@@ -29,6 +41,15 @@ public static class QuaternionExtensions
return new Vector3d(x, y, z);
}
+ ///
+ /// Converts this quaternion to a containing an Euler representation of the rotation.
+ ///
+ /// The quaternion to convert.
+ ///
+ /// if the resulting vector should be in radians; or if the resulting
+ /// vector should be in degrees.
+ ///
+ /// The Euler representation of .
public static Vector3d ToEulerAnglesF(this Quaternion value, bool radians = true)
{
float a = 2.0f * value.Y * value.W - 2.0f * value.X * value.Z;
@@ -53,7 +74,14 @@ public static class QuaternionExtensions
return new Vector3d(x, y, z);
}
- // https://www.euclideanspace.com/maths/geometry/rotations/conversions/quaternionToAngle/index.htm
+ //
+ ///
+ /// Converts this quaternion to an axis/angle pair.
+ ///
+ /// The quaternion to convert.
+ /// The axis value.
+ /// The angle value.
+ ///
public static void ToAxisAngle(this Quaternion value, out Vector3 axis, out float angle)
{
angle = 2.0f * MathF.Acos(value.W);
@@ -65,6 +93,12 @@ public static class QuaternionExtensions
axis = new Vector3(x, y, z);
}
+ ///
+ /// Converts this quaternion to an axis/angle pair.
+ ///
+ /// The quaternion to convert.
+ /// The axis value.
+ /// The angle value.
public static void ToAxisAngle(this Quaternion value, out Vector3d axis, out double angle)
{
angle = 2.0 * Math.Acos(value.W);
diff --git a/VpSharp/src/FogMode.cs b/VpSharp/src/FogMode.cs
index 49b9de7..02249fa 100644
--- a/VpSharp/src/FogMode.cs
+++ b/VpSharp/src/FogMode.cs
@@ -5,10 +5,33 @@
///
public enum FogMode
{
+ ///
+ /// None.
+ ///
None,
+
+ ///
+ /// Linear fog mode.
+ ///
Linear,
- Exp,
- Exponential = Exp,
- Exp2,
- Exponential2 = Exp2
+
+ ///
+ /// Exponential fog mode.
+ ///
+ Exponential,
+
+ ///
+ /// Exponential squared fog mode.
+ ///
+ Exponential2,
+
+ ///
+ /// Exponential fog mode. This value is used for serialization purposes.
+ ///
+ Exp = Exponential,
+
+ ///
+ /// Exponential squared fog mode. This value is used for serialization purposes.
+ ///
+ Exp2 = Exponential2
}
diff --git a/VpSharp/src/VirtualParadiseClient.Worlds.cs b/VpSharp/src/VirtualParadiseClient.Worlds.cs
index d8ebee4..b290206 100644
--- a/VpSharp/src/VirtualParadiseClient.Worlds.cs
+++ b/VpSharp/src/VirtualParadiseClient.Worlds.cs
@@ -40,7 +40,7 @@ public sealed partial class VirtualParadiseClient
}
///
- /// Gets a read-only view of the worlds returned by the universe server.
+ /// Gets a read-only view of the worlds returned by the universe server.
///
/// An containing values.
///