Skip to content

Commit 53a5b2a

Browse files
committed
GimbalManager: tighten XML doc comments
1 parent 3bc01e8 commit 53a5b2a

1 file changed

Lines changed: 10 additions & 8 deletions

File tree

ExtLibs/ArduPilot/Mavlink/GimbalManagerProtocol.cs

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -152,10 +152,10 @@ public bool HasAllCapability(MAVLink.GIMBAL_MANAGER_CAP_FLAGS flags, byte gimbal
152152
}
153153

154154
/// <summary>
155-
/// Get the reported attitude of the gimbal. Yaw always reported relative to the earth frame.
155+
/// Gets the reported attitude of the gimbal in the earth frame.
156156
/// </summary>
157-
/// <param name="gimbal_device_id">Device ID of the gimbal. 0 means all gimbals</param>
158-
/// <returns></returns>
157+
/// <param name="gimbal_device_id">Device ID of the gimbal. 0 means the first gimbal.</param>
158+
/// <returns>The gimbal attitude quaternion, or <c>null</c> if no status has been received.</returns>
159159
public Quaternion GetAttitude(byte gimbal_device_id = 0)
160160
{
161161
if (!GimbalStatus.TryGetValue(gimbal_device_id, out var status))
@@ -242,12 +242,14 @@ public Task<bool> SetRCYawLockAsync(bool yaw_lock, byte gimbal_device_id = 0)
242242
}
243243

244244
/// <summary>
245-
/// Set the attitude of the gimbal with a quaternion. Yaw always reported relative to the earth frame.
245+
/// Commands the gimbal to a given attitude.
246246
/// </summary>
247-
/// <param name="q">Gimbal attitude quaternion</param>
248-
/// <param name="yaw_lock">True if the gimbal should continue to point in this orientation. False if it should follow the yaw of the vehicle.</param>
249-
/// <param name="gimbal_device_id">Device ID of the gimbal. 0 means all gimbals</param>
250-
/// <returns></returns>
247+
/// <param name="q">Desired attitude quaternion in the earth frame.</param>
248+
/// <param name="yaw_lock">
249+
/// <c>true</c> to hold the earth-frame yaw; <c>false</c> to follow vehicle yaw.
250+
/// </param>
251+
/// <param name="gimbal_device_id">Device ID of the gimbal. 0 means the first gimbal.</param>
252+
/// <returns><c>true</c> if the command was acknowledged; otherwise, <c>false</c>.</returns>
251253
public Task<bool> SetAttitudeAsync(Quaternion q, bool yaw_lock, byte gimbal_device_id = 0)
252254
{
253255
var pitch = q.get_euler_pitch() * MathHelper.rad2deg;

0 commit comments

Comments
 (0)