XML documentation

Open Peewi opened this issue 3 years ago • 1 comments

I think it'd be really nice to have a Nuget package with documentation included. Some code files already have proper ///<summary> comments already, but there are also files that have documentation as plain // comments.

I tried building Steamworks.NET.Standard.csproj with GenerateDocumentationFile enabled, but got XML comment has badly formed XML errors from the following files:

/com.rlabrecque.steamworks.net/Runtime/types/MatchmakingTypes/gameserveritem_t.cs
/com.rlabrecque.steamworks.net/Runtime/types/SteamNetworkingTypes/SteamNetworkingIdentity.cs
/Steamworks.NET/com.rlabrecque.steamworks.net/Runtime/autogen/SteamEnums.cs

I'm a big fan of seeing documentation directly in Visual Studio and I think it makes code easier to work with.

Jul 31 '22 11:07 Peewi

Hmm yeah, looks like we largely only do the whole /// <summary> dance here for functions specifically.

https://github.com/rlabrecque/Steamworks.NET/blob/master/CodeGen/src/interfaces.py#L755-L762

Not quite sure why I didn't end up doing that for types (including interfaces themselves)

Jul 31 '22 21:07 rlabrecque