stride3d / stride-docs

This repository hosts the source code for the Stride documentation. Contributors can follow the build instructions provided to run the website locally.

Home Page:https://doc.stride3d.net/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Wiki - Add comment about userdoc

VaclavElias opened this issue · comments

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..

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.

Thank you. That will help to clarify my updates.