Skip to content

docs: generate XML docs from moby sources#97

Merged
HofmeisterAn merged 13 commits intotestcontainers:mainfrom
campersau:modelcomments
Apr 22, 2026
Merged

docs: generate XML docs from moby sources#97
HofmeisterAn merged 13 commits intotestcontainers:mainfrom
campersau:modelcomments

Conversation

@campersau
Copy link
Copy Markdown

@campersau campersau commented Apr 16, 2026

Parse go code comments and annotate c# types and fields with them.
This also adds the comments into the nuget package.

@campersau campersau marked this pull request as ready for review April 20, 2026 13:29
Copy link
Copy Markdown
Collaborator

@HofmeisterAn HofmeisterAn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool idea. I'll take a look at it later today or tomorrow. One thing that came to mind. It would be good to document the release tag (Docker version) we used to generate the model classes (README.md, somewhere in the sources, or the NuGet). WDYT?

@campersau
Copy link
Copy Markdown
Author

Yes, I can think of a readme file inside of the nuget package or just simply inside of the nuget package description.

@campersau
Copy link
Copy Markdown
Author

campersau commented Apr 21, 2026

Something like this? a87e576
image
image

Copy link
Copy Markdown
Collaborator

@HofmeisterAn HofmeisterAn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! I've made a few changes LMKWYT. Happy to merge it.

Comment thread src/Directory.Build.props
@HofmeisterAn HofmeisterAn changed the title Models comments docs: generate XML docs from moby sources Apr 22, 2026
@HofmeisterAn HofmeisterAn added the documentation Improvements or additions to documentation label Apr 22, 2026
Comment thread tools/specgen/specgen.go
@campersau
Copy link
Copy Markdown
Author

LGTM!

@HofmeisterAn HofmeisterAn merged commit d1eb254 into testcontainers:main Apr 22, 2026
15 checks passed
@campersau campersau deleted the modelcomments branch April 22, 2026 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants