diff --git a/Source/Editor/GUI/Docking/DockPanel.cs b/Source/Editor/GUI/Docking/DockPanel.cs index 0f31759f2..bf982e6b9 100644 --- a/Source/Editor/GUI/Docking/DockPanel.cs +++ b/Source/Editor/GUI/Docking/DockPanel.cs @@ -237,9 +237,7 @@ namespace FlaxEditor.GUI.Docking /// Determines whether panel contains the specified tab. /// /// The tab. - /// - /// true if panel contains the specified tab; otherwise, false. - /// + /// true if panel contains the specified tab; otherwise, false. public bool ContainsTab(DockWindow tab) { return _tabs.Contains(tab); diff --git a/Source/Editor/GUI/Drag/DragHelper.cs b/Source/Editor/GUI/Drag/DragHelper.cs index ca4974931..cd01112d6 100644 --- a/Source/Editor/GUI/Drag/DragHelper.cs +++ b/Source/Editor/GUI/Drag/DragHelper.cs @@ -62,17 +62,11 @@ namespace FlaxEditor.GUI.Drag /// /// Gets a value indicating whether this instance has valid drag data. /// - /// - /// true if this instance has valid drag data; otherwise, false. - /// public sealed override bool HasValidDrag => Objects.Count > 0; /// /// Gets the current drag effect. /// - /// - /// The effect. - /// public override DragDropEffect Effect => HasValidDrag ? DragDropEffect.Move : DragDropEffect.None; /// diff --git a/Source/Editor/IEditable.cs b/Source/Editor/IEditable.cs index 524ce3dea..b89793da0 100644 --- a/Source/Editor/IEditable.cs +++ b/Source/Editor/IEditable.cs @@ -1,4 +1,4 @@ -// Copyright (c) 2012-2021 Wojciech Figat. All rights reserved. +// Copyright (c) 2012-2021 Wojciech Figat. All rights reserved. using System; @@ -17,9 +17,6 @@ namespace FlaxEditor /// /// Gets a value indicating whether this object is edited (dirty state). /// - /// - /// true if this object instance is edited; otherwise, false. - /// bool IsEdited { get; } /// diff --git a/Source/Editor/Modules/ContentEditingModule.cs b/Source/Editor/Modules/ContentEditingModule.cs index f9d6e825c..fe235d481 100644 --- a/Source/Editor/Modules/ContentEditingModule.cs +++ b/Source/Editor/Modules/ContentEditingModule.cs @@ -69,9 +69,7 @@ namespace FlaxEditor.Modules /// The item. /// The new short name. /// The hint text if name is invalid. - /// - /// true if name is valid; otherwise, false. - /// + /// true if name is valid; otherwise, false. public bool IsValidAssetName(ContentItem item, string shortName, out string hint) { // Check if name is the same except has some chars in upper case and some in lower case diff --git a/Source/Editor/Modules/SceneModule.cs b/Source/Editor/Modules/SceneModule.cs index ffbd876fe..4a583a0d8 100644 --- a/Source/Editor/Modules/SceneModule.cs +++ b/Source/Editor/Modules/SceneModule.cs @@ -101,9 +101,7 @@ namespace FlaxEditor.Modules /// Determines whether the specified scene is edited. /// /// The scene. - /// - /// true if the specified scene is edited; otherwise, false. - /// + /// true if the specified scene is edited; otherwise, false. public bool IsEdited(Scene scene) { var node = GetActorNode(scene) as SceneNode; @@ -113,9 +111,7 @@ namespace FlaxEditor.Modules /// /// Determines whether any scene is edited. /// - /// - /// true if any scene is edited; otherwise, false. - /// + /// true if any scene is edited; otherwise, false. public bool IsEdited() { foreach (var scene in Root.ChildNodes) @@ -129,9 +125,7 @@ namespace FlaxEditor.Modules /// /// Determines whether every scene is edited. /// - /// - /// true if every scene is edited; otherwise, false. - /// + /// true if every scene is edited; otherwise, false. public bool IsEverySceneEdited() { foreach (var scene in Root.ChildNodes) diff --git a/Source/Editor/Undo/Undo.cs b/Source/Editor/Undo/Undo.cs index 80a5d69a3..999034dc6 100644 --- a/Source/Editor/Undo/Undo.cs +++ b/Source/Editor/Undo/Undo.cs @@ -61,41 +61,26 @@ namespace FlaxEditor /// /// Gets or sets a value indicating whether this is enabled. /// - /// - /// true if enabled; otherwise, false. - /// public virtual bool Enabled { get; set; } = true; /// /// Gets a value indicating whether can do undo on last performed action. /// - /// - /// true if can perform undo; otherwise, false. - /// public bool CanUndo => UndoOperationsStack.HistoryCount > 0; /// /// Gets a value indicating whether can do redo on last undone action. /// - /// - /// true if can perform redo; otherwise, false. - /// public bool CanRedo => UndoOperationsStack.ReverseCount > 0; /// /// Gets the first name of the undo action. /// - /// - /// The first name of the undo action. - /// public string FirstUndoName => UndoOperationsStack.PeekHistory().ActionString; /// /// Gets the first name of the redo action. /// - /// - /// The first name of the redo action. - /// public string FirstRedoName => UndoOperationsStack.PeekReverse().ActionString; /// diff --git a/Source/Engine/Core/Math/Half.cs b/Source/Engine/Core/Math/Half.cs index d2519578a..be60c83dc 100644 --- a/Source/Engine/Core/Math/Half.cs +++ b/Source/Engine/Core/Math/Half.cs @@ -41,57 +41,57 @@ namespace FlaxEngine private ushort value; /// - /// Number of decimal digits of precision. + /// Number of decimal digits of precision. /// public const int PrecisionDigits = 3; /// - /// Number of bits in the mantissa. + /// Number of bits in the mantissa. /// public const int MantissaBits = 11; /// - /// Maximum decimal exponent. + /// Maximum decimal exponent. /// public const int MaximumDecimalExponent = 4; /// - /// Maximum binary exponent. + /// Maximum binary exponent. /// public const int MaximumBinaryExponent = 15; /// - /// Minimum decimal exponent. + /// Minimum decimal exponent. /// public const int MinimumDecimalExponent = -4; /// - /// Minimum binary exponent. + /// Minimum binary exponent. /// public const int MinimumBinaryExponent = -14; /// - /// Exponent radix. + /// Exponent radix. /// public const int ExponentRadix = 2; /// - /// Additional rounding. + /// Additional rounding. /// public const int AdditionRounding = 1; /// - /// Smallest such that 1.0 + epsilon != 1.0 + /// Smallest such that 1.0 + epsilon != 1.0 /// public static readonly float Epsilon; /// - /// Maximum value of the number. + /// Maximum value of the number. /// public static readonly float MaxValue; /// - /// Minimum value of the number. + /// Minimum value of the number. /// public static readonly float MinValue; @@ -106,7 +106,7 @@ namespace FlaxEngine public static readonly Half One; /// - /// Initializes a new instance of the structure. + /// Initializes a new instance of the structure. /// /// The floating point value that should be stored in 16 bit format. public Half(float value) @@ -115,7 +115,7 @@ namespace FlaxEngine } /// - /// Gets or sets the raw 16 bit value used to back this half-float. + /// Gets or sets the raw 16 bit value used to back this half-float. /// public ushort RawValue { @@ -124,7 +124,7 @@ namespace FlaxEngine } /// - /// Converts an array of half precision values into full precision values. + /// Converts an array of half precision values into full precision values. /// /// The values to be converted. /// An array of converted values. @@ -137,7 +137,7 @@ namespace FlaxEngine } /// - /// Converts an array of full precision values into half precision values. + /// Converts an array of full precision values into half precision values. /// /// The values to be converted. /// An array of converted values. @@ -150,7 +150,7 @@ namespace FlaxEngine } /// - /// Performs an explicit conversion from to . + /// Performs an explicit conversion from to . /// /// The value to be converted. /// The converted value. @@ -160,7 +160,7 @@ namespace FlaxEngine } /// - /// Performs an implicit conversion from to . + /// Performs an implicit conversion from to . /// /// The value to be converted. /// The converted value. @@ -170,31 +170,29 @@ namespace FlaxEngine } /// - /// Tests for equality between two objects. + /// Tests for equality between two objects. /// /// The first value to compare. /// The second value to compare. - /// - /// true if has the same value as ; otherwise, false. + /// true if has the same value as ; otherwise, false. public static bool operator ==(Half left, Half right) { return left.value == right.value; } /// - /// Tests for inequality between two objects. + /// Tests for inequality between two objects. /// /// The first value to compare. /// The second value to compare. - /// - /// true if has a different value than ; otherwise, false. + /// true if has a different value than ; otherwise, false. public static bool operator !=(Half left, Half right) { return left.value != right.value; } /// - /// Converts the value of the object to its equivalent string representation. + /// Converts the value of the object to its equivalent string representation. /// /// The string representation of the value of this instance. public override string ToString() @@ -204,7 +202,7 @@ namespace FlaxEngine } /// - /// Returns the hash code for this instance. + /// Returns the hash code for this instance. /// /// A 32-bit signed integer hash code. public override int GetHashCode() @@ -214,35 +212,31 @@ namespace FlaxEngine } /// - /// Determines whether the specified object instances are considered equal. + /// Determines whether the specified object instances are considered equal. /// /// /// - /// - /// true if is the same instance as or - /// if both are null references or if value1.Equals(value2) returns true; otherwise, false. + /// true if is the same instance as or if both are null references or if value1.Equals(value2) returns true; otherwise, false. public static bool Equals(ref Half value1, ref Half value2) { return value1.value == value2.value; } /// - /// Returns a value that indicates whether the current instance is equal to the specified object. + /// Returns a value that indicates whether the current instance is equal to the specified object. /// /// Object to make the comparison with. - /// - /// true if the current instance is equal to the specified object; false otherwise. + /// true if the current instance is equal to the specified object; false otherwise. public bool Equals(Half other) { return other.value == value; } /// - /// Returns a value that indicates whether the current instance is equal to a specified object. + /// Returns a value that indicates whether the current instance is equal to a specified object. /// /// Object to make the comparison with. - /// - /// true if the current instance is equal to the specified object; false otherwise. + /// true if the current instance is equal to the specified object; false otherwise. public override bool Equals(object obj) { if (obj == null) diff --git a/Source/Engine/Utilities/StringUtils.cs b/Source/Engine/Utilities/StringUtils.cs index f9b3ab9a4..cda545197 100644 --- a/Source/Engine/Utilities/StringUtils.cs +++ b/Source/Engine/Utilities/StringUtils.cs @@ -140,9 +140,7 @@ namespace FlaxEngine /// Determines whether the specified path is relative or is absolute. /// /// The input path. - /// - /// true if the specified path is relative; otherwise, false if is relative. - /// + /// true if the specified path is relative; otherwise, false if is relative. public static bool IsRelative(string path) { bool isRooted = (path.Length >= 2 && char.IsLetterOrDigit(path[0]) && path[1] == ':') ||