Skip to content

Commit

Permalink
Removed unnecessary XML docs regions.
Browse files Browse the repository at this point in the history
  • Loading branch information
vchelaru committed Apr 6, 2024
1 parent 7628974 commit 72e9992
Showing 1 changed file with 0 additions and 28 deletions.
28 changes: 0 additions & 28 deletions Engines/FlatRedBallXNA/FlatRedBall/Gui/Cursor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ public partial class Cursor

IWindow mWindowPushed;

#region XML Docs
/// <summary>
/// The window that the cursor was over when the mouse button was pressed.
/// </summary>
Expand All @@ -59,10 +58,8 @@ public partial class Cursor
/// pushed and without accidentally clicking on other Buttons. This is also used
/// with ToggleButtons to control when they are pressed and unpressed.
/// </remarks>
#endregion
public IWindow mWindowSecondaryPushed;

#region XML Docs
/// <summary>
/// If this value is true, the Cursor will not move in response to the mouse or gamepad.
/// </summary>
Expand All @@ -71,12 +68,10 @@ public partial class Cursor
/// The staticPosition value is only used by the engine when over the button on an UpDown. When pushing down
/// on an UpDown button, the staticPosition is set to true, and set to false when releasing the mouse button.
/// </remarks>
#endregion
public bool StaticPosition;

private IWindow mLastWindowOver;

#region XML Docs
/// <summary>
/// The window that the cursor has grabbed.
/// </summary>
Expand All @@ -86,7 +81,6 @@ public partial class Cursor
/// not recognize which types of Windows can be dragged, so windows must be grabbed through the Cursor.GrabWindow
/// method. The windowGrabbed's onDrag event is fired every frame.
/// </remarks>
#endregion
public IWindow WindowGrabbed;

internal Sides mSidesGrabbed = Sides.None;
Expand All @@ -113,7 +107,6 @@ public partial class Cursor

Ray mLastRay;

#region XML Docs
/// <summary>
/// Storage for reference to a grabbed object.
/// </summary>
Expand All @@ -125,10 +118,8 @@ public partial class Cursor
/// "snapping" its center to the Cursor's tip.
/// <seealso cref="FlatRedBall.Gui.Cursor.SetObjectRelativePosition"/>
/// </remarks>
#endregion
IStaticPositionable mObjectGrabbed;

#region XML Docs
/// <summary>
/// The relative x position of a grabbed object from the center of the cursor.
/// </summary>
Expand All @@ -138,10 +129,8 @@ public partial class Cursor
/// <seealso cref="FlatRedBall.Gui.Cursor.GetCursorPositionForSprite(ref float, ref float, float)"/>
/// <seealso cref="FlatRedBall.Gui.Cursor.SetObjectRelativePosition"/>
/// </remarks>
#endregion
public float ObjectGrabbedRelativeX;

#region XML Docs
/// <summary>
/// The relative y position of a grabbed object from the center of the cursor.
/// </summary>
Expand All @@ -151,7 +140,6 @@ public partial class Cursor
/// <seealso cref="FlatRedBall.Gui.Cursor.GetCursorPositionForSprite(ref float, ref float, float)"/>
/// <seealso cref="FlatRedBall.Gui.Cursor.SetObjectRelativePosition"/>
/// </remarks>
#endregion
public float ObjectGrabbedRelativeY;

/// <summary>
Expand All @@ -161,23 +149,19 @@ public partial class Cursor

public bool PrimaryDoublePush;

#region XML Docs
/// <summary>
/// Determines whether the primary button is down this frame.
/// </summary>
#endregion
public bool PrimaryDown;

/// <summary>
/// Whether the primary button was clicked (released) this frame. A release is when the primary button is down last frame but not down this frame.
/// </summary>
public bool PrimaryClick;

#region XML Docs
/// <summary>
/// Determines whether the primary button was double clicked this frame.
/// </summary>
#endregion
public bool PrimaryDoubleClick;


Expand All @@ -187,32 +171,24 @@ public partial class Cursor
double mLastTimePrimaryClick;
double mLastTimePrimaryPush;

#region XML Docs
/// <summary>
/// Determines whether the secondary button was pushed this frame.
/// </summary>
#endregion
public bool SecondaryPush;

#region XML Docs
/// <summary>
/// Determines whether the secondary button is down this frame.
/// </summary>
#endregion
public bool SecondaryDown;

#region XML Docs
/// <summary>
/// Determines whether the secondary button was clicked (released) this frame.
/// </summary>
#endregion
public bool SecondaryClick;

#region XML Docs
/// <summary>
/// Determines whether the secondary button was double clicked this frame.
/// </summary>
#endregion
public bool SecondaryDoubleClick;


Expand Down Expand Up @@ -369,7 +345,6 @@ public InputDevice LastInputDevice
}

bool active = true;
#region XML Docs
/// <summary>
/// Sets whether the cursor is active.
/// </summary>
Expand All @@ -388,7 +363,6 @@ public InputDevice LastInputDevice
/// <para>secondaryPush</para>
///
/// </remarks>
#endregion
public bool Active
{
set
Expand Down Expand Up @@ -665,13 +639,11 @@ public IWindow WindowPushed
}
}

#region XML Docs
/// <summary>
/// Assigns the ObjectGrabbed and calculates the relative position of the
/// grabbed object. After this method is called, UpdateObjectGrabbedPosition can be called
/// every frame to position the grabbed object.
/// </summary>
#endregion
public IStaticPositionable ObjectGrabbed
{
get { return mObjectGrabbed; }
Expand Down

0 comments on commit 72e9992

Please sign in to comment.