Feature Request: Resolve Missing XML For Public Type Warnings about monogame HOT 4 OPEN

Thank you for proposing!

Tom is working on the onboarding process. Once setup, we'll be able to welcome contributions.

from monogame.

@AristurtleDev I'm ok with updating to use the new language.

from monogame.

Routinely I find myself wishing documentation for MonoGame was more available via intellisense, so would much appreciate this task happening.

I am willing to provide identification, sign an NDA, etc. to complete the grunt work of moving the XML documentation over if it would be helpful.

-Brett

from monogame.

@mrhelmut
cc: @Maniekko @dellis1972 @tomspilman

while working through some of this, I'm noticing some documentation language that might need to be updated. For instance, several of the == operator overload methods in the original XNA documentation just state the same thing

Compares the current instance of a class to another instance to determine whether they are the same.

(source: https://learn.microsoft.com/en-us/previous-versions/windows/xna/bb196576(v=xnagamestudio.42))

However, this summary text isn't correct. For instance, most of these are struct not class members. A more modern summary text would be something like

Returns a value that indicates whether two [explicit-type-name] are equal

where [explicit-type-name] is the type name like Bgr565

In these instances, would it be preferred to just use the original XNA documentation, or would it be ok to update the text to match a more modern summary?

from monogame.