Where can I find ECS method documentation?

Unity Engine
, , ,
1

Hi all, I see quite a few posts showing code like this:

        /// <summary>
        /// Returns a quaternion constructed by first performing 3 rotations around the principal axes in a given order.
        /// All rotation angles are in radians and clockwise when looking along the rotation axis towards the origin.
        /// When the rotation order is known at compile time, it is recommended for performance reasons to use specific
        /// Euler rotation constructors such as EulerZXY(...).
        /// </summary>
        /// <param name="x">The rotation angle around the x-axis in radians.</param>
        /// <param name="y">The rotation angle around the y-axis in radians.</param>
        /// <param name="z">The rotation angle around the z-axis in radians.</param>
        /// <param name="order">The order in which the rotations are applied.</param>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public static quaternion Euler(float x, float y, float z, RotationOrder order = RotationOrder.Default)

With extensive information in the XML summary, but I only get stubs/high level docs when I try to find info about methods.

A link/description of how to open the manual/code for an ECS method from Unity/Visual Studio would be much appreciated.

2

Yeah not sure how to make visual studios show this by default, there might be a way but it’s been a while since I’ve used VS, if not something you’re probably going to need to request specifically with the VS team. However if you use the Resharper plugin it should appear fine (or it’s visible with Rider etc)

3

Under preferences->External Tools there’s a whole bunch of checkboxes. After you click them and regenerate, all the F12 shortcuts should be more useful.

4

You saved my day. I only had local and embedded packages ticked. Thank you.

5

You can also dig into the package cache and explore the code as written.