softprops / shiplift

🐳 🦀 rust interface for maneuvering docker containers
MIT License
624 stars 119 forks source link

Document API endpoints #260

Closed vv9k closed 3 years ago

vv9k commented 3 years ago

What did you implement:

api_doc procedural macro that can be used to easily annotate functions and methods to automatically add hyperlinks to docker api reference website. Before I go on and finish documenting all endpoints I wanted to ask for a review and potential suggestions.

I think a proc macro is the best solution here. We have to compile syn and quote anyways as they are in the dependency tree so it's not that costly.

Closes: #259

How did you verify your change:

Ran cargo doc --no-deps and got expected results