DocFx warnings when building API Documentation
Opened this issue · 1 comments
AristurtleDev commented
Link to Document
No response
Description
DocFx generates the following warnings when generating the API 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 attribute
warning: /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 attribute
warning: /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 attribute
warning: /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 attribute
warning: /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 attribute
warning: /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 attribute
warning: /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 attribute
warning: /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 attribute
warning: /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 attribute
warning: /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 attribute
warning: /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 attribute
warning: /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 attribute
warning: /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 attribute
warning: /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 attribute
warning: /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 attribute
warning: /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 attribute
warning: /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 attribute
warning: /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 attribute
warning: /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 attribute
warning: /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 attribute
warning: /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)'.
Processing MonoGame.Framework
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 774These are just warnings and not errors, but would be nice to clean up what we can.
AristurtleDev commented
After the most recent changes to the develop branch, there are two warnings showing now.
Invalid link: '<a href="#Microsoft_Xna_Framework_GraphicsDeviceManager_CreateDevice">CreateDevice()</a>'. The file api/Microsoft.Xna.Framework.GraphicsDeviceManager.yml doesn't contain a bookmark named 'Microsoft_Xna_Framework_GraphicsDeviceManager_CreateDevice'.
Invalid link: '<a href="#Microsoft_Xna_Framework_GameComponentCollection_OnComponentRemoved_Microsoft_Xna_Framework_GameComponentCollectionEventArgs_">OnComponentRemoved(GameComponentCollectionEventArgs)</a>'. The file api/Microsoft.Xna.Framework.GameComponentCollection.yml doesn't contain a bookmark named 'Microsoft_Xna_Framework_GameComponentCollection_OnComponentRemoved_Microsoft_Xna_Framework_GameComponentCollectionEventArgs_'.
Working to resolve these next