Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some kind of API or Reference documentation? #949

Open
xaedes opened this issue Oct 29, 2020 · 3 comments
Open

Some kind of API or Reference documentation? #949

xaedes opened this issue Oct 29, 2020 · 3 comments
Labels

Comments

@xaedes
Copy link

xaedes commented Oct 29, 2020

Is there some kind of API reference?
netmq.readthedocs.io is just prosa and examples.

The code contains lots of documenting comments, where is the autogenerated documentation from this?

@drewnoakes
Copy link
Member

The ZeroMQ guide is the best foundational reference for ZeroMQ in general.

netmq.readthedocs.io provides some code samples specific to the particular .NET binding.

There's currently no browseable documentation generated from the doc comments, though they should be appearing in your IDE when consuming the project via a NuGet package.

@xaedes
Copy link
Author

xaedes commented Oct 30, 2020

Agreed, the ZeroMQ guide is a nice read.

It would be really awesome if the online documentation would include html documentation generated by the already existing sand castle project =)

An API reference browseable without huge IDE is a benefit for every great library.

@stale
Copy link

stale bot commented Apr 17, 2022

This issue has been automatically marked as stale because it has not had activity for 365 days. It will be closed if no further activity occurs within 56 days. Thank you for your contributions.

@stale stale bot added the stale label Apr 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants