stride-docs icon indicating copy to clipboard operation
stride-docs copied to clipboard

Wiki - Add comment about userdoc

Open VaclavElias opened this issue 2 years ago • 2 comments
trafficstars

https://stride-docs-test.azurewebsites.net/latest/en/manual/scripts/public-properties-and-fields.html#adding-property-descriptions

Add this comment so one can understand what it means when generating Stride docs, that this xml tag is not for a docs but for the Stride Studio..

VaclavElias avatar Jun 09 '23 19:06 VaclavElias

If I remember correctly, <summary> is used for XML comments (normal C# way of doing things), but there's a custom comments processor which reads <userdoc> and outputs a simplified file (not XML) that is read by GameStudio. There was a PR in the last two years which enabled GameStudio to also read XML comments.

manio143 avatar Jun 10 '23 03:06 manio143

Thank you. That will help to clarify my updates.

VaclavElias avatar Jun 12 '23 09:06 VaclavElias