Skip to content
This repository has been archived by the owner on Dec 18, 2023. It is now read-only.

Documentation for public API #90

Open
ProphetLamb opened this issue Oct 8, 2022 · 3 comments
Open

Documentation for public API #90

ProphetLamb opened this issue Oct 8, 2022 · 3 comments
Labels
documentation Improvements or additions to documentation hacktoberfest

Comments

@ProphetLamb
Copy link
Collaborator

When compiling to release mode, missing XML-documentation warnings are emitted. The generated XML-documentation is used to generate the API-documentation. It is therefore essential to have good documentation coverage. (I am personally very bad at it ^^)
@ProphetLamb ProphetLamb added documentation Improvements or additions to documentation hacktoberfest labels Oct 8, 2022
@jeffugo
Copy link

jeffugo commented Oct 10, 2022

Hi @ProphetLamb. I'd like to give this a go.

@ProphetLamb
Copy link
Collaborator Author

@jeffugo Awesome! Let me know if you need any assistance. Keep in mind, that these warnings are only generated for a release build dotnet build -c:Release.
Have fun!

@ProphetLamb ProphetLamb added the in-progress Work on the issue has commenced label Oct 16, 2022
@jeffugo
Copy link

jeffugo commented Oct 17, 2022

Hi @ProphetLamb. Unfortunately, I won't be able to work on this. I took on another project when I didn't get a reply after a few days.

@ProphetLamb ProphetLamb removed the in-progress Work on the issue has commenced label Oct 17, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation hacktoberfest
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ProphetLamb @jeffugo