docs: improve XML Comment

[CBID2]

PR Details

This PR improves the XML comment in the chapter about Enum Flags

Description

One of the users in Discord pointed out some inconsistencies in this chapter. Here's what's been done so far:

Defintion

• Turn "Flags that control how ray tests are performed" to "Flags that allows to modify default execution and performance of ray tests algorithms.".

Fields (Still a work in progress)

• Implement None = 0 Default execution with no modifiers.
• Add "Default execution with no modifiers." under None = 0
• Add "Do not return a hit when a ray traverses a back-facing triangle. The option refers only to triangle meshes - collision shapes are volumes and do not utilize backfaces, so it's hitpoint detection is not affected" under FilterBackfaces = 1 .
• Add "Prevents returned face normal getting flipped when a ray hits a back-facing triangle. The option refers only to triangle meshes - collision shapes are volumes and do not utilize backfaces, so it's hitpoint detection is not affected" under KeepUnflippedNormal = 2.
• Add "Uses an approximate but faster ray intersection algorithm. The algorithm is also used by default, even if the flag value is not used" under UseSubSimplexConvexCastRaytest = 4.
• Add "Switch convex cast algorithm from sub-simplex to slower, but more precise and complete Gilbert-Johnson-Keerthi variant". under UseGjkConvexCastRaytest = 8.
• Add "Don't use the heightfield raycast accelerator. This option reduces additional memory allocation at the expense of increased CPU cycles" under DisableHeightfieldAccelerator = 16.
• Mention eflags can be combined with bit operator potential newbies.

Related Issue

Closes #193

Motivation and Context

Improving this chapter would help new users understand that it is possible to combine more than one flag in raycast methods using bit operators.

Types of changes

• Docs change / refactoring / dependency upgrade
• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• My change requires a change to the documentation.
• I have added tests to cover my changes.
• All new and existing tests passed.
• I have built and run the editor to try this change out.

[manio143]

There's some misalignment in this PR where some comments are placed below the member instead of above it.