Documentation for SDK Libraries
tracked
Faxmashine
In the Udon Graph and Udon Sharp there is currently no documentation. It would be convenient to have direct access to each function's documentation from Unity.
Here's an example from UdonSharp, with documentation from https://docs.vrchat.com/docs/player-audio inserted:
Current:
public void SetVoiceDistanceNear(float near) => VRCPlayerApi._SetVoiceDistanceNear(this, near);
Proposed:
/// <summary>
/// The near radius, in meters, where volume begins to fall off. It is strongly recommended to leave the Near value at zero for realism and effective spatialization for user voices.
/// </summary>
/// <param name="far">in Meters, Range 0 - 1,000,000</param>
public void SetVoiceDistanceFar(float far) => VRCPlayerApi._SetVoiceDistanceFar(this, far);
According to the contributors of UdonSharp they cannot add documentation to the libraries themselves (for technical reasons).
For completeness sake I've attached an example of what it might look like in the Udon Graph. Though perhaps that should be a separate post.
Log In
This post was marked as
tracked
Heather May
How is this not already a thing anyways? It's standard practice for public - and even private - apis to have inline documentation, and c# already has a well defined format, which is shown above in an abbreviated fashion.
Happyrobot33
please for the love of god can we get this, itd help MASSIVELY when using vscode for U# and also developing normal C# code that has to interact with parts of the SDK. It doesnt even need to be in graph, just
having
it there would be massiveDrBlackRat
I would also love for the Nodes that currently link to the Unity Docs to have a short explanation on what they do. For someone who wants to learn how to make stuff with graph, who also has no prior coding experience, linking to the Unity Docs is kinda useless. They often don't understand them and are just getting overwhelmed by it.
Pikapetey
im STRUGGLEING with trying to learn as udon doesn't point to any learning resources.
Momo the Monster
interested
FairlySadPanda
Momo the Monster:
gasp
Momo the Monster
Strongly Agree!
FairlySadPanda
Upvoting this old Canny. VRC is providing the SDK3 codebase for our consumption, and just like any other public SDK it should have strong internal documentation that does not rely on Googling/checking a website.