GoaLitiuM/FlaxEngine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Tweaks for doc comments

Browse Source
This commit is contained in:
Wojciech Figat
2021-12-07 13:24:05 +01:00
parent c0bcb54044
commit ea71e8cbe6
8 changed files with 36 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Source/Editor/GUI/Docking/DockPanel.cs
View File

@@ -237,9 +237,7 @@ namespace FlaxEditor.GUI.Docking
/// Determines whether panel contains the specified tab.
/// </summary>
/// <param name="tab">The tab.</param>
/// <returns>
/// <c>true</c> if panel contains the specified tab; otherwise, <c>false</c>.
/// </returns>
/// <returns><c>true</c> if panel contains the specified tab; otherwise, <c>false</c>.</returns>
public bool ContainsTab(DockWindow tab)
{
return _tabs.Contains(tab);

6
Source/Editor/GUI/Drag/DragHelper.cs
View File

@@ -62,17 +62,11 @@ namespace FlaxEditor.GUI.Drag
/// <summary>
/// Gets a value indicating whether this instance has valid drag data.
/// </summary>
/// <value>
/// <c>true</c> if this instance has valid drag data; otherwise, <c>false</c>.
/// </value>
public sealed override bool HasValidDrag => Objects.Count > 0;
/// <summary>
/// Gets the current drag effect.
/// </summary>
/// <value>
/// The effect.
/// </value>
public override DragDropEffect Effect => HasValidDrag ? DragDropEffect.Move : DragDropEffect.None;
/// <summary>

5
Source/Editor/IEditable.cs
View File

@@ -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
/// <summary>
/// Gets a value indicating whether this object is edited (dirty state).
/// </summary>
/// <value>
/// <c>true</c> if this object instance is edited; otherwise, <c>false</c>.
/// </value>
bool IsEdited { get; }
/// <summary>

4
Source/Editor/Modules/ContentEditingModule.cs
View File

@@ -69,9 +69,7 @@ namespace FlaxEditor.Modules
/// <param name="item">The item.</param>
/// <param name="shortName">The new short name.</param>
/// <param name="hint">The hint text if name is invalid.</param>
/// <returns>
/// <c>true</c> if name is valid; otherwise, <c>false</c>.
/// </returns>
/// <returns><c>true</c> if name is valid; otherwise, <c>false</c>.</returns>
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

12
Source/Editor/Modules/SceneModule.cs
View File

@@ -101,9 +101,7 @@ namespace FlaxEditor.Modules
/// Determines whether the specified scene is edited.
/// </summary>
/// <param name="scene">The scene.</param>
/// <returns>
/// <c>true</c> if the specified scene is edited; otherwise, <c>false</c>.
/// </returns>
/// <returns><c>true</c> if the specified scene is edited; otherwise, <c>false</c>.</returns>
public bool IsEdited(Scene scene)
{
var node = GetActorNode(scene) as SceneNode;
@@ -113,9 +111,7 @@ namespace FlaxEditor.Modules
/// <summary>
/// Determines whether any scene is edited.
/// </summary>
/// <returns>
/// <c>true</c> if any scene is edited; otherwise, <c>false</c>.
/// </returns>
/// <returns><c>true</c> if any scene is edited; otherwise, <c>false</c>.</returns>
public bool IsEdited()
{
foreach (var scene in Root.ChildNodes)
@@ -129,9 +125,7 @@ namespace FlaxEditor.Modules
/// <summary>
/// Determines whether every scene is edited.
/// </summary>
/// <returns>
/// <c>true</c> if every scene is edited; otherwise, <c>false</c>.
/// </returns>
/// <returns><c>true</c> if every scene is edited; otherwise, <c>false</c>.</returns>
public bool IsEverySceneEdited()
{
foreach (var scene in Root.ChildNodes)

15
Source/Editor/Undo/Undo.cs
View File

@@ -61,41 +61,26 @@ namespace FlaxEditor
/// <summary>
/// Gets or sets a value indicating whether this <see cref="Undo"/> is enabled.
/// </summary>
/// <value>
/// <c>true</c> if enabled; otherwise, <c>false</c>.
/// </value>
public virtual bool Enabled { get; set; } = true;
/// <summary>
/// Gets a value indicating whether can do undo on last performed action.
/// </summary>
/// <value>
/// <c>true</c> if can perform undo; otherwise, <c>false</c>.
/// </value>
public bool CanUndo => UndoOperationsStack.HistoryCount > 0;
/// <summary>
/// Gets a value indicating whether can do redo on last undone action.
/// </summary>
/// <value>
/// <c>true</c> if can perform redo; otherwise, <c>false</c>.
/// </value>
public bool CanRedo => UndoOperationsStack.ReverseCount > 0;
/// <summary>
/// Gets the first name of the undo action.
/// </summary>
/// <value>
/// The first name of the undo action.
/// </value>
public string FirstUndoName => UndoOperationsStack.PeekHistory().ActionString;
/// <summary>
/// Gets the first name of the redo action.
/// </summary>
/// <value>
/// The first name of the redo action.
/// </value>
public string FirstRedoName => UndoOperationsStack.PeekReverse().ActionString;
/// <summary>

64
Source/Engine/Core/Math/Half.cs
View File

@@ -41,57 +41,57 @@ namespace FlaxEngine
private ushort value;
/// <summary>
/// Number of decimal digits of precision.
/// Number of decimal digits of precision.
/// </summary>
public const int PrecisionDigits = 3;
/// <summary>
/// Number of bits in the mantissa.
/// Number of bits in the mantissa.
/// </summary>
public const int MantissaBits = 11;
/// <summary>
/// Maximum decimal exponent.
/// Maximum decimal exponent.
/// </summary>
public const int MaximumDecimalExponent = 4;
/// <summary>
/// Maximum binary exponent.
/// Maximum binary exponent.
/// </summary>
public const int MaximumBinaryExponent = 15;
/// <summary>
/// Minimum decimal exponent.
/// Minimum decimal exponent.
/// </summary>
public const int MinimumDecimalExponent = -4;
/// <summary>
/// Minimum binary exponent.
/// Minimum binary exponent.
/// </summary>
public const int MinimumBinaryExponent = -14;
/// <summary>
/// Exponent radix.
/// Exponent radix.
/// </summary>
public const int ExponentRadix = 2;
/// <summary>
/// Additional rounding.
/// Additional rounding.
/// </summary>
public const int AdditionRounding = 1;
/// <summary>
/// Smallest such that 1.0 + epsilon != 1.0
/// Smallest such that 1.0 + epsilon != 1.0
/// </summary>
public static readonly float Epsilon;
/// <summary>
/// Maximum value of the number.
/// Maximum value of the number.
/// </summary>
public static readonly float MaxValue;
/// <summary>
/// Minimum value of the number.
/// Minimum value of the number.
/// </summary>
public static readonly float MinValue;
@@ -106,7 +106,7 @@ namespace FlaxEngine
public static readonly Half One;
/// <summary>
/// Initializes a new instance of the <see cref = "T:FlaxEngine.Half" /> structure.
/// Initializes a new instance of the <see cref = "T:FlaxEngine.Half" /> structure.
/// </summary>
/// <param name = "value">The floating point value that should be stored in 16 bit format.</param>
public Half(float value)
@@ -115,7 +115,7 @@ namespace FlaxEngine
}
/// <summary>
/// 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.
/// </summary>
public ushort RawValue
{
@@ -124,7 +124,7 @@ namespace FlaxEngine
}
/// <summary>
/// Converts an array of half precision values into full precision values.
/// Converts an array of half precision values into full precision values.
/// </summary>
/// <param name = "values">The values to be converted.</param>
/// <returns>An array of converted values.</returns>
@@ -137,7 +137,7 @@ namespace FlaxEngine
}
/// <summary>
/// Converts an array of full precision values into half precision values.
/// Converts an array of full precision values into half precision values.
/// </summary>
/// <param name = "values">The values to be converted.</param>
/// <returns>An array of converted values.</returns>
@@ -150,7 +150,7 @@ namespace FlaxEngine
}
/// <summary>
/// Performs an explicit conversion from <see cref = "T:System.Single" /> to <see cref = "T:FlaxEngine.Half" />.
/// Performs an explicit conversion from <see cref = "T:System.Single" /> to <see cref = "T:FlaxEngine.Half" />.
/// </summary>
/// <param name = "value">The value to be converted.</param>
/// <returns>The converted value.</returns>
@@ -160,7 +160,7 @@ namespace FlaxEngine
}
/// <summary>
/// Performs an implicit conversion from <see cref = "T:FlaxEngine.Half" /> to <see cref = "T:System.Single" />.
/// Performs an implicit conversion from <see cref = "T:FlaxEngine.Half" /> to <see cref = "T:System.Single" />.
/// </summary>
/// <param name = "value">The value to be converted.</param>
/// <returns>The converted value.</returns>
@@ -170,31 +170,29 @@ namespace FlaxEngine
}
/// <summary>
/// Tests for equality between two objects.
/// Tests for equality between two objects.
/// </summary>
/// <param name = "left">The first value to compare.</param>
/// <param name = "right">The second value to compare.</param>
/// <returns>
/// <c>true</c> if <paramref name = "left" /> has the same value as <paramref name = "right" />; otherwise, <c>false</c>.</returns>
/// <returns><c>true</c> if <paramref name = "left" /> has the same value as <paramref name = "right" />; otherwise, <c>false</c>.</returns>
public static bool operator ==(Half left, Half right)
{
return left.value == right.value;
}
/// <summary>
/// Tests for inequality between two objects.
/// Tests for inequality between two objects.
/// </summary>
/// <param name = "left">The first value to compare.</param>
/// <param name = "right">The second value to compare.</param>
/// <returns>
/// <c>true</c> if <paramref name = "left" /> has a different value than <paramref name = "right" />; otherwise, <c>false</c>.</returns>
/// <returns><c>true</c> if <paramref name = "left" /> has a different value than <paramref name = "right" />; otherwise, <c>false</c>.</returns>
public static bool operator !=(Half left, Half right)
{
return left.value != right.value;
}
/// <summary>
/// Converts the value of the object to its equivalent string representation.
/// Converts the value of the object to its equivalent string representation.
/// </summary>
/// <returns>The string representation of the value of this instance.</returns>
public override string ToString()
@@ -204,7 +202,7 @@ namespace FlaxEngine
}
/// <summary>
/// Returns the hash code for this instance.
/// Returns the hash code for this instance.
/// </summary>
/// <returns>A 32-bit signed integer hash code.</returns>
public override int GetHashCode()
@@ -214,35 +212,31 @@ namespace FlaxEngine
}
/// <summary>
/// Determines whether the specified object instances are considered equal.
/// Determines whether the specified object instances are considered equal.
/// </summary>
/// <param name = "value1" />
/// <param name = "value2" />
/// <returns>
/// <c>true</c> if <paramref name = "value1" /> is the same instance as <paramref name = "value2" /> or
/// if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>
/// <returns><c>true</c> if <paramref name = "value1" /> is the same instance as <paramref name = "value2" /> or if both are <c>null</c> references or if <c>value1.Equals(value2)</c> returns <c>true</c>; otherwise, <c>false</c>.</returns>
public static bool Equals(ref Half value1, ref Half value2)
{
return value1.value == value2.value;
}
/// <summary>
/// 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.
/// </summary>
/// <param name = "other">Object to make the comparison with.</param>
/// <returns>
/// <c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
/// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
public bool Equals(Half other)
{
return other.value == value;
}
/// <summary>
/// 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.
/// </summary>
/// <param name = "obj">Object to make the comparison with.</param>
/// <returns>
/// <c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
/// <returns><c>true</c> if the current instance is equal to the specified object; <c>false</c> otherwise.</returns>
public override bool Equals(object obj)
{
if (obj == null)

4
Source/Engine/Utilities/StringUtils.cs
View File

@@ -140,9 +140,7 @@ namespace FlaxEngine
/// Determines whether the specified path is relative or is absolute.
/// </summary>
/// <param name="path">The input path.</param>
/// <returns>
/// <c>true</c> if the specified path is relative; otherwise, <c>false</c> if is relative.
/// </returns>
/// <returns><c>true</c> if the specified path is relative; otherwise, <c>false</c> if is relative.</returns>
public static bool IsRelative(string path)
{
bool isRooted = (path.Length >= 2 && char.IsLetterOrDigit(path[0]) && path[1] == ':') ||