search

Shockah / Nickel

A modding API / mod loader for the game Cobalt Core.
Apache License 2.0
3 stars 5 forks source link

XML documentation of all public Nickel methods #33

Closed Shockah closed 3 months ago

Shockah commented 9 months ago

At the same time, a PR doing this should enable a linting rule to warn about any missing documentation for public members.

Fayti1703 commented 8 months ago

Would it be possible to annotate the public members somehow (e.g. with a JetBrains.Annotations.PublicAPI attribute)? That would help with getting an overview of what needs to be documented.

Shockah commented 8 months ago

It's essentially all types which are public, and all public members of said types.

Fayti1703 commented 8 months ago

At the same time, a PR doing this should enable a linting rule to warn about any missing documentation for public members.

Looking into this, it turns out MSBuild property GenerateDocumentationFile (which enables generating an .xml file with the documentation extracted) automatically enables the built-in warning for missing documentation on public types (CS1591).

(dotnet format does not display these, however. If we want a warning on PRs, that will require separate setup.)

Shockah commented 3 months ago

Done in upcoming Nickel 1.0.0. The warning for missing docs is not yet setup.