Skip to content

Generate XML documentation#206

Merged
tthiery merged 2 commits into
sharpbrick:masterfrom
FantasyTeddy:xml-doc
Jun 6, 2026
Merged

Generate XML documentation#206
tthiery merged 2 commits into
sharpbrick:masterfrom
FantasyTeddy:xml-doc

Conversation

@FantasyTeddy

@FantasyTeddy FantasyTeddy commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

I noticed, that there is no XML documentation in the NuGet packages.

I'm adding it globally (in the Directory.Build.props) and disable warnings about missing XML comments for public types or members (CS1591).

#205 non-breaking

@tthiery

tthiery commented Jun 6, 2026

Copy link
Copy Markdown
Member

Is there a particular motivation to activate the documentation? I mean most classes do not have a single documentation on it, I wonder which benefit this brings us beyond a longer build time?

I love what you do here, but if we do it, we have to first create meaningful class-level documentation before we start adding a file which bring zero benefits. I personally always prefer the library to be self-explaining and provide good markdown tutorials. That is also the reason why the README looks like it does.

Do you want to contribute a full class-level documentation?

@FantasyTeddy

Copy link
Copy Markdown
Contributor Author

The benefit that I can see, is that we could at least provide some documentation for anything that is already documented.

There is already some relevant documentation (e.g. DuploTrainBaseMotor.StartPowerAsync) that further explains how a method should be used.
I agree that the library should be self-explaining to some level, but having good class/method documentation can add meaningful benefits for anyone unfamiliar with it.

@tthiery

tthiery commented Jun 6, 2026

Copy link
Copy Markdown
Member

Okay, then let us do this.

@tthiery tthiery merged commit f90765c into sharpbrick:master Jun 6, 2026
1 check passed
@FantasyTeddy FantasyTeddy deleted the xml-doc branch June 6, 2026 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants