From 0339e518a513624a531fe787c0e446d64ef23588 Mon Sep 17 00:00:00 2001
From: friflo <ullrich@praetz.de>
Date: Sun, 5 Jan 2025 10:03:36 +0100
Subject: [PATCH] add EntityConverter.EntityToDataEntity() docs

---
 src/ECS/Serialize/EntityConverter.cs | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/ECS/Serialize/EntityConverter.cs b/src/ECS/Serialize/EntityConverter.cs
index fe5b8222..2667af11 100644
--- a/src/ECS/Serialize/EntityConverter.cs
+++ b/src/ECS/Serialize/EntityConverter.cs
@@ -29,7 +29,11 @@ public EntityConverter() {
     }
     
     /// <summary>
-    /// Returns the passed <see cref="Entity"/> as a <see cref="DataEntity"/> 
+    /// Returns the passed <see cref="Entity"/> as a <see cref="DataEntity"/>
+    /// <param name="pretty">
+    /// If true each component in <see cref="DataEntity.components"/> JSON is written in a separate line.<br/>
+    /// If false <see cref="DataEntity.components"/> JSON has no line feeds.
+    /// </param>
     /// </summary>
     public DataEntity EntityToDataEntity(Entity entity, DataEntity dataEntity, bool pretty)
     {