Skip to content

Commit

Permalink
docs: Enhance Entity class comment with detailed description. (#2423)
Browse files Browse the repository at this point in the history
The comment for the `Entity` class has been updated to provide a more detailed description. It now specifies that the class represents a game entity that typically aggregates multiple `EntityComponent` instances. Additionally, it includes references to the Stride documentation for more information about adding and managing entities.
  • Loading branch information
VaclavElias authored Sep 1, 2024
1 parent 1cc9c24 commit ba36a7e
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion sources/engine/Stride.Engine/Engine/Entity.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
namespace Stride.Engine
{
/// <summary>
/// Game entity. It usually aggregates multiple EntityComponent
/// Represents a game entity that typically aggregates multiple <see cref="EntityComponent"/> instances.
/// For more information about entities, see <see href="https://doc.stride3d.net/latest/en/manual/game-studio/add-entities.html">Adding entities</see>
/// and <see href="https://doc.stride3d.net/latest/en/manual/game-studio/manage-entities.html">Managing entities</see>.
/// </summary>
//[ContentSerializer(typeof(EntityContentSerializer))]
//[ContentSerializer(typeof(DataContentSerializer<Entity>))]
Expand Down

0 comments on commit ba36a7e

Please sign in to comment.