Resolve DocFx Documentation Warnings #8155
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR is to resolve the following warnings that are issued by DocFx when generating the site documentation.
warning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Platform/SDL/SDL2.cs(139,19): warning CS0659: 'Sdl.Version' overrides Object.Equals(object o) but does not override Object.GetHashCode()warning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Platform/SDL/SDL2.cs(139,19): warning CS0661: 'Sdl.Version' defines operator == or operator != but does not override Object.GetHashCode()warning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Graphics/PackedVector/HalfTypeHelper.cs(13,24): warning CS8981: The type name 'uif' only contains lower-cased ascii characters. Such names may become reserved for the language.warning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Color.cs(176,16): warning CS3021: 'Color.Color(uint)' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Color.cs(1791,23): warning CS3021: 'Color.PackedValue' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Game.cs(338,27): warning CS3021: 'Game.Window' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Graphics/PackedVector/Short4.cs(65,22): warning CS3021: 'Short4.PackedValue' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Graphics/PackedVector/Short2.cs(35,15): warning CS3021: 'Short2.PackedValue' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Graphics/PackedVector/Rgba64.cs(18,16): warning CS3021: 'Rgba64.PackedValue' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Graphics/PackedVector/Rgba1010102.cs(19,21): warning CS3021: 'Rgba1010102.PackedValue' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Graphics/PackedVector/Rg32.cs(18,21): warning CS3021: 'Rg32.PackedValue' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Graphics/PackedVector/NormalizedShort4.cs(35,22): warning CS3021: 'NormalizedShort4.PackedValue' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Graphics/PackedVector/NormalizedShort2.cs(35,21): warning CS3021: 'NormalizedShort2.PackedValue' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Graphics/PackedVector/Alpha8.cs(20,21): warning CS3021: 'Alpha8.PackedValue' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Graphics/PackedVector/NormalizedByte4.cs(35,21): warning CS3021: 'NormalizedByte4.PackedValue' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Graphics/PackedVector/NormalizedByte2.cs(35,23): warning CS3021: 'NormalizedByte2.PackedValue' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Graphics/PackedVector/Bgr565.cs(47,23): warning CS3021: 'Bgr565.PackedValue' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Graphics/PackedVector/Bgra4444.cs(49,23): warning CS3021: 'Bgra4444.PackedValue' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Graphics/PackedVector/HalfVector4.cs(79,22): warning CS3021: 'HalfVector4.PackedValue' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Graphics/PackedVector/Bgra5551.cs(19,23): warning CS3021: 'Bgra5551.PackedValue' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Graphics/PackedVector/Byte4.cs(65,21): warning CS3021: 'Byte4.PackedValue' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Graphics/PackedVector/HalfVector2.cs(53,21): warning CS3021: 'HalfVector2.PackedValue' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework/Graphics/PackedVector/HalfSingle.cs(19,23): warning CS3021: 'HalfSingle.PackedValue' does not need a CLSCompliant attribute because the assembly does not have a CLSCompliant attributewarning: /home/runner/work/monogame-11ty/monogame-11ty/external/MonoGame/MonoGame.Framework.Content.Pipeline/InvalidContentException.cs(99,30): warning CS0672: Member 'InvalidContentException.GetObjectData(SerializationInfo, StreamingContext)' overrides obsolete member 'Exception.GetObjectData(SerializationInfo, StreamingContext)'. Add the Obsolete attribute to 'InvalidContentException.GetObjectData(SerializationInfo, StreamingContext)'.warning: InvalidCref: Invalid cref value "!:other" found in XML documentation comment for Equals defined in ../external/MonoGame/MonoGame.Framework/BoundingBox.cs Line 463.warning: InvalidCref: Invalid cref value "!:obj" found in XML documentation comment for Equals defined in ../external/MonoGame/MonoGame.Framework/BoundingBox.cs Line 476.warning: InvalidCref: Invalid cref value "!:a" found in XML documentation comment for op_Equality defined in ../external/MonoGame/MonoGame.Framework/BoundingBox.cs Line 760.warning: InvalidCref: Invalid cref value "!:b" found in XML documentation comment for op_Equality defined in ../external/MonoGame/MonoGame.Framework/BoundingBox.cs Line 760.warning: InvalidCref: Invalid cref value "!:a" found in XML documentation comment for op_Inequality defined in ../external/MonoGame/MonoGame.Framework/BoundingBox.cs Line 774.warning: InvalidCref: Invalid cref value "!:b" found in XML documentation comment for op_Inequality defined in ../external/MonoGame/MonoGame.Framework/BoundingBox.cs Line 774Related Issues
This is in response to the following issue in the MonoGame documentation repo: MonoGame/docs.monogame.github.io#10