Stowage/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-12-07 22:00:10 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #102765 from Delsin-Yu/csharp-typed-collections-documentation-improvments

Browse source 
[C#] Improve Documentation for Typed `Godot.Collections` Wrappers
This commit is contained in:
Thaddeus Crews 2025-03-10 21:05:52 -05:00
commit 4af4b66d1b
No known key found for this signature in database
GPG key ID: 62181B86FE9E5D84
2 changed files with 16 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

11
modules/mono/glue/GodotSharp/GodotSharp/Core/Array.cs
View file

@ -1035,12 +1035,17 @@ namespace Godot.Collections
}
/// <summary>
/// Typed wrapper around Godot's Array class, an array of Variant
/// typed elements allocated in the engine in C++. Useful when
/// interfacing with the engine. Otherwise prefer .NET collections
/// Typed wrapper around Godot's Array class, an array of <typeparamref name="T"/>
/// annotated, Variant typed elements allocated in the engine in C++.
/// Useful when interfacing with the engine. Otherwise prefer .NET collections
/// such as arrays or <see cref="List{T}"/>.
/// </summary>
/// <typeparam name="T">The type of the array.</typeparam>
/// <remarks>
/// While the elements are statically annotated to <typeparamref name="T"/>,
/// the underlying array still stores <see cref="Variant"/>, which has the same
/// memory footprint per element as an untyped <see cref="Array"/>.
/// </remarks>
[DebuggerTypeProxy(typeof(ArrayDebugView<>))]
[DebuggerDisplay("Count = {Count}")]
[SuppressMessage("ReSharper", "RedundantExtendsListEntry")]

11
modules/mono/glue/GodotSharp/GodotSharp/Core/Dictionary.cs
View file

@ -476,13 +476,18 @@ namespace Godot.Collections
}
/// <summary>
/// Typed wrapper around Godot's Dictionary class, a dictionary of Variant
/// typed elements allocated in the engine in C++. Useful when
/// interfacing with the engine. Otherwise prefer .NET collections
/// Typed wrapper around Godot's Dictionary class, a dictionary of <typeparamref name="TKey"/>
/// and <typeparamref name="TValue"/> annotated, Variant typed elements allocated in the engine in C++.
/// Useful when interfacing with the engine. Otherwise prefer .NET collections
/// such as <see cref="System.Collections.Generic.Dictionary{TKey, TValue}"/>.
/// </summary>
/// <typeparam name="TKey">The type of the dictionary's keys.</typeparam>
/// <typeparam name="TValue">The type of the dictionary's values.</typeparam>
/// <remarks>
/// While the elements are statically annotated to <typeparamref name="TKey"/> and <typeparamref name="TValue"/>,
/// the underlying dictionary still stores <see cref="Variant"/>, which has the same memory footprint per element
/// as an untyped <see cref="Dictionary"/>.
/// </remarks>
[DebuggerTypeProxy(typeof(DictionaryDebugView<,>))]
[DebuggerDisplay("Count = {Count}")]
[SuppressMessage("Design", "CA1001", MessageId = "Types that own disposable fields should be disposable",