Skip to content

Commit

Permalink
add EntityConverter.EntityToDataEntity() docs
Browse files Browse the repository at this point in the history
  • Loading branch information
friflo committed Jan 5, 2025
1 parent a8f36aa commit 0339e51
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion src/ECS/Serialize/EntityConverter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'entity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'dataEntity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'entity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'dataEntity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'entity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'dataEntity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'entity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'dataEntity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'entity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'dataEntity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'entity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'dataEntity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'entity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'dataEntity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'entity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'dataEntity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'entity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'dataEntity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'entity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)

Check warning on line 38 in src/ECS/Serialize/EntityConverter.cs

View workflow job for this annotation

GitHub Actions / build

Parameter 'dataEntity' has no matching param tag in the XML comment for 'EntityConverter.EntityToDataEntity(Entity, DataEntity, bool)' (but other parameters do)
{
Expand Down

0 comments on commit 0339e51

Please sign in to comment.